dan/ops-jrz1
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
ops-jrz1/templates/plugin-skeleton/README.md
Dan 3d33a45cc9 Add learner dev environment, testing infrastructure, and skills 
Learner account management:
- learner-add.sh: create accounts with SSH, plugin skeleton
- learner-remove.sh: remove accounts with optional archive
- plugin-skeleton template: starter maubot plugin

Testing:
- flake.nix: add checks output for pre-deploy validation
- smoke-test.sh: post-deploy service verification

Documentation:
- learner-onboarding.md: VS Code Remote-SSH setup guide
- learner-admin.md: account management procedures

Skills:
- code-review.md: multi-lens code review skill
- orch, worklog: symlinks to shared skills
2025-12-28 22:23:06 -05:00

1,021 B
Raw Blame History

MODULE_NAME

A maubot plugin by USERNAME.

Quick Start

  1. Edit MODULE_NAME/bot.py to customize your bot
  2. Run make build to create the plugin package
  3. Upload to maubot via the admin UI (http://localhost:29316)

Commands

Command Description
!hello Says hello
!ping Responds with pong
!whoami Tells you your Matrix ID

Development

make check   # Verify Python syntax
make build   # Build .mbp file
make clean   # Remove built files

Files

  • maubot.yaml - Plugin manifest (ID, version, modules)
  • MODULE_NAME/bot.py - Your bot code
  • Makefile - Build automation

Adding Commands

Edit MODULE_NAME/bot.py and add a new method:

@command.new("mycommand")
async def my_command(self, evt: MessageEvent) -> None:
    """Description of what it does"""
    await evt.reply("Response!")

Resources