FiveM and RedM Plugin
ticket-tool-link connects your FiveM or RedM server to one Discord server. When someone opens a ticket, staff see the player's in-game name, whether they are online and when they were last seen, details from your framework such as character name and job, and any active ban from txAdmin or your server's own ban list. One resource covers both FiveM and RedM.
Community and Pro
Game server plugins are included with Community and Pro, the same as lookups and ban lookup. Game Server Plugins compares the five official plugins.
Requirements
- Server: a FiveM or RedM server (FXServer) that can run server-side JavaScript resources.
- Framework (optional): ESX, QBCore or ox_core, for the character name and job on the card.
- Ban source (optional): txAdmin. Without it, the resource reports its own ban list or your framework's bans.
- Network: outbound HTTPS to
dash.ticket-tool.app. There is no port to open.
How members are matched
FiveM and RedM servers see each connected player's discord: identifier from Cfx.re. Ticket Tool sends the plugin the ticket opener's Discord ID, and the plugin finds the player with that identifier. Members don't link anything: the lookup works for anyone who has Discord connected to their Cfx.re account and has played on your server.
Your server's admins can already see the Discord IDs of players on their own server. Ticket Tool sends a ticket opener's Discord ID only to the plugin of the Discord server the ticket was opened in.
Download
Download ticket-tool-link-fivem-<version>.zip from the FiveM releases page of the open-source ticket-tool-app/integrations repository.
Setup
Create a plugin key
Go to Dashboard → Automations → Connections. Under Game server plugins, click Create a key, pick FiveM / RedM and name it after the server. Copy the key: it is only shown once. Create one key for each server you run.
Install the resource
Unzip the release into your server's resources folder. It unzips to resources/ticket-tool-link.
Paste the key
Add the key as a convar to server.cfg, above the ensure line that starts the resource:
set ticket_tool_key "ttp_0123456789abcdef.your-key-here"
ensure ticket-tool-link
Restart the server, or run ticketlink reload in the server console. Within a few seconds the key shows Connected now on the Connections page, and ticketlink status says the resource is connected. Keep server.cfg out of public repositories: the key can answer lookups for your Discord server.
Turn it on in a category
Edit a category and open Game server tools on the General tab. Switch on FiveM / RedM in the Lookups card, tick FiveM / RedM in the Ban lookup card, or both.
Commands
| Command | What it does |
|---|---|
ticketlink status | Shows the connection state, key id, Discord server and ban source |
ticketlink reload | Re-reads the convars and reconnects |
Run them in the server console, or in game as a player with the command.ticketlink ace.
Configuration
All settings are convars in server.cfg, set above ensure ticket-tool-link:
| Convar | Default | What it does |
|---|---|---|
ticket_tool_key | The full key from the dashboard. Required | |
ticket_tool_server_name | The name staff see for this server; empty uses the key's name | |
ticket_tool_ban_provider | auto | auto, txadmin, server or none |
ticket_tool_txadmin_db | Where to read txAdmin bans from, when txAdmin's isn't found on its own |
What staff see
- Lookups card: the player's in-game name, Online on the server or Offline with the last-seen date, when they first joined, their Steam profile when the player has Steam linked in FiveM, and up to six extra lines from the plugin, such as character name and job.
- Ban lookup card: a FiveM / RedM row with the reason, date, expiry and moderator.
- Variables:
{fivem.name},{fivem.online},{fivem.last_seen},{fivem.first_seen},{fivem.server},{fivem.steam_id},{fivem.url}and{fivem.details}, plus{bans.fivem.banned},{bans.fivem.reason}and the otherbans.fivemfields.{fivem.linked}is alwaystrue, since the Discord account is the link. Variables says what each one holds.
If the plugin is offline or slow, the ticket still opens straight away and the card says the plugin didn't answer.
Ban sources
provider | Ban source |
|---|---|
txadmin | txAdmin bans |
server | The resource's own list, or your framework's bans |
Rotating or revoking a key
On the Connections page, Rotate issues a new key for the same entry and stops the old one at once, so put the new key in the plugin's config and reload. Revoke deletes the key, and FiveM lookups show as unavailable. To build a plugin of your own, see the Game Plugin Protocol.