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

Some notes on goals and endings

holo
2025-09-24 23:26:01 +10:00
parent 264ff4358b
commit ada940369a
1 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Home.md

@@ -187,12 +187,33 @@ The only contribution statistics command we currently have is `!subathon lb` whi
## Goals ## Goals
(Goals will be mentioned when achieved.) The tracker also has rudimentary support for 'subathon goals', by means of the below commands.
The goal progress will be mentioned in `!subathon`, and when a goal is achieved, the tracker will send a message to chat with the goal description.
> croccyhelper: testFromUser contributed 25 points and added 25 minutes to the timer! Thank you
<3
> croccyhelper: We have reached Goal #1: Do some cool stuff !! Thank you everyone for your support
<3
| Usage | Permissions | Description |
| --- | --- | --- |
| `!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 <points> <description>` | Moderators | Add a new goal with required `points` and name `description`. |
| `!goals remove <points>` | Moderators | Remove all goals which required exactly `points`. |
## When the timer (or you) finishes ## When the timer (or you) finishes
When the timer runs out (i.e. the timer duration exceeds the (possibly capped) earned time), there are a few small things to note.
- Nothing happens in the moment, except the timer will tick down to 00:00 and stay there.
- Contributions will not longer be accepted, and will not trigger any message or add to the timer, or be tracked as contributions.
- Until the subathon has been explicitly paused (or stopped), a moderator may use `!subathon adjust` to add points to the timer, which, if the timer is not capped, may 'unfinish' it with no negative effects.
- The subathon still counts as 'active', so commands such as `!subathon lb` will still work as expected, until the subathon has been fully stopped with `!subathon stop`.
**Technical Note:** The 'end' of a subathon is represented entirely virtually, with a subathon being considered as finished if the duration equals or exceeds the earned time. If a subathon is finished in this sense, it may be paused, but it can not be resumed or contributed to except via `adjust`. All reported durations will act as if the subathon total duration is equal to the earned time.
## Afterword ## Afterword
Thank you for using HoloTech Subathon Tracker, part of Holo Technology Solutions! Thank you for using HoloTech Subathon Tracker, part of Holo Technology Solutions!