@robojs/maintenance

Put your bot into maintenance mode without shutting it down. When enabled, all commands, context menus, and events are intercepted and users receive a configurable message. The plugin persists state across restarts, so maintenance mode survives reboots.

Features

Installation

To install, run:

npx robo add @robojs/maintenance@next

Or create a new project with the plugin pre-installed:

npx create-robo@next my-project -p @robojs/maintenance@next

Once installed, the plugin's command, middleware, and lifecycle hook are registered automatically by Robo.js. No additional setup is required for basic usage.

The /maintenance command

The plugin registers a single slash command:

Toggle maintenance mode in Discord:

• /maintenance enabled:True -- enables maintenance mode, replies with "Maintenance mode enabled."
• /maintenance enabled:False -- disables maintenance mode, replies with "Maintenance mode disabled."

The command persists the new state to Flashcore, so the setting survives bot restarts.

How it works

The plugin installs a middleware that runs before every handler in your Robo. When maintenance mode is active, the middleware checks each incoming handler and decides whether to block it.

What gets blocked

When maintenance mode is enabled:

• Commands -- Blocked. The user receives the maintenance message as a reply.
• Context menus -- Blocked. The user receives the maintenance message as a reply.
• Events -- Blocked silently (no message sent since events have no interaction to reply to).

What always passes through

These are never blocked, regardless of maintenance state:

• Robo auto-generated handlers -- Internal framework handlers always execute.
• This plugin's own handlers -- The /maintenance command and _start lifecycle hook always work.
• Excluded items -- Commands, context menus, and events listed in the exclude configuration arrays bypass maintenance mode.

Default exclusions

The _start lifecycle event is excluded by default. This ensures the plugin can initialize on startup even if maintenance mode was persisted from a previous session.

Persistence

Maintenance state is stored in Flashcore under the key __plugin_maintenance_enabled. This means:

• Enabling maintenance via the /maintenance command persists across restarts.
• Disabling it also persists, so the bot won't unexpectedly return to maintenance mode.
• The persisted Flashcore value takes precedence over the maintenanceEnabled config option. If you enabled maintenance via the command, setting maintenanceEnabled: false in your config won't override it -- you need to use the command (or clear the Flashcore key) to disable it.

Quick configuration

Customize the maintenance message and exclude specific commands:

export default {
	maintenanceMessage: 'We are performing scheduled maintenance. Please check back soon.',
	excludeCommands: ['ping', 'status']
}

export default {
	maintenanceMessage: 'We are performing scheduled maintenance. Please check back soon.',
	excludeCommands: ['ping', 'status']
}

With this config, /ping and /status continue to work during maintenance. All other commands return the custom message.

Next Steps