2018-06-13 18:41:05 -04:00
|
|
|
# maubot
|
2022-03-25 08:22:37 -04:00
|
|
|
![Languages](https://img.shields.io/github/languages/top/maubot/maubot.svg)
|
|
|
|
[![License](https://img.shields.io/github/license/maubot/maubot.svg)](LICENSE)
|
|
|
|
[![Release](https://img.shields.io/github/release/maubot/maubot/all.svg)](https://github.com/maubot/maubot/releases)
|
|
|
|
[![GitLab CI](https://mau.dev/maubot/maubot/badges/master/pipeline.svg)](https://mau.dev/maubot/maubot/container_registry)
|
|
|
|
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
|
|
|
|
[![Imports](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
|
|
|
|
|
2018-09-23 10:56:21 -04:00
|
|
|
A plugin-based [Matrix](https://matrix.org) bot system written in Python.
|
2018-06-13 18:41:05 -04:00
|
|
|
|
2021-04-03 08:37:22 -04:00
|
|
|
## Documentation
|
2018-12-05 10:16:40 -05:00
|
|
|
|
2021-04-03 08:37:22 -04: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 19:21:22 -04:00
|
|
|
|
2018-06-13 18:41:05 -04:00
|
|
|
## Discussion
|
|
|
|
Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net)
|
2018-06-15 11:47:58 -04:00
|
|
|
|
|
|
|
## Plugins
|
2024-03-10 11:10:41 -04:00
|
|
|
A list of plugins can be found at [plugins.mau.bot](https://plugins.mau.bot/).
|
2021-09-02 09:18:10 -04:00
|
|
|
|
2023-06-26 08:26:53 -04:00
|
|
|
To add your plugin to the list, send a pull request to <https://github.com/maubot/plugins.maubot.xyz>.
|
2018-10-30 16:20:10 -04:00
|
|
|
|
2023-06-26 08:26:53 -04:00
|
|
|
The plugin wishlist lives at <https://github.com/maubot/plugin-wishlist/issues>.
|