removed game speed for being broken and an antifeature anyway. added color support.

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
index 98687a6..1eb6718 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,33 @@ make
 
 Then just telnet to the port. If no port is specified, the server will run on port 4000.
 
+# Server Options
+
+The tc binary checks for a file named config.yaml in the local directory, or else it creates one.
+
+The game is designed to run with 600ms game ticks. You can change this without issue, but it will change how fast *everything* in the game happens. If you just want the game to "respond faster", that's not possible. **The ticks are a game mechanic.** Techniques like as science flicking, weapon switches, and certain power-skilling methods would not work with instant response or short ticks. Being able to instantly walk anywhere would negate the Agility skill, walk command, APS system, and fast-travel technology.
+
+```
+game:
+  tick_length: 600
+```
+
+The telnet/http/https options are pretty self-explanatory. TC does not handle HTTPS certs for you. Use something like [certbot](https://certbot.eff.org/) on your server. The HTTP(S) server is just for a simple web client.
+
+```
+telnet:
+  enabled: true
+  port: 4000
+http:
+  enabled: false
+  port: 8080
+https:
+  enabled: false
+  port: 8443
+  cert_file: "/path/to/cert.pem"
+  key_file: "/path/to/key.pem"
+```
+
 # Setting
 
 TC is a low-tech sci-fi MUD. Computer systems are severely regulated following an attempted hostile takeover of Earth by a benevolent dictator AI. Corrupt politicians were jailed. Harmful industries shuttered. Wealth and power were redistributed as the AI began to build Utopia.