Configuration

Dreamliner server configuration is written in YAML. Each server has its own config stored in the database after upload.

#File format

emojis:
  success: "<:blurplecheck:1533947878668763278>"
  error: "<:redcheck:1533947951481749504>"
  neutral: "<:greycheck:1533948078615298148>"
  warning: "<:warning:1533948583995244734>"
  unchecked: "<:greycheck:1533948078615298148>"

levels:
  "ROLE_OR_USER_SNOWFLAKE": 100   # Admin
  "ROLE_OR_USER_SNOWFLAKE": 50    # Mod

# Server events: joins, leaves, edits, deletes, voice activity, role/nickname changes
server_log_channel_id: "1111111111111111111"

# Moderation: infractions, automod, censor, /clean, voice mod, cases, expirations
moderation_log_channel_id: "1111111111111111111"

# Deprecated - use moderation_log_channel_id instead
# log_channel_id: "1234567890123456789"

# When true, command replies are only visible to the user who ran the command.
ephemeral_responses: false

plugins:
  utility:
    config:
      jumbo_size: 128
      autojoin_threads: true
      info_on_single_result: true
    overrides:
      - level: ">=50"
        config:
          can_search: true
          can_clean: true

#Emojis

The emojis block sets the icons used on command response embed titles:

emojis:
  success: "<:blurplecheck:1533947878668763278>"
  error: "<:redcheck:1533947951481749504>"
  neutral: "<:greycheck:1533948078615298148>"
  warning: "<:warning:1533948583995244734>"
  unchecked: "<:greycheck:1533948078615298148>"

• success - positive outcomes (saved, updated, reloaded, etc.)
• error - permission denied, invalid input, not found, etc.
• neutral - general information and commands
• warning - soft failures and advisories (not configured, already exists, etc.)
• unchecked - disabled or off states

Embed author always shows Dreamliner with the bot avatar. The title shows the emoji plus command title (e.g. success emoji + Configuration saved).

Custom Discord emojis use the <:name:id> form and must be available to the bot.

#Response visibility

ephemeral_responses: false

When false (default), command replies are public in the channel. Set to true to make all responses ephemeral (only visible to the user who ran the command).

#Permission levels

The template ships with an empty map: levels: {}.

Replace that with indented role/user ID entries (do not keep the {} braces when adding IDs):

levels:
  "ROLE_OR_USER_SNOWFLAKE": 100   # Admin
  "ROLE_OR_USER_SNOWFLAKE": 50    # Mod

A member's level is the highest level from their roles and their user ID. Overrides use level syntax like ">=50" to grant plugin permissions to mods without listing every user.

For a complete setup guide with examples, see Permissions setup.

#Log channels

server_log_channel_id: "1234567890123456789"
moderation_log_channel_id: "1234567890123456789"

The legacy log_channel_id still works as a fallback for moderation logs. See Logs plugin for the full event list and log format.

#Plugin sections

Each plugin is configured under plugins.<name>:

#Override criteria

For everyday grants (user / role / everyone) and level assignment, prefer /permissions instead of editing YAML. See Permissions.

#Merge behavior

On upload, your YAML is deep-merged with config/default.server.yaml. You only need to include keys you want to change.

See also: Autorole, Logs, Starboard.

#Config commands

#Workflow

1. Run /config template (new server) or /config download (existing server).
2. Edit the YAML file locally, or use the website config editor (loads the schema from this repo).
3. Run /config validate to check for errors (optional).
4. Run /config upload to apply.

Machine-readable schema for the editor is generated with npm run schema:export into schema/guild-config.schema.json (also run during prebuild).

#/config update

When Dreamliner ships new default settings, run /config update to pick up changes you did not customize. Your overrides are preserved using the raw YAML from your last upload.

If your config was saved before this feature existed, the bot uses diff detection against the stored defaults snapshot. Re-uploading via /config upload improves future updates.

#Reloading

Admins with can_reload_guild can run /reload to re-read the config from the database without re-uploading.

#Plugin index

Dreamliner is organized into plugins under the plugins: key. Each plugin has its own config, optional overrides, and enabled flag.

See Documentation index for setup guides per plugin. The default template (/config template) includes all configurable fields.