Skip to content

Latest commit

 

History

History
141 lines (84 loc) · 4.63 KB

rust.md

File metadata and controls

141 lines (84 loc) · 4.63 KB

Rust

System requirements

  • RAM: 4GB-12GB, Increases depending upon map size
  • CPU: Dual core 3.4GHz, Rust is mono thread
  • Bandwidth: 10mbps upload

Modded server with Oxide

LinuxGSM supports downloading, updating, or removing Oxide.

./rustserver mods-install

Useful Links

General Information

https://developer.valvesoftware.com/wiki/Rust_Dedicated_Server

Oxide Support

https://oxidemod.org/threads/setting-up-a-linux-server-with-lgsm.16528/

RustAdmin

Server RCON administration tool
https://www.rustadmin.com/

Online Rcon tool by facepunch

https://facepunch.github.io/webrcon/

Wipe

A server wipe is used to reset a Rust server by deleting certain types of data about the map and players.

Map Wipe

A map wipe is when the game server deletes (wipes) all the entity information by players interacting with the server, for example, buildings and objects, map resources are also reset. However, individual player data is kept.

To do a Map wipe with LinuxGSM use the command:

./rustserver wipe

Blueprint Wipe

A blueprint wipe is where player data is deleted (wiped). This includes player blueprints, entries, positions and inventories. Generally, a blueprint wipe only happens alongside a map wipe.

To do a Map+Blueprint wipe with LinuxGSM use the command:

./rustserver full-wipe

Automated Wipe

Using cron it is possible to automate your server wipes. The below example will wipe the server every Sunday night at midnight.

0 0 * * 0 /home/rustserver/rustserver wipe > /dev/null 2>&1

Random Seed

If the seed is not set in config when the wipe commands are used a random seed is set.

seed=""

Rust Server with LinuxGSM Video tutorial

A quick tour of Rust special features, and install guide for Rust and Oxide.

https://www.youtube.com/watch?v=6GaoyPeN71g

If you need more help, here is a video that shows a bit more into depth how to use LinuxGSM, how the directory structure works, it also explains the basics of a Rust Server and other stuff, that's why it's 20 minutes long, otherwise, if you're experienced, you can get your server up and running in around 5 minutes without any mods.

https://www.youtube.com/watch?v=eFH9Qj-hUOM

Install Oxide

Oxide is an API allowing you to run mods for you Rust server.

LinuxGSM now handles the install of Oxide for Rust, with mods-install and mods-update commands.

./rustserver mods-install

If a Rust update has been released, then an Oxide update will soon follow. To update Oxide, you can then run:

./rustserver mods-update

Install Oxide addons

To install Oxide addons place them into the serverfiles/oxide/plugins directory. This will cause them to load automatically when starting the server.

If you need to edit any addon configs, they will be located in serverfiles/oxide/config.

To update an addon without restarting the server, you'll need to reload the addon with an RCON command.

oxide.reload PluginName

RCON

Send RCON commands:

RCON is the protocol used to send commands to your server. You will need a tool to use it. Here are 3 of them:

To use software like Rusty, you need to alter LinuxGSM config and change rconweb="0". To use Facepunch tool, Rustadmin desktop or Rustadmin Online, you can leave it at default rconweb="1"

Note: Facepunch web tool currently don't accept domain names, you need to enter server IP.

Essential RCON Commands

save ; will save the server state (useful before a stop or restart)
oxide.reload PluginName ; will reload a plugin after updating it
ownerid STEAMID64 "Nickname" "Reason" ; to add an owner
moderatorid STEAMID64 "Nickname" "Reason" ; to add a moderator
server.writecfg ; will save config changes, including new admins

Note: append server.writecfg after adding an admin, and player needs to reconnect the server in order for it to be applied.