eggs/game_eggs/steamcmd_servers/v_rising
Dimitris Kafetzis 6c35a95966
[V Rising] Change the console key to backtick from tilde (#1939)
I don't know whether this was true in previous versions of the sever, but currently the key to open the admin console within the game is the backtick key, not tilde. I suggest we reflect that in the readme to avoid confusion.
2022-11-01 12:07:59 -07:00
..
egg-v-rising.json ref: change variable permissions 2022-06-12 23:08:22 +03:00
README.md [V Rising] Change the console key to backtick from tilde (#1939) 2022-11-01 12:07:59 -07:00

V Rising

NOTE: Server version currently marked as Early Access by the V Rising developers. Your mileage may vary as updates are released.


Authors / Contributors


Red-Thirten

💻 🔨

Kapatheus

💻 💡

Game Description

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.


Egg Capabilities

  • Currently runs the Windows build of the server via Wine. This egg will be updated when a proper, native Linux server binary is released.
  • Configurable to automatically check for server updates on start via SteamCMD. Forcing validation is also configurable.
  • All ServerHostSettings.json settings can be automatically configured via Startup variables.
    • This includes: Server name, game settings preset, password, max players, auto save settings, and more...
  • RCON ready (*requires extra port see Server Ports). See the RCON section under Manual Configuration Topics for more info.

Server Ports

  • Default server ports are listed below, but all three ports can be changed freely.
  • The only required port is the Game port, but the Query port is needed for the server to appear in the server list (Direct connect is still possible without the Query port). There have also been reports that servers only appear in the server list if they are popular, so consider this when troubleshooting.
  • Clients connect via the Game port.
  • The RCON port is optional and only required if the server owner enables/uses RCON.
Port Default Protocol
Game (Primary Port in Pterodactyl) 9876 UDP
Query 9877 UDP
RCON 25575 TCP

Installation/System Requirements

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. ----

Manual Configuration Topics

The following are various topics covering manual configuration procedures the egg does not handle automatically that may be useful to server owners:

Save File and Custom Settings Location

You can find the game settings and saves in the ~/save-data/ directory.

Server Game Settings

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.

Becoming an Administrator

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, bring it down 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).

Transfer Local/Client Save to the Server

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

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.