FiveM SDK
Powerful FiveM integration for media uploads and logging
FiveM SDK
The Fivemanage FiveM SDK provides seamless integration with your FiveM server, enabling effortless media uploads and structured logging without complex HTTP requests.
Features
- Screenshot Capture - Take client screenshots from server-side
- Client-side Uploads - Direct NUI integration for images/videos
- Smart Logging - Automatic player identifier attachment
- Flexible Config - Customize everything via config.json
- Secure - Built-in token management and validation
Prerequisites
Required Dependency: screenshot-basic - Essential for capturing client screenshots.
Download and install screenshot-basic before proceeding with the SDK installation.
Installation
Download the SDK
Obtain the latest release of the Fivemanage SDK from the release page. Ensure you download the fmsdk.zip file. It's recommended to download this release instead of cloning the repository unless you intend to build the project yourself.
Extract to Resources
Unzip and place the fmsdk folder into your FiveM server's resources folder.
Setup Dependencies
If not already present, download and set up screenshot-basic by following its installation instructions. This resource is essential for capturing client screen images.
Configure Server CFG
Make sure screenshot-basic is started before fmsdk in your server.cfg. Add the following lines:
ensure screenshot-basic # Only add this line if `screenshot-basic` is not already ensured in your configuration.
ensure fmsdk # The SDK must be started after the `screenshot-basic` resource.Add the following ConVars to your server.cfg for API authentication:
set FIVEMANAGE_MEDIA_API_KEY your_api_key
set FIVEMANAGE_LOGS_API_KEY your_api_keyLearn more about ConVars in the FiveM documentation.
Resource Configuration
Review and adjust the settings in config.json to match your preferences and requirements. This file contains important configuration options that affect how the SDK operates on your server.
Next Steps
- Image Upload - Learn how to upload images and screenshots
- Logs - Implement comprehensive logging functionality