generated from HoloTech/twitch-bot-template
Add command list
+15
-4
@@ -29,7 +29,7 @@ Croccyfocus uses the "delete messages" permission to enforce hyperfocus mode, an
|
||||
*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.*
|
||||
|
||||
|
||||
## Entering and Leaving Hyperfocus
|
||||
## Using Hyperfocus
|
||||
|
||||
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.
|
||||
@@ -45,9 +45,9 @@ To leave hyperfocus mode early, the command `!unfocus` or its alias `!uncrocus`
|
||||
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
|
||||

|
||||
<img src="https://media.discordapp.net/attachments/575722229619490826/1505944984019533854/image.png?ex=6a238a4f&is=6a2238cf&hm=1ba9c65533a60ef01034901c47a2af2bc695d164355e8675062a77acd1644bd2&=&format=webp" height=200 />
|
||||
|
||||
TODO: Other styling examples as well
|
||||
TODO: Other styling examples as well, and host image properly
|
||||
|
||||
Users can check when their (and others) hyperfocus sessions will end with `!hyperfocused` or `!hyperfocused @user`.
|
||||
However to make it even easier, streamers can add the *focuslist widget* to their streams,
|
||||
@@ -59,7 +59,18 @@ The widget colours, text, and shape may also be fully customised by modifying th
|
||||
|
||||
## Command Reference
|
||||
|
||||
TODO: Command Reference
|
||||
<div align="center">
|
||||
|
||||
| Command | Description | Example |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| `!hyperfocus [duration]` | Enter hyperfocus mode for `duration` or until `:50` (UTC) | `!hyperfocus 1h 30m` |
|
||||
| `!focuswith @user` | Enter hyperfocus mode for the same duration as `user` (has remaining). | `!focuswith @Holonomy` |
|
||||
| `!hyperfocused [@user]` | Show how long the given user (or yourself) is in hyperfocus for. | `!hyperfocused @Holonomy` |
|
||||
| `!unfocus` | Exit hyperfocus mode early. | `!unfocus` |
|
||||
| `!focuslist` | Show your channel's focuslist browser source link. | `!focuslist` |
|
||||
| `!addfocus` | Show the Croccyfocus invite/authorisation link. | `!addfocus` |
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
[^1]: https://doi.org/10.1007/s00426-019-01245-8
|
||||
Reference in New Issue
Block a user