Files
matrix-quotes-bot/README.md

41 lines
981 B
Markdown

# Ancestor Quote Bot
A Matrix chatbot that responds to `/quote` commands with random quotes from Darkest Dungeons' Narrator/Ancestor.
## Setup
1. Copy `.env.example` to `.env` and fill in your credentials:
```bash
cp .env.example .env
```
2. Build the Docker image:
```bash
docker build -t ancestor-quote-bot .
```
3. Run the bot:
```bash
docker run --rm \
-e MATRIX_HOME_SERVER=https://your.matrix.server.com \
-e MATRIX_ACCESS_TOKEN=your_access_token_here \
ancestor-quote-bot
```
## Configuration
- `MATRIX_HOME_SERVER`: Your Matrix homeserver URL (e.g., https://matrix.org)
- `MATRIX_ACCESS_TOKEN`: Bot access token for authentication
- `BOT_COMMAND`: The command trigger (default: `!quote`)
## Usage
Type the bot command in any room you've joined, and it will reply with a random Ancestor quote.
Example:
```
Room: #general:matrix.org
!quote
Bot: Dispatch this thug in brutal fashion, that all may hear of your arrival!
```