RUST: Modding your Server using Oxide

From TRUgaming Wiki
Jump to navigation Jump to search

Main Page | RUST

** WARNING!!!! ***

Not all mods are supported for mod stacking (multiple mods). Mods may also be outdated upon release of new game updates which have caused major issues for server owners in the past (data loss, crashing).
Also, note that technical support related to mods will be rather limited. The moment mods are installed, we are not held liable for any issues which may be related to the mod install - including data loss, service
instability, and so forth. You are given every tool necessary to add and maintain mods.

  • Oxide cannot be totally uninstalled. The Uninstall option in the mod manager simply changes the flag, allowing you to reinstall it.
    • Oxide replaces several key Rust .dll files.
    • To remove Oxide from your server you need to Reinstall (wipe) your server from the Actions tab menu.
  • Oixde for Rust:
    • Oxide for Rust Website
      Please make sure you follow the Oxide/Rust page for updates and issues regarding updates.
      Sometimes the Oxide developer will disable things because of patch issues and this may break plugins!!!!!


Installation

  • To install Oxide on your server:
  1. Stop your server
  2. Go to the Mod Manager
    ModManager.png
  3. Click on the Install link for Oxide. This will download and install the latest version of Oxide.
    NoOxide.png
    IMPORTANT When installing Oxide use the Configuration Editor option not the Default Values option
    OxideInstall.png
  4. Click on the Install button
  5. Once the installation is complete, Start your server

Update

Option 1

  1. Stop your server
  2. Click on the Updates icon
    Updates.png
  3. Click on the [Install] link for the Oxide Update
    Updates1.png
  4. Start your server

Option 2

  • To Update Oxide on your server:
  1. Stop your server
  2. Go to the Mod Manager
    ModManager.png
  3. select the Uninstall option for Oxide. Note: this does NOT remove the Oxide files or plugins from your server
    YesOxide.png
  4. Once complete, select the 'Install option
    NoOxide.png
    IMPORTANT When installing Oxide use the Configuration Editor option not the Default Values option
    OxideInstall.png
  5. Click on the Install button
  6. Once the installation is complete, Start you server


** NOTE:
If you have installed any other mods, not plugins, that rely on the Oxide mod, such as RUST:IO, it will need to be uninstalled first **

Installing Plugins

  1. Using the File Manager,
    FileManager.png,
  2. Navigate to the /oxide/plugins folder
    OxideFolder.png
  3. Using the Upload option from the menu to Upload your plugins files from your local PC(.cs files) to your server.
    Oxideplugs.png


  • This does not configure your plugins (if they require additional configuration), you will still need to do this manually
  • Any new plugins should automatically load when detected by Oxide. If not, you may have to use a RCON utility like RustAdmin and issue the "oxide.reload *" command,


NOTE: Plugins file names ARE VERY IMPORTANT. When uploading them to the server YOU MUST MAINTAIN the plugin name.
Rustplugins.png

Failure to follow this rule will result in the following type of error message in the oxide_xxxx-xx-xx.txt log file

19:32 [Error] Plugin filename NoDecay (2).cs must match the main class NoDecay (should be NoDecay.cs)
19:32 [Error] Plugin filename PlayerAdministration (1).cs must match the main class PlayerAdministration (should be PlayerAdministration.cs)
19:32 [Error] Plugin filename ZoneManager (1).cs must match the main class ZoneManager (should be ZoneManager.cs)

Oxide Commands

Commands Default Values Description
oxide.load "file name" Loads a plugin with name given (do not include file extension)
oxide.reload "file name" Reloads a plugin via its file name (do not include file extension)
oxide.unload "file name" Unloads a plugin via its file name (do not include file extension)
version Displays the Oxide Version and the Rust Network Protocol version within the Console.

Verify Oxide is Running

  • In-game:
    1. You need to connect to your server as an Admin
    2. Press the F1 key to bring up the console
    3. type in oxide.version. You should see the following output:
      Oxideversion.png


  • RustAdmin:
  1. Launch RustAdmin and connect to your server (More info on using RustAdmnin below)
  2. Click on the Console tab from the Top menu, then the Console tab from the left hand tab options.
  3. In the input box next to the Quick Commands button enter oxide.version.
    You should see the following output:
    Rustadminox.png

Oxide Permissions System

For more information on Oxide permissions take a look here Oxide Permissions

If the plugin you are planning on using is from the uMod.org website, check the #Permissions section for details.

Top

Handy Plugins

The following plugins may help you with server performance

  • Password Protect Your Server
    Rust 'DOES NOT have a native/built-in password protection.
    This plugin provides name and chat command password protection for the server

Top

Validate your Plugins .json Files

  • If you edit your plugins, make sure you format them correctly.
  • If you do not pay attention to this, they WILL NOT WORK!!

Top