Introduction
Welcome! These docs have been crafted by community members with the approach and perspective of server owners and developers/modders.
The following is a brief rundown of what's currently available for you to check out in a nutshell and an exploration to unannounced newly introduced features.
Rust — References & Resources
This heavy packed documentation website is filled with loads of resources for accessing all, up-to-date in-game information and more!
- Items — This section contains a comprehensive list of all items available in the game.
- Entities — This section contains a comprehensive list of all entity prefabs available in the game.
- Prefabs — This section contains a comprehensive list of all prefabs available in the game.
- ConVars — All available Rust console variables.
- Blueprints — This section contains a comprehensive list of all crafting blueprints available in the game.
- Commands — Here's a full list of all currently available CarbonAuto variables you can use to expand on what Rust already provides.
Carbon — References & Resources
The docs are filled with lots of framework related information and resources.
- Hooks — This section contains a comprehensive list of all hooks available in Carbon.
- ConVars — Here's a full list of all currently available Carbon commands you can use.
- Switches — Here's a full list of all currently available Carbon switches you can use.
- Commands — Here's a full list of all currently available Carbon commands you can use.
Modules
Carbon modules are similar to plugins but are built directly into Carbon. They provide a lightweight way to add common functionality, such as managing players or increasing stack sizes.
You can check them out here
Oxide Porting
An in-depth understanding of the necessary changes that are done when you're transferring your Oxide server over to Carbon.
Get started with learning the differences between Carbon and Oxide here
Release Notes
We're releasing consistent updates every month with the Rust wipe and sometimes mid-month updates addressing potential bugs that were newly introduced or found as well as soft-launching Carbon features which get announced throughout the month.
Read current or previous update patch notes over here
Server Browser
Carbon's integrated Server Browser puts the entire Rust multiplayer landscape at your fingertips. An intuitive interface, powered by a lightning-fast fuzzy index, lets you drill down from thousands of servers to the perfect match in just a few clicks.
- Smart search - instantly match on hostname, IP (with optional port), map name or even tag keywords.
- Visual population meter - colour-coded bars and exact player counts make it easy to spot crowded hubs or quiet hideaways.
- Deep filtering - stack AND/OR filters for tags, pick a geographic region, lock in a specific Rust build, or set min/max player ranges.
- One-click join - copy the server's
IP:Port
straight to your clipboard, ready for the in-game console.
Check it out
Control Panel
High-fidelity WebRcon based control panel allowing you to manage players, entities, permissions and more, straight from your browser! Get started
here!
Everything that's happening is in-browser and
does not make any requests to any third-party servers (including ours).
Connections
The actual connections are also done in your browser and RCon password never leaves your network other than when sent to the server you're trying to connect.
All servers and overall data is stored in your browser Local Storage.
Player and Inventory Management
Under the Players tab, you can inspect active players on the server, as well as preview and manage their inventories. Yes, manage. You can drag and drop items in their inventories, or even give them items.
Entity Search & Inspection
Use the Entities tab to search for any entities active on the server and manage general properties, like position, health, and manage players' metabolism stats and more!
Permission Management
Manage permissions for plugins and modues straight from the control panel!
Chatting
Preview and interact with people chatting on your server, all within the Control Panel! (Clicking on player names opens up their Steam profile)
Changelog