Skip to content

Commit

Permalink
docs: improve REAMDE
Browse files Browse the repository at this point in the history
JamesIves committed Jul 15, 2024
1 parent 9a17093 commit 5f4bbbb
Showing 3 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,9 @@

If you wish to add server configurations, such as add-ons, plugins, map rotations, etc, you can add them to the `config` directory. The `config` directory is volume mapped within the directory for the game you're starting the container for. For example, if you're starting a container for `cstrike`, you can add things like `mapcycle.txt` or `motd.txt` here and it would appear within the corresponding `cstrike` directory on the server.

> [!NOTE]
> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md).
```
├── hlds
│ ├── cstrike
3 changes: 3 additions & 0 deletions container/config/README.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,9 @@

If you wish to add server configurations, such as add-ons, plugins, map rotations, etc, you can add them to the `config` directory. The `config` directory is volume mapped within the directory for the game you're starting the container for. For example, if you're starting a container for `cstrike`, you can add things like `mapcycle.txt` or `motd.txt` here and it would appear within the corresponding `cstrike` directory on the server.

> [!NOTE]
> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md).
```
├── hlds
│ ├── cstrike
2 changes: 1 addition & 1 deletion container/mods/README.md
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ If you want to run a custom mod, you can do so with the `mods` directory. The `m
```

> [!NOTE]
> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../README.md).
> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md).
1. Create a folder called `mods` that lives alongside where you would normally start the server process. If you've cloned this project locally, you'd place them alongside this README file.
2. 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`.

0 comments on commit 5f4bbbb

Please sign in to comment.