Installer l’agent

Exports serveur

La resource fivedock donne cinq exports à vos scripts serveur. Appelez-les depuis du Lua côté serveur : ils passent par la connexion de l’agent, votre script n’a donc besoin d’aucun token. fivedock_upload_allow décide quelles resources peuvent appeler ceux qui envoient des fichiers.

-- server.lua: /evidence <player id> screenshots that player, for staff only
RegisterCommand('evidence', function(source, args)
  local target = tonumber(args[1])
  if not target then return end

  exports.fivedock:screenshot(target, {
    folder   = '/evidence',
    encoding = 'webp', -- 'jpg' (default), 'png' or 'webp'
    quality  = 0.85,   -- 0 to 1
  }, function(err, file)
    if err then
      print(('screenshot failed: %s'):format(err))
      return
    end
    print(('%s, %d bytes, %s'):format(file.url, file.size, file.mimeType))
  end)
end, true)

-- a file your resource wrote to resources/my-script/cache/shot.jpg
exports.fivedock:upload({
  resource = 'my-script',      -- defaults to the resource calling the export
  path     = 'cache/shot.jpg', -- relative to that resource's folder
  name     = 'shot.jpg',
  folder   = '/screenshots',
}, function(err, file)
  if not err then print(file.url) end
end)

exports.fivedock:uploadFile('my-script', 'cache/shot.jpg', {
  name   = 'shot.jpg',
  folder = '/screenshots',
}, function(err, file)
  if not err then print(file.id, file.url) end
end)

Le callback

Chaque export d’envoi appelle cb(err, file) une seule fois. En cas de succès, err vaut nil et file est une table avec id, url, size et mimeType. En cas d’échec, err est une chaîne qui dit pourquoi, et file vaut nil.

function(err, file)
  -- on success: err = nil
  --   file = { id = '8Kq2nR4t', url = 'https://cdn.fivedock.dev/f/8Kq2nR4t.jpg',
  --            size = 48213, mimeType = 'image/jpeg' }
  -- on failure: err = 'screenshot-basic is not started' (or another reason), file = nil
end

report

Dépose un signalement de joueur que le staff de service voit dans le panel. source est le joueur qui signale, message dit ce qui s’est passé, et subjectSource, si vous le passez, est le joueur signalé. Renvoie true, ou false et une raison : empty quand le message fait moins de 3 caractères, too_soon dans les 30 secondes qui suivent le dernier signalement de ce joueur.

-- source reports subjectSource; subjectSource is optional
local ok, reason = exports.fivedock:report(source, 'He rammed my car at Legion Square', 12)
if not ok then
  print(('report refused: %s'):format(reason)) -- 'empty' or 'too_soon'
end

log

Écrit un événement dans la Black Box. source est le joueur concerné, ou 0 pour aucun ; event est un nom à points comme money.transfer ; meta est une table de champs facultative, et un amount numérique dedans compte pour les alertes d’économie. L’agent enregistre déjà tout seul les connexions et déconnexions, les morts, le chat, les mouvements d’argent d’ESX et de QBCore, les déplacements d’ox_inventory et les bans, kicks et avertissements de txAdmin : cet export sert à ce que seuls vos scripts savent.

-- source is the player it is about, or 0; meta is optional
exports.fivedock:log(source, 'money.transfer', 'Paid 500 to Bo for the car', {
  amount = 500, to = 'license:9a4f…',
})