RustSetup : Docs

Thank you so much for purchasing our item.

If you have any questions that are beyond the scope of this help file, Please feel free to contact via Support Page.

Installation :

Follow the steps below to setup your Rust server:

1. First of all, make sure your server is running in Oxide mode.
2. Unzip the downloaded package. Inside it, you will find several files and two folders:
   • Config Files - A folder that contains 3 other folders (config, data & lang)
   • Designs - A folder that contains the different designs used
   • Plugins.pdf - Plugins list
   • README.pdf - Docs link
3. For each setup, we provide a list of used plugins that you must download. You will find it in your folder under the name "Plugins.pdf".
   Download all plugins from the list. (Rust plugins are .cs files)
4. Once all the plugins have been downloaded, upload all the .cs files to the plugin folder (rust/oxide/plugins) in your FTP.
5. Once the plugins have been uploaded, restart your server. _{(A complete reboot is necessary for the plugins to install.)}
6. Once the server has restarted, shut it down again.
7. From your FTP, go to rust/oxide/config, delete all .json files. Replace them with the downloaded files from Config Files/config.
8. Almost the same for rust/oxide/data, delete all .json files, delete oxide.groupe.data and all the folders. Replace them with the downloaded files from Config Files/data.
9. And also for rust/oxide/lang, delete all the folders. Replace them with the downloaded files from Config Files/lang.
10. Once all the files have been transferred, you can restart your server.



Your server is now operational with your desired configuration!

If you only want to add your server name, click here.

How to update your setup :

When you receive a product update notification on CodeFling, here's what you need to do to update your setup:

1. The procedure for updating your setup is relatively similar to that of installation. However, there will be no need to download all the plugins again. Only those that are new, for this see the "Updates" section on the product page.
2. (If there are any) place the new plugins in the folder rust/oxide/plugins
3. Stop your server.
4. Go to rust/oxide/config, delete all .json files. Replace them with the downloaded files from Config Files/config.
5. Almost the same for rust/oxide/data, delete all .json files, delete oxide.groupe.data and all the folders. Replace them with the downloaded files from Config Files/data.
6. And also for rust/oxide/lang, delete all the folders. Replace them with the downloaded files from Config Files/lang.
7. Once all the files have been transferred, you can restart your server.



Your server is now updated!

Rust Server Structure

If you are new to Rust server management, here is a short explanation:

- All of the files that we are going to modify are located in rust/oxide folder.

- Each plugin, once uploaded to the plugin folder, will create configuration files after restarting the server.
  You will find these configuration files in the following locations:

• oxide/config: General configuration of the plugin
• oxide/data: Configuring plugin data
• oxide/lang: Configuration of texts and writings

- To modify the display of your server (its name, banner, etc.), you will find a file called "server.cfg".
 This file may change location depending on your host. However, you can generally edit it from your hosting panel.
 If not, you might be able to find it here rust/server/rust/cfg.

For simple management of your server, we recommend using the RustAdmin tool.

If you need more information, please visit facepunch wiki: https://wiki.facepunch.com

Main Plugins Description

Here is the list of main plugins which have configurations that you can modify as you wish :

Obviously almost all the plugins on your servers have configuration files. But many do not necessarily require editing.

For more information on plugin configurations and their permissions, go to the official plugin pages.

Permissions

How to put yourself admin:

To give yourself admin permissions, type this command in your server console: oxide.usergroup add :YourSteamID: admin
Find more about Rust Oxide permissions here.

Pre-configured permission group:

How to manage permission:

To manage your permissions, you need a plugin that will allow you to do it from the game.
For this, there are two main plugins:

- AdminMenu: AdminMenu is a very complete plugin which in addition to allowing you to manage your permissions, will allow you to do a lot of other things. Give yourself, moderate players and teleport. This plugin is absolutely a must have.

- Permissions Manager: PermissionsManager is a plugin that will allow you to manage your permissions, and for free.

For more information about permissions, we recommend this tutorial.

Map Customization

If you want to change the map for your server, simply go to your main configuration file server.cfg

Inside this file, you will find the following lines (the numbers in green will probably be different on your side):

server.seed 42070
server.worldsize 2000

server.seed is the unique id of your card.
server.worldsize the size of your map.

You can go to RustMaps.com to be able to choose through different maps.
Once your choice is made, simply copy the seed and the size of the map into your file and restart your server.

Place your server name

To replace the "YourServer" tags with the name of your server, here are the files that must be modified:

Custom Outpost

Generally, we add recyclers, chairs and a Water Catcher. Thanks to the “Monument Addons” plugin.
For more information, visit the official plugin page. However, if you wish to add or remove certain items, follow the instructions below:

To remove items:

If you want to remove an item, aim at it, then type in the chat:

/makill

To add an item:

If you want to add an item, there are two ways. You must always aim at the desired location, and:

/maspawn *entity* : Type the name of the object you want

/maspawn : Take the desired object in your hand, and type the command.

Even after a map wipe, the entities will remain there. However, the entities must be placed inside the monument zones.

Server Info Settings

In your server.cfg file (or your dashboard) you will find the different lines to modify the title of your server.

To modify your server tags, add the following line to the end of your file:

server.tags EU,weekly

You can view the list of tags here

server.headerimage YourImageLink

Replace "YourImageLink" with your image link. The server header image size must be 512x256 or 1024x512.

server.description "Welcome to YourServer 3x!\nFore more information please write /info in chat.\n\nMap Size : 2000 - Max Group : 5\nWipe schedule: Every Monday @ 8:00AM (UTC+1)\n\n-3x (Loot Tables / Gathering)\n-Custom Outpost\n Home System\n TP, Clans & BP Tier 1 unlocked\n VIP Kit"

To create spaces, use \n

Online Store / Tebex

If you want to monetize your server (for VIP kits for example), here is a quick tutorial:

To automate everything without hassle, we will use the Tebex platform.
It is a very well-known and expert site in the field.

- Create a account

- To set up your store, follow the tutorial and instructions from Tebex.

(Their tutorial being very well done, we leave you in their expert hands for this part)

How to link your VIP Kit with your package :

When creating a kit using the RustKits plugin, you can create a permission with the kit in the "permission" section.
To do this, simply write kits.NameOfYourPermission example: kits.vip

Now with your plugin that manages permissions, you can give your permission (kits.NameOfYourPermission) to a group you want.
For example, in your setup, there is a VIP kit which is only accessible to the VIP group.

-Now go to your package from Tebex. In the last section at the bottom you will find the "Game Server Commands" section.
-Select the server then click on “Add Command”.
-Select "When the package is purchased".
-In the command section, enter this oxide.usergroup add {id} kits.vip
This command will add the Steam ID to the desired group. (here for example: VIP Group)
From Tebex, when you type {id}, it will automatically place the Steam ID of the user purchasing the package.

You can now distribute your VIP kits to your players.

Automatic Wipe

If you want to be able to wipe your server using a simple command in the console, here's how to do it:

To create a simple command that will wipe your server, we recommend using Server Wipe System.

The plugin is a .dll file, so you need to place it in the folder rust/HarmonyMods then restart your server.

Once restarted, a .json configuration file will be created in the "HarmonyMods" folder.

Once the plugin is configured to your liking, all you need to do is program the automatic command (wipe forced or wipe weekly) from your dashboard.

For more information about wipe in general, we recommend this tutorial.