Format README.md for cgit

main
Jerry Aldrich 5 years ago
parent a8d3d115e1
commit d518f1b7bb
  1. 16
      README.md

@ -2,7 +2,7 @@
## Usage ## Usage
``` ```text
docker run --rm -it \ docker run --rm -it \
-e IWAD_URL=https://files.jerryaldrichiii.com/public/doom2.wad \ -e IWAD_URL=https://files.jerryaldrichiii.com/public/doom2.wad \
-e RETRO_MODE=true \ -e RETRO_MODE=true \
@ -12,7 +12,8 @@ docker run --rm -it \
jerryaldrichiii/doom-server jerryaldrichiii/doom-server
``` ```
Configurables (Set via ENV): ### Configurables (set via ENV)
- IWAD_URL=https://files.jerryaldrichiii/public/doom2.wad - Specify IWAD : - IWAD_URL=https://files.jerryaldrichiii/public/doom2.wad - Specify IWAD :
- RETRO_MODE=true - Enable my idea of retro doom. It does the following: - RETRO_MODE=true - Enable my idea of retro doom. It does the following:
- Disables jumping - Disables jumping
@ -25,24 +26,25 @@ Configurables (Set via ENV):
## Connecting ## Connecting
Download Zandronum: [https://zandronum.com/download](https://zandronum.com/download)
### Locally (For testing) ### Locally (For testing)
- Download Zandronum: [https://zandronum.com/download](https://zandronum.com/download)
- Download the same Doom IWAD that is on the server (Set via IWAD_URL env var) - Download the same Doom IWAD that is on the server (Set via IWAD_URL env var)
- `wget https://files.jerryaldrichiii.com/public/freedm.wad` - `wget https://files.jerryaldrichiii.com/public/freedm.wad`
- Connect to the server: - Connect to the server:
- `zandronum -iwad /path/to/freedm.wad -connect localhost` - `zandronum -iwad /path/to/freedm.wad -connect localhost`
### FreeDM ### FreeDM - doom.jerryaldrichiii.com
- Download the same Doom IWAD that is on the server - Download Zandronum: [https://zandronum.com/download](https://zandronum.com/download)
- Download the same Doom IWAD that is on the server:
- `wget https://files.jerryaldrichiii.com/public/freedm.wad` - `wget https://files.jerryaldrichiii.com/public/freedm.wad`
- Connect to the server: - Connect to the server:
- `zandronum -iwad /path/to/freedm.wad -connect doom.jerryaldrichiii.com` - `zandronum -iwad /path/to/freedm.wad -connect doom.jerryaldrichiii.com`
### Doom 2 (Shareware) ### Doom 2 (Shareware) - doom.jerryaldrichiii.com
- Download Zandronum: [https://zandronum.com/download](https://zandronum.com/download)
- Download the same Doom IWAD that is on the server - Download the same Doom IWAD that is on the server
- `wget https://files.jerryaldrichiii.com/public/doom2.wad` - `wget https://files.jerryaldrichiii.com/public/doom2.wad`
- Connect to the server: - Connect to the server:

Loading…
Cancel
Save