SYS.SETUP
> FIVEM_API - Installation & Configuration Guide
Follow these steps to connect Discord role records, Chroma FiveM API licensing, ACE mappings, and the FiveM resource into one working permission pipeline.
Install Chroma FiveM API
Install both parts of the Chroma FiveM API pipeline before generating your server key or configuring ACE permissions.
> PART_01 - INVITE THE BOT
Add the Chroma Discord Perms API bot to the Discord server that owns your FiveM or RedM community roles.
- Grant Administrator during setup so slash commands and role recovery can operate
- Keep Server Members Intent enabled for accurate member and role tracking
- Role records sync automatically when member roles change
> PART_02 - GET THE FIVEM RESOURCE
Download the free Chroma FiveM Resource from Tebex and install it into your FiveM server resources folder.
Get Free ResourceActivate the Guild License
Most API operations require an active guild license. Start billing from Discord using the subscription command.
/subscribe
Starts the Chroma Discord Perms API subscription for the current guild.
After Stripe reports the payment, the bot updates the guild license expiration, subscriber ID, and subscription ID in the API database.
IMPORTANT
If a guild has an expired subscription record, an admin may need to run /unsubscribe before a new subscription can be started.
Generate the Server Key
Generate the key your FiveM or RedM resource will use to authenticate with Chroma FiveM API.
/generate_server_key
Requires guild_admin access or the guild owner. The command asks for confirmation before replacing an existing key.
The generated key is shown once in an ephemeral Discord response. Add it to your server resource configuration before restarting or reloading the resource.
Configure API Permissions
Use the API permission engine to delegate operational commands to trusted roles or users.
/permission Add <trigger> <role_or_user>
Example: allow a staff role to update ACE mappings.
/permission Add [Ace Cmd Access] [@Server Admin]
Common triggers:
Map Discord Roles to ACE
Map Discord roles to the ACE groups and permissions your FiveM resource should grant.
/ace set <role>
Enter groups and ACE values in the modal. Leave both empty to remove that role mapping.
After saving mappings, run the console refresh command in your FiveM server:
chromaapireload
Run the First Full Sync
Seed the API with current Discord role records before relying on the FiveM resource.
/syncallmemberstoapi
Writes each member's non-everyone role IDs into the API database in batches.
For a single user correction, run /syncmembertoapi. The bot will also keep records fresh automatically when member roles change.
Link Extra Discord Guilds
If one FiveM server needs role data from multiple Discord guilds, link secondary guilds as slave guilds to the parent license.
/link_slave_guild <slave_guild_id>
The requester must be an administrator in both guilds.
Slave guilds inherit the parent guild's license key. If a slave needs its own key later, the guild owner can unlink it through /generate_server_key.
> SETUP_COMPLETE
API link is live - now what?
Use the command reference to review every sync, ACE, license, billing, and recovery command available to your staff.
View Command Reference