HoloTech/hyperfocus-twitch-bot
1
0
Fork 0
generated from HoloTech/twitch-bot-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweak wording

holo
2026-06-05 21:43:51 +10:00
parent 68ca0df48e
commit 01838db748
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Focus-docs.md
+7 -8
@@ -15,18 +15,18 @@ Any chatter (including mods!) can enter hyperfocus for a given time by writing e
Then for the next 25 minutes, they will only be able to write emojis and commands, Then for the next 25 minutes, they will only be able to write emojis and commands,
and any other messages will be automatically deleted as a gentle reminder not to get distracted. and any other messages will be automatically deleted as a gentle reminder not to get distracted.
They can come out early with **`!unfocus`**, and show other users they are locked in and unable to chat with **`!hyperfocused`**. They can come out early with **`!unfocus`**, and show other users they are locked in and unable to chat with **`!hyperfocused`**.
They will also be shown on the (optional) on-stream browser widget so everyone can see that they are locked in and how long is left. They will also be shown on the (optional) on-stream browser widget so everyone can see who is locked in and how long is left.
Users can also follow each other into hyperfocus by writing **`!focuswith @user`**, which will match their hyperfocus timer to the given user. Users can also follow each other into hyperfocus by writing **`!focuswith @user`**, which will match their hyperfocus timer to the given user.
## Adding to your channel ## Adding focus to your channel
Use this link to authorise and add croccyfocus to your channel: https://croccyfocus.thewisewolf.dev/invite Use this link to authorise and invite croccyfocus: https://croccyfocus.thewisewolf.dev/invite
If your channel has a particularly high level of verification set, you may need to give croccyfocus moderator status by writing `/mod croccyfocus` in chat before it can send messages. This is usually not required, since the invite link grants the needed permissions directly. If your channel has a particularly high level of verification set, you may also need to make croccyfocus a moderator by writing `/mod croccyfocus` in chat before it can send messages. This is usually not required, since the invite link grants the needed permissions directly.
Croccyfocus uses the "delete messages" permission to enforce hyperfocus mode, and uses the "write chat messages as your user" permission to be able to delete *your own* messages in hyperfocus mode (since only the streamer can delete their own or other moderator's messages). Croccyfocus uses the "delete messages" permission to enforce hyperfocus mode, and uses the "write chat messages as your user" permission to be able to delete *your own* messages in hyperfocus mode (since only the streamer can delete their own or other moderator's messages).
*Croccyfocus will never send chat messages with another user's account, will never delete messages outside of hyperfocus mode, and performs no recording of messages or user information aside from usernames, IDs, commands, and temporary logging of deleted messages for development purposes.* *Croccyfocus will never send chat messages with another user's account, will never delete messages outside of hyperfocus mode, and performs no recording of messages or user information aside from usernames, IDs, commands (and information therein), and temporary logging of hyperfocus deleted messages for development purposes.*
## Hyperfocus Usage ## Hyperfocus Usage
@@ -36,12 +36,11 @@ To enter hyperfocus mode:
- `!hyperfocus duration` -- Hyperfocus for the given `duration`, which may be written as any combination of days, hours, minutes, and seconds, and any English abbreviation thereof. E.g. `1day 2hrs 10m` or `10 minutes` or `1h5m` are all accepted. - `!hyperfocus duration` -- Hyperfocus for the given `duration`, which may be written as any combination of days, hours, minutes, and seconds, and any English abbreviation thereof. E.g. `1day 2hrs 10m` or `10 minutes` or `1h5m` are all accepted.
- `!focuswith @user` -- Hyperfocus for the same duration as the given user. (The duration will not be updated if the other user leaves focus early or changes their focus time.) - `!focuswith @user` -- Hyperfocus for the same duration as the given user. (The duration will not be updated if the other user leaves focus early or changes their focus time.)
While in hyperfocus mode, *any message which is not either a command or entirely consisting of emojis* will be deleted as a gentle reminder to stay focused. Note that: While in hyperfocus mode, *any message which is not either a command or entirely consisting of emojis* will be deleted as a gentle encouragement to stay focused. Note that:
- Only Twitch and Unicode emojis are supported, *not* 7TV emotes. - Only Twitch and Unicode emojis are supported, *not* 7TV emotes.
- Commands are recognised by the message starting with a command prefix such as `!` - Commands are recognised by the message starting with a command prefix such as `!`
To leave hyperfocus mode early, the command `!unfocus` may be used. To leave hyperfocus mode early, the command `!unfocus` or its alias `!uncrocus` may be used.
The alias `!uncrocus` may also be used if `!unfocus` clashes with another bot.
The hyperfocus mode ***is shared amongst all channels using croccyfocus***, so if you go into focus in one channel, you won't be able to chat in any channel until your focus ends! The hyperfocus mode ***is shared amongst all channels using croccyfocus***, so if you go into focus in one channel, you won't be able to chat in any channel until your focus ends!