From 5ebb04c76420f8ca3b5a72c26163389d523f09ae Mon Sep 17 00:00:00 2001
From: hgw <hgw@noreply.localhost>
Date: Sat, 16 Sep 2023 06:59:18 -0700
Subject: [PATCH] Update Config

---
 Config.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 53 insertions(+), 4 deletions(-)

diff --git a/Config.md b/Config.md
index d9aac55..b1529e4 100644
--- a/Config.md
+++ b/Config.md
@@ -14,10 +14,42 @@ IRC
 | channels     | Array list of channels the bot will join | ["#example1", "#example2"] |
 | nickname     | Nickname     | mercury |
 | username     | Username     | mercury | 
-| realname     | Real Name     | git.supernets.org/hogwart7/mercury |
+| realname     | Real Name     | git.supernets.org/hgw/mercury |
 | autorejoin     | Auto Rejoin if bot is disconnected (this does not include crashes, Docker will handle auto-restarts in that case)    | true/false |
-| floodprotection     | Queue messages to prevent excess flood kicks     | true/false |
-| floodprotectiondelay     | How long to queue messages for if floodprotection is enabled     | Number (milliseconds) |
+| prefix | Client command prefix | Anything I suppose, default is m! |
+
+Flood Protection
+
+| Variable   | Description | Options/Example |
+| --------   | -------- | ---------- |
+| flood_protection     | Queue messages to prevent excess flood kicks     | true/false |
+| flood_protection_delay     | How long to queue messages for if floodprotection is enabled     | Number (milliseconds) |
+| command_listen_timeout | Timeout for the command listener, prevents the client from responding to spammed commands and getting banned, I recommend leaving this at the default value. Enabled irrespective of flood_protection unless set to 0 | Number (milliseconds) |
+
+Error Handling
+
+| Variable   | Description | Options/Example |
+| --------   | -------- | ---------- |
+| error_logging | Toggling sending console errors to IRC | true/false |
+| error_channel | Channel to send console errors to | #channel |
+| error_channel_pass | Password for the nominated error_channel, if it exists, leave this variable blank if not | Channel Password |
+
+Colours
+
+[See here for a guide on colour codes](https://modern.ircdocs.horse/formatting.html#color)
+
+| Variable   | Description | Options/Example |
+| --------   | -------- | ---------- |
+| date | Feed date colour | 00-98 |
+| brackets | Brackets colour | 00-98 |
+| title | Feed title colour | 00-98 |
+| author | Feed author colour | 00-98 |
+| body | Feed main text content colour | 00-98 |
+| link | Feed link colour | 00-98 |
+| help_logo | Colour of logo in m!help, if enabled | 00-98 |
+| help_motd | Colour of MOTD in m!help, if enabled | 00-98 |
+| warning | Colour of "WARNING" in warning messages | 00-98 |
+| error | Colour of "ERROR" in error messages | 00-98 |
 
 Feed
 
@@ -27,9 +59,26 @@ Feed
 | body_max_chars | How many main body characters to allow in any one post, to prevent single posts being split in to multiple messages | Number (characters) |
 | time_format | Time format to use for post timestamps | DD MMM YYYY HH:mm:ss ZZ |
 | timezone | IANA time zone to use for post timestamps | GMT (for GMT) or Pacific/Auckland (for other) |
+| default_amount | Default amount of feed entries to post if the amount specified can not be achieved | 5 is recommended |
 
 Twitter 
 
 | Variable | Description | Options/Example |
 | -------- | ----------- | --------------- |
-| nitter_instances | Array list of Nitter instances for the bot to cycle through (prevents load on any one instance). Domain name only, the rest is preformatted. | ["nitter.id4.us", "nitter.pufe.org"] |
\ No newline at end of file
+| nitter_instances | Array list of Nitter instances for the bot to cycle through (prevents load on any one instance). Domain name only, the rest is preformatted. | ["nitter.id4.us", "nitter.pufe.org"] |
+| default_amount | Default amount of tweets to post if the amount specified can not be achieved | 5 is recommended |
+
+Misc
+
+| Variable | Description | Options/Example |
+| -------- | ----------- | --------------- |
+| display_help_logo | Display the Mercury logo in m!help | true/false
+| logging | Toggle logging actions to the terminal output, good for debugging | true/false
+
+MOTD
+
+| Variable | Description | Options/Example |
+| -------- | ----------- | --------------- |
+| enable | Toggle the MOTD in m!help. Setting version sets the output to the value of version below | true/false/version |
+| list | Array list of all MOTD outputs, randomised when m!help is run | ["Output 1", "Output 2"] |
+| version | Version of Mercury, this setting will be replaced soon. | Version |
\ No newline at end of file