its-matrix-bot/README.md

15 lines
580 B
Markdown
Raw Normal View History

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 00:40:28 +01:00
## Setup
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.
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
- `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix messages