maubot/README.md

maubot

A plugin-based Matrix bot system written in Python.

Documentation

All setup and usage instructions are located on docs.mau.fi. Some quick links:

• Setup (or with Docker)
• Basic usage
• Encryption

Discussion

Matrix room: #maubot:maunium.net

Plugins

Open a pull request or join the Matrix room linked above to get your plugin listed here.

The plugin wishlist lives at https://github.com/maubot/plugin-wishlist/issues.

Official plugins

• sed - A bot to do sed-like replacements.
• factorial - A bot to calculate unexpected factorials.
• media - A bot that replies with the MXC URI of images you send it.
• dice - A combined dice rolling and calculator bot.
• karma - A user karma tracker bot.
• xkcd - A bot to view xkcd comics.
• echo - A bot that echoes pings and other stuff.
• rss - A bot that posts RSS feed updates to Matrix.
• reminder - A bot to remind you about things.
• translate - A bot to translate words.
• reactbot - A bot that responds to messages that match predefined rules.
• exec - A bot that executes code.
• commitstrip - A bot to view CommitStrips.
• supportportal - A bot to manage customer support on Matrix.
• †gitlab - A GitLab client and webhook receiver.
• github - A GitHub client and webhook receiver.
• tex - A bot that renders LaTeX.
• altalias - A bot that lets users publish alternate aliases in rooms.
• satwcomic - A bot to view SatWComics.
• songwhip - A bot to post Songwhip links.
• manhole - A plugin that lets you access a Python shell inside maubot.

Deprecated/unmaintained plugins

• jesaribot - A simple bot that replies with an image when you say "jesari".
  • Superseded by reactbot
• gitea - A Gitea client and webhook receiver.

3rd party plugins

While not a comprehensive list, https://maubotplugins.mssj.me aims to be a crowd-sourced list of plugins from around the web.