Skip to main content

Game Server Plugins

A game server plugin lets your own server answer for one Discord server. When a ticket opens, Ticket Tool asks the plugin about the opener, and staff see the player's profile in the Lookups card and their bans in the Ban Lookup card. Staff can also act on a player from Discord, and players can send a report from in game that opens a ticket. The official plugins are open source, in ticket-tool-app/integrations.

Community and Pro

Game server plugins are included with Community and Pro: lookups, ban lookup and in-game reports. Staff actions need Pro. On Free, plugin requests are refused.

Pick your game

GameHow the opener is matchedBan sources
MinecraftA code typed in game (/ttlink)LiteBans, AdvancedBan, LibertyBans, vanilla
FiveM and RedMDiscord ID, nothing to linktxAdmin, the server's own list
Garry's ModShared Steam accountULX, SAM, banned_user.cfg
RustShared Steam accountThe server's own ban list
CS2Shared Steam accountCS2-SimpleAdmin, the server's own list

"Shared Steam account" means the Steam account the member linked on their Linked accounts page and shared with your Discord server. Members who haven't shared one get a No Steam account shared with this server row instead.

How it works

1
Create a key
One per game server, under Automations → Connections
2
Plugin connects out
It holds an outbound HTTPS connection to Ticket Tool
3
Ticket opens
Ticket Tool asks the plugin about the opener
4
Staff see the card
Profile and bans, posted where only staff can see them
  • No port to open. The plugin only makes outbound HTTPS requests to dash.ticket-tool.app, and Ticket Tool never connects to your server or its database.
  • One key, one Discord server. A key can only answer lookups and report account links for the Discord server that created it. It can't read tickets or change settings.
  • The ticket never waits. Lookups get 4 seconds and ban checks 5. A plugin that is offline or slow leaves a note on the card, and the ticket opens anyway.
  • Profiles are always live. Ticket Tool asks the plugin on every ticket, so online status is current. Ban answers are cached for 10 minutes per member, like every ban lookup source.

Keys

Create keys under Dashboard → Automations → Connections, in the Game server plugins section. Click Create a key, pick the game and name the key after the server. The name is shown on the ban lookup card when a player is banned on that server. Copy the key straight away: it is only shown once, and it only works with the plugin for that game.

The section shows each key's game, when its plugin last connected and which version it reported. A key shows Connected now while its plugin is online.

  • Rotate issues a new key for the same entry and stops the old one at once. The plugin stays offline until you paste the new key into its config and reload it.
  • Revoke deletes the key. The plugin stops working, and lookups for that server show as unavailable.

Staff actions

With Pro, staff can message, warn, kick or unban a player from Discord. Each plugin type you hold a key for shows up as a Game server app, such as Minecraft or Rust, wherever connected-app actions are offered:

  • On a ticket: Run an app action under Connected apps in the dashboard's ticket panel. It needs the Manage Settings permission.
  • In a flow: an Integration node such as Game server: Kick player from the node picker, for example to kick a player when a staff member picks Kick in a ban appeal flow.
  • In a rule: Do something in a connected app as the action of an automation rule.
ActionFieldsNotes
MessagePlayer, messageThe player must be online
WarnPlayer, warningThe player must be online
KickPlayer, reasonThe player must be online; reason optional
UnbanPlayerNot available on FiveM and RedM

Player is a Discord user ID and defaults to {{ticket.creator.id}}, the member who opened the ticket. Ticket Tool finds them in game by the account they linked: their Minecraft account, the Steam account they shared with your server, or on FiveM their Discord ID. The in-game message names the staff member who ran it.

  • Off until you turn it on. Every action is off in the plugin's config. A plugin that hasn't turned an action on is never sent one, and the key's row on the Connections page lists the actions each plugin has on.
  • Sent to every connected server of that game. On a network with several keys for the same game, every connected plugin with the action on gets it, and the first one that carries it out answers. An unban lifts the ban wherever it's found.
  • A clear answer either way. If the player is offline, isn't banned, or the action is off, staff see why, and a flow takes its error path.

In-game reports

On Community and Pro, players can type /report in game (!report on Garry's Mod and CS2), optionally naming the player they're reporting. Turn reports on in the plugin's config, then add an automation rule with the trigger When a player sends a report in game and the action Open a ticket.

1
Player reports
/report Griefer123 breaking the spawn fountain
2
Plugin sends it
Signed with the server's key, one report per cooldown
3
Rule opens a ticket
In the category the rule picks
4
Staff see the report
Who sent it, who they reported, and from which server
  • Opened as the reporter when Ticket Tool knows them. A player whose linked game account matches one member of your server gets the ticket as that member. Otherwise the bot opens it, and the report says no linked account was found.
  • One ticket per reporter. If the reporter already has an open ticket in that category, the report is posted there instead of opening another.
  • Rate limited. Each player has a cooldown set in the plugin's config, and each key can send at most 10 reports a minute.

Each plugin's page has the config to turn actions and reports on.

Build your own

The protocol is plain HTTPS and JSON with HMAC signing, and works for any game. Game Plugin Protocol has the endpoints, message shapes and test values, and the integrations repository holds Java, TypeScript and .NET SDKs.