diff --git a/README.md b/README.md index 41af56e..860b9f7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,53 @@ # Docker Doom Server -Specify WAD with the WAD_URL env var - -Enable retro mode by setting the RETRO_MODE env mode to "true". This does the -following: - - Disables jumping - - Disables mouse look - - Disables crouching - - Disables altering FOV - - Disables crosshairs - - Enables forced weapon switching on pickup - -Enable item (including weapons) respawning by setting the $ITEM_RESPAWN env -var to true +## Usage + +``` +docker run --rm -it \ + -e IWAD_URL=https://files.jerryaldrichiii.com/public/doom2.wad \ + -e RETRO_MODE=true \ + -e ITEM_RESPAWN=true \ + -e SV_HOSTNAME=doom.yourdomain.com \ + -p 10666:10666/udp \ + jerryaldrichiii/doom-server +``` + +Configurables (Set via ENV): + - IWAD_URL=https://files.jerryaldrichiii/public/doom2.wad - Specify IWAD : + - RETRO_MODE=true - Enable my idea of retro doom. It does the following: + - Disables jumping + - Disables mouse look + - Disables crouching + - Disables altering FOV + - Disables crosshairs + - Enables forced weapon switching on pickup + - ITEM_RESPAWN=true - Enable item (including weapons) respawning + +## Connecting + +Download Zandronum: [https://zandronum.com/download](https://zandronum.com/download) + +### Locally (For testing) + +- Download the same Doom IWAD that is on the server (Set via IWAD_URL env var) + - `wget https://files.jerryaldrichiii.com/public/freedm.wad` +- Connect to the server: + - `zandronum -iwad /path/to/freedm.wad -connect localhost` + +### FreeDM + +- Download the same Doom IWAD that is on the server + - `wget https://files.jerryaldrichiii.com/public/freedm.wad` +- Connect to the server: + - `zandronum -iwad /path/to/freedm.wad -connect doom.jerryaldrichiii.com` + +### Doom 2 (Shareware) + +- Download the same Doom IWAD that is on the server + - `wget https://files.jerryaldrichiii.com/public/doom2.wad` +- Connect to the server: + - `zandronum -iwad /path/to/doom2.wad -connect doom.jerryaldrichiii.com:10667` + +## Notes See WIP/ for other nearly finished attempts of other servers