2022-11-13 00:19:16 +01:00
|
|
|
# IT-Syndikat matrix bot
|
|
|
|
|
|
|
|
|
|
Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at).
|
|
|
|
|
|
2022-11-13 11:05:59 +01:00
|
|
|
This bot was recently rewritten in Rust, the original python implementation can be found in the
|
|
|
|
|
[python-legacy branch][pycode].
|
|
|
|
|
|
|
|
|
|
[pycode]: https://git.it-syndikat.org/IT-Syndikat/its-matrix-bot/src/branch/python-legacy
|
|
|
|
|
|
2022-11-13 00:40:28 +01:00
|
|
|
## Setup
|
|
|
|
|
|
2022-11-13 09:20:36 +01:00
|
|
|
For all these steps, either install the binary using `cargo install` and then run it as
|
|
|
|
|
`its-matrix-bot`, or run the project directly from the repository using `cargo run --` (e.g. `cargo
|
|
|
|
|
run -- setup`).
|
|
|
|
|
|
2022-11-13 09:20:18 +01:00
|
|
|
1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location
|
|
|
|
|
later specified using `-c, --config`)
|
|
|
|
|
2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot
|
|
|
|
|
user's password.
|
2022-11-13 00:40:28 +01:00
|
|
|
3. Start the bot using `its-matrix-bot run`.
|
|
|
|
|
|
2022-11-13 00:19:16 +01:00
|
|
|
## Available commands
|
|
|
|
|
|
|
|
|
|
- `!isitopen`: check if the hackerspace is currently open
|
2022-11-13 09:20:18 +01:00
|
|
|
- `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix
|
|
|
|
|
messages
|
|
|
|
|
|
|
|
|
|
<!-- vim: set tw=100: -->
|
