🐔Pterodactyl
Helpful startup for your Pterodactyl Rust server hosting needs.
This guide assumes that you have already installed Pterodactyl panel, and are familiar with how to set up servers. You should also already have a location, a node, and ports already allocated on that node. If you don't know how to do any of this, or you missed a step, please refer to the Pterodactyl Panel installation instructions below. A link to their Discord server is also below for you to get support during installation. They however do not support Carbon specific questions, only questions relating to Pterodactyl panel itself, or the Rust egg that ships with Pterodactyl Panel. Just keep that in mind.
Pterodactyl Installation Instructions
Difference Between Carbon Builds
The difference between the Production, Preview, and Edge builds of Carbon are:
Production - The most stable version of Carbon. Updated once every few weeks.
Preview - Updated frequently, contains future features for testing, and you will run into a few bugs here and there.
Edge - Like living on the edge? This is the most current version of Carbon, and it used mainly by developers and server owners to test brand new features of Carbon that are still in the Beta development stage. Expect some bugs.
One other thing is the difference between the Minimal and Standard versions of Carbon. The minimal version of Carbon does not contain the Admin Module, CarbonAuto, or the Zip Dev Script Processor. Its basically a lightweight version of carbon, stripping away the QoL features and focuses only on plugin execution. Its not like minimal is faster then the Standard build, it just has less "clutter".
Default Rust Egg
Carbon is now built into the default Rust egg that comes with the standard installation of Pterodactyl panel. For help with this egg, please visit the Pterodactyl Panel Discord
Official Carbon.gg Egg (Created by SturdyStubs & BippyMiester)
SturdyStubs & BippyMiester have also created a Custom Carbon Egg as well. This is a newer addition to the Carbon egg collection. This egg includes all of the Carbon builds, as well as a build for Oxide. This enables you to easily test the difference in performance between Oxide and Carbon. It also includes some great QoL features!
You can download the egg here.
The main functionality of this egg is to have the ability to switch seamlessly between all Carbon builds, Oxide, and Vanilla. If you launch the egg with an Oxide build, you can then switch right on over to Carbon, and it will handle all of the removal and clean up of all of the Oxide files for you. If you switch to Vanilla from either Carbon or Oxide, it will make sure those files are cleaned up as well.
You also have the ability to set a "Modding Root" folder. This folder is very important, as it allows you to have different plugins, configs, and data for different wipes or maps. For example, you are running a proc gen map, and you are running a set of plugins that makes sense to have on a proc gen map, then you decide on wipe day to switch to a spooky, Halloween themed map. Obviously you'll probably want to have some different plugins running on that custom Halloween themed map. You can make that switch easily by just specifying the "Modding Root" folder that you want to use, instead of having to delete files, configs, etc.
Difference Between The Docker Images
We have three docker images that we are now using with version > 2.x. Production, Staging, and Beta. These different docker images will help you test new features of the pterodactyl egg, before they're officially released. The follow the same descriptions as the Carbon builds, but are not related to Carbon in any way. These docker images are apart of the egg.
Production - The most stable version of the Egg. Updated once every few weeks.
Staging - Updated frequently, contains future features for testing, and you will run into a few bugs here and there.
Beta - This is the most current version of the egg, and it used mainly by developers and server owners to test brand new features of the egg that are still in the Beta development stage. Expect some bugs or server crashes from time to time.
You can switch between these branches without having to modify anything in your filesystem.
Egg Variables
Server Name - Your servers name as it appears in the server browser
Description - The description of your server that shows up when a person selects your server from the server browser
URL - The link that opens when a person clicks on "Visit Site" in-game in the server browser
Max Players - Max number of players your server will hold
Server Image - The header image of your server thats displayed in the server browser in game
RCON Port - The port number that the RCON websocket will run on
RCON Password - The password to authenticate on the RCON websocket
Save Interval - How often the Rust server should save the configurations (Different from backing up your server)
Additional Arguments - Add additional startup parameters to the server
App Port - Port for the Rust+ App. -1 to disable.
Server Logo - The icon that shows up in the Rust+ App for your server
Custom Map URL - Overwrites the map with the one from the direct download URL. Invalid URLs will cause the server to crash.
Level - The world file for Rust to use.
World Size - The world size for a procedural map.
World Seed - The seed for a procedural map.
Query Port - Server Query Port. Can't be the same as Game's primary port.
Modding Framework - The modding framework to be used: carbon, oxide, vanilla. Defaults to "vanilla" for a non-modded server installation.
Modding Root Directory - The root directory of your modding framework - If using carbon, this should be set to carbon. If using oxide, this should be set to oxide. You can not use carbon framework with a root directory that contains the word oxide, and vise versa.
Server Tags - Server tags allow your server to be categorized. There is a list below of all tags. Separate each tag with a comma such as: weekly,NA,vanilla | All available server tags are listed here
Server Identity - The directory of your server. Default is set to rust.
Auto Update - Determines if the server with automatically update on start.
Chaos Code Extension - Download and use the ChaosCode extension?
Discord Extension - Download and use the Discord Extension?
RustEdit Extension - Download and install the RustEdit Extension?
Validate Game Files - Determine if you want the server to validate the game files every time the server starts.
App Public IP - Unless you know what you're doing. Leave this field blank!!!! This is very important! Please do not change this unless you have read the Rust+ App documentation here
Framework Update - Disable installation / update of any chosen framework.
Gamemode - Gamemode of Rust
Log File Location - Logfile location
Debug Mode - Do you want to enable the egg's debug mode?
Adding The Egg To The Nest
First we need to add the egg to the Rust nest.
Login to the admin dashboard of your Pterodactyl panel installation.
Click on the "Nests" link in the side bar on the left.
Since there is already a "Rust" nest, we don't have to create a new one. Lets just go ahead and add the egg to the nest. Click on the green "Import Egg" button on the right.
Select the Custom Carbon Egg that you just downloaded by clicking browse, then navigate to the location you saved the egg to, and double click the file.
Next we need to select the "Rust" nest under the "Associated Nest" field.
INSERT_IMPORT_EGG_ALL_CARBON_IMAGE
Now all we have to do is click on "Import".
Installing the Server
This server installation guide is very similar to the Custom Rust Egg by MikeHawk, with some key differences. Some of the steps for installation might be the same. Please make sure to read these installation instructions throughly.
Log into your admin dashboard of your panel.
Navigate to your Servers by clicking on "Servers" on the side bar.
Click the "Create New" button on the right
Configure your server details in the "Core Details" section
For your port allocations you are going to need 1 main port, and 3 additional allocations. These allocations are for the Query Port, RCON Port, and App Port.
INSERT_ALLOCATION_MANAGEMENT_IMAGE
Configure your "Application Feature Limits" and "Resource Management" sections to your liking
Under "Nest Configuration", select the "Rust" Nest
Then if your "Egg" field does not already say "Rust Carbon", change it to "Rust Carbon".
INSERT_NEST_CONFIGURATION_ALL_CARBON_IMAGE
The "Docker Configuration" section can be skipped.
Next is the big part. The "Startup Configuration" section. In this section, you can fill out everything pretty much to your liking. However there are a few new options here that are not apart of the Default Rust Egg.
Under the "Modding Framework" variable, you can choose different options for either Carbon, Oxide, or Vanilla. This is a combined version of the "Carbon Build" and "Minimal" variables from the other Custom Rust Egg by MikeHawk. The key difference here is this egg is also set up for the staging branch of Rust as well. The Staging Branch is only available with Carbon. See the "Difference Between Carbon Builds" section at the top of this page for more information.
Lastly, the major difference between the Default Rust egg, and the Carbon Rust egg, is that you can set an IP address for your Rust+ App. This is critical in ensuring that your Rust+ connection is able to connect to the Rust+ API. Set this value to the public IP address of your server.
Additionally, you can configure different Carbon/Oxide root directories. This is good if you want to run a certain set of plugins on one map, but don't want to go through the hassle of copying and pasting over different configs for that map. All you have to do is just change your Carbon directory, and it will automatically switch over to those plugins, configs, and data files.
An important thing to note is that the "Modding Root" variable should be set appropriately. If you're running a build of Carbon, your "Modding Root" should have the word "carbon" in it. Same thing for Oxide. If you're running Oxide, your "Modding Root" variable should have the word "oxide" in it. The vanilla option does not need to have the variable set.
Do not forget to set your RCON, Query, and App ports to the appropriate ports that you assigned under the "Core Details" section. These ports should be equal to one of the three ports you assigned under your "Additional Ports" section.
Start your server by clicking the green "Create Server" button at the bottom of the page.
And that's it! You now have a Custom Carbon Rust server installed and ready to use!
Last updated