solareon/vrising-svr repository overview

⁠Docker container for linux vrising server

Based upon steamcmd with WINE added. Supports modifying server config via environment variables in addition to manual changes to the ServerGameSettings.json

⁠V Rising Dedicated Server Instructions

The V Rising Dedicated Server is as it sounds a dedicated server application running under WINE inside Docker for the game V Rising⁠.

⁠Running the Server

There are two methods to run the server. Docker Compose is the recommended version as it will all you to easily modify environment variables and restart/shutdown your server without remembering a complicated command line

⁠docker compose

version: "3"
services: 
  vrising:
    container_name: vrising-server
    image: solareon/vrising-svr:latest
    volumes: 
      - ~/vrising/server:/mnt/vrising/server
      - ~/vrising/persistentdata:/mnt/vrising/persistentdata
    environment:
      - "TZ=Europe/Berlin"
      - "SERVER_NAME=A V-Rising Server"
      - "SERVER_DESCRIPTION=A server for my friends"
      - GAME_PORT=27015
      - QUERY_PORT=27016
      - MAX_USERS=40
      - MAX_ADMIN=4
      - SERVER_FPS=30
      - "SAVE_NAME=world1"
      - "SERVER_PASS=password"
      - STEAM_LIST=true
      - AUTOSAVE_NUM=50
      - AUTOSAVE_INT=300
      - "GAME_PRESET=StandardPvP"
      - RCON_ENABLE=true
      - RCON_PORT=25575
      - "RCON_PASSWORD=rconpassword"
    ports: 
      - "27015:27015/udp"
      - "27016:27016/udp"
      - "25575:25575/tcp"
    restart: unless-stopped

⁠docker cli

    docker run -d --name='vrising-server' \
    -e "TZ=Europe/Berlin" \
    -e "SERVER_NAME=A V-Rising Server" \ 
    -e "SERVER_DESCRIPTION=A server for my friends" \
    -e GAME_PORT=27015 \
    -e QUERY_PORT=27016 \
    -e MAX_USERS=40 \
    -e MAX_ADMIN=4 \
    -e "SAVE_NAME=world1" \
    -e "SERVER_PASS=password" \
    -e STEAM_LIST=true \
    -e AUTOSAVE_NUM=50 \
    -e AUTOSAVE_INT=300 \
    -e "GAME_PRESET=StandardPvP" \
    -e RCON_ENABLE=true \
    -e RCON_PORT=25575 \
    -e "RCON_PASSWORD=rconpassword" \
    -v '/home/user/vrising-server/server':'/mnt/vrising/server':'rw' \
    -v '/home/user/vrising-server/persistentdata':'/mnt/vrising/persistentdata':'rw' \
    -p 27015:27015/udp \
    -p 27016:27016/udp \
    -p 25575:25575/tcp \
    'solareon/vrising-svr:latest'

⁠Configuring the Server

There are two main settings files that the server is using.

• ServerHostSettings.json
• ServerGameSettings.json

As the names suggest, one of them is for hosting related settings and the other one is for game play related settings.

The default settings of these can be found in /server/VRisingServer_Data/StreamingAssets/Settings/. These are only for reference and not used during the running over the server

After the server has loaded the default files it looks for local overrides. These are located in: /persistentdata/Settings

Note: ServerHostSettings.json is overwritten on startup using information from server variables. If you do not define the environment variables they will be filled with the defaults from the table below.

Definitions for ServerGameSettings.json are available here (PDF)⁠

⁠Environment Variables

The most important settings exposed as environment variables are the following:

If you want others to connect to your server, make sure you allow the server through your firewall. You might also need to forward ports on your router. To do this, please follow your manufacturer's instructions for your particular router.

If you want your server to show up on the server list you need to make sure that both the specified queryPort and gamePort is open in your firewall and forwarded on your router, otherwise just opening/forwarding the gamePort will be enough.

⁠Server Administration (In-Game)

To become an administrator in the game you will first need to modify the adminlist.txt file under /persistentdata/Settings/ with your steamId (one steamId 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 located under /persistentdata/Settings/ but you can also modify this manually (one steamId per line).

⁠Admin Commands

Below is a list of some admin commands available in the console. This documentation is a work in progress

⁠Save Files

The default location for save files are: /persistentdata/Saves/

⁠Backups

It is highly recommended to backup the save files often and before patching or before starting the server after having patched.

The current auto save settings allows you to set save interval and save count. So with the same amount of disk space you either save often but maybe not have that many save files (not so far back in time), or save less often (longer rollback in-case of crash) and have more save files, or high number of on both and consume more disk space. So, again, regularly backing up you save files is highly recommended in case your game state becomes corrupted.

For a point of comparison most save games are around 50-70MB per save. The default configuration will use around 3GB

⁠RCON

Altough currently with limited functionality, you can configure the server to listen to RCON connections. If you are not familiar with RCON you can read more about it here: https://developer.valvesoftware.com/wiki/Source_RCON_Protocol⁠.

To enable RCON, enable the appropriate environment variables

These are the currently available commands:

To connect to the server you need an RCON client. There are multiple available, one known to work with V Rising is https://github.com/Tiiffi/mcrcon⁠.