Developer Documentation

Guides for people writing modules or contributing to the bot core.

Module authors

Start here if you want to add a new feature as a module:

Writing a module - file layout, module.json, lifecycle, end-to-end example.
Events - event handler shape, lifecycle gates (botReadyAt, allowPartial, ignoreBotReadyCheck), Discord and custom events you can listen to.
Commands - config / run / subcommands / autocomplete, options, context-menu commands, registration.
Gateway intents - declaring intents / optionalIntents in module.json, degrading when a privileged intent is not granted, the operator allowlist.
Database models - Sequelize Model.init pattern, models-dir, accessing models from events.
Field-level encryption - the secure-storage serialization layer: which columns are protected and how to register a new sensitive field.
Localization - adding strings to locales/en.json and using localize().
Nickname manager - the shared service for changing member nicknames without modules fighting each other.

For module config files (config.json, streamers.json, etc.):

Configuration files - schema reference: field types, defaults, dependsOn, elementToggle, validation.
Country localization - how user-facing strings in config files are extracted and translated.

The string + embed format used in allowEmbed config fields. Canonical reference (v2 / v3 / v4):

Migration - writing database migrations so schema changes reach existing installs.

Run npm run verify-configs to validate every module's config schema. CI runs this on every PR via .github/workflows/verify-configs.yml.