doorbell-matrix-bot/README.md

# doorbell-matrix-bot
<p>Doorbell bot for matrix</p>
<p>The bot will only respond & join in authorized rooms (add authorized room IDs in `config.json` => `rooms`).
NOTE: The bot needs to have the room authorized before being invited. If the bot is invited, then has the room authorized in the config, it <b>will not</b> join!</p>
<p>The commands to trigger the doorbell is: "doorbell", "open", "ring", "knock", "ding", "dong" & "dingdong"</p>

# How to run:
## Step 1: Getting an access token
### Step 1.1: Inserting required info to generate token
- Fill in: `homeserver` (`config.json`)
- Fill in: `username` (`logAuthToken.json`)
- Fill in: `password` (`logAuthToken.json`)

### Step 1.2: Getting the token
- Run: `logAuthToken.mjs` (Command: `node logAuthToken.mjs`)
- If all is done correctly, an access token should be logged in the console

## Step 2: Running the bot
### Step 2.1: Inserting more required information
- Fill in: `homeserver` (`config.json`) (This should already be filled if step `1.1` was done)
- Fill in: `token` (`config.json`) (This is the token you got in step `1.2`)
- Fill in: `prefix` (`config.json`)
- Fill in: `rooms` (`config.json`)
- Fill in: `doorbellWebhook` (`config.json`)
### Step 2.2: Actually running the bot
- Run: `index.mjs` (Command: `node index.mjs`)
- If all is done correctly, the bot should be running