Instalar el agente

Exports de servidor

El recurso fivedock da cinco exports a tus scripts de servidor. Llámalos desde Lua del lado del servidor: van por la conexión del propio agente, así que tu script no necesita ningún token. fivedock_upload_allow decide qué resources pueden llamar a los de subida.

-- 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)

El callback

Cada export de subida llama a cb(err, file) una sola vez. Si sale bien, err es nil y file es una tabla con id, url, size y mimeType. Si falla, err es un texto que dice por qué, y file es 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

Envía un reporte de jugador que el staff de guardia ve en el panel. source es el jugador que reporta, message cuenta qué pasó y subjectSource, si lo pasas, es el jugador reportado. Devuelve true, o false y un motivo: empty si el mensaje tiene menos de 3 caracteres, too_soon si no han pasado 30 segundos desde el último reporte de ese jugador.

-- 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

Escribe un evento en la Black Box. source es el jugador del que trata, o 0 si no es de nadie; event es un nombre con puntos como money.transfer; meta es una tabla opcional de campos, y un amount numérico dentro cuenta para las alertas de economía. El agente ya registra por sí solo las entradas y salidas, las muertes, el chat, los cambios de dinero de ESX y QBCore, los movimientos de ox_inventory y los bans, kicks y avisos de txAdmin, así que este export es para lo que solo saben tus scripts.

-- 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…',
})