Awaken as a vampire. Hunt for blood in nearby settlements to regain your strength and evade the scorching sun to survive. Raise your castle and thrive in an ever-changing open world full of mystery. Gain allies online and conquer the land of the living.
From Stunlock Studios's Website:
Awaken as a vampire. Hunt for blood in nearby settlements to regain your strength and evade the scorching sun to survive. Raise your castle and thrive in an ever-changing open world full of mystery. Gain allies online and conquer the land of the living.
ServerHostSettings.json settings can be automatically configured via Startup variables.
ServerHostSettings.json file created in ~/save-data/Settings/.| Port | Default | Protocol |
|---|---|---|
| Game (Primary Port in Pterodactyl) | 9876 | UDP |
| Query | 9877 | UDP |
| RCON | 25575 | TCP |
| Bare Minimum | Recommended | |
|---|---|---|
| Processor | Recent x86/64 (AMD/Intel) processor. No 32 bit or ARM support. | Unsubstantiated reports say that RCON uses significantly more CPU when enabled, but I have not been able to replicate myself. |
| RAM | 3072 MiB | 4096-6144 MiB |
| Storage | 3.5 GB | 5-10 GB (or more, depending on save size or frequency) |
| Game Ownership | Not required at all. | ---- |
The following are various topics covering manual configuration procedures the egg does not handle automatically that may be useful to server owners:
You can find the game settings and saves in the ~/save-data/ directory.
Standardized game settings can be applied via the "Game Settings Preset" startup parameter. If you would like a more custom array of settings to adjust, you can copy the ServerGameSettings.json file located in ~/VRisingServer_Data/StreamingAssets/Settings/ to ~/save-data/Settings/ and adjust as needed. Also, ensure "Game Settings Preset" is set to empty/null. A list of settings, with a description of what each setting does and the min/max values where applicable, can be found here.
To become an administrator in the game you will first need to open the adminlist.txt file under ~/VRisingServer_Data/StreamingAssets/Settings/ and add your steamID64 (one steamID64 per line). This can be done without restarting your server. To become an administrator in the game you need to enable the console in the options menu, open it with ` and authenticate using the adminauth console command. Once an administrator you can use a number of administrative commands like banuser, bancharacter, banned, unban and kick.
If you ban users through the in-game console the server will automatically modify the banlist.txt file, but you can also modify this manually (one steamID64 per line).
Follow these instructions by the developer very carefully. Note: The -saveName <name> command line parameter and GameSettingsPreset setting are handled automatically by the Egg's "Save Name" and "Game Settings Preset" startup parameters, respectively. Also, if a custom ServerGameSettings.json file exists for any reason in the ~/save-data/Settings directory, delete it.
RCON can allow general and restart announcements to be made to the server remotely (functions which are not currently supported by the console command line). You can enable RCON by properly configuring the relevant variables under the Startup tab of your Pterodactyl server. The RCON port must be allocated to the server. Click here for list of valid commands and recommended RCON client.
| Name | Tag |
|---|---|
| Wine (Latest) | ghcr.io/ptero-eggs/yolks:wine_latest |
| Wine (Staging) | ghcr.io/ptero-eggs/yolks:wine_staging |
| Name | Description | Environment Variable | Default Value | User Viewable | User Editable |
|---|---|---|---|---|---|
| [Host] Server Query Port | UDP port for Steam server list features. | VR_QUERY_PORT | 9877 | Yes | No |
| [Host] Hide IP Address | When listing server on EOS server list, the IP address will not be shown/advertised. Players will connect via relay servers. | VR_HIDEIPADDRESS | false | No | No |
| Automatic Updates | Quickly checks for any server updates on startup, and updates if necessary. | AUTO_UPDATE | 1 | Yes | Yes |
| Game Settings Preset | What preset of game settings the server should run. Some settings may not apply after the save file is first created. Leave empty/null if you are using a single-player uploaded save or a custom ServerGameSettings.json file in the `~/save-data/Settings/` directory. | VR_PRESET | Yes | Yes | |
| Game Difficulty Preset | What preset of game difficulty the server should run. Some settings may not apply after the save file is first created. Leave empty/null if you are using a single-player uploaded save or a custom ServerGameSettings.json file in the `~/save-data/Settings/` directory. | VR_DIFFICULTY_PRESET | Difficulty_Normal | Yes | Yes |
| Server Name | Name of the server. The name that shows up in server list. | VR_NAME | V Rising Dedicated Server | Yes | Yes |
| Server Description | Short server description. Shows up in details panel of server list when entry is selected. Also printed in chat when connecting to server. | VR_DESCRIPTION | Welcome to the server! | Yes | Yes |
| Max Connected Users | Max number of concurrent players on server. The maximum number technically supported is 128. | VR_MAX_USERS | 40 | Yes | Yes |
| Max Connected Admins | Max number of admins to allow connection even when the server is full. | VR_MAX_ADMINS | 4 | Yes | Yes |
| Server Password | Password required to join the server. Leave blank to have no password. | VR_PASSWORD | Yes | Yes | |
| Secure Server | Enable VAC protection on server. VAC banned clients will not be able to connect. (true | false) | VR_SECURE | true | Yes | Yes |
| Save Name | Name of save file / directory. | VR_SAVE_NAME | world1 | Yes | Yes |
| Auto Save Count | Number of autosaves to keep. | VR_SAVE_COUNT | 20 | Yes | Yes |
| Auto Save Interval | Interval in seconds between each autosave. | VR_SAVE_INTERVAL | 120 | Yes | Yes |
| [Advanced] Server FPS | Target FPS for server. | VR_FPS | 30 | Yes | Yes |
| [Advanced] Lower FPS When Empty | Run the server at a lower framerate target when no players are logged in. (true | false) | VR_LOWER_FPS_WHEN_EMPTY | false | Yes | Yes |
| [Advanced] Lower FPS When Empty Value | Set the framerate target for when "[Advanced] Lower FPS When Empty" is active. | VR_LOWER_FPS_WHEN_EMPTY_VALUE | 10 | Yes | Yes |
| [Advanced] List On Epic | Register on EOS list server or not. The client looks for servers here by default, due to additional features available. (true | false) | VR_LIST_ON_EOS | true | Yes | Yes |
| [Advanced] List On Steam | Register on Steam list server or not. (true | false) | VR_LIST_ON_STEAM | true | Yes | Yes |
| [RCON] Enable RCON | Enable or disable RCON functionality. (true | false) See the following link for info on how to connect and use RCON: https://github.com/StunlockStudios/vrising-dedicated-server-instructions/blob/master/1.0.x/INSTRUCTIONS.md#rcon-1 | VR_RCON_ENABLED | false | Yes | Yes |
| [RCON] RCON Password | Password required to connect to RCON if it is enabled. | VR_RCON_PASSWORD | somepassword | Yes | Yes |
| [RCON] RCON Port | TCP Port used to connect to RCON. Must be allocated to the server for RCON to work. | VR_RCON_PORT | 25575 | Yes | No |
| [Repair] Validate Server Files | Leave empty (no value) for OFF or set to "true" for ON. Validates all server files when Automatic Updates is enabled. Note: This will significantly increase server startup times, so it is recommended to only enable this when needed. | VALIDATE | Yes | Yes | |
| [System] V Rising Dedicated Server App ID | Used for installation and updates. Rarely needs to be changed. | SRCDS_APPID | 1829350 | No | No |
| [System] Use Windows Branch | Tells the installer/updater to only download the Windows branch of the server (the only branch currently available) so that it can run on Wine. Cannot be changed. | WINDOWS_INSTALL | 1 | No | No |
| [System] WINEDEBUG | Used to suppress WINE FIXME messages. Rarely needs to be changed. | WINEDEBUG | -all | No | No |
| [System] WINEARCH | Used for compatibility. Cannot be changed. | WINEARCH | win64 | No | No |
| [System] WINEPATH | Used for compatibility. Cannot be changed. | WINEPATH | /home/container | No | No |
#!/bin/bash
## File: V Rising Egg - egg-v-rising.json
## Authors: David Wolfe (Red-Thirten), Kapatheus
## Date: 2024/08/02
## License: MIT License
## Image to install with is 'ghcr.io/ptero-eggs/installers:debian'
# Download and install SteamCMD
export HOME=/mnt/server
cd /tmp
mkdir -p $HOME/steamcmd $HOME/steamapps
curl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
tar -xzvf steamcmd.tar.gz -C $HOME/steamcmd
cd $HOME/steamcmd
# SteamCMD fails otherwise for some reason, even running as root.
# This is changed at the end of the install process anyways.
chown -R root:root /mnt
# Install/Verify game server using SteamCMD
./steamcmd.sh +force_install_dir $HOME +login anonymous $( [[ "${WINDOWS_INSTALL}" == "1" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} validate +quit
# Set up 32 and 64 bit libraries
mkdir -p $HOME/.steam/sdk{32,64}
cp -v linux32/steamclient.so $HOME/.steam/sdk32/steamclient.so
cp -v linux64/steamclient.so $HOME/.steam/sdk64/steamclient.so
## V Rising Setup
mkdir -p $HOME/save-data/Settings
# Check for successful installation.
cd $HOME/VRisingServer_Data/StreamingAssets/Settings
if [[ -f ServerHostSettings.json ]]; then
echo -e "\nV Rising Dedicated Server successfully installed!\n"
else
echo -e "\n\nSteamCMD failed to install the V Rising Dedicated Server!"
echo -e "\tTry reinstalling the server again.\n"
exit 1
fi