matrix-bot/README.md

# 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

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"