A plugin-based Matrix bot system.
Go to file
2021-12-13 15:03:56 +02:00
alembic Add support for end-to-end encryption. Fixes #46 2020-07-12 14:55:41 +03:00
docker Move plugin databases to new path in docker image 2021-11-21 23:33:21 +02:00
examples Update hello world example and add config example 2019-01-07 08:14:29 +02:00
maubot Include unhandled error body in force-JSON middleware 2021-12-12 21:15:01 +02:00
.dockerignore Remove .md files from .dockerignore 2020-07-12 18:06:31 +03:00
.editorconfig Update management spec 2018-10-31 22:27:59 +02:00
.gitignore Finish plugin API and add basic login system 2018-10-31 02:03:38 +02:00
.gitlab-ci.yml Don't fail CI if removing one of the standalone tags fails 2021-11-30 12:37:34 +02:00
alembic.ini Add Alembic setup 2019-09-28 17:21:03 +03:00
Dockerfile Remove separate docker example config 2021-11-19 17:22:17 +02:00
Dockerfile.ci Add missing line to CI dockerfile 2021-12-13 15:03:56 +02:00
LICENSE Initial commit 2018-06-14 01:41:05 +03:00
MANIFEST.in Add support for end-to-end encryption. Fixes #46 2020-07-12 14:55:41 +03:00
optional-requirements.txt Refactor __main__.py and fix things 2021-11-19 15:22:54 +02:00
README.md Update README.md 2021-11-20 16:53:59 +02:00
requirements.txt Update mautrix-python 2021-11-20 16:54:07 +02:00
setup.py Fix things in standalone mode 2021-11-19 15:23:10 +02:00

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:

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.

3rd party plugins

  • subreddit linkifier - A bot that condescendingly corrects a user when they enter an r/subreddit without providing a link to that subreddit
  • giphy - A bot that generates a gif (from giphy) given search terms
  • trump - A bot that generates a Trump tweet with the given content
  • poll - A bot that will create a simple poll for users in a room
  • urban - A bot that fetches definitions from Urban Dictionary.
  • twilio - Maubot-based SMS bridge
  • tmdb - A bot that posts information about movies fetched from TheMovieDB.org.
  • invite - A bot to generate invitation tokens from matrix-registration
  • wolframalpha - A bot that allows requesting information from WolframAlpha.
  • pingcheck - A bot to ping the echo bot and send rtt to Icinga passive check
  • ticker - A bot to return financial data about a stock or cryptocurrency.
  • weather - A bot to get the weather from wttr.in and return a single line of text for the location specified
  • youtube previewer - A bot that responds to a YouTube link with the video title and thumbnail.
  • reddit previewer - A bot that responds to a link of a reddit post with the sub name and title. If available, uploads the image or video.
  • pocket - A bot integrating with Pocket to fetch articles and archive them.

† Uses a synchronous library which can block the whole maubot process (e.g. requests instead of aiohttp)

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.