Add configuration section

Home.md

@@ -29,14 +29,19 @@ These docs will assume the command prefix is `!`.
 
 
 ## Setting up
-To start a new subathon, start by running `!subathon setup`, described below.
+To start a new subathon, the broadcaster should first choose how much each contribution will be worth, how much time the timer should start with, and whether there is a time cap, and create a new subathon with that information by using `!subathon setup` described below. Note that all options except `initial_hours` are also adjustable post-creation with `!subathon config`. If you want to customise the name of the subathon, that should also be done through `!subathon config name`.
 
+The creation command will return a link to the subathon timer, which may be copied and included as an OBS browser source.
+Note that the browser source/timer does not have any disconnection protection, so if the bot is restarted or if there is a connection issue on the side of the computer running OBS, the timer may disconnect and not update. To fix this, if there has been a disconnection, open the OBS browser source and press "Refresh Cache" to refresh the page and reconnect the timer. This will not affect the tracked contributions in any way, as all data is stored server-side. The OBS timer link can be retrieved at any time by the broadcaster using `!subathon link`.
+
+At this point the subathon has been started, but will be in a 'paused' state. The timer should be showing the number of hours given in `initial_hours`, but should not be running. Sub and bit contributions will be counted and will raise the timer even while paused.
+
+For further configuration, see the next section.
 
 | Usage | Permissions | Description |
 | --- | --- | --- |
 |`!subathon setup <initial_hours> <t1score> <t2score> <t3score> <bitscore> <timescore> [cap]` | Only Broadcaster | Setup and start a new subathon. |
-
+|`!subathon link` | Moderators | Displays the OBS/browser link for the subathon timer. |
-
 
 
 #### Arguments
@@ -55,11 +60,47 @@ To start a new subathon, start by running `!subathon setup`, described below.
 > !subathon setup 6 5 10 20 0.1 10 6  
 > croccyhelper: Setup your subathon! Use !subathon resume to get the timer running. Use !subathon config to see and set options, including the name. Your timer link for OBS: https://izashi.thewisewolf.dev/tracker/timer?community=3
 
+## Configuration
+The name, points added per contribution, seconds added per point, and timer cap of the subathon are all dynamically configurable with `!subathon config`. Running `!subathon config` itself will show you the list of options and their values, `!subathon config <option>` will show you the current value and further information about that option, and `!subathon config <option> <value>` will set that option to the provided value, if possible.
 
-### `!subathon link`
 | Usage | Permissions | Description |
 | --- | --- | --- |
-| `!subathon link` | Moderators | Displays the OBS/browser link for the subathon timer. |
+| `!subathon config` | Moderators | Display a summary of the current subathon configuration. |
+| `!subathon config name [new name]` | Moderators | View or update the subathon name. |
+| `!subathon config cap [new cap]` | Moderators | View or update the subathon timer cap. |
+| `!subathon config scores [<t1score> <t2score> <t3score> <bitscore>]` | Moderators | View or update the score table (number of points contributions are worth). |
+| `!subathon config timescore [new score]` | Moderators | View or update the seconds-per-point score of the subathon. (⚠️ Retroactive) |
+
+#### Examples
+> !subathon config  
+> croccyhelper: name="Testing" ; cap=6 (hours, 0 means no cap) ; scores=5.0 10.0 20.0 0.1 (t1, t2, t3, and 1 bit point scores) ; timescore=10 (seconds per point) ; Use !!subathon config <option> [value] to see or set each option!
+
+> !subathon config name  
+> croccyhelper: Name of the subathon, used whenever the subathon is mentioned. Accepts any string. Currently: "Testing" Example: !subathon config name Birthday Subathon
+
+> !subathon config name Birthday Subathon  
+> croccyhelper: Updated the subathon name to "Birthday Subathon"
+
+> !subathon config cap  
+> croccyhelper: Duration cap for this subathon, in hours, including the initial time. Contributions given after the cap has been reached will be accepted, but will not raise the timer. Accepts an integer, with 0 meaning no cap. Currently: 6 hours. Example: !subathon config cap 24
+
+> !subathon config cap 0  
+> croccyhelper: The timer cap has been removed! To infinity and beyond!
+
+> !subathon config cap 10  
+> croccyhelper: The subathon timer has been capped to 10 hours.
+
+> !subathon config scores  
+> croccyhelper:  The number of points each type of contribution (t1 sub, t2 sub, t3 sub, and 1 bit) will add to the subathon. Not retroactive. Accepts four floats. Currently: 5.0 10.0 20.0 0.1 Example: !subathon config scores 5 10 20 0.1
+
+> !subathon config scores 5 10 20 0.1  
+> croccyhelper: Successfully updated subathon score table.
+
+> !subathon config timescore  
+> croccyhelper: The number of seconds each contributed point adds to the timer. WARNING: This setting is retroactive and should generally not be used. Accepts an integer. Currently: 10 (seconds per point) Example: !subathon config timescore 10
+
+> !subathon config timescore 5
+> croccyhelper: Subathon time score updated (NOTE: This is retroactive).
 
 
 ## Pausing and Resuming