Modules

Zumito provides a set of official modules that extend your bot with ready-to-use features. Each module is an npm package under the @zumito-team scope and integrates directly with the Zumito framework via the bundles configuration.

Available modules

Admin Centralized web dashboard for bot management with Discord OAuth2 authentication.

BuiltByBit License License verification against the BuiltByBit API with periodic checks and custom callbacks.

Canvas Utility library for canvas rendering, image processing, and GIF generation.

Discord Auth Reusable Discord OAuth2 JWT authentication service shared by Admin and User Panel.

DisTube (Music) Music playback with YouTube, Spotify, SoundCloud support and a user-facing queue panel.

File Manager Abstract FileManager contract for building modular storage backends.

Local Filesystem Local filesystem storage implementing the FileManager contract for development environments.

Logger Logging service with Discord channel output and database persistence.

Reactions Interactive GIF reaction commands with customizable categories and multi-language templates.

S3 Assets S3-compatible blob storage (AWS, DigitalOcean, MinIO, Cloudflare R2) implementing FileManager.

Sentry Sentry error monitoring integration — captures all command, API, and module errors automatically.

Stickman Fight Animated stick figure battles using Discord user avatars and generated GIFs.

User Panel User-facing dashboard for server management, account settings, and extensible navigation.

Architecture

All modules extend Module from zumito-framework and register themselves in the ServiceContainer. They can provide:

• Services — Injectable classes consumed by other modules.
• Commands — Discord slash/prefix commands.
• Routes — HTTP endpoints (admin pages, API, etc.).
• Navigation items — Sidebar entries in Admin or User Panel.

Modules can declare dependencies on other modules using static dependencies and optionalDependencies properties. The framework automatically resolves these dependencies and loads modules in the correct order using topological sorting. See Module lifecycle for details.

Dependency graph

The following graph shows the dependency relationships between official modules. These are resolved automatically by the framework at boot time.

zumito-framework (core)
├── admin-module
│   └── reactions-module
├── builtbybit-license
├── canvas-module
│   ├── stickmanfight
│   └── distube-module
├── discord-auth
│   ├── admin-module
│   └── user-panel-module
├── file-manager
│   ├── s3-assets
│   └── local-filesystem
├── logger-module
├── sentry
├── user-panel-module
│   └── distube-module
└── stickmanfight

Installation

Install any module via npm and add it to your zumito.config.ts bundles:

zumito.config.ts

export default {
    bundles: [
        '@zumito-team/admin-module',
        '@zumito-team/logger-module',
        // ...
    ]
}