Nucleus supports "role" based permissions that automatically inherit all recommended permissions
This is one of two ways to assign permissions quickly. The alternative is using the
/nucleus setupperms, which is described here. Do not use both.
Nucleus supports adding a “super” permission that grants all permissions recommended for a given user role.
Nucleus is not a permissions management plugin. Roles are simply a template you can apply to a permission group.
If you do not want Nucleus to use new recommended permissions when you update Nucleus, but wish to review this manually, use
The following permissions automatically grant role defaults:
nucleus.userthat acts as a “super permission” for any permission labelled as
USERin the permission tables
nucleus.modthat acts as a “super permission” for any permission labelled as
MODin the permission tables
nucleus.adminthat acts as a “super permission” for any permission labelled as
ADMINin the permission tables
nucleus.ownerthat acts as a “super permission” for any permission labelled as
OWNERin the permission tables
These do not, and will never, override any explicit permission that has been set.
The owner, admin and mod permissions do not inherit other roles. To grant all permissions up to an including the owner roles, you must grant all of the roles above.
For example, granting
nucleus.owneronly grants the permissions marked as owner, not admin, mod or user permissions.
As an example, you give your moderators the
nucleus.mod permission. This, for example, gives them permission to enter staff chat. However, maybe you don’t want them to access this. If you set
false, this will override
nucleus.mod. The same can be said for parent permissions, if you set
false, a check to
nucleus.staffchat.base will return
false, regardless of whether
nucleus.mod is set.
While this is cleaner than using
/nucleus setupperms, you must be aware of the following:
/nucleus setuppermswill continue to exist, and will not grant new permissions automatically if they are added in new releases (but will if you re-run the setupperms commands).
If you do not want to use the role permissions, this can be turned off in the config by setting
false and reloading.