matrix-bot/README.md

39 lines
928 B
Markdown

# Matrix Bot
Uses [matrix-nio](https://github.com/poljar/matrix-nio/)
Requires libolm to be installed. in Debian this is done with `apt install libolm-dev`
## Requiements
- Python 3.8
- libolm
## Intallation
Clone this repo
git clone https://git.gaja-group.com/gaja-group/matrix-bot MATRIX_BOT_DIR
Create a virtualenv
cd MATRIX_BOT_DIR
virtualenv -p python3 venv
source MATIRX_BOT_DIR/venv/bin/activate
pip install .
## 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`
source MATIRX_BOT_DIR/venv/bin/activate
cd
matrix-bot verify
After that you can begin sending messages
source MATIRX_BOT_DIR/venv/bin/activate
cd
matrix-bot message "Message Content" # To send to the default room
matrix-bot message -r '!yourRoomId' "Message Content" # To send to a specific room