Skip to main content

​
Prerequisites

Before installing the SDK, ensure you have the following:
  • A Fivemanage account and API keys (Media and Logs).
  • screenshot-basic: Required for capturing client screenshots.

​
Installation Steps

1

Download the SDK

Obtain the latest release of the Fivemanage SDK from the GitHub releases page. Download the fmsdk.zip file.
2

Extract to Resources

Unzip the fmsdk.zip and place the fmsdk folder into your FiveM server’s resources directory.
Ensure the folder is named fmsdk and is placed directly in the resources folder. FMSDK does not support category folders.
3

Install Dependencies

If you don’t have screenshot-basic installed, download it and add it to your resources folder. This is essential for the takeImage functionality.
4

Configure server.cfg

Add the following lines to your server.cfg. Ensure screenshot-basic starts before fmsdk.
ensure screenshot-basic
ensure fmsdk
5

Set API Keys

Add your Fivemanage API keys as ConVars in your server.cfg:
set FIVEMANAGE_MEDIA_API_KEY "your_media_api_key"
set FIVEMANAGE_LOGS_API_KEY "your_logs_api_key"
You only need to set the keys for the features you plan to use.

​
Configuration

After installation, you can further customize the SDK’s behavior by editing the config.json file located within the fmsdk resource folder.

Configuration Guide

Explore all available configuration options in config.json.