RUST

From TRUgaming Wiki
Revision as of 14:53, 11 April 2019 by Fjamieson (talk | contribs) (Server Performance)
Jump to navigation Jump to search

Main_Page | All_Supported_Games

RUST Wipes


NOTE:   A forced map wipe happens the first Thursday of every month with the update.  
        TRUgaming does not control the wipes, this is done by the game developers.

Handy Links

How To Get Started

All TRUgaming servers are by default vanilla, this means, NO mods or plugins.

Before you start to add mods/plugins or customize your configuration:

  • Familiarize yourself with the Game Control Panel (cpanel.trugaming.com)
    There are several pages on this Wiki site that cover the various options.
  • Make sure you can connect to your server. Play around and make sure it all works.
  • Make yourself server Admin, instructions on this are below.
  • Try out some of the Admin commands.
  • For the more adventurous, try out the RCON utilities. Things like RustAdmin or WebRCON. They can be useful admin tools.
  • If you decide to add mods to your server, you will need to install Oxide. Oxide is a Plugin Manager, so any mods you want will be governed by the game and Oxide.
    If you are going to use Oxide, make sure you read the documentation on Oxide, especially its permissions system as a lot of plugins use this.
    Oxide installation instructions below.
  • Next step is to decide what plugins you want.
    Read the plugin documentation closely. Look for special installation instructions or additional configuration requirements as well as permissions that may need to be set.
    Other things to look for include but not limited to; dependencies on other plugins, conflicts with other plugins, the age of the plugin and when it was last updated.
    There are lots of plugins out there, but not all will work with the latest versions of Rust and/or Oxide. You could spend hours troubleshooting for no reason other than this.
  • When adding your plugins, add one or two at a time and test them to make sure they work. Adding a whole bunch at once can complicate troubleshooting especially if there is a conflict.
    If you run into an issue, remove all but the one you feel is causing the issue and work on getting it running as expected, then add the other know working ones back in.


Top

Connecting to my Server

I can't Find my server


    In-game Server List: i can take a while for it to show up in the Rust in-game list..this is because of Steam and Rust
            Not TRUgaming.
    Make sure your server: 1) is started and 2) if you have made recent changes..make sure you did not break anything!!!!
            We don't know what you changed so it is hard for us to help unless you remember what you did
    If you Reinstalled your server and chose the "Default" option and did not change your server name.. 
            Your server name is now "Rust Server"

Manual Connect

  1. Press F1 to open the console
  2. Enter connect <IP Address> : <Port number>
    Example: connect 123.123.123.123:25000

If you get the message:
Disconnect reason: Wrong Connection Protocol: Server Update Required
Disconnected (wrong Connection Protocol: Server update required) - returning to main menu
You need to run a Steam Update on your server

Favorites Connect

  1. Add your server to your Steam /Servers/Favorites
  2. Launch your Rust game
  3. Click on FIND GAME
  4. Click on Favourited
    You server should appear in the 'server name' list
  5. Click on your server name
  6. Click on JOIN SERVER

Top

How To Make Your Server Private

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

  • Install Oxide (via the Control Panel Mod Manager) and use the Whitelist plugin found here:Whitelist Plugin.

Top


Modding your server using Oxide (uMod.org)

**  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.

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

Validate your Plugins .json Files

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

Top

Server Configuration

How To Change My Server Name/Description

  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, default is Server1), 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

Top

How to change Map Size and Map Seed)

The predefined command lines have the following options.

  • RCON Password
  • Server Identity - we provide 3 options Server 1, Server 2 and Server 3 ( more on Server Identity here)
  • 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 6000 ; map size in meters
  1. Stop your server
  2. Click on the Commandline Manager icon.
  3. Make the appropriate changes as detailed above
  4. Click Apply
  5. Start your server

NOTE: If you have changed the Map Size or Map Seed values it can take several minutes for your server to generate the new map files, so PLEASE BE PATIENT!!


    PLEASE NOTE: 
      THE LARGER THE MAP SIZE THE MORE RAM YOU WILL REQUIRE.  
      A 6000 map size (36 square kilometers) will use 6GB of RAM by default.  This is before you start adding mods and playing.

Custom CommandLines

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 6000 ; 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

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.
Rustservid.png
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

   ** NOTE **
         CURRENTLY IN TESTING

Website Hosted Map

  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

Config File Changes

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

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

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. Stop the RUST server.
  3. Open the File Manager.
  4. Navigate to the following folder: server/my_server_identity/.
    See the appropriate section below

Delete Blueprints

  • Locate the \server\<active_server_identity>\ folder.
    For your <active_server_identity> , check your Selected command line or Selected Custom Commandline
  • Delete the player.blueprints.*.db file.

Delete Map Data

  • Locate the \server\<active_server_identity>\ folder.
    For your <active_server_identity> , check your Selected command line or Selected Custom Commandline
  • Delete the “.sav” and “.map” files in this folder.

Delete Player Data

  • Locate the \userdata folder in the root of your server
  • Delete these folders.

Top

Server Admin

RUST ADMIN Roles

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.

Adding/Editing users.cfg File

NOTE: This file may not exists.
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)


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

Using RustAdmin

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 (VERY IMPORTANT you chose this option)
    • 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 **NOTE** RustAdmin does not like special characters in the RCON password
  3. Click on the Save button
    • By default your 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


RCON (Remote Console)

Change RCON Password

  1. Click on the Commandline Manager icon
  2. Click on the 'Selected' link (Right hand side) for your active commandline or go to the Custom Commandline (if you have a Custome Commandline in use) and select it there.
  3. This will open a series of input boxes, one of which is your RCON password, change as appropriate. DO NOT USE ANY SPECIAL CHARACTERS - @#$%^&&*)
  4. Click on th e'Apply link to update the commandline
    This will force a server restart
    Give it a little time before attempting to connect

WebRCON

On the Service Information is a WebRCON link, this take you to the Facepunch WebRCON site: WebRcon
We are not responsible or this site, if it is down contact them not TRUgaming. It is provided a resource only

  1. Click on the WebRCON link Webrconlink.png and this will take you to the above site.
    It will pre-poulate your IP Address and RCON port information
    Webrconsite.png
  2. Enter your RCON password and press CONNECT
    If you do not remember your RCON password you can find it;
    1. By clicking on the Commandline Manager, the RCON passowrd is listed next tot he +rcon.password item in the list, or
    2. By Clicking on the RCON Info icon on the Service Information tab.
      Click on the OK button the Execute the Script. This will open a window and provide you with the necessary information
~~~~~~~~~~~~~~~~~~~~~
IP Address: <IP ADDRESS>
Game Port: <PORT #>
RCON Port: <PORT #>
RCON Password: <RCON Password>
~~~~~~~~~~~~~~~~~~~~~
The script has executed successfully. You may close this window.

Scheduling RCON Messages

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

Rust Admin Commands

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

Server Performance

Things that can Impact your server

  • Restarting the server can improve performance. It is common for heavily modded servers to restart daily (or more). Vanilla servers tend to restart much less frequently.
  • Use decay and upkeep settings that work for your server and help to control the growth of entities. You can change decay and upkeep settings to make them more or less aggressive (there are lots of oxide plugins that adjust decay as well).
  • Unused raided bases and random clutter on the map just waste entities.
  • Every time the server saves it impacts players. Consider setting the save interval longer (server.saveinterval).
    Currently the default is 600 seconds set by default in the commandline: +server.saveinterval 600
    Add server.saveinterval <interval to your <identify>/cfg/server.cfg file to override the commandline value
  • Animal AI appears to have a large impact on server performance. Many owners will turn off animal AI at peak times (ai.think 0). This does impact gameplay (bears won’t attack for example) but it might be worth the extra performance.
  • Some extensions/plugins are more expensive (performance-wise) than others. And it depends on what they are doing. If a plugin is doing a bunch of stuff every tick (OnTick) or is looping through every single entity frequently it can cause issues.
    It can also happen if a plugin has created and is using a large data file (stored within /oxide/data) – clearing out large data files is often advised between server wipes.
  • RUSTIO and LustyMap are examples of an extensions/plugins that do a lot. And so they could have an impact on server performance.


Rust Server Memory

Rust continues to eat memory. From some some testing we have done we have established the following:

Rustmemory.png

The default Map Size is 4000


Top