VRising Server Docker

[!NOTE] This image features ✨gracefully server shutdown✨, meaning you should not experience rollbacks after an shutdown/restart.
A Docker container for hosting your own dedicated server using Ubuntu 24.04 and WineHQ 9.

Acknowledgements

• Base image from CM2Walki/steamcmd

• Code from palworld-server-docker

Getting Started

Follow this docker-compose-yml example and check environment variables below for more information.

services:
  vrising:
    image: diyagi/vrising-server-docker:latest
    restart: unless-stopped # Required for the restarts to work
    stop_grace_period: 15s # Might need to increase with longer saves
    ports:
      - 9876:9876/udp
      - 9877:9877/udp
    environment:
      TZ: "America/Los_Angeles"
      PUID: 1001
      PGID: 1001
      VR_NAME: "V Rising Docker Server"
      VR_DESCRIPTION: "V Rising server hosted on Docker"
      VR_RCON_ENABLED: true
      VR_RCON_PASSWORD: "rconPassword"
      VR_RCON_PORT: 25575
      VR_GAME_PORT: 9876
      VR_QUERY_PORT: 9877
      VR_LIST_ON_EOS: true
      VR_LIST_ON_STEAM: true
      VR_SAVE_NAME: "dockerWorld"
    volumes:
    - ./awesome-vrising-server/server:/vrising/server
    - ./awesome-vrising-server/data:/vrising/data
    - ./awesome-vrising-server/announce:/vrising/announce # Only needed if you are using Auto Announce

[!TIP] To manually change the ServerGameSettings.json and/or ServerHostSettings.json you need to set COMPILE_GAME_SETTINGS and/or COMPILE_HOST_SETTINGS to false.

When setting COMPILE_GAME_SETTINGS or COMPILE_HOST_SETTINGS to true you are expected to use environment variables to configure the server without touching ServerGameSettings.json and/or ServerHostSettings.json

Container Environment Variables

Host Settings Environment Variables (Game Server)

[!IMPORTANT] VR_ prefixed environment variables are used by the game server itself, not added by the container.

Because these are read by the game server itself, setting COMPILE_HOST_SETTINGS to false won't affect how these environment variables work. Official Doc.

These environment variables will override their respective values in ServerHostSettings.json.

Host Settings Environment Variables

[!IMPORTANT] The environment variables below are added by the container, when using any of these they will overwrite what's in the ServerHostSettings.json file.

When using these environment variables any configuration manually made to ServerHostSettings.json will be overwritten, meaning you should only use environment variables to configure ServerHostSettings.json.

If you want to manually change the ServerHostSettings.json file set COMPILE_HOST_SETTINGS to false, this will disable all environment variables below.

Game Settings Environment Variables

[!IMPORTANT] The environment variables below are added by the container, when using any of these they will overwrite what's in the ServerGameSettings.json file.

When using these environment variables any configuration manually made to ServerGameSettings.json will be overwritten, meaning you should only use environment variables to configure ServerGameSettings.json.

If you want to manually change the ServerGameSettings.json file set COMPILE_GAME_SETTINGS to false, this will disable all environment variables below.

[!NOTE] Not everything in ServerGameSettings.json can be configured using environment variables.

If you need anything that's not covered feel free to open an Issue or PR.

RCON Commands

[!WARNING] RCON will only work if it's properly configured, either by setting it's environment variables (VR_RCON_ENABLED, VR_RCON_PORT and VR_RCON_PASSWORD) or by manually configuring it in the ServerHostSettings.json file.

To use RCON you can use docker exec:

docker exec -it container-name rcon-cli "<command> <value>"

If you need external RCON access, remember to expose it's port in the container.

Auto Announce

[!IMPORTANT] This requires RCON to be enabled !

Auto Announce works by reading text files with the extension .announce, each file is one message and the Auto Announce will rotate through each file in a loop.
The folder containing the .announce files must be mounted inside the container to the path /vrising/announce.
The time between each message can be configured using cron expression with the environment variable AUTO_ANNOUNCE_CRON_EXPRESSION.

It is recommended to follow this pattern to name the .announce files:
00-something.announce 01-something.announce
The first 2 numbers will dictate the order of the message, meaning 00 will be the first message to be displayed and after the amount of time set with AUTO_ANNOUNCE_CRON_EXPRESSION the message 01 will be displayed.
You can replace something in the file name with anything that helps you identify the message inside it.

[!IMPORTANT] Announces are limited to 510 characters, this is a limit imposed by the game.

After mounting the announce folder with the messages, you can test each message by running the following command with the message number as the parameter (like 00 or 01) while the server is running:

docker exec -it container-name testannounce <message number>

Messages can be modified while the server is running, but the cron expression (AUTO_ANNOUNCE_CRON_EXPRESSION) requires a restart to apply.
More info about message formatting for the announcements (like colors!) here.