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

Add tracking section

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

63
Home.md

@@ -120,40 +120,69 @@ Typically, you will want to pause the timer for breaks or sleep, and resume it w
| Usage | Permissions | Description | | Usage | Permissions | Description |
| --- | --- | --- | | --- | --- | --- |
| `!subathon pause` | Moderators | Pause the subathon. See [[Home#Pausing and Resuming]] | | `!subathon pause` | Moderators | Pause the subathon|
| `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down. See [[Home#Pausing and Resuming]] | | `!subathon resume` | Moderators | Resume the subathon so the timer resumes counting down|
## Points, contributions, and events ## Tracking Contributions
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. 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. Our tracker 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.
Whenever a user contributes, with the *exception* of contributions via Blerp, a message is sent thanking them for the contribution and informing them how many points and how much time they added to the timer (when not capped). For example:
**When a user (re)subscribes (capped)**
> testFromUser contributed 5 points towards our subathon! Thank you <3
**When a user (re)subscribes (uncapped)**
> testFromUser contributed 5 points and added 5 minutes to the timer! Thank you <3
### Subscription contributions ### Subscription contributions
When a user subscribes, re-subscribes, or gifts subscriptions, we add points to the tracker by `number of subs` * `tier score` where `tier score` is one of the configured `t1score`, `t2score, or `t3score` multipliers, and `number of subs` is the number of users affected. In the first two cases, the `number of subs` is always `1`, even if the user subscribes for multiple months.
We then send a message thanking that user, and informing them of how many points and how much time they added to the timer (if not capped).
If Gift subscriptions are given anonymously, then we still send a message, thanking 'Anonymous Gifter'.
Prime subscriptions are counted as a Tier 1 subscription, however a miscalculation *may* occur with Prime subscriptions if the user first subscribes and then chooses to later send their subscription message, since it is possible both will be counted as a subscription. Whether this does occur depends on undocumented details of the Twitch API. Keep an eye out for this and please contact the developer if there are any issues.
### Bits and cheers ### Bits and cheers
When bits are used in the channel via cheers, chat modifiers (large emotes etc), celebrations, or by sending bits along with a chat message, we add points to the tracker by `number of bits` * `bitscore`.
### Blerp messages ### Blerp messages
When we receive a message from the blerp user in either of the following forms:
> blerp: Machinestalkerwolfie used 0 bits to play Laughing Barney
> blerp: !For 25 bits, LaPierreDeSlimeVT played Laughing Barney!
We add points to the tracker by `number of bits` * `bitscore`.
These points are contributed on behalf of the blerp user instead of the source user, by client request.
### Manual adjustment ### Manual adjustment
Moderators may also add points to the timer manually, either on behalf of a target user, or as the 'anonymous' user. The target user does not need to be active in chat, and it may be useful to add points on behalf of various e.g. bots to categorise manually adjusted points.
(Automatic contributions)
(Manual contributions)
| Usage | Permissions | Description | | Usage | Permissions | Description |
| --- | --- | --- | | --- | --- | --- |
| `!subathon adjust <amount> [@user]` | Moderators | Add `amount` points (may be negative to remove) points to the subathon. Optionally on behalf of @user. |
#### Adjustment Arguments
| Argument | Required | Accepts | Description |
| --- | --- | --- | --- |
#### Adjustment Examples #### Adjustment Examples
(Adding anonymously) > !subathon adjust 10
(Adding on behalf of a user) > Added 10 point(s) to the timer
(Removing on behalf of a user)
> !subathon adjust -10
> Removed 10 point(s) from the timer
#### Example > !subathon adjust 10 @croccyhelper
> Added 10 point(s) to the timer on behalf of croccyhelper
> !subathon adjust -10 @croccyhelper
> Removed 10 point(s) from the timer on behalf of croccyhelper
### Statistics
The only contribution statistics command we currently have is `!subathon lb` which displays the top 10 contributors to the subathon.
> !subathon lb
> Birthday Subathon top 10 leaderboard: Unknown: 25 points, ralphluv: 25 points, Unknown: 25 points, Unknown: 25 points, Unknown: 25 points, Nuevois: 25 points, Unknown: 25 points, Theblackop241: 5 points, Unknown: 5 points, ItsKalcefy: 5 points
## Goals ## Goals
@@ -161,8 +190,6 @@ Our subathon timer is no different. The tracker will automatically keep track of
(Goals will be mentioned when achieved.) (Goals will be mentioned when achieved.)
## Stats
## When the timer (or you) finishes ## When the timer (or you) finishes