docs: 📝 Improve documentation

CONTRIBUTING.md

@@ -16,7 +16,7 @@ The four main requirements for this project are:
 1. File an issue on the [Issues board](https://github.com/JamesIves/hlds-docker/issues), or create a discussion on the [Discussions board](https://github.com/JamesIves/hlds-docker/discussions).
 2. Once discussed and agreed upon, clone the project.
 3. Make your changes.
-4. Validate your changes; at the very least, please build the image and start a server.
+4. Validate your changes; at the very least, please build the image and start a server. [You can learn how to build the images using the guide located here](docs/BUILD_A_CUSTOM_IMAGE.md).
 5. Submit a pull request to the `beta` branch.
 6. Once reviewed, your changes will be made available on DockerHub via the `-beta` tag, for example `jives/hlds:cstrike-beta`.
 7. After some more tests, changes will be made sent to the `main` branch where the production images will be published.

README.md

@@ -1,51 +1,37 @@
-# Half-Life Dedicated Server With Docker 🐋 📦
+<img align="right" width="180" height="auto"  src="./.github/docs/docker.svg" alt="Crowbar">
 
-<img align="right" width="120" height="auto"  src="./.github/docs/crowbar.png" alt="Crowbar">
+# Half-Life Dedicated Server With Docker
 
-Creates a [Half-Life Dedicated Server](https://help.steampowered.com/en/faqs/view/081A-106F-B906-1A7A) instance using [Docker](https://www.docker.com). You can run any games the Half-Life Dedicated Server client supports out of the box, including the ability to add custom configurations, mods and plugins.
+[Half-Life Dedicated Server](https://help.steampowered.com/en/faqs/view/081A-106F-B906-1A7A) powered by [Docker](https://www.docker.com). Supports all the classic [GoldSrc](https://developer.valvesoftware.com/wiki/GoldSrc) Half-Life games and mods, including the ability to add custom configurations and plugins.
 
 Special thank you to all the past and present [GitHub Sponsors](https://github.com/sponsors/JamesIves) 💖.
 
 <!-- sponsors --><a href="https://github.com/Chooksta69"><img src="https://github.com/Chooksta69.png" width="25px" alt="Chooksta69" /></a>&nbsp;&nbsp;<a href="https://github.com/MattWillFlood"><img src="https://github.com/MattWillFlood.png" width="25px" alt="MattWillFlood" /></a>&nbsp;&nbsp;<a href="https://github.com/jonathan-milan-pollock"><img src="https://github.com/jonathan-milan-pollock.png" width="25px" alt="jonathan-milan-pollock" /></a>&nbsp;&nbsp;<a href="https://github.com/raoulvdberge"><img src="https://github.com/raoulvdberge.png" width="25px" alt="raoulvdberge" /></a>&nbsp;&nbsp;<a href="https://github.com/robjtede"><img src="https://github.com/robjtede.png" width="25px" alt="robjtede" /></a>&nbsp;&nbsp;<a href="https://github.com/hadley"><img src="https://github.com/hadley.png" width="25px" alt="hadley" /></a>&nbsp;&nbsp;<a href="https://github.com/kevinchalet"><img src="https://github.com/kevinchalet.png" width="25px" alt="kevinchalet" /></a>&nbsp;&nbsp;<a href="https://github.com/Yousazoe"><img src="https://github.com/Yousazoe.png" width="25px" alt="Yousazoe" /></a>&nbsp;&nbsp;<a href="https://github.com/github"><img src="https://github.com/github.png" width="25px" alt="github" /></a>&nbsp;&nbsp;<a href="https://github.com/annegentle"><img src="https://github.com/annegentle.png" width="25px" alt="annegentle" /></a>&nbsp;&nbsp;<a href="https://github.com/planetoftheweb"><img src="https://github.com/planetoftheweb.png" width="25px" alt="planetoftheweb" /></a>&nbsp;&nbsp;<a href="https://github.com/melton1968"><img src="https://github.com/melton1968.png" width="25px" alt="melton1968" /></a>&nbsp;&nbsp;<a href="https://github.com/szepeviktor"><img src="https://github.com/szepeviktor.png" width="25px" alt="szepeviktor" /></a>&nbsp;&nbsp;<a href="https://github.com/sckott"><img src="https://github.com/sckott.png" width="25px" alt="sckott" /></a>&nbsp;&nbsp;<a href="https://github.com/provinzkraut"><img src="https://github.com/provinzkraut.png" width="25px" alt="provinzkraut" /></a>&nbsp;&nbsp;<a href="https://github.com/electrovir"><img src="https://github.com/electrovir.png" width="25px" alt="electrovir" /></a>&nbsp;&nbsp;<a href="https://github.com/Griefed"><img src="https://github.com/Griefed.png" width="25px" alt="Griefed" /></a>&nbsp;&nbsp;<!-- sponsors -->
 
-## Setup ⚙️
+## Getting Started 🚀
 
 Before starting, ensure you have the [Docker daemon](https://www.docker.com/) and the [Docker CLI tool](https://docs.docker.com/engine/reference/commandline/cli/) installed and available.
 
 > [!IMPORTANT]  
 > The following steps will not work if you use an ARM architecture system. For best results, use a system running x86-64.
 
-### Pre-Built Images
+To get started as quickly as possible you can run the following in your terminal. Be sure to adjust the image name (`jives/hlds`) so the tag corresponds with the game you want to start the server for. Additionally you can adjust the server startup arguments by modifying the `command` property; [for a list of available arguments, visit the Valve Developer Wiki](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server).
 
-If you're just looking to start a server as quickly as possible you can follow these steps to use a pre-built image on [Docker Hub](https://hub.docker.com/repository/docker/jives/hlds) or the [GitHub Container Registry](https://github.com/JamesIves/hlds-docker/pkgs/container/hlds).
-
-1. Create a `docker-compose.yml` file by copying and pasting the example below. Adjust the `image` property so the tag name corresponds with the game you want to use. Additionally you can adjust the server startup arguments by modifying the `command` property; [for a list of available arguments, visit the Valve Developer Wiki](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server).
-
-> [!NOTE]  
-> In the majority of cases you'll need to specify `+map` for the server to be joinable.
-
-```yml
-services:
-  hlds:
-    build: docker
-    # 📣 Adjust the image value here with the desired game you want the server to use.
-    image: jives/hlds:cstrike
-    volumes:
-      - "./config:/temp/config"
-      - "./mods:/temp/mods"
-    ports:
-      - "27015:27015/udp"
-      - "27015:27015"
-      - "26900:2690/udp"
-    environment:
-      - GAME=${GAME}
-    # 📣 Modify your server startup commands here.
-    # 📣 Remember: Stating map is based on the game, and will likely be different between images.
-    command: +maxplayers 12 +map cs_italy
+```bash
+docker run -d \
+  --name hlds \
+  -v "$(pwd)/config:/temp/config" \
+  -v "$(pwd)/mods:/temp/mods" \
+  -p 27015:27015/udp \
+  -p 27015:27015 \
+  -p 26900:26900/udp \
+  -e GAME=${GAME} \
+  jives/hlds:cstrike  \
+  "+maxplayers 12 +map cs_italy" # 📣 Modify your server startup commands here. You can specify the image with the desired game you want the server to run in the line above.
 ```
 
 > [!TIP]  
-> Available images include:
+> You can find the available images below. Be sure to adjust the `+map` parameter when changing the game as it may cause the server to not start properly if unavailable.
 >
 > - `jives/hlds:valve` ([Half-Life Deathmatch](https://store.steampowered.com/app/70/HalfLife/))
 > - `jives/hlds:cstrike` ([Counter-Strike](https://store.steampowered.com/app/10/CounterStrike/))
@@ -55,94 +41,22 @@ services:
 > - `jives/hlds:ricohet` ([Ricochet](https://store.steampowered.com/app/60/Ricochet/))
 > - `jives/hlds:dod` ([Day of Defeat](https://store.steampowered.com/app/30/Day_of_Defeat/))
 > - `jives/hlds:tfc` ([Team Fortress Classic](https://store.steampowered.com/app/20/Team_Fortress_Classic/))
-
-2. Start the image. Once the Half-Life Dedicated Server client starts, you'll receive a stream of messages, including the server's public IP address and any startup errors.
-
-```bash
-docker compose up
-```
-
-3. Connect to your server via the IP address by loading the game on [Steam](https://store.steampowered.com/) and start playing. You must own a copy of the game on Steam in order to play. ⌨️
-
-### Building an Image
-
-If you want to build an image yourself, you can follow the steps below. This can be useful in cases where you want to make changes to the build scripts.
-
-1. Clone this project.
-2. Define the game you want the server to run. You can do this by setting an environment variable on your command line.
-
-```bash
-export GAME=cstrike
-```
-
-Before continuing to the next steps, verify that the environment variable is set by running `echo $GAME` in your terminal. It should send back the variable you just set.
-
-> [!TIP]
-> Available options include:
 >
-> - `valve` ([Half-Life Deathmatch](https://store.steampowered.com/app/70/HalfLife/))
-> - `cstrike` ([Counter-Strike](https://store.steampowered.com/app/10/CounterStrike/))
-> - `czero` ([Counter-Strike Condition Zero](https://store.steampowered.com/app/80/CounterStrike_Condition_Zero/))
-> - `dmc` ([Deathmatch Classic](https://store.steampowered.com/app/40/Deathmatch_Classic/))
-> - `gearbox` ([Half-Life Opposing Force](https://store.steampowered.com/app/50/HalfLife_Opposing_Force/))
-> - `ricohet` ([Ricochet](https://store.steampowered.com/app/60/Ricochet/))
-> - `dod` ([Day of Defeat](https://store.steampowered.com/app/30/Day_of_Defeat/))
-> - `tfc` ([Team Fortress Classic](https://store.steampowered.com/app/20/Team_Fortress_Classic/))
-
-3. Build the image.
-
-```sh
-docker compose build
-```
+> Images are also available on the [GitHub Container Registry](https://github.com/JamesIves/hlds-docker/pkgs/container/hlds).
 
-4. If you want to modify the server startup arguments, you can provide a `command` property within `docker-compose.yml`; [for a list of available arguments, visit the Valve Developer Wiki](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server).
+Once the command finishes its process you can connect to your server via the public IP address by loading the game on [Steam](https://steampowered.com). **You must own a copy of the game on Steam in order to play**.
 
 > [!NOTE]  
-> In the majority of cases you'll need to specify `+map` for the server to be joinable.
+> If you're unable to join the server you can check for errors in the server logs by running `docker ps` to get the container id followed by `docker logs <container id>`.
 
-```yml
-services:
-  hlds:
-    command: +maxplayers 16 +map cs_italy
-```
+### Docker Compose
 
-5. Start the image. Once the Half-Life Dedicated Server client starts, you'll receive a stream of messages, including the server's public IP address and any startup errors.
+If you'd prefer to configure your server using [Docker Compose](https://docs.docker.com/compose/), you can simply pull down the project repository to your system and run `docker compose up` from the root. Be sure to make any modifications you need such as changing the game image and server startup commands in [docker-compose.yml](docker-compose.yml) before running `docker compose up`.
 
-```bash
-docker compose up
-```
-
-6. Connect to your server via the IP address by loading the game on [Steam](https://store.steampowered.com/) and start playing. You must own a copy of the game on Steam in order to play. ⌨️
-
-## Server Configuration 🔧
-
-### Configs and Plugins
-
-If you wish to add server configurations, such as add-ons, plugins, map rotations, etc, you can add them to the `config` directory. Any configuration files will be copied into the container on start and placed within the folder for the specified game. For example, if you set the game as `cstrike`, the contents of the config folder will be placed within the `cstrike` directory on the server.
-
-### Custom Mods
-
-If you want to run a custom mod, you can do so with the `mods` directory. Similar to the `config` directory, this folder will be copied into your container on start alongside the other game folders.
-
-1. Add your mod files as a sub-directory of `mods`. For example if the mod name is `decay`, you'd place it in `mods/decay`.
-2. Define the `GAME` environment variable so it points to your mod name. This works if you're using a pre-built image `docker-compose.yml` or by building one yourself.
-
-```bash
-export GAME=decay
-```
-
-3. Build the image. If you don't want to build the image, I suggest using the pre-built `jives/hlds:valve` image.
-
-```bash
-docker compose build
-```
-
-4. Start the image. Most Half-Life mods require _specific_ startup arguments, refer to the [Valve Developer Wiki](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server) and the instructions for the mod you're trying to run for more details. You can find details about how to add these above.
-
-```bash
-docker compose up
-```
+## Advanced Setup ⚙️
 
-## Ownership 🧰
+If you'd like to customize the server client further please check out the following advanced setup guides.
 
-The Half-Life Dedicated Server client, Steam, SteamCMD and the titles themselves are property and ownership of [Valve Software](https://valvesoftware.com). All this software does is make it easier to interface with their provided tooling.
+- [Server Configs and Plugins](docs/SERVER_CONFIGS_AND_PLUGINS.md)
+- [Custom Mods](docs/CUSTOM_MODS.md)
+- [Building a Custom Image](docs/BUILDING_AN_IMAGE.md)

docker-compose.local.yml

@@ -0,0 +1,16 @@
+services:
+  hlds:
+    build:
+      context: .
+      args:
+        - GAME=${GAME}
+    volumes:
+      - "./config:/temp/config"
+      - "./mods:/temp/mods"
+    ports:
+      - "27015:27015/udp"
+      - "27015:27015"
+      - "26900:2690/udp"
+    environment:
+      - GAME=${GAME}
+    command: +maxplayers 12 +log on

docker-compose.yml

@@ -1,9 +1,9 @@
 services:
   hlds:
-    build:
-      context: .
-      args:
-        - GAME=${GAME}
+    build: docker
+    # 📣 Adjust the image value here with the desired game you want the server to use.
+    image: jives/hlds:cstrike
+    # 📣 Learn more about these volumes in the advanced setup guides.
     volumes:
       - "./config:/temp/config"
       - "./mods:/temp/mods"
@@ -13,4 +13,6 @@ services:
       - "26900:2690/udp"
     environment:
       - GAME=${GAME}
-    command: +maxplayers 12 +log on
+    # 📣 Modify your server startup commands here.
+    # 📣 Remember: Stating map is based on the game, and will likely be different between images.
+    command: +maxplayers 12 +map cs_italy