Documentation menu

Docs/Information/General Configuration

General Configuration

The top-level config sections every server uses - web access, levels, commands, and the prefix.

Your server's config is one YAML document. This page covers the top-level sections that are not tied to a single plugin. Every example is valid YAML you can paste into the Config page; comments (# like this) are yours to keep and survive every dashboard edit.

web

Controls who can open your server in the dashboard, and with what role.

web:
  148359099782791168: admin   # full control, can grant access
  206212600596398080: editor  # can change configuration
  189990173222164545: mod     # infractions, notes, blacklist pages
  524930629414463498: viewer  # read-only

Keys are Discord user IDs. Roles, lowest to highest: viewer, mod, editor, admin.

levels

Command permission levels for the chat commands, keyed by role ID or user ID:

levels:
  411175551308398592: 100  # Admin role
  411175640047812611: 50   # Mods
  205088232529251329: 100  # or a specific user

Built-in tiers: 0 everyone, 10 trusted, 50 moderator, 100 admin. A member's level is the highest their ROLES grant. Listing a user id in levels overrides that outright, in either direction, so it is also how you demote one person who holds a high-level role. Command docs on each plugin page assume these defaults.

commands

commands:
  prefix: '!'
  overrides:
    - name: purge
      out: { level: 100 }         # raise purge to admin-only
    - plugin.name: tags
      out: { disabled: true }     # turn a whole plugin's commands off
    - name: rank
      out: { cooldown: 30 }       # one use per member per 30s
  lockdown:
    - group: infractions
      out:
        channels: [674638168474915242]   # only usable here
  • prefix - the chat prefix for this server.
  • overrides - per-command/group/plugin rules: change the required level, disable commands entirely, or put a per-member cooldown (in seconds) on one. Match a rule with name:, group:, or plugin.name: at the top level of the rule, and put the effect under out:. Moderators and above are exempt from cooldowns.
  • lockdown - restrict where commands may run, by channel, category, or role allow/exclude lists.

The dashboard's Setup → Access & Permissions page has a structured editor for these plus a "Would it run?" resolver: pick a command, a channel and a member, and it tells you whether the bot would execute it and which rule decided.

nickname

nickname: HepBoat

Sets the bot's nickname in your server. Setting it through Discord's client works just as well.

plugins

Everything else lives under plugins: - one block per plugin, and a plugin only runs if its block exists. An empty block enables a plugin with defaults:

plugins:
  utilities: {}
  infractions:
    mute_role: 674638268135047186

See the plugins overview for the full list.