HoloTech/twitch-subathon-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adjust command reference

holo
2025-09-24 22:12:37 +10:00
parent 5b2d24190f
commit ebddf01029
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Home.md

@@ -5,18 +5,18 @@ These docs will assume the command prefix is `!`.
| Usage | Permissions | Description | | Usage | Permissions | Description |
| --- | --- | --- | | --- | --- | --- |
| `!subathon` | All Users | Displays summary information about the currently running subathon. | | `!subathon` | All Users | Displays summary information about the currently running subathon. |
| `!subathon setup <initial_hours> <t1score> <t2score> <t3score> <bitscore> <timescore> [cap]` | Only Broadcaster | Setup and start a new subathon. See [[Home#setting up]] | | `!subathon setup <initial_hours> <t1score> <t2score> <t3score> <bitscore> <timescore> [cap]` | Only Broadcaster | [Setup](#setting-up) and start a new subathon. |
| `!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 link` | Moderators | Displays the OBS/browser link for the subathon timer. |
| `!subathon pause` | Moderators | Pause the subathon. See [[Home#pausing and resuming]] | | `!subathon pause` | Moderators | [Pause](#pausing-and-resuming) the subathon. |
| `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down. See [Pausing and Resuming](#pausing-and-resuming) | | `!subathon resume` | Moderators | [Resume](#pausing-and-resuming) the subathon so the timer resumes counting down. |
| `!subathon adjust <amount> [@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` | Moderators | Display a summary of the current subathon configuration. |
| `!subathon config name [new name]` | Moderators | View or update the subathon name. | | `!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 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 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) | | `!subathon config timescore [new score]` | Moderators | View or update the seconds-per-point score of the subathon. (⚠️ Retroactive) |
| `!subathon adjust <amount> [@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 stop` | Only broadcaster | ⚠️ Permanently stops the subathon. Cannot be reversed. Subathon cannot be accessed after stopping. |
| `!goals` | All Users | Show the goals that have been setup for the active subathon. | | `!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 remaining` | All Users | Show the subathon goals that have yet to be achieved. |
| `!goals add <points> <description>` | Moderators | Add a new goal with required `points` and name `description`. | | `!goals add <points> <description>` | Moderators | Add a new goal with required `points` and name `description`. |