2018-06-13 22:41:05 +00:00
# maubot
2022-03-25 12:22:37 +00:00
[](LICENSE)
[](https://github.com/maubot/maubot/releases)
[](https://mau.dev/maubot/maubot/container_registry)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
2018-09-23 14:56:21 +00:00
A plugin-based [Matrix ](https://matrix.org ) bot system written in Python.
2018-06-13 22:41:05 +00:00
2021-04-03 12:37:22 +00:00
## Documentation
2018-12-05 15:16:40 +00:00
2021-04-03 12:37:22 +00:00
All setup and usage instructions are located on
[docs.mau.fi ](https://docs.mau.fi/maubot/index.html ). Some quick links:
* [Setup ](https://docs.mau.fi/maubot/usage/setup/index.html )
(or [with Docker ](https://docs.mau.fi/maubot/usage/setup/docker.html ))
* [Basic usage ](https://docs.mau.fi/maubot/usage/basic.html )
* [Encryption ](https://docs.mau.fi/maubot/usage/encryption.html )
2018-11-01 23:21:22 +00:00
2018-06-13 22:41:05 +00:00
## Discussion
Matrix room: [#maubot:maunium.net ](https://matrix.to/#/#maubot:maunium.net )
2018-06-15 15:47:58 +00:00
## Plugins
2021-09-02 13:18:10 +00:00
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
2018-06-15 15:47:58 +00:00
* [sed ](https://github.com/maubot/sed ) - A bot to do sed-like replacements.
2018-09-23 14:56:21 +00:00
* [factorial ](https://github.com/maubot/factorial ) - A bot to calculate unexpected factorials.
2018-10-30 20:20:10 +00:00
* [media ](https://github.com/maubot/media ) - A bot that replies with the MXC URI of images you send it.
* [dice ](https://github.com/maubot/dice ) - A combined dice rolling and calculator bot.
* [karma ](https://github.com/maubot/karma ) - A user karma tracker bot.
2018-11-01 10:34:08 +00:00
* [xkcd ](https://github.com/maubot/xkcd ) - A bot to view xkcd comics.
2018-11-01 23:21:22 +00:00
* [echo ](https://github.com/maubot/echo ) - A bot that echoes pings and other stuff.
2018-11-27 00:35:44 +00:00
* [rss ](https://github.com/maubot/rss ) - A bot that posts RSS feed updates to Matrix.
2019-06-08 09:34:54 +00:00
* [reminder ](https://github.com/maubot/reminder ) - A bot to remind you about things.
2019-06-20 14:18:41 +00:00
* [translate ](https://github.com/maubot/translate ) - A bot to translate words.
2019-06-22 23:14:24 +00:00
* [reactbot ](https://github.com/maubot/reactbot ) - A bot that responds to messages that match predefined rules.
2019-09-01 11:46:13 +00:00
* [exec ](https://github.com/maubot/exec ) - A bot that executes code.
2019-09-28 16:03:50 +00:00
* [commitstrip ](https://github.com/maubot/commitstrip ) - A bot to view CommitStrips.
* [supportportal ](https://github.com/maubot/supportportal ) - A bot to manage customer support on Matrix.
2021-11-20 14:53:59 +00:00
* †[gitlab](https://github.com/maubot/gitlab) - A GitLab client and webhook receiver.
2020-01-01 21:05:14 +00:00
* [github ](https://github.com/maubot/github ) - A GitHub client and webhook receiver.
2020-10-04 11:06:41 +00:00
* [tex ](https://github.com/maubot/tex ) - A bot that renders LaTeX.
* [altalias ](https://github.com/maubot/altalias ) - A bot that lets users publish alternate aliases in rooms.
* [satwcomic ](https://github.com/maubot/satwcomic ) - A bot to view SatWComics.
* [songwhip ](https://github.com/maubot/songwhip ) - A bot to post Songwhip links.
2021-11-19 18:24:39 +00:00
* [manhole ](https://github.com/maubot/manhole ) - A plugin that lets you access a Python shell inside maubot.
2021-09-02 13:18:10 +00:00
### 3rd party plugins
* [subreddit linkifier ](https://github.com/TomCasavant/RedditMaubot ) - A bot that condescendingly corrects a user when they enter an r/subreddit without providing a link to that subreddit
* [giphy ](https://github.com/TomCasavant/GiphyMaubot ) - A bot that generates a gif (from giphy) given search terms
* [trump ](https://github.com/jeffcasavant/MaubotTrumpTweet ) - A bot that generates a Trump tweet with the given content
* [poll ](https://github.com/TomCasavant/PollMaubot ) - A bot that will create a simple poll for users in a room
* [urban ](https://github.com/dvdgsng/UrbanMaubot ) - A bot that fetches definitions from [Urban Dictionary ](https://www.urbandictionary.com/ ).
* [twilio ](https://github.com/jeffcasavant/MaubotTwilio ) - Maubot-based SMS bridge
2021-11-19 17:59:23 +00:00
* [tmdb ](https://codeberg.org/lomion/tmdb-bot ) - A bot that posts information about movies fetched from TheMovieDB.org.
2020-12-15 23:04:51 +00:00
* [invite ](https://github.com/williamkray/maubot-invite ) - A bot to generate invitation tokens from [matrix-registration ](https://github.com/ZerataX/matrix-registration )
2020-12-29 10:28:59 +00:00
* [wolframalpha ](https://github.com/ggogel/WolframAlphaMaubot ) - A bot that allows requesting information from [WolframAlpha ](https://www.wolframalpha.com/ ).
2021-09-02 13:18:10 +00:00
* †[pingcheck](https://edugit.org/nik/maubot-pingcheck) - A bot to ping the echo bot and send rtt to Icinga passive check
2021-01-12 01:24:47 +00:00
* [ticker ](https://github.com/williamkray/maubot-ticker ) - A bot to return financial data about a stock or cryptocurrency.
2021-04-07 17:33:36 +00:00
* [weather ](https://github.com/kellya/maubot-weather ) - A bot to get the weather from wttr.in and return a single line of text for the location specified
2021-09-02 13:18:10 +00:00
* †[youtube previewer](https://github.com/ggogel/YoutubePreviewMaubot) - A bot that responds to a YouTube link with the video title and thumbnail.
2021-11-19 17:59:23 +00:00
* †[reddit previewer](https://github.com/ggogel/RedditPreviewMaubot) - A bot that responds to a link of a reddit post with the sub name and title. If available, uploads the image or video.
2021-08-08 14:04:47 +00:00
* [pocket ](https://github.com/jaywink/maubot-pocket ) - A bot integrating with Pocket to fetch articles and archive them.
2022-03-20 01:03:03 +00:00
* [alternatingcaps ](https://github.com/rom4nik/maubot-alternatingcaps ) - A bot repeating last message using aLtErNaTiNg cApS.
2022-03-25 17:53:19 +00:00
* [metric ](https://github.com/edwardsdean/maubot_metric_bot ) - A bot that will reply to a message that contains imperial units and replace them with metric units.
* [urlpreview ](https://github.com/coffeebank/coffee-maubot/tree/master/urlpreview ) - A bot that responds to links with a link preview embed, using Matrix API to fetch meta tags
2022-07-27 11:45:30 +00:00
* [hasswebhookbot ](https://github.com/v411e/hasswebhookbot ) - A bot receiving webhooks from [Home Assistant ](https://github.com/home-assistant )
* [ovgumensabot ](https://github.com/v411e/ovgumensabot ) - A bot that automatically sends meals from OvGU canteen every day
2018-10-30 20:20:10 +00:00
2021-09-02 13:18:58 +00:00
† Uses a synchronous library which can block the whole maubot process (e.g. requests instead of aiohttp)
2019-06-22 23:14:24 +00:00
2021-09-02 13:18:10 +00:00
### Deprecated/unmaintained plugins
* [jesaribot ](https://github.com/maubot/jesaribot ) - A simple bot that replies with an image when you say "jesari".
* Superseded by reactbot
* [gitea ](https://github.com/saces/maugitea ) - A Gitea client and webhook receiver.
