Skip to main content

Rust Plugin

TicketToolLink connects your Rust 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, their playtime, and any active ban from the server's ban list. It is a single-file plugin for Oxide (uMod) and Carbon.

Community and Pro

Lookups, ban lookup and in-game reports are included with Community and Pro. Staff actions need Pro. Game Server Plugins compares the five official plugins.

Requirements

  • Server: a Rust dedicated server running Oxide (uMod) or Carbon.
  • Network: outbound HTTPS to dash.ticket-tool.app. There is no port to open.

How members are matched

Ticket Tool looks up the Steam account the ticket opener linked on their Linked accounts page and shared with your Discord server, and asks the plugin about that SteamID64. There is no in-game linking: members link Steam once, by signing in through Steam or importing it from Discord. If the opener hasn't shared a Steam account with your server, the card says so and the plugin isn't asked.

Download

Download TicketToolLink-rust-<version>.cs from the Rust releases page of the open-source ticket-tool-app/integrations repository. Each release has a .sha256 checksum file next to it.

Setup

Create a plugin key

Go to Dashboard → Automations → Connections. Under Game server plugins, click Create a key, pick Rust and name it after the server. Copy the key: it is only shown once. Create one key for each server you run.

Install the plugin

Rename TicketToolLink-rust-<version>.cs to TicketToolLink.cs and put it in oxide/plugins (Oxide) or carbon/plugins (Carbon). The plugin loads on its own and creates its config file: oxide/config/TicketToolLink.json or carbon/configs/TicketToolLink.json.

Paste the key

Paste the whole key from the dashboard into the key field:

{
  "key": "ttp_0123456789abcdef.your-key-here",
  "api-url": "https://dash.ticket-tool.app"
}

Run ticketlink reload. Within a few seconds the key shows Connected now on the Connections page, and ticketlink status says the plugin is connected. The key is never written to the server log.

Turn it on in a category

Edit a category and open Game server tools on the General tab. Switch on Rust in the Lookups card, tick Rust server in the Ban lookup card, or both.

Commands

CommandPermissionWhat it does
ticketlink statustickettoollink.adminShows the connection state, key id, Discord server and ban source
ticketlink reloadtickettoollink.adminRe-reads the config and reconnects

Both work from the server console. To let a player run them in game, grant tickettoollink.admin with your permissions plugin.

What staff see

  • Lookups card: the player's in-game name with a link to their Steam profile, their SteamID64, Online on the server or Offline with the last-seen date, when they first joined, and up to six extra lines from the plugin, such as their playtime.
  • Ban lookup card: a Rust server row with the reason, date, expiry and moderator from the server's own ban list. Steam's VAC and game bans are a separate Ban Lookup source.
  • Variables: {rust.linked}, {rust.name}, {rust.steam_id}, {rust.url}, {rust.online}, {rust.last_seen}, {rust.first_seen}, {rust.server} and {rust.details}, plus {bans.rust.banned}, {bans.rust.reason} and the other bans.rust fields. Variables says what each one holds.

If the plugin is offline or slow, the ticket still opens straight away. Staff see the linked Steam account and a note that the plugin didn't answer.

Staff actions and in-game reports

Staff can message, warn, kick or unban a player from Discord, and players can report from in game. Both are off until you turn them on in the plugin's config, and Ticket Tool only offers the actions you turned on. Staff actions need Pro; in-game reports work on Community and Pro. Staff actions and In-game reports explain where staff run them and how a report opens a ticket.

{
  "actions": ["message", "warn", "kick", "unban"],
  "reports": true,
  "report-command": "report",
  "report-cooldown-seconds": 60
}

Run ticketlink reload after changing them.

ActionWhat happens in game
messageThe player gets a chat message from the staff member
warnThe player gets a warning in chat
kickThe player is kicked with the reason staff typed
unbanThe player is removed from the server's ban list (ServerUsers), which is then saved

Staff text is shown as typed, without Rust's rich text tags. With reports on, /report [player] <message> sends a report to Ticket Tool. The first word counts as the reported player only when it's the name of someone online, and each player can send one report every report-cooldown-seconds.

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 Rust lookups show as unavailable. To build a plugin of your own, see the Game Plugin Protocol.