Permissions and FredBoat

When developing the permission system it was decided we wanted a simple permission system that could easily be configured. FredBoat uses 4 different ranks each with different permissions.

• 3: Admin

Can change FredBoat configuration and edit permissions

• 2: DJ

Can skip, can pause/unpause, can change repeat mode, can change shuffle mode, etc

• 1: User

Can add tracks to the queue and can only skip their own tracks

• 0: Base

Given to everyone without higher ranks. Cannot modify the queue or player, but can still use commands like ;;list, ;;np, etc

Special notes

• Users with the Discord "Administrator" permission and owners implicitly have all perms.
• Permissions are specific for a server, never a channel.
• Higher ranks also have lower rank permissions.
• Permissions can be granted to users or roles. This includes the @everyone role.
• By default, everyone has the DJ and User roles, but this can be restricted.

The permission commands

These are the command available:

;;admin add <user/role>
;;admin del <user/role>
;;admin list
;;dj add <user/role>
;;dj del <user/role>
;;dj list
;;user add <user/role>
;;user del <user/role>
;;user list

The name of the command specifies which rank you are modifying or listing.

These commands are restricted to users with the ADMIN permissions, apart from the list subcommand. The add subcommand can be used to add users or roles.

The del subcommand can be used to remove a user or role from a rank:

You do not need to specify the full name of a user or role to add/remove them. FredBoat will do a case-insensitive search of the names and ID numbers.

A note about selfhosting

The owner of the bot application the bot is running on is automatically given the BOT_OWNER permission. Admins specified in configuration.yml are granted the BOT_ADMIN role. These ranks allows nearly complete control of the bot for things like restarting the bot, in addition to ADMIN permissions in all servers.