safesupport-bot/README.md

72 lines
2.1 KiB
Markdown
Raw Normal View History

2020-03-02 22:43:30 +00:00
# OCRCC Bot
2020-03-23 03:38:07 +00:00
A simple Matrix bot that handles inviting, uninviting, and notifying Riot users on the recieving end of the [OCRCC chatbox](https://github.com/nomadic-labs/ocrcc-chatbox).
2020-03-02 22:43:30 +00:00
A demo of this bot is hosted on Glitch: https://glitch.com/edit/#!/nomadic-labs-ocrcc-bot
You can remix it and continue developing directly on Glitch. All you need to do is add an `.env` file with the following variables:
```
2020-03-23 03:38:07 +00:00
MATRIX_SERVER_URL=
BOT_DISPLAY_NAME=
BOT_USERNAME=
BOT_PASSWORD=
BOT_USERID=
FACILITATOR_ROOM_ID=
FACILITATOR_GROUP_ID=
CHAT_OFFLINE_MESSAGE=
CAPTURE_TRANSCRIPTS=
2020-03-02 22:43:30 +00:00
```
2020-03-23 03:38:07 +00:00
## What does the bot do?
* The bot receives an invitation to every chatroom created by the embedded chatbox, and automatically accepts
* Upon joining a new room, the bot invites all of the members of the Facilitators community
* When the first facilitator accepts the invitation, the bot uninvites the rest of the facilitators
* The bot notifies the Support Chat Notifications chatroom when there is a support request and when a facilitator joins
* If there are no facilitators online, the bot notifies the support seeker
* The bot makes the facilitator a moderator of the chatroom so they can change the room settings (i.e. room name)
* The bot listens to all the incoming messages and prints them to a transcript if that setting is enabled (`CAPTURE_TRANSCRIPT`)
* Messages that start with `!bot` are treated as commands.
* The bot sends a notification to the support chatroom and the Support Chat Notifications room if it crashes
### Bot commands
|Command|Response|
2020-03-23 03:39:32 +00:00
--- | ---
2020-03-23 03:40:35 +00:00
|`!bot hi`|Bot responds with a greeting|
|`!bot transcript`|Bot sends the chat transcript as a .txt file|
|`!bot transcript` please|Bot happily sends the transcript :)|
2020-03-02 22:43:30 +00:00
## Local development
If you prefer to develop locally instead of on Glitch:
Clone the project
```
git clone https://github.com/nomadic-labs/ocrcc-bot.git
```
Install dependencies
```
cd ocrcc-bot
yarn
```
Copy the sample `.env` file and add in your own variables
```
cp .env.sample .env
```
Start the local server
```
2020-03-16 22:21:04 +00:00
yarn develop
```
Run the tests
```
yarn test
```
Production build
```
yarn build
2020-03-02 22:43:30 +00:00
```