generated from HoloTech/twitch-bot-template
Add Usage section
+27
-3
@@ -11,7 +11,7 @@ Ever wanted to tell your chat/colleagues that you *really can't talk right now*
|
|||||||
In Croccyfocus, **hyperfocus mode** is a per-user ***emote and command only mode***.
|
In Croccyfocus, **hyperfocus mode** is a per-user ***emote and command only mode***.
|
||||||
|
|
||||||
|
|
||||||
Any chatter (including mods and the streamer themselves) can enter hyperfocus for a given time by writing e.g. **`!hyperfocus 25m`**.
|
Any chatter (including mods!) can enter hyperfocus for a given time by writing e.g. **`!hyperfocus 25m`**.
|
||||||
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`**.
|
||||||
@@ -22,13 +22,37 @@ Users can also follow each other into hyperfocus by writing **`!focuswith @user`
|
|||||||
## Adding to your channel
|
## Adding 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 add croccyfocus to your channel: 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 app the needed permissions directly.
|
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.
|
||||||
|
|
||||||
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 the streamer's messages, or other mods 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 temporary logging of deleted messages for development purposes.*
|
||||||
|
|
||||||
|
|
||||||
|
## Hyperfocus Usage
|
||||||
|
|
||||||
|
To enter hyperfocus mode:
|
||||||
|
- `!hyperfocus` -- Hyperfocus until the the clock reads "10 minutes to the hour", or `:50`, in UTC time. This is to facilitate the 'default' 50/10 pomo, with the focus session starting on the hour. (NOTE: This default will become customisable in future.)
|
||||||
|
- `!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.)
|
||||||
|
|
||||||
|
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:
|
||||||
|
- Only Twitch and Unicode emojis are supported, *not* 7TV emotes.
|
||||||
|
- Commands are recognised by the message starting with a command prefix such as `!`
|
||||||
|
|
||||||
|
To leave hyperfocus mode early, the command `!unfocus` 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!
|
||||||
|
|
||||||
|
## User list widget and customisation
|
||||||
|
TODO: Widget
|
||||||
|
TODO: Note on recency
|
||||||
|
TODO: Customisation notes (new file)
|
||||||
|
|
||||||
|
## Command Reference
|
||||||
|
|
||||||
|
TODO: Command Reference
|
||||||
|
|
||||||
|
|
||||||
[^1]: https://doi.org/10.1007/s00426-019-01245-8
|
[^1]: https://doi.org/10.1007/s00426-019-01245-8
|
||||||
Reference in New Issue
Block a user