A secure system for installing and managing private GitHub plugins in your Modmail bot with enhanced features and better reliability.

You can achieve the same by placing your GITHUB_TOKEN inside the .env of your bot. Remember that you shouldn't install any plugins in your bot, since they have full control and can hack your guild and NUKE it. If you install any plugin, it must be from a dev you trust!

• Private Repo Support: Install plugins from private repositories without using .env
• Interactive UI: Paginated embeds with reaction controls
• Auto-Detection: Smart cog name detection for better compatibility
• Progress Tracking: Real-time loading status updates
• Help Integration: Automatic command help display after successful install

?plugin add WebKide/modmail-plugins/private-plugins@main

Replace ? with your bot's prefix if you changed it

1. Go to GitHub Token Settings
2. Select scopes Scopes define the access for personal tokens.

• ✅ repo (Full control of private repositories)

  • repo:status (Access commit status)

  • repo_deployment (Access deployment status)

  • public_repo (Access public repositories)

  • repo:invite (Access repository invitations)

  • security_events (Read and write security events)

• No other scopes needed

3. Expiration (recommended: 90 days)

4. Scroll down and Click:

   
5. ⚠️ Make sure to copy your personal access token now. You won’t be able to see it again!

• 🔐 Token grants read access to ALL private repos
• 🚫 Never commit tokens to code
• 🔄 Rotate tokens periodically

1. User: ?private load user/repo/plugin-name@main
2. Bot: » Downloading plugin-name@main...
3. Bot: ✅ Downloaded! Now loading...
4. Bot: ✅ Successfully loaded plugin-name!
5. Bot: Shows available commands automatically

After loading any plugin:

• Automatically displays available commands
• Shows correct help command (?help YourPrivateCogName)
• Handles nested plugin structures

• Detailed error messages with trace information
• Directory structure validation
• Requirements.txt installation feedback

+ PRIVATE PLUGINS (PAGE 1/2) +
1️⃣ /private-plugin-name@master
  user/repo | User analytics system
2️⃣ /private-plugin-name@master
  user/repo | Automated DB backups
...
⬅️ ➡️ (Navigate)
React with number to update private-plugin

Q: How are cog names detected?
A: The system automatically scans for class YourPrivateCogName(commands.Cog) in plugin files.

Q: What if my plugin has a different structure?
A: Use ?private guide to see the recommended structure and addapt accordingly.

Q: Can I see plugin loading progress?
A: Yes! The bot now shows real-time download and load status, with clear error messages.

Q: How do I troubleshoot installation issues?
A: Use ?private debug user repo branch to diagnose problems.

Issue: "Could not find plugin directory"

1. Check repository structure matches ?private guide
2. Verify branch exists, usually @main
3. Use ?private debug to test access

Issue: "Missing setup function"

1. Ensure __init__.py contains setup(bot)
2. Validate with ?private validate plugin-name

Issue: "Commands not showing in help"

1. Check cog class inherits from commands.Cog
2. Verify command decorators are properly used
3. Use ?private guide to compare your implementation

Run ?private guide to see:

1. Required repository structure
2. Example cog implementation
3. Installation command format
4. Best practices for plugin development