commit e32c38858802971954bb6778c553d9622f913b42 Author: holo Date: Wed Sep 24 20:17:25 2025 +1000 Add command reference. diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..8a7e11f --- /dev/null +++ b/Home.md @@ -0,0 +1,101 @@ +# Usage Documentation +These docs will assume the command prefix is `!`. + +## Command Reference +| Usage | Permissions | Description | +| --- | --- | --- | +| `!subathon` | All Users | Displays summary information about the currently running subathon. | +| `!subathon setup [cap]` | Only Broadcaster | Setup and start a new subathon. See [[Home#Setting up and configuring]] | +| `!subathon stop` | Only broadcaster | ⚠️ Permanently stops the subathon. Cannot be reversed. Subathon cannot be accessed after stopping. | +| `!subathon link` | Moderators | Displays the OBS/browser link for the subathon timer. | +| `!subathon pause` | Moderators | Pause the subathon. See [[Home#Pausing and Resuming]] | +| `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down. See [[Home#Pausing and Resuming]] | +| `!subathon adjust [@user]` | Moderators | Add `amount` points (may be negative to remove) points to the subathon. Optionally on behalf of @user. | +| `!subathon lb` | All Users | Display the top 10 contributors to the subathon, in order, by points. | +| `!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 [ ]` | 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) | +| `!goals` | All Users | Show the goals that have been setup for the active subathon. | +| `!goals remaining` | All Users | Show the subathon goals that have yet to be achieved. | +| `!goals add ` | Moderators | Add a new goal with required `points` and name `description`. | +| `!goals remove ` | Moderators | Remove all goals which required exactly `points`. | + + +## Goals + +(Goals will be mentioned when achieved.) + + +## Setting up and configuring +### `!subathon setup` +| Usage | Permissions | Description | +| --- | --- | --- | +|`!subathon setup [cap]` | Only Broadcaster | Setup and start a new subathon. | + + + +Should be used exactly once at the start of a subathon. +Note that all arguments except `initial_hours` are adjustable post-creation with `!subathon config`. + +#### Arguments +| Argument | Required | Accepts | Description | +| --- | --- | --- | --- | +|`initial_hours` | yes | Integer | Number of hours to start the subathon with. | +| `t1score` | yes | Float | Number of points a t1 subscription is worth. | +| `t2score` | yes | Float | Number of points a t2 subscription is worth. | +| `t3score` | yes | Float | Number of points a t3 subscription is worth. | +| `bitscore` | yes | Float | Number of points a single bit is worth. | +| `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 + +> !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 + + +### `!subathon link` +| Usage | Permissions | Description | +| --- | --- | --- | +| `!subathon link` | Moderators | Displays the OBS/browser link for the subathon timer. | + + +## Pausing and Resuming +Use `!subathon pause` to pause a subathon and `!subathon resume` to continue it. + +Subathons will continue to accept contributions and raise the timer while paused, +but the timer will no longer count down with the regular passage of time. + +Subathons will automatically pause when the stream goes offline, but they do not automatically resume. + +### `!subathon resume` +| Usage | Permissions | Description | +| --- | --- | --- | +| `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down. | + +#### Arguments + + +#### Example + +### `!subathon adjust` +| Usage | Permissions | Description | +| --- | --- | --- | + + +#### Arguments +| Argument | Required | Accepts | Description | +| --- | --- | --- | --- | + +#### Example + + + +#### Example + +## Events and Contributions + +(Automatic contributions) +(Manual contributions) \ No newline at end of file