From f86f1150f0e55ac5c0ff0bfe969bd39c0cfccafd Mon Sep 17 00:00:00 2001
From: Lucas Briese <lbriese@mail.uni-paderborn.de>
Date: Mon, 29 Jul 2019 22:02:56 +0200
Subject: [PATCH] - fix, readd readme

---
 README.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 101 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8013440
--- /dev/null
+++ b/README.md
@@ -0,0 +1,101 @@
+# GMOD TTT
+GMOD TTT server image, https://hub.docker.com/r/jusito/
+
+## TODO
+* sv_password not working
+* rcon not working
+* scrds doesn't like different internal / external ports (thats why no ports are exposed)
+* replacer config in other repo u2d?
+* health check -> details
+* volume for steam workshop
+* volume for other games
+* volume for gmod config
+* AppArmor Profile
+
+## Getting Started
+1. Create public workshop collection without maps, dummy ID:=123456. Use `jusito/docker-ttt [...] +host_workshop_collection 123456`. Create a collection with maps ID:=7891011 and add/link it to 123456. If you want the clients to automatically load the collection from the workshop when connecting without subscribing, use `-e WORKSHOP_COLLECTION_ID=123456`. The users loading all non-maps at startup and the map if needed, but you don't need to point them to the collection in the workshop.
+2. Do this elements need CSS, HL2, HLDM, TF2? Use `-e INSTALL_CSS=true` or `-e INSTALL_HL2=true` aso.
+3. Which ports? 27015/udp is default for game traffic x/tcp for rcon, for 27016 you would use `-p 27016:27016/udp [...] jusito/docker-ttt [...] -port 27016`.
+4. Set environment variables like servername `-e SERVER_NAME="My Server"`, password `-e SERVER_PASSWORD="securepw"` and timezone for cron `-e TZ="Europe/Berlin"`, default short downtime at Sunday 10 o'clock.
+5. Add options for server like startmap `+map ttt_rooftops_2016_v1` and max players `-maxplayers 10`
+
+### run example without rcon
+```
+docker run -d \
+ -e INSTALL_CSS=true \
+ -p 27015:27015/udp \
+ -e SERVER_NAME="My Server" \
+ -e SERVER_PASSWORD="securepw" \
+ -e TZ="Europe/Berlin" \
+ jusito/docker-ttt:gmod_ttt_debian \
+ -port 27015 \
+ +map ttt_rooftops_2016_v1 \
+ -maxplayers 10
+```
+
+### run example with rcon
+```
+docker run -d \
+ -e WORKSHOP_COLLECTION_ID=123456 \
+ -e INSTALL_CSS=true \
+ -p 27015:27015/udp -p 27015:27015/tcp \
+ -e SERVER_NAME="My Server" \
+ -e SERVER_PASSWORD="securepw" \
+ -e TZ="Europe/Berlin" \
+ jusito/docker-ttt:gmod_ttt_debian \
+ -port 27015 \
+ +map ttt_rooftops_2016_v1 \
+ -maxplayers 10 \
+ -usercon +rcon_password "yourPW"
+```
+
+## Tags
+* lgsm\_debian - Linux Game Server Manager in Debian
+* gmod\_debian - Garrys Mod with Debian and LGSM
+* gmod\_ttt\_debian
+
+## Environment Variables
+
+### Server Properties
+### additional config
+### Internal Used (don't change please)
+
+## GMOD Parameters
+
+## LGSM Usage
+docker exec -it CONTAINER ./home/steam/gmodserver console
+
+## File Locations
+### Volumes
+
+### Other
+
+
+## environment variables
+If set every workshop item at the collection is added as forced, that means its automatically downloaded on connecting. Don't add collections with maps here just like weapons aso.
+WORKSHOP_COLLECTION_ID=
+
+This variables are used to write the value to the server.cfg:
+SERVER_NAME=""
+SERVER_PASSWORD=""
+SERVER_VOICE_ENABLE="1"
+
+If set to "true" the game is installed and mounted, most of the time you want to add the css content.
+INSTALL_CSS=false
+INSTALL_HL2=false
+INSTALL_HLDM=false
+INSTALL_TF2=false
+
+## server config
+http://ttt.badking.net/config-and-commands/convars
+https://wiki.garrysmod.de/server.cfg
+
+Path in container is:
+docker cp "your server.cfg path" CONTAINER:/home/steam/serverfiles/garrysmod/cfg/server.cfg
+
+
+## Additional
+- Debian Buster, one dependency is missing: https://packages.debian.org/search?keywords=lib32tinfo5
+- Alpine, steamcmd doesn't like musl
+### Debian Buster
+Currently one dependency is missing: https://packages.debian.org/search?keywords=lib32tinfo5