diff --git a/docs/Permissions System.md b/docs/Permissions System.md index 32ad3407..4bc92998 100644 --- a/docs/Permissions System.md +++ b/docs/Permissions System.md @@ -1,9 +1,7 @@ Permissions Overview =================== Have you ever felt confused or even overwhelmed when trying to set Nadeko's permissions? In this guide we will be explaining how to use the -permission commands correctly and even cover a few common questions! Every command we discuss here can be found in the [Commands List](http://nadekobot.readthedocs.io/en/1.0/Commands%20List/#permissions). - -**To see the old guide for versions 0.9 and below, see [here](http://nadekobot.readthedocs.io/en/latest/Permissions%20System/)** +permission commands correctly and even cover a few common questions! Every command we discuss here can be found in the [Commands List](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#permissions). Why do we use the Permissions Commands? ------------------------------ @@ -15,17 +13,20 @@ With the permissions system it possible to restrict who can skip the current son First Time Setup ------------------ -To change permissions you **must** meet the following requirement: +To change permissions you **must** meet the following requirements: -**Have the role specified by `.permrole` (By default, this is Nadeko)** +**Be the owner of the server.** + +**If you are NOT the server owner, get the role specified by `.permrole` (By default, this is Nadeko).** If you have an existing role called `Nadeko` but can't assign it to yourself, create a new role called `Nadeko` and assign that to yourself. +![img0](https://i.imgur.com/5QKZqqy.gif) If you would like to set a different role, such as `Admins`, to be the role required to edit permissions, do `.permrole Admins` (you must have the current permission role to be able to do this). Basics & Hierarchy ----- -The [Commands List](http://nadekobot.readthedocs.io/en/1.0/Commands%20List/#permissions) is a great resource which lists **all** the available commands, however we'll go over a few commands here. +The [Commands List](http://nadekobot.readthedocs.io/en/latest/Commands%20List/#permissions) is a great resource which lists **all** the available commands, however we'll go over a few commands here. Firstly, let's explain how the permissions system works - It's simple once you figure out how each command works! The permissions system works as a chain, everytime a command is used, the permissions chain is checked. Starting from the top of the chain, the command is compared to a rule, if it isn't either allowed or disallowed by that rule it proceeds to check the next rule all the way till it reaches the bottom rule, which allows all commands. @@ -35,7 +36,7 @@ To view this permissions chain, do `.listperms`, with the top of the chain being If you want to remove a permission from the chain of permissions, do `.removeperm X` to remove rule number X and similarly, do `.moveperm X Y` to move rule number X to number Y (moving, not swapping!). As an example, if you wanted to enable NSFW for a certain role, say "Lewd", you could do `.rolemdl NSFW enable Lewd`. -This adds the rule to the top of the permissions chain so even if the default `.sm NSFW disabled` rule exists, the "Lewd" role will be able to use the NSFW module. +This adds the rule to the top of the permissions chain so even if the default `.sm NSFW disable` rule exists, the "Lewd" role will be able to use the NSFW module. If you want the bot to notify users why they can't use a command or module, use `.verbose true` and Nadeko will tell you what rule is preventing the command.