mirror of https://github.com/maubot/maubot.git
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# maubot
|
|
|
|
[](LICENSE)
|
|
[](https://github.com/maubot/maubot/releases)
|
|
[](https://mau.dev/maubot/maubot/container_registry)
|
|
[](https://github.com/psf/black)
|
|
[](https://pycqa.github.io/isort/)
|
|
|
|
A plugin-based [Matrix](https://matrix.org) bot system written in Python.
|
|
|
|
## Documentation
|
|
|
|
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)
|
|
|
|
## Discussion
|
|
Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net)
|
|
|
|
## Plugins
|
|
A list of plugins can be found at [plugins.mau.bot](https://plugins.mau.bot/).
|
|
|
|
To add your plugin to the list, send a pull request to <https://github.com/maubot/plugins.maubot.xyz>.
|
|
|
|
The plugin wishlist lives at <https://github.com/maubot/plugin-wishlist/issues>.
|