Update config-dist.yml

config-dist.yml

@@ -1,21 +1,21 @@
 irc:
-  channel: "#changeme"
-  username: "changeme"
+  channel: "#changeme" # Your twitch channel
+  username: "changeme" # Your bots username
   oauth_token: # leave this blank to start the token generator
-  server: "irc.chat.twitch.tv"
-  clearmsg_timeout: 10
+  server: "irc.chat.twitch.tv" # Twitch IRC server, default should be fine
+  clearmsg_timeout: 10 # Time to wait for a new message to be deleted before being read
 
 http:
-  port: 80
-  bind: "localhost"
+  port: 80 # Internal webserver port
+  bind: "localhost" # Internal webserver IP/Hostname, use 0.0.0.0 to listen on all interfaces
 
 bot:
-  start_enabled: True
-  subonly: False
-  modonly: False
-  message_length: 200
+  start_enabled: True # Start the bot with TTS active, if set to False you need to enable TTS with !ton
+  subonly: False # Only Subs can use TTS
+  modonly: False # Only Mods can use TTS
+  message_length: 200 # Max. TTS message length
 
-messages:
+messages: # Things the bot can send as chat message
   toff: "TTS is now inactive."
   ton: "TTS is now active."
   too_long: "Sorry, your TTS message is too long."
@@ -32,7 +32,7 @@ messages:
   votes: "Votes"
 
 log:
-  level: "INFO"
+  level: "INFO" # Loglevel, valid values are: DEBUG, INFO, WARNING, ERROR, CRITICAL (do not use DEBUG in a production environment)
 
 usermapping:
-  gpkvt: "gpk"
+  gpkvt: "gpk" # rename users when being read, to make their names shorter or sound better.