Configuration

The configuration for EnduraBot takes place in 3 files.

|──data /
|   |── misc_text.json
|   |── permissions.json
|   └── variables.json

Variables¶

variables.json has the meat and potatoes of relevant configuration.

Permissions¶

As of version 2.1 EnduraBot centralized it's permissions checking to the contents of data/permissions.json.

{
    "editrole": [
        1426035365671731292
    ],
    "alert": [
        3456789012345678901
    ]
}

The keys (e.g editrole) are the programmatic function names of registered commands. The value of the key, being a list, are role IDs authorized to use the command.

If a registered command does not have an entry in permissions.json EnduraBot will presume that anyone in the server may use it. Furthermore, any member on the server with the Discord Administrator permission automatically passes all permissions checks.

To find the programmatic name for a command one may search the files in the cogs folder. Unless the entire file is dedicated to one command, generally, comments precede the code that registers a command.

Lets take a look at the /about command.

# --- COMMAND: /about ---

    @app_commands.command(name="about", description="Get information about EnduraBot.")
    @app_commands.check(check_permissions)
    @app_commands.guilds(GUILD_ID)
    async def about(self, interaction: discord.Interaction):

In the above case the programmatic name for the command is about. It is the name of the declared asynchronus function (async def) following the decorator registering a Discord application command (@app_commands.command()).

Miscellaneous text¶

Certain functions of EnduraBot rely on lists of string values in order to function properly. These are stored here.