diff --git a/Home.md b/Home.md index 407c17c..ff1646b 100644 --- a/Home.md +++ b/Home.md @@ -23,10 +23,6 @@ These docs will assume the command prefix is `!`. | `!goals remove ` | Moderators | Remove all goals which required exactly `points`. | -## Goals - -(Goals will be mentioned when achieved.) - ## Setting up 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`. @@ -44,7 +40,7 @@ For further configuration, see the next section. |`!subathon link` | Moderators | Displays the OBS/browser link for the subathon timer. | -#### Arguments +#### Setup Arguments | Argument | Required | Accepts | Description | | --- | --- | --- | --- | |`initial_hours` | yes | Integer | Number of hours to start the subathon with. | @@ -55,7 +51,7 @@ For further configuration, see the next section. | `timescore` | yes | Integer | Number of seconds to add to the timer per point. | | `cap` | no | Integer | Optional number of hours to cap the subathon at. | -#### Example +#### Setup Example > !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 @@ -71,7 +67,7 @@ The name, points added per contribution, seconds added per point, and timer cap | `!subathon config scores [ ]` | 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 +#### Configuration 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