diff --git a/How-to-add-focus.md b/Focus-docs.md similarity index 61% rename from How-to-add-focus.md rename to Focus-docs.md index 4fff6db..4ab1610 100644 --- a/How-to-add-focus.md +++ b/Focus-docs.md @@ -1,4 +1,4 @@ -# Hyperfocus Documentation (for admins) +# Croccyfocus Documentation (for admins) ## What Is Hyperfocus > ***Hyperfocus** is a phenomenon that reflects one's complete absorption in a task, to a point where a person appears to completely ignore or 'tune out' everything else.*[^1] @@ -19,5 +19,16 @@ They will also be shown on the (optional) on-stream browser widget so everyone c 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 +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. + +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 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.* + + + [^1]: https://doi.org/10.1007/s00426-019-01245-8 \ No newline at end of file