Docs

Rust Integration

Connect a Rust (Facepunch) server to Discord for status, killfeed, per-wipe statistics and Steam linking

Overview

The Rust module links a Rust (Facepunch) server to your Discord server. It posts live status and a killfeed, keeps per-wipe player statistics and leaderboards, and lets members connect their Steam account to their Discord account. There are two ways to connect, and the one you pick decides how much detail Modora can see.

RCON modePlugin mode

Connection Modes

Every Rust server is registered in the dashboard with one of two connection modes. RCON is the starting point and works everywhere. Plugin mode is RCON plus an extra data source, so it does everything RCON does and more.

RCON mode

Works on any Rust server, including vanilla. No mod, no plugin, no server files to change. Setup is pasting the RCON host, port and password from your host panel into the dashboard.

  • • Live server status: online or offline, player count and map seed
  • • Killfeed posts naming the attacker and the victim
  • • Kills, deaths and K/D per player
  • • Playtime and leaderboards for the current wipe
  • • Steam account linking and the linked role

Plugin mode

Adds the Modora.cs plugin on top of RCON, running on Oxide or Carbon. The plugin reports events the console never prints, so only this mode can deliver the items below.

  • • Gathered resources and farming leaderboards
  • • Weapon, distance and body part on every kill
  • • Raid alerts
  • • In-game reports that arrive in Discord
  • • Exact wipe detection, reported by the server itself

The killfeed is not the same in both modes

On RCON alone the killfeed names the attacker and the victim, and that is all it can name. Weapon, distance and body part are not in the console output, so they only appear once the plugin is installed.

Features

Live status

A status message in a channel of your choice, showing whether the server is up, how many players are on and which map seed is running.

Killfeed

Kills posted to a channel as they happen. Attacker and victim in both modes, weapon and distance and body part in plugin mode.

Leaderboards

Boards for kills, K/D and playtime over the running wipe, readable in Discord and in the dashboard.

Wipe handling

Statistics are kept per wipe. When the server wipes, the boards start over and the previous wipe stays readable.

Steam linking

Members connect their Steam account to their Discord account through the dashboard or with a code typed in game chat.

Raid alerts

Alerts when a base is being raided. Plugin mode only, because the console does not report raids.

In-game reports

A player reports someone in game and the report lands in Discord for your staff. Plugin mode only.

Gather tracking

Gathered resources per player and a farming board. Plugin mode only, and switched off until you turn it on.

Setup: RCON

This is the whole setup for RCON mode. Nothing is installed on the game server.

01

Turn on the Rust module

Open your server in the Modora dashboard and enable the Rust module.

02

Add the server

Add a Rust server, give it a name and choose RCON as the connection mode.

03

Paste the RCON details

Fill in the RCON host, the RCON port and the RCON password. Your game host shows these in its control panel.

04

Pick the channels

Choose which channel gets the status message, the killfeed and the leaderboards. Every one of them is off until you pick a channel for it.

Setup: Plugin

Plugin mode keeps the RCON connection and adds Modora.cs on the game server. Do the RCON setup first, then continue here.

01

Switch the server to plugin mode

Open the server you added and change the connection mode to plugin.

02

Copy the API key

The dashboard shows an API key for this server. It is how the plugin proves which server it is reporting for. You can regenerate it at any time, which immediately invalidates the old one.

03

Install Modora.cs

Download Modora.cs from the dashboard and drop it in the plugins folder of your Oxide or Carbon install. One of the two is required, because vanilla Rust cannot load plugins.

04

Configure the plugin

Put the API key in the plugin configuration and reload the plugin. The dashboard shows when the server last reported in, so you can confirm it arrived.

05

Turn on the plugin features you want

Raid alerts, in-game reports and gather tracking each have their own switch and each starts off. Turn on the ones you want.

Info

Plugin mode does not replace RCON. The RCON connection stays in place for live status, and the plugin adds the events the console cannot report.

Wipes

A wipe is the axis the whole module turns on. Rust servers reset regularly, and statistics that carry across a reset stop meaning anything, so Modora stores everything per wipe.

How wipes are handled

  • Player statistics are stored against the wipe they were earned in
  • Leaderboards reset when the server wipes and start again from zero
  • Previous wipes stay readable, so nothing is thrown away
  • In plugin mode the server reports the wipe itself, so the moment is exact

The monthly force wipe

Facepunch force wipes on the first Thursday of the month. Whether your server also wipes the map or blueprints outside of that is the server owner's choice, and Modora follows whatever your server does.

Account Linking

Statistics only reach a Discord member once their Steam account is connected. There are two routes, and a server can offer both.

Through the dashboard

A member signs in with Steam from the dashboard. Steam confirms who they are, and Modora connects that Steam account to their Discord account.

With a code in game chat

A member gets a code from the bot and types it in the game chat of your server. The server sees who typed it, which connects the same two accounts without leaving the game.

Tip

Optionally you can name a role that every member with a linked account gets. It is a normal Discord role, so you decide what it unlocks.

Discord Commands

/rust status

Show the current state of your Rust servers: up or down, players on and map seed.

/rust top

Show the top players of the current wipe. Rank on kills, K/D or playtime.

/rust profile

Show the Rust statistics of yourself or another member for the current wipe.

/rust link

Explain how to link a Steam account to a Discord account.

Gather Tracking

Gather tracking counts the resources a player collects and turns them into a farming board. It works only in plugin mode, and it is off until a server owner switches it on.

Why this one is opt-in

Every other part of the module records notable events: a kill, a join, a wipe. Gather tracking records every swing of a tool, which makes it by far the largest amount of data the module stores. That is why it is a separate switch instead of something that comes on by default.

What Each Mode Cannot Do

Neither mode does everything. Knowing the edges up front is cheaper than finding them later.

RCON mode cannot

  • Name the weapon, distance or body part on a kill
  • Count gathered resources or build a farming board
  • Send raid alerts
  • Receive in-game reports
  • Detect a wipe exactly, because it has to infer one from a changed map seed

Plugin mode still needs

  • Oxide or Carbon on the game server, since vanilla Rust loads no plugins
  • A working RCON connection, which plugin mode keeps rather than replaces
  • The plugin to be reachable, so a server that stops reporting stops adding new events

What Modora Never Does

The module reads what a server owner has switched on, and nothing else.

  • • It does not read or store anything you have not turned on. Every feature has its own switch, and each one starts off.
  • • Chat relay is off by default. Game chat is only sent to Discord once you enable it and pick a channel.
  • • Gather tracking is a separate opt-in, kept apart from the rest for exactly that reason.

Was this page helpful?