Skip to content

Installing and Managing Plugins

Plugins are like "apps" for MaiBot - they give your bot superpowers! 🚀

What Are Plugins?

Plugins add cool features to MaiBot, like:

  • 🎮 Game plugins - Play games with users
  • 🎨 Art plugins - Generate images
  • 🎵 Music plugins - Play music
  • 🌤️ Weather plugins - Check weather forecasts
  • 📚 Learning plugins - Teach knowledge

Installing Plugins

  1. Open WebUI and click "Plugin Management"
  2. Click "Install Plugin" button
  3. Enter plugin URL (GitHub link)
  4. Click "Install" and wait for completion

Example URL:

https://github.com/author/plugin-name

Method 2: Local Installation

  1. Download plugin code to your computer
  2. In plugin management page, click "Local Install"
  3. Select the plugin folder
  4. Confirm installation

Managing Installed Plugins

Viewing Plugins

The plugin page shows:

  • 📋 Plugin name and description
  • 🔧 Version and author
  • Status (green=enabled, gray=disabled)
  • 📖 Instructions (click to view)

Enabling/Disabling Plugins

  • Switch ON → Plugin active
  • Switch OFF → Plugin inactive
  • Changes take effect immediately, no restart needed

Configuring Plugins

Some plugins have custom settings:

  1. Click plugin's "Settings" button
  2. Modify configuration options
  3. Save changes (take effect immediately)

Common settings:

  • API keys (for plugins needing external services)
  • Trigger keywords
  • Feature toggles

Updating Plugins

When new versions are available:

  1. Click "Update" button
  2. Wait for download and installation
  3. Automatic completion, data won't be lost

Uninstalling Plugins

Remove unwanted plugins:

  1. Click "Uninstall" button
  2. Confirm uninstallation
  3. Plugin files will be deleted

⚠️ Note: Plugin data may be lost after uninstallation

Essential for Beginners

  • Welcome plugin - Auto-welcome new users
  • Help plugin - Provide command help
  • Check-in plugin - Daily check-in feature

For Fun

  • Gacha plugin - Simulate various card draws
  • Dice plugin - Dice rolling games
  • Riddle plugin - Guess riddles and brain teasers

Practical

  • Translation plugin - Multi-language translation
  • Calculator plugin - Math calculations
  • Time plugin - Time and date queries

Usage Tips

Plugin Conflicts

If plugins have overlapping or conflicting features:

  • Only enable needed plugins
  • Adjust plugin priority
  • Contact plugin authors for updates

Performance Optimization

Too many plugins may affect performance:

  • Uninstall unused plugins promptly
  • Regularly clean up useless plugins
  • Monitor plugin resource usage

Security Reminders

  • Only install plugins from trusted sources
  • Check plugin permission requirements
  • Regularly update plugin versions

Common Questions

Q: Plugin installation failed? A: Check network connection, confirm plugin URL is correct, check error messages

Q: Plugin not working? A: Confirm plugin is enabled, check configuration is correct, view MaiBot logs

Q: Where to find plugins? A: Search "MaiBot plugin" on GitHub, or join community for recommendations

Q: Can I develop my own plugins? A: Of course! There are development docs and example code, even beginners can learn

Getting Help

  • Plugin pages have usage instructions
  • Check plugin README documentation
  • Join MaiBot community groups to ask
  • Submit issues on GitHub