Setup

Setting up Sprinto (Server owners/managers)

Steps:

1. Invite Sprinto — Bring Sprinto to your Discord server, or pass this link to the server owner or someone who has permission to add bots. All requested permissions are optional. Alternative links: The Join button on Sprinto's DiscordBots page; or use Sprinto's _invite command.

2. That's it. You're ready to Sprint!

But what else can I do as a server admin? (Optional steps)

3. Create a dedicated sprint room. Sprinto usage can quickly overwhelm any chat room, so almost all servers create a dedicated sprint channel with a name like #writing-sprints, #sprints-and-excerpts or something thematically appropriate for their server like #word_sprint_dojo. Sprinto often fails to see any usage when he has to share a general #bots channel. Some servers even have two sprint channels, one for short sprints (perhaps 5 or 10 minutes) and one for longer sprinters (up to an hour). Sprints started in different channels run independently. You cannot run more than one simultaneous sprint in one channel.

4. Create a Sprint MC role. If you create a role named "Sprint MC" (or "Sprint MCs", any case), anyone assigned the role will have additional powers to help run and manage sprints. So far, all that means is they can cancel any sprint with _cancel please. The guild owner and administrators also have Sprint MC permissions. In future, there may be more SprintMC-specific commands, such as changing default sprint settings and stuff.

5. _create_active_role to set up an @Active Sprinter role. Active Sprinters now get automatically added to the @Active Sprinter role during the sprint if it exists, so you can see sprinters (and that a sprint is happening) in the members list. It also lets sprinters @ each other easily. At the end of the Sprint everyone is removed. Also works with multiple sprint rooms. _create_active_role will guide you through the process.

6. What about Sprinto's permissions? Sprinto currently needs no more than the default permissions which @everyone will have by default: to "Read Messages", "Send Messages" and (optionally*) "Read Message History", and "Manage Roles" for the above.

7. So then why did Sprinto ask for more permissions when I invited Sprinto? So far, these are all for future features. Until recently Sprinto asked for no permissions, so use the "invite" link at the top of the page to re-invite him to add these new permissions. Sprinto will need the following for planned features: manage roles, send TTS messages, priority speaker. But he'll continue to work without any special permissions.

8. Sprints in the wrong rooms? If you're worried about users starting sprints outside of the sprint rooms, you can remove Sprinto's "Send Messages" permission in rooms you don't want Sprinto to respond in, or remove his "Read Messages" permission in channels you don't want Sprinto seen in. You can also order his role to place him higher in the members list to help user find the Sprint bot. (He won't have his own default role if he's only got default permissions)

9. How about changing the prefix? Sprinto responds to commands starting with an underscore (_) or a mention (@Sprinto). If this conflicts with another bot in your sprinting channel, please request a prefix change on Sprinto's support discord server (Sprinto Planet). Use @Sprinto prefix to check the current prefix on your server. I haven't made the prefix user-configurable yet because no one's ever had a problem with it or even mentioned it.

10. Rename Sprinto and give him a thematically suitable nickname on your server, such as Sir Sprinto Esquire.

---

* Footnote: Why "Read Message History"? The boring details you don't need to know. Under very special circumstances Sprinto may find "Read Message History" helpful, but feel free to turn it off if you're paranoid about bots. Sprinto will sometimes clean up its response after the user deletes their error-triggering command. To do this, Sprinto may sometimes need "Read Message History". It probably shouldn't need this permission to do that, but it does due to how the Discord.Net API is structured, requiring a message to be loaded before it can be deleted. It's a default permission anyway and Sprinto will operate just fine without it just the same, but congrats on reading this far.]