This page takes you from inviting Miyu to a server that's ready to use. It takes about ten minutes.
To add Miyu to a server you need the Manage Server permission there. Pick one of these:
| Link | What Miyu gets |
|---|---|
| Discord App Directory | Miyu's page on Discord, with an "Add App" button |
| Invite without admin rights | All the permissions Miyu's features need, but not Administrator |
| Invite with admin rights | Full Administrator. Easiest to set up and test with. |
| Invite with no permissions | Only slash commands. You set every permission by hand. |
We always recommend giving Miyu only the permissions it needs and setting up role and channel permissions yourself. The admin link is handy for testing.
Without Administrator, Miyu can only see and post in private channels you've added it to. With Administrator it can see everything. Tickets and reports work best with Administrator, because their channels are private.
You can get the invite links again at any time with m!invite.
Go to Server Settings → Roles and drag the Miyu role above every role it should hand out or manage. Discord doesn't let a bot give, remove or moderate roles that sit above its own. This matters for verification, join roles, the troll check, timeouts, kicks and bans.
If you didn't use the admin link, also make sure Miyu can see and write in the channels it should work in, like log channels or your welcome channel.
Type m!help in any channel Miyu can see. You'll get a list of all command groups. Add a group name to see what's in it, for example m!help tickets. More on the Help Command page.
Miyu always listens to m! and to a mention like @Miyu help. If you want your own prefix as well, see Bot Prefix.
Many staff commands check for a staff role instead of a Discord permission. Add your staff roles and give each one an access level:
m!staff role add @Admins admin
m!staff role add @Moderators mod
m!staff role add @Helpers helper
Check the result with m!staff role list. Staff Roles explains what each level can do.
The server owner and anyone with the Administrator permission can always use every staff command. You don't need to add a staff role for them.
Some features are modules that you switch on or off per server. See what's available and what's on right now:
m!modules list
Then turn on what you need:
m!modules enable levelSystem
m!modules enable eventLogging
Quote embeds and user reports are on from the start. Everything else stays off until you enable it. The full list is on Modules.
That's it. If something doesn't work the way you expect, have a look at Troubleshooting.