RUST

From TRUgaming Wiki
Jump to navigation Jump to search

Main_Page | All_Supported_Games

Handy Links[edit]

How To Change My Server Info[edit]

  1. From your Game Control Panel:
    Gamesrvmgt.png
  2. Stop your server by clicking on the Stop icon
    StopServer.png
  3. Click on the Configuration Files icon
  4. Edit your active Server profile (By default this is my_server_identity), by clicking on the Text Editor link next to the appropriate server.cfg file
    RustCfg.png
    You can confirm which Server is active by looking at your active Command Line, under the Commandline Manager, if you are using something other than the default.
    RustCmdline.png
  5. To change your Server Description
    Locate the following line(s):
    ## Sets the "Description" portion of the in game browser.
    server.description "Welcome to the Rust server \nThis server is hosted by TRUgaming.com \nWe hope you enjoy your stay, and have fun!"
    Edit the section between the quotes
    NOTE You can use the \n to force a new line in your description
  6. To change your Server Name:
    Locate the following line(s):
    ##Sets a hostname.
    server.hostname "Rust Server - TRUgaming.com Hosted"
    Edit the section between the quotes
  7. Save your configuration file
  8. Return to your Service Information tab and Start your server back up

How To Make Your Server Private[edit]

Currently there is no way to add a password to Rust servers.

There are still a couple of ways to stop other players joining your server:

  • Method A
    Add the following line to your server.cfg:
    server.steamgroup <steam group id>
    This will restrict your server to players in that Steam group
  • Method B
    Install Oxide (via the control panel mod manager) and use the Whitelist plugin found here.

Scheduling RCON Messages[edit]

Server Auto Announcements for RUST is essentially scheduled a command
Auto Announcements are a useful for giving information to users when your not online.

To set up a command you open the Scheduled Tasks Tab in your Cpanel

  • New Task (Console/RCON Command)
  • Enter your PW for your Rcon
  • Command to Execute: Say “your message” Will be a server message
  • Name: Name your Message (For organization)


Now depending on how often you want your command to run (for me I like every 45 to 75min)

  • Type: Daily
  • Start: Day and time you want the first message
  • Recur Every: 1 Day
  • Repeat task: Check
  • Repeat Every: (how often you want it) Minutes
  • For: 24 Hours


Examples
say "(Feature Reminder) Need an admin? Reach an admin on the community Discord, link found on our website www.yoursite.com!"
say "(Rule Reminder) Full list of rules and to report abuse - Visit our website www.yoursite.com”

We would like to thank Jason Longo for putting this together.
Top

Oxide (uMod.org)[edit]

Installation[edit]

  • 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[edit]

  • 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


Installing Plugins[edit]

  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,


Oxide Commands[edit]

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[edit]

  • 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[edit]

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

Server Configuration[edit]

Custom CommandLines[edit]

Our command line implementation provides enough stock information for you to get your server up and running.
The custom command lines have the following options.

  • Description - a short name for your new command line (Required)
  • Server Identity - we provide 3 options Server 1, Server 2 and Server 3 ( more on Server Identity here)
  • No Decay - adding this option to your command line will add the necessary options to stop building and other decay in the game
  • Server Level - this is the map that the server will start on (see Server Identity section below for more information)
  • Map Seed - The seed used to generate the procedural level. Should be between -2,147,483,647 and 2,147,483,647
  • World Size - default 4000; range : 2000 to 8000 ; map size in meters

If you want the option active, make sure you click on the check box: By creating two additional Custom Command line options we basically have provided you with three servers in one. Remember, only one is active at a time :-)

Server Identity[edit]

We provide 3 Server Identity options, here after referred to by <server identity>. This allows you to configure 3 seperate playing environments (maps, world size, admins, server name, etc)
These can be found under the Server folder and are named:

  • my_server_identity (default)
  • my_server_identity_2
  • my_server_identity_3

Each has its own separate configuration file named server.cfg which is located in the cfg folder under each <server identity> folder.

The /cfg/server.cfg file initially contains all the required info for the server to run.
A copy of this information is also in each of the server.cfg in the different <server identity> folders.
If the server/<server identity>/cfg/server.cfg file does not exist or is empty

  • Open up a copy of your /cfg/server.cfg file and copy (Ctrl A, and Ctrl C) the contents, then paste the contents into the server.cfg file under the appropriate <server identity>/cfg/server.cfg ' file.

or

  • Download a copy of your /cfg/server.cfg file to your local PC, navigate to the server/<server identity>/cfg/ folder and upload the server.cfg file there.

When the server starts it uses the <server identity> that is configured in the Default Commandline or if set the Selected/active Custom Commandline

The <server identity>/cfg/ folder also contains copies of your bans and users.cfg files:

into the appropriate <server identity>/cfg/ folder so depending on which server you are running, you can have different admins, etc.

Custom Maps[edit]

   ** NOTE **
         CURRENTLY IN TESTING

Website Hosted Map[edit]

  1. Make sure you've installed Oxide from your servers Mod Manager! (and make sure it is working)
  2. Upload your map to something like Dropbox.
    * Make sure you copy the download link
    * Make sure you allow enable downloading so others to download the file
  3. Under the Commandline Manager, Select the Custom Map command line
  4. In the Server Level input box, paste the URL for the map
    Example: https://www.dropbox.com/<some additional stuff here>/yourmapname.map?dl=1
    If using Dropbox, make sure you include the ?dl=1 in the line
  5. Click on the Apply option. This will restart your server.

Top

Server Administration[edit]

Config File Changes[edit]

Best Practices

  1. Stop your server before making any config file changes Wait a few minutes before you START your server back up)
  2. Before you make any changes you make to the <server identity>/cfg/serverauto.cfg file(s), you should run the Backup Server Configs option from the Service Information tab.
  3. START or RESTART your server for changes to take effect.



PLEASE WAIT at least 5 minutes before attempting to connect to your server after any RESTART or STOP/START

The variables used in the configuration files are very specific, any typos and your server will either not run or the feature you are trying to tweak will not work as expected.

Some of these commands can be issued via RCON, RUSTAdmin.

Source: Rust Dedicated Server Wiki

Server Password Protection[edit]

Please Note: RUST does NOT offer password protection by default, so anyone can connect to your server when it is up and running.

To restrict unwanted users from joining your server you have two options, both require the use of the Oxide Mod
You can either use a Whitelist plugin or Password plugin for Oxide. Have a look at the Oxidemod.org website for more information.

REMEMBER:

  1. When adding plugins, that you use one that is up to date and/or compatible with the version of Oxide/RUST you are running.
  2. TRUgaming cannot offer support for the plugins, you will need to contact the developer.

Server Wipe[edit]

When do map wipes happen?
Map Wipes occur when the game server’s admin performs a manual Map Wipe. It’s typical for Map Wipes to happen on a monthly or bi-weekly basis on many RUST servers. Some RUST servers are also “permanent servers” and only wipe when forced by RUST server updates.

How to wipe your Rust server's player data and world

  1. Log into your game control panel.
  2. View your game service.
  3. Stop the RUST server.
  4. Open the File Manager.
  5. Navigate to the following folder: server/my_server_identity/.
    See the appropriate section below
  6. Start the RUST server

Delete Blueprints[edit]

  • Locate the \server\<active_server_identity>\user.1\ folder.
    For your <active_server_identity> , check your Selected command line or Selected Custom Commandline
  • Delete the contents of this folder.

Delete Map Data[edit]

  • Delete the “.sav” and “.map” files in this folder.
  • The seed you have selected will be the folder you wish to delete (you can delete them all to be sure)


** OBSOLETE **

  • Delete Player Data
    To delete the player data only, delete the Storage.db and UserPersistence.db files. This includes blueprints, inventories, positions, etc.

Top

Making Myself Server Admin[edit]

RUST ADMIN Roles[edit]

ownerid – This is an admin role that allows the creation and deletion of other admins.
moderatorid – This is an admin without the ability to create and delete other admins.


Method 1: Edit users.cfg File[edit]

NOTE: This file may not exists unless you have used the above steps first.
This file, if it exists, can be found in your \server\<server identity>\cfg folder
Rustadmin.png
If not you create create a new file, by clicking on the New File icon and entering in the name users.cfg once in the appropriate folder


  • Before you go any further... you will need to get the SteamID64 for any Admins/Moderators you want to add.
    Go here for more info on how to do this SteamID64
  1. Stop your server
  2. Open your File Manager and locate the users.cfg file (as shown above)
  3. Create/Edit the file as needed
    ownerid 76561198308XXXXXX "Name" "noreason"
    moderatorid 76561198308XXXXXX "Name" "noreason"
  4. Save file
  5. Start your server (wait a few minutes for your server to start back up...before you try to connect)



Method 2: Using RustAdmin[edit]

Install an RUSTAdmin program on your PC (https://www.rustadmin.com/)

Before you configure RustAdmin:

  • On the Service Information tab, there is Server RCON Info icon. Click on this and execute the script.
    This will display the necessary RCON info for you to set up RustAdmin

To configure Rust Admin

  1. Click the Configuration tab
  2. Select the WebRcon option under RCON Type
    • In the Server window
      • Enter your server's IP in the IP section (do not include the port)
      • Enter the server port in the server port section
      • Enter the RCON port in the RCON Port section
      • Enter the RCON password
  3. Click on the Save button
    • By default you Configuration will be New Configuration, you will be prompted for a new configuration name.
      Enter this and click Ok

RustAdmin.png

  • For more information on other configuration options see the RustAdmin documentation by clicking on the Help and Support link in the RustAdmin application
  • Before you go any further... you will need to get the SteamID64 for any Admins/Moderators you want to add.
    Go here for more info on how to do this SteamID64


Using RustAdmin
Click the Server tab in the top left corner, then click connect.
Once you've connected to your server, run these commands:

server.writecfg
ownerid SteamID64 "Name"
server.writecfg

Once you have added yourself as an admin on the server, you will need to exit your game if you are currently connected to your server and log back in,
so you can use the available admin commands from the in-game F1/Console or you can simply issue any and all admin commands from the RustAdmin interface.

Top

Rust Admin Commands[edit]

With recent changes to RUST, several of the websites that you will find when searching for 'RUST admin commands' are out of date.
The ones that we have found to be most up todate are:

Top