Go to file

Patrick Neff c60809b94a Update README		2020-08-04 12:08:16 +02:00
.vscode	Re-add .vscode directory	2020-08-03 18:37:56 +02:00
matrix_bot	Update README	2020-08-04 12:08:16 +02:00
.editorconfig	Initial commit	2020-08-03 18:32:53 +02:00
.gitignore	Add control script	2020-08-04 12:03:56 +02:00
Pipfile	Add control script	2020-08-04 12:03:56 +02:00
Pipfile.lock	Add control script	2020-08-04 12:03:56 +02:00
README.md	Update README	2020-08-04 12:08:16 +02:00
setup.cfg	Initial commit	2020-08-03 18:32:53 +02:00
setup.py	Add control script	2020-08-04 12:03:56 +02:00

README.md

Matrix Bot

Uses matrix-nio

Requires libolm to be installed. in Debian this is done with apt install libolm-dev

Requiements

Python 3.8
libolm

Intallation

Create a virtualenv

mkdir MATRIX_BOT_DIR
virtualenv -p python3 venv
source venv/bin/activate
pip install https://git.gaja-group.com/gaja-group/matrix-bot

Usage

Before you can send encrypted messages you must verify the bot with the matrix homeserver. To to login and do this use matrix-bot verify

cd MATRIX_BOT_DIR
source venv/bin/activate
matrix-bot verify

After that you can begin sending messages

cd MATRIX_BOT_DIR
source venv/bin/activate
matrix-bot message  "Message Content" # To send to the default room
matrix-bot message -r '!yourRoomId' "Message Content" # To send to a specific room

Or start the bot in daemon mode. In this mode the configured room will be monitored for incoming messages and you can send messages from external scripts with matrix-botctl

cd MATRIX_BOT_DIR
source venv/bin/activate
matrix-bot

# Then you can send messages with

matrix-botctl message "Message Content"