v-rising-wine-docker-image

This docker image is supposed to run a v rising server. At the time of writing the server is only available as a windows executable. This project therefore uses wine to run the server.

The image is available on docker hub (mephi00/v-rising-wine).

Setting up the container

In order to access the Server, you need to expose the specified server port on the udp protocol. In docker this is achieved by the argument -p <external port>:<server port>/udp. For the server to be visible on the public listing, the query port has to be exposed by the udp protocol as well. This is achieved the same way as described above.
Addionally, the afore mentioned ports have to be publicly exposed in your router settings.
If you want the public listing to work properly, please make sure, that the ports are the same on the container and on the host.
For an example docker compose file please take a look here

Please note, that upon first start up, the server initialises the world, which takes about 10 minutes, maybe longer. Additionally, the container begins by updating the game server, so you are not relying on a new image in order to update the server to a new version. This also takes some time, so don't panic when your server isn't immediately available.

Configurations

The server can be configured using environment variables or by providing configuration files

Using environment variables

Variables to configure Settings in ServerHostSettings.json

Variable Name	Datatype	Description	Default Value
VR_NAME	string	Name of the server	Required Value
VR_SAVE_NAME	string	Name of the world save	Required Value
VR_LIST_ON_EOS	boolean	Whether to list the server in the in-game server browser	false
VR_LIST_ON_STEAM	boolean	Whether to list the server in steam	false
VR_GAME_PORT	int	Port of the server	9876
VR_QUERY_PORT	int	Port for the Query Interface	9877
VR_PASSWORD	string	The server password	Empty string
VR_DESCRIPTION	string	Description of the server	Empty string
VR_MAX_USERS	int	Num of max concurrent players	40
VR_MAX_ADMINS	int	Num of max concurrent player using admin menu	4
VR_SETTING_PRESET	string	Setting preset provided by Stunlock Studios	Empty String
VR_ENABLE_RCON	boolean	Whether to enable RCON access to the server	false
VR_RCON_PASSWORD	string	Password for the RCON access	Empty Sring

Variables to configure settings in ServerGameSettings.json

Variable Name	Datatype	Description	Default Value
VR_GAME_MODE	PvP or PvE	Whether the game is pvp or pve	PvP
VR_MAX_HEALTH_MOD	float	Modifier for the health of player characters	1.0
VR_MAX_HEALTH_GLOBAL_MOD	float	Modifier for the health of all entities	1.0
VR_RESOURCE_YIELD_MOD	float	Modifier for the resource yield	1.0
VR_DAY_DURATION_SECONDS	float	Duration of a day in seconds	1080.0
VR_DAY_START_HOUR	int	Hour of the (in-game) 24h day for the sun to rise	9
VR_DAY_END_HOUR	int	Hour of the (in-game) 24h day for the sun to set	17
VR_TOMB_LIMIT	int	Limit of number of Tombs in a castle	12
VR_NEST_LIMIT	int	Limit of number of Vermite Nests in a castle	4
VR_DEATH_CONTAINER_PERMISSIONS	Anyone or ClanMembers	Who can pick up items of a dead vampire	Anyone
VR_CLAN_SIZE	int	Maximum number of players in a clan	4

Using configuration files

For a fully custom experience, providing your own setting files is recommended.
The files ServerGameSettings.json and ServerHostSettings.json must be present in the folder /saves/Settings/. You can mount a folder to /saves/Settings or just add the Settings subfolder to your /saves mount.
If they aren't present, the environment variables are used for configuration.

Providing a settings file only partly will not work and the server will start with default settings.

**Please beware, when using a mix of settings files and environment variables for a configuration, that the settings will not be adjusted when changing the environment variables. If you want to change the settings accordingly, delete the file from the /saves/Settings folder.**

Example files

Example files can be found here, these contain the default settings by Stunlock Studios.

Save File Location

The Save folder is /saves. In order to have access to the save files for an easy backup, mount a folder to /saves, the save files are located in the Saves subfolder and the configuration files are saved in the subfolder Settings.
The mount option can also be used to transfer your save files from a different installation or playthrough. For this to work be aware of the folder structure and, that the save name has to be set to your added save state.

adminlist.txt and banlist.txt

The adminlist.txt and banlist.txt files are located in the /saves/Settings folder. In there you can add your steamid to become and admin or add a steamid to the banlist.