🧩 ADB Plugin Registry

• What is this?
• Why ADB?
• Submitting your Plugin
  • Plugin Entry Reference
  • Add your entry
  • Open a PR
• Plugin Requirements
• Review Process
• License

This repo holds a single file — plugins.json — the authoritative list of community plugins available to Advanced Discord Bot. Every ADB instance reads this file to populate its in-dashboard marketplace. If your plugin is in here, users can find and install it.

Submission flow:

1. You build a plugin and publish it to npm (start from adb-plugin-template).
2. You open a PR adding one entry to plugins.json.
3. A maintainer reviews and merges.
4. It appears in every marketplace automatically — no bot redeploy needed.

This is the recommended way to distribute a community plugin. You can always npm install adb-plugin-yourname into a bot directly, but listing here is how users discover it.

ADB is a self-hosted Discord bot platform — a framework, not a fixed-feature bot.

If you build bots: stop rewriting the same command loader, config store, database wiring, and dashboard for every project. ADB Core handles hosting, per-guild config, storage, slash-command deployment, hot-reload, and the dashboard UI. You write a load(ctx) function and ship a feature — the rest is already there. A working plugin is a few files (index.js, plugin.json); the template ships a local test harness so you can iterate with no bot and no database running.

If you run a server: ADB becomes exactly the bot you need. Browse the marketplace, install only the plugins you want, and configure each one from the dashboard. It's built to be safe with third-party code:

• Sandboxed by default — every isolated plugin runs in a worker thread. It cannot touch your bot token, the filesystem, the raw Discord client, or the database directly.
• Capability-gated — a plugin can only do what its manifest declares. Read the permissions / capabilities field before you install and you know exactly what it's allowed to do.
• Transparent — every listed package is public on npm and open source. You can read the code of any plugin before installing it.
• Granular control — enable, disable, or reconfigure any plugin per server, anytime, from the dashboard.

Install plugins from people you've never met and still know precisely what they can and can't do.

Each entry in plugins.json supports these fields. This mirrors the marketplace-facing subset of your plugin's plugin.json manifest.

These keys match what you see in plugins.json today — copy an existing entry as your starting point.

Fork the repo and add your plugin to the plugins array in plugins.json:

{
  "plugins": [
    {
      "name": "adb-plugin-reminders",
      "displayName": "Reminders",
      "description": "Adds /remind to set, list, and cancel personal reminders. Delivers via DM with a channel fallback.",
      "author": "DeadIndian",
      "version": "1.3.0",
      "category": "utility",
      "npmPackage": "adb-plugin-reminders",
      "main": "index.js",
      "requiresRestart": false,
      "verified": true,
      "permissions": ["db.read", "db.write", "commands.register"],
      "configSchema": {
        "type": "object",
        "properties": {
          "maxPerUser": { "type": "number", "default": 25, "minimum": 1, "maximum": 200 }
        }
      }
    }

    // 👉 add your plugin object here
  ]
}

verified is set by maintainers during review — leave it out or false in your PR.

Commit, push your fork, and open a pull request against main. That's it — wait for review.

• Published to npm with a package name starting adb-plugin-.
• Ships a valid plugin.json manifest (see the template).
• Follows the ADB plugin contract — exports async load(ctx) and stays isolation-safe.
• Declares every capability it uses; must not attempt to escape the sandbox.
• Must not break the bot.

Before merging, maintainers check:

• The plugins.json entry is valid JSON with all required fields.
• The npm package installs and loads cleanly in a real bot.
• The declared permissions / capabilities match what the code actually does.
• No security issues — no sandbox-escape attempts, no undisclosed network/filesystem access, no obfuscated code.

This registry is licensed under the GNU Affero General Public License v3.0 — see LICENSE. It follows the policies of the main ADB project:

• Contributing: CONTRIBUTING.md
• Code of Conduct: CODE_OF_CONDUCT.md
• Security Policy: SECURITY.md