Installation

To start, you need to create a project. If you haven't done that yet, go to the website right now, create a project, and come back here — if anything is unclear.

Connect server

1. Go to the Servers section.
2. Click the Connect server button.

3. In the window that opens, download the plugin.

Oxide

Place the downloaded RustApp.cs into the oxide/plugins folder.

Carbon

Place the downloaded RustApp.cs into the carbon/plugins folder.

4. Once the plugin is successfully initialized on the server, copy the ra.pair {code} command from the previously opened window and run it in the server console.
5. Now that the server is connected, you’ll be prompted to finish the setup by specifying the name that will be displayed on the website.

Short Server Name

We recommend choosing a short and unique server name. For example, if you have multiple servers with numbers, use names like #01, #02, and so on. If your servers have unique names like MAIN or MONDAYS, use those instead.

Plugin Config

It’s also a good idea to adjust the plugin configuration right away to fit your needs. For example, if your server is listed under the Community tab where custom interfaces are not allowed, you should disable the report interface. To do this, simply remove the report and reports commands from the plugin. See the example below.

RustApp.json (Community tab mode)

{
  "[UI] Chat commands": [ 
    "report", 
    "reports"
  ], 
  "[UI] Chat commands": [], 
}

Below you can read more about all the plugin configuration parameters.

RustApp.json

{
  "[UI] Chat commands": [
    "report",
    "reports"
  ],
  // Report reasons that will be shown to the player when submitting a report via the plugin's UI
  "[UI] Report reasons": [
    "Cheat",
    "Macros",
    "Abuse"
  ],
  // Cooldown (in seconds) before the player can submit another report
  "[UI] Cooldown between reports (seconds)": 300,
  // Whether to automatically handle reports submitted via the in-game F7 menu
  "[UI] Auto-parse reports from F7 (ingame reports)": true,
  // Number of days to show the "Checked" tag after a player passes a check
  "[UI] Show 'recently checked' checkbox (amount of days)": 7,
  // SteamID of the avatar shown in plugin messages (default is the RustApp logo)
  "[Chat] SteamID for message avatar (default account contains RustApp logo)": "76561198134964268",
  // Command used to send contact information during a player check
  "[Check] Command to send contact": "contact",
  // Do not modify these settings unless you know what you're doing — they are required for full site functionality
  "[Components • Custom actions] Allow console command execution": true,
  "[Components • Signages] Collect signages": true,
  "[Components • Kills] Collect kills": true,
  "[Components • Mutes] Support mutes system": true
}