Rust
Rust
44 ArticlesRust Admin Commands List
Here is a list of all commands for Rust. ::ProseNote{title="Important" description="Some commands listed here may only work with an RCON console. If the command does not work in-game, try running it via RCON. You can find our RCON guide here." appearance="default"} :: Commands identified with an asterisk (\) are only available via RCON. This guide explains how to find a player's SteamID for commands that require it. | Syntax | Accepted Values | Description | Notes | | ----- | ----- | ----- | ----- | | admin.mutevoice "player" | player name/Steam64 ID | Prevent a player from speaking in-game | \ | | admin.unmutevoice "player" | player name/Steam64 ID | Allow a player to speak in-game | \ | | admin.mutechat "player" | player name/Steam64 ID | Prevent a player from sending messages via in-game chat | \ | | admin.unmutechat "player" | player name/Steam64 ID | Allow a player to send messages via in-game chat | \ | | chat.say "text" | string | Prints your text in the chat | \ | | craft.add \[id\] | Item ID | Add an item to your crafting queue | You must have the appropriate items in your inventory | | craft.cancel \[id\] | Item ID | Cancel the crafting task of the specified item | \ | | craft.canceltask | \ | Cancel the item currently being crafted | \ | | entity.debug\lookat | \ | Enable debugging for the entity you are looking at | \ | | entity.find\entity \[entity\] | Entity name | Find the position of all entities with the provided name | \ | | entity.find\group \[entity\group\] | Entity group name | Find the position of all entity groups with the provided name | \ | | entity.find\id \[id\] | Entity ID | Find the position of an entity with the given ID | \ | | entity.find\parent | \ | Find the position of all parent entities | \ | | entity.find\radius \[radius\] | Integer | Find the position of all entities in the given radius | \ | | entity.find\self | \ | Find the position of the player entity | \ | | entity.find\status \[status\] | Entity status | Find an entity with the given status | \ | | entity.spawn \[entity\] | Entity name | Spawn an entity where you are looking | \ | | entity.spawnat \[entity\] \[worldPos\] | Entity name/position | Spawn an entity at the specified position in the world | \ | | entity.spawnhere \[entity\] \[distance\] | Entity name/integer | Spawn an entity nearby at the specified distance away from the player | \ | | entity.spawnitem \[entity\] | Entity item name | Spawn an item in the world | \ | | env.addtime 0-24 | Integer between 0-24 | Fast-forward time by the specified number of hours | \ | | gc.collect | \ | Collect the garbage dump | \ | | global.ban "player" "reason" | player name | Ban a player from the game | "reason" is optional | | global.banid "player" "reason" | Steam64 ID | Ban a player from the game by Steam ID | "reason" is optional | | global.banlist | \ | Displays a list of banned users | \ | | global.banlistex | \ | Displays a list of banned users with reasons and usernames | \ | | global.cleanup() | \ | \ | \ | | global.colliders() | \ | \ | \ | | global.error() | \ | \ | \ | | global.injure() | \ | \ | \ | | global.kick "player" | player name/Steam64 ID | Kick a player from the server | \ | | global.kickall "reason" | \ | Kick everyone from the game | "reason" is optional | | global.kill() | \ | \ | "reason" is optional | | global.listid | \ | Displays a list of banned users by ID | \ | | global.moderatorid "id" | Steam64 ID | Make a player a server moderator | AuthLevel 1, (Moderator) | | global.objects() | \ | \ | \ | | global.ownerid "id" | Steam64 ID | Make a player a server owner | AuthLevel 2, (Admin) | | global.players | \ | Prints out currently connected players | \ | | global.queue() | \ | \ | \ | | global.quit() | \ | Leave the game | \ | | global.removemoderator "id" | Steam64 ID | Remove a moderator | \ | | global.removeowner "id" | Steam64 ID | Remove an owner | \ | | global.report() | \ | \ | \ | | global.respawn() | \ | \ | \ | | global.respawn\sleepingbag() | \ | \ | \ | | global.respawn\sleepingbag\remove() | \ | \ | \ | | global.restart | \ | Restart the server with a 300 seconds warning at 5 second intervals | \ | | global.say "text" | string | Sends a message to all players in chat | \ | | global.setinfo() | \ | \ | \ | | global.sleep() | \ | \ | \ | | global.spectate() | \ | \ | \ | | global.status | \ | Prints out currently connected players and server stats | Only available for admins | | global.teleport() | \ | \ | \ | | global.teleport2me() | \ | \ | \ | | global.teleportany() | \ | \ | \ | | global.textures() | \ | \ | \ | | global.unban "id" | Steam64 ID | Unban a player from the game | \ | | global.users() | \ | Shows user info for players on server | \ | | god true/false | true or false | Makes the playing running the command invincible | | hierarchy.cd() | \ | \ | \ | | hierarchy.del() | \ | \ | \ | | hierarchy.ls() | \ | \ | \ | | inventory.endloot() | \ | \ | \ | | inventory.give() | \ | \ | \ | | inventory.giveall() | \ | \ | \ | | inventory.givearm() | \ | \ | \ | | inventory.givebp() | \ | \ | \ | | inventory.givebpall() | \ | \ | \ | | inventory.giveid() | \ | \ | \ | | inventory.giveto() | \ | \ | \ | | noclip | | Allows the user running the command to fly | | | pool.clear() | \ | \ | \ | | pool.status() | \ | \ | \ | | server.backup | \ | Backup the server folder | \ | | server.fill\groups() | \ | \ | \ | | server.fill\populations() | \ | \ | \ | | server.fps | \ | \ | \ | | server.readcfg | \ | Load server config | \ | | server.save | \ | Force a save-game | \ | | server.start | \ | Starts a server | \ | | server.stop | \ | Stops a server | \ | | server.writecfg | \ | Save all config changes | \ | | weather.clouds() | \ | \ | \ | | weather.fog() | \ | \ | \ | | weather.rain \[value\] | Value between 0 and 1.0, 0 is none, 1.0 is 100% | Set the rain factor in the server | Using anything other than a valid value will set it to auto | | weather.wind() | \ | \ | \ |
How to Use Rust Oxides Permission System
This guide is designed to help you understand Oxide's permission system. It will cover the basics of what a permission is, how to give them to your players, and how to work with Oxide’s group system. Before getting started, you will need to do the following: 1. Install Oxide on your server. If you’re unsure how to do this, check out our guide on installing Oxide. 2. Install a few Oxide plugins. You can find a large library of them here. This guide will use the plugin Enhanced Ban System by austinv900 for its examples. This plugin allows you to ban users on your server list with permissions instead of assigning moderatorid/ownerid. --- Permissions Oxide allows you to add various plugins to your server which can alter gameplay through various commands or functionalities. Many of these features have associated permissions, allowing you to control who has access to each of them. In short, permissions are simply a string or sequence of letters and digits, commonly separated into sections using periods. These sections are referred to as “permission nodes” or “nodes” for short. Our example plugin features a few different permissions, for instance . When a user has this permission, it allows them to use the command Wildcards: A wildcard acts as a “grant all” for a node, and is commonly denoted by the asterisk symbol. For example, the permission will grant the user all permissions from our example plugin. --- Groups Occasionally you may want to assign the same set of permissions to multiple people. For instance, you may want admins on your server to have access to commands such as banning and kicking. Instead of assigning each user the same permissions, Oxide features the group system. Oxide’s permission groups offer the following features: Create multiple groups with any names. Quickly add and remove permissions to a group. Add and remove users from a group. Users inherit permissions from their groups. Create group hierarchies with inheritance. --- Inheritance When a user is assigned a group, they are not directly given the permissions, rather they inherit the permissions from the group. When called upon, the permission system will first check if the player has the permission, if not it will check if their groups do. Similarly, you may assign groups a “parent” group. The “child” group will then inherit all permissions the parent has. Below is an example of how the player Mitch inherits permissions from the Admin group, which inherits from the Mod group. Oxide’s Permission Commands Player Commands | Command | Description | | ----- | ----- | | | Grants a permission to an individual player. | | | Revokes a permission from an individual player. | Group Commands | Command | Description | | ----- | ----- | | | Creates a new group with the specified group-name. The title and rank are optional, but if provided sets those two values. | | | Sets the title of the group. The rank is optional, but if provided sets the rank of the group. | | | Deletes the group. | | | Grants a permission to a group. | | | Revokes a permission from a group. | | | Set a parent for a group, the group will inherit all permissions from the parent. | | | Adds a user to a group. | | | Removes a user from a group | Information commands | Command | Description | | ----- | ----- | | | Shows the permissions a user has | | | Shows data for a specific group. Includes permissions, parents, title, rank, and members. | | | Shows which users or groups have this permission. | | | Shows a list of all groups. | | | Show all registered permissions from all plugins and Oxide. |
How to Update Your Rust Server (and Oxide/Carbon)
Automatic updates are enabled by default on our Rust servers. Updates will take effect in-game after a server restart. --- Updating your Server To make sure that automatic updates are enabled on your server, you can follow these steps: 1. Access your control panel and Stop your server. 2. Navigate to the Files tab. 3. Open Rust Server Settings. 4. Set Steam Updates to Enabled. 5. Save the file and Restart your server. Your Rust server and Oxide or Carbon should now be updated and ready to use.
How to Setup Rust RCON
There are multiple tools you can use to set up RCON with a Rust server; however, we recommend using RustAdmin. --- How to find your RCON information You will need to take note of your server IP, RCON password, and RCON port before you can connect to RCON. 1. Open your server's control panel. 2. Find your server IP and port. 3. Find your RCON password in your Rust Server Settings. 4. Find your RCON port in the Ports tab of the control panel. Setting up Rust RCON To set up RCON using RustAdmin, you can follow these steps: 1. Download the RustAdmin Desktop Client, located here. 2. Once RustAdmin is downloaded, extract the ZIP file and run RustAdmin.exe. 3. Switch to the Configuration tab and set the following properties with the information you found earlier: 4. At the bottom, next to the dropdown that says New Configuration, press Save and pick a name for your configuration when prompted. 5. At the top, press Server and click Connect. You should now be connected to your server. It is important to note that Shockbyte's Rust servers do not use the default RCON port; instead, they use the server's port.
How to Set a Server Name for Your Rust Server
When connecting to your server in Rust or viewing the server in the Steam server list, all servers have a custom name displayed. You can modify the server name for your Shockbyte Rust server via our server control panel. --- Setting a Rust Server Name You can set a Rust Server name in the Rust Server Settings. 1. Login to your server control panel and Stop your server. 2. Navigate to the Config tab. 3. Open the Rust Server Settings. 4. For the Server Name setting, enter the name you wish to use. Try to keep it shorter than 60 characters and do not include special characters. If it's too long, the server may not appear in the community/modded list. 5. Once you have entered your new settings, press Save and then restart your server for the changes to take effect.
How to Reset Your Rust World & Playerdata
Rust server owners should reset their worlds regularly to help keep their community active. You can also reset just the player data which won't affect the world or server configuration. ::ProseNote{title="Important" description="This action is irreversible! Please make sure you have a backup if you wish to keep your files. We have a guide on how to manually back up your server here." appearance="default"} :: Resetting your Server's Player Data It is possible to reset your player data while still keeping your server's existing world. In order to do this, you will need to delete all of the player-related files using your server's file manager. 1. Access your control panel and Stop your server. 2. Navigate to the Files tab. 3. Navigate to the directory. 4. Navigate to (or the current server identity of your server). 5. Delete all files that include the word player, these will be files as highlighted in the image below. 6. Start your server. After completing these steps your Rust server's player data should be entirely reset. --- Resetting Your Server's World To delete or reset your server's world, you will need to delete all files associated with it. 1. Access your control panel and Stop your server. 2. Navigate to the Files tab. 3. Navigate to the directory. 4. Navigate to (or the current server identity of your server). 5. Delete the file. If you're not using a custom map this will be the file labelled . 6. Delete any files ending with if present. 7. Start your server. After completing these steps your old map should be removed, and a fresh new map will be on your server. For custom maps, follow this guide.
How to Pair the Rust+ Mobile App with Your Server
Rust+ is the official Rust companion app that allows you to pair servers you play on with the app on your phone. You can view the server status, chat with other players, view the map and more. --- Setup and Pair Rust+ You will be able to set up and pair Rust+ for your server. 1. Download the Rust+ app on your phone (iOS, Android). Push Notifications must be enabled for the app. 2. On your control panel, navigate to the Ports tab. 3. Find the port for RustPlus and make a note of it for later. 4. In your file, set the port number you copied earlier and set your server's IP under the settings. - If you are unable to locate the server.cfg file, you can refer to our guide on the topic here. - The setting lines can be added to the file manually if they are not present. - - Set the port you copied earlier - - Set your server's IP (Not including the port) 5. Save the file and Restart your server. 6. Once your server is back online, join your server and press Esc to open the menu, then select Rust+. 7. If it worked correctly, you should see a Pair with Server button appear - click it. Otherwise, press refresh (sometimes you need to restart both the game and the mobile app). 8. You will either receive a push notification on your phone or, if the app is open, you should see your server appear, and you will be able to press Pair Server on your phone. That's it! The app should now be connected successfully. --- You can find additional information about setting up the Rust+ companion app for Rust servers on the Wiki.