Fivemanage SDK
Screenshots, image uploads and centralized logs for FiveM through exports.fmsdk.
Activation Contract
Load this skill when the user installs or configures the Fivemanage SDK, captures or uploads player screenshots, sends logs to the Fivemanage dashboard, or calls any exports.fmsdk function in Lua or JavaScript.
Hard Rules
- The resource folder must be named
fmsdkand sit directly inresources/; category folders are not supported. screenshot-basicis required fortakeImage/takeServerImageand mustensureBEFOREfmsdkinserver.cfg.- API keys are ConVars in
server.cfg(FIVEMANAGE_MEDIA_API_KEY,FIVEMANAGE_LOGS_API_KEY), never inconfig.json. Set only the keys for the features used. takeImageis CLIENT-side;takeServerImage(playerSource, ...)anduploadImage(buffer, ...)are SERVER-side.Log(dataset, level, message, metadata)is the primary log export;Info/Warn/Error(dataset, message, metadata)are fixed-level shorthands.LogMessageis legacy.- Include
playerSource/targetSourcein metadata so the SDK attaches player identifiers automatically. - Never expose API tokens to NUI; use presigned URLs for client-side uploads.
Decision Gates
| Need | Call |
|---|---|
| Screenshot from the player's own client | exports.fmsdk:takeImage({ ... }) |
| Screenshot of a player from the server | exports.fmsdk:takeServerImage(playerSource, { ... }) |
| Upload an existing image file/buffer | exports.fmsdk:uploadImage(buffer, { ... }) |
| Log with explicit level | exports.fmsdk:Log(dataset, level, message, metadata) |
| Quick log | exports.fmsdk:Info/Warn/Error(dataset, message, metadata) |
| Automatic player/chat/resource logs | config.json inside fmsdk |
Execution Steps
- Verify install order and ConVars (read rules/installation.md).
- Pick the side and export from Decision Gates.
- Attach metadata (
name,description,playerSource) so entries are searchable. - Choose a dataset per concern (
economy,anticheat,admin_actions). - Enable automatic events in
config.jsonwhen useful (read rules/configuration.md).
Output Contract
Return the server.cfg lines when installing, then runnable Lua or JS using exports.fmsdk with the side explicit and metadata included.
References
- rules/installation.md — download, folder placement, server.cfg order, API keys.
- rules/images.md — takeImage, takeServerImage, uploadImage, metadata.
- rules/logs.md — Log, Info/Warn/Error, LogMessage, datasets, identifiers.
- rules/configuration.md — config.json, automatic events, presigned URLs.
- rules/reference-links.md — official docs and SDK download.
Upstream docs: https://docs.fivemanage.com/fivem-sdk/installation