Screenshots - FiveMesh Docs

Screenshot helpers use screenshot-basic to capture an image, then upload it through the SDK server resource. Start screenshot-basic before fivemesh-sdk.

ensure screenshot-basic
ensure fivemesh-sdk

Capture from the server

Use takeServerImage when a server script wants to request a screenshot from a specific player.

local result = exports["fivemesh-sdk"]:takeServerImage(source, {
    reason = "support-ticket"
}, {
    path = "screenshots/support",
    filename = "ticket.webp",
    encoding = "webp",
    quality = 0.82
}, 15000)

if not result.success then
    print(("FiveMesh screenshot failed: %s"):format(result.error.message))
    return
end

print(result.object.publicUrl)

The last argument is the timeout in milliseconds.

Capture from the client

Use client takeImage when client code should trigger its own screenshot.

local result = exports["fivemesh-sdk"]:takeImage({
    reason = "profile"
}, {
    path = "screenshots/profile",
    filename = "profile.webp"
})

if not result.success then
    print(("FiveMesh screenshot failed: %s"):format(result.error.message))
    return
end

print(result.object.publicUrl)

The client export sends the request back to the SDK server resource. The service key stays server-side.

Options

Option	Description
`path`	Destination folder inside your allowed CDN path.
`filename`	Stored filename.
`encoding`	Screenshot encoding: `png`, `jpg` or `webp`.
`quality`	Screenshot quality passed to `screenshot-basic`.
`metadata`	Custom metadata stored with the uploaded object.