# DayZDockerServer

A Linux [DayZ](https://dayz.com) server in a [Docker](https://docs.docker.com/) container. The main script's
functionality is derived from [this project](https://github.com/thelastnoc/dayz-sa_linuxserver). That functionality is
described [here](https://steamcommunity.com/sharedfiles/filedetails/?id=1517338673). The goal is to reproduce some of
that functionality but also add more features. 

## Caveat Emptor

As of DayZ release 1.15, a [Linux DayZ server](https://steamdb.info/app/1042420/) was made available in Dayz
Experimental. This has not been officially released, so this will only run a DayZ Experimental server at the
moment. Only the [DayZ Experimental client](https://dayz.fandom.com/wiki/Experimental) will be able to connect to it.

This process will create a docker volume for the unprivileged user's home directory, which stores the DayZ server files.
This volume can get quite large. It will require at least 2G of disk space for the default install. Much more with mods.

## Configure and Build

Ensure [Docker](https://docs.docker.com/engine/install/) and [Docker compose](https://docs.docker.com/compose/install/)
are installed.

Edit `files/serverDZ.cfg` and set the values of any variables there. 
See the [documentation](https://forums.dayz.com/topic/239635-dayz-server-files-documentation/):

```
hostname = "Something other than Server Name";   // Server name
```
A random RCON password will be generated and output to the log when the server is run.

Build the Docker image:
```
docker compose build
```

### Steam Integration

[SteamDMD](https://developer.valvesoftware.com/wiki/SteamCMD) is used to manage Steam downloads. A vanilla DayZ server
can be installed with the `anonymous` Steam user, but most mods cannot. If the goal is to add mods, a real Steam login
must be used. Login:
```
docker compose run --rm main dayzserver login
```
Follow the prompts. Hit enter to accept the default, which is to use the `anonymous` user, otherwise use your real
username and keep following the prompts to add your password and Steam Guard code. With Steam Guard enabled on the Steam
account, entering the password will trigger the sending of an email with the code. This process will wait indefinitely
until the code is entered.

The credentials will be managed by [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD) and stored in the
docker volume. All subsequent SteamCMD commands will use the cached credentials. so this process does not need to be
repeated unless the session expires or the docker volume is deleted. 

Run the command again to manage the login. See [Manage](#manage). 

## Run
Launch the container into the background:
```
docker compose up -d main
```
Tail the log:
```
docker compose logs -f main
```
  
## Manage

This just runs a bash shell in the container. It allows for the file system and files to be easily inspected.
### Shell in the container
```
docker compose run --rm main bash
```
### RCON
A command line RCON client is included: https://github.com/indepth666/py3rcon.
The dayzserver script manages what's necessary to configure and run it:
```
docker compose exec main dayzserver rcon
```
To reset the RCON password in the Battle Eye configuration file, simply delete it, and a random one will be generated
on the next server startup:
```
docker compose run --rm main rm serverfiles/battleye/baserver_x64_active*
```
### Update the DayZ server files
It's probably not a good idea to update the server files while it's running. Make sure it's down first:
```
docker compose down
```
Then run the command:
```
docker compose run --rm main dayzserver update
```
Don't forget to [bring it back up](#run).

### Workshop - Add / List / Remove / Update mods
Interactive interface for adding, listing, removing, and updating mods. 
```
docker compose run --rm main dayzserver workshop add id1 [id2...] | list | remove id [id2...] | update 
```
Look for mods in the [DayZ Workshop](https://steamcommunity.com/app/221100/workshop/). Browse to one. In its URL will be
an `id` parameter. Here is the URL to SimpleAutoRun: https://steamcommunity.com/sharedfiles/filedetails/?id=2264162971. To
add it:
```
docker compose run --rm main dayzserver workshop add 2264162971
```
Adding and removing mods will add and remove their names from the `-mod=` parameter.

Note multiple ids may be specified to both add and remove.

## TODO

* Makage -mod= command line. Allow for mods to exist but not be part of that parameter.
* RCON to the server. Send real time messages to players, such as restart announcements.