From f6ee96e8ab603a5c06680fb40fd2281e9d32f4f0 Mon Sep 17 00:00:00 2001 From: holo Date: Wed, 24 Sep 2025 21:18:15 +1000 Subject: [PATCH] Add configuration section --- Home.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 5 deletions(-) diff --git a/Home.md b/Home.md index 0881aae..407c17c 100644 --- a/Home.md +++ b/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 [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