bluebubbles-bot/README.md

41 lines
991 B
Markdown
Raw Normal View History

2023-04-08 04:48:34 +00:00
# bluebubbles_bot
2023-04-10 21:01:07 +00:00
2023-04-08 04:48:34 +00:00
## A chatbot for a local BlueBlubbles server.
2023-04-08 04:30:59 +00:00
2023-04-10 21:01:07 +00:00
![Build Status](https://jenkins.cronocide.net/job/git.cronocide.net/job/bluebubbles-bot/job/master/badge/icon?subject=Jenkins%20Build)
2023-04-08 04:48:34 +00:00
## Usage
2023-04-08 04:30:59 +00:00
2023-04-08 04:48:34 +00:00
```
2023-04-10 21:14:28 +00:00
usage: bluebubbles_bot [-h] [-l LOG] [-v]
optional arguments:
-h, --help show this help message and exit
-l LOG, --log LOG Specify a file to log to.
-v, --verbose Include verbose information in the output. Add 'v's for more output.
2023-04-08 04:30:59 +00:00
2023-04-10 21:14:28 +00:00
Example:
bluebubbles_bot -h
2023-04-08 04:48:34 +00:00
```
2023-04-10 21:14:28 +00:00
bluebubbles_bot loads instances of the `PersonaSkill` class from python files in the [skills](/skills) folder.
You may configure the skill by specifying `startup` and `shutdown` functions to configure your skills as required.
It will be helpful to follow the examples in the [skills](/skills) folder for designing your skills for the bot.
2023-04-08 04:48:34 +00:00
## Installation
1.
2.
3.
## Configuration
2023-04-10 21:14:28 +00:00
The following environment variables must be set to configure the bot:
2023-04-08 04:48:34 +00:00
```
```
## Justification
2023-04-08 04:30:59 +00:00