https://github.com/cybergruppe/cyberbot
Matrix chatbot framework with one battery included 💬
https://github.com/cybergruppe/cyberbot
bot chatbot matrix notification-service python
Last synced: 2 months ago
JSON representation
Matrix chatbot framework with one battery included 💬
- Host: GitHub
- URL: https://github.com/cybergruppe/cyberbot
- Owner: SFTtech
- License: other
- Created: 2020-08-29T16:08:28.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T23:42:56.000Z (6 months ago)
- Last Synced: 2025-07-16T21:55:22.563Z (3 months ago)
- Topics: bot, chatbot, matrix, notification-service, python
- Language: Python
- Homepage:
- Size: 497 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - cybergruppe/cyberbot - A modular bot for the matrix protocol, supporting encryption. (bot)
README
# Cyberbot
Matrix chatbot in Python, with encryption support and easy to use API.
## Installation
Dependency installation in a `.venv` in the source directory:
```sh
pdm install
```
## Running
Running from the source directory:
```sh
pdm run cyberbot -c config
```
## Usage
Activate the bot in a room by inviting it.
Cyberbot will then invite you to a configuration room, in which you can configure the rooms where the bot is active in.
### Commands
As the functionality of the bot depends heavily on the active plugins.
Use `help` in a configuration room to see what is available in your current configuration.
## Development
Cyberbot is built by using `matrix-nio`.
Room interaction is implemented in `modules/`: see [./PLUGINS.md](PLUGINS.md) for information on how to create plugins.