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

Improve structure

holo
2025-09-24 21:35:20 +10:00
parent f6ee96e8ab
commit 358c2c9c6d
1 changed files with 40 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
Home.md

@@ -23,10 +23,6 @@ These docs will assume the command prefix is `!`.
| `!goals remove <points>` | 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 [<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
#### 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 <option> [value] to see or set each option!
@@ -111,32 +107,59 @@ 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`
Typically, you will want to pause the timer for breaks or sleep, and resume it when you come back.
| Usage | Permissions | Description |
| --- | --- | --- |
| `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down. |
| `!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]] |
#### Arguments
## Points, contributions, and events
The core function of a subathon tracker is to keep track of the contributions to the subathon, and raise the timer when a contribution is received.
Our subathon timer is no different. The tracker will automatically keep track of (re)subscriptions, bits, and Blerp messages, and will raise the timer when they are received according to the configured score table. It is also possible for moderators to manually add or remove points from the subathon, either anonymously or on behalf of a specific user.
### Subscription contributions
#### Example
### Bits and cheers
### Blerp messages
### Manual adjustment
(Automatic contributions)
(Manual contributions)
### `!subathon adjust`
| Usage | Permissions | Description |
| --- | --- | --- |
#### Arguments
#### Adjustment Arguments
| Argument | Required | Accepts | Description |
| --- | --- | --- | --- |
#### Example
#### Adjustment Examples
(Adding anonymously)
(Adding on behalf of a user)
(Removing on behalf of a user)
#### Example
## Events and Contributions
(Automatic contributions)
(Manual contributions)
## Goals
(Goals will be mentioned when achieved.)
## Stats
## At the end
## Afterword
Thank you for using HoloTech Subathon Tracker, part of Holo Technology Solutions!
We hope you have a great subathon.
For questions and support, please feel free to reach out to @conatum on Discord, or email me at [mailto:holo.tech@thewisewolf.dev](holo.tech@thewisewolf.dev)