Cronocide/bluebubbles-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fd92993892
bluebubbles-bot/README.md
Daniel Dayley fd92993892 Updated README
2023-04-10 23:51:34 -06:00

1.2 KiB
Raw Blame History

bluebubbles_bot

A chatbot for a local BlueBlubbles server.

Build Status

Usage

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.

Example:
	bluebubbles_bot -h

bluebubbles_bot loads instances of the PersonaSkill class from python files in the 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 folder for designing your skills for the bot.

Installation

Configuration

The following environment variables must be set to configure the bot:

BB_SERVER_URL : The URL of the BlueBubbles server, including protocol and port.

BB_SERVER_PASSWORD : The password to the BlueBubbles server.

USE_PRIVATE_API : Whether or not to use the Private API in BlueBubbles. Default is false

Justification