0.1.12 • Published 3 years ago
@team-choco/choco-bot v0.1.12
NOTE: THIS BOT IS CURRENTLY UNDER HEAVY DEVELOPMENT, USE AT YOUR OWN RISK
@team-choco/choco-bot
Kweh! Choco Bot is here for all your Final Fantasy XIV needs!
Usage
$ npm install -g @team-choco/choco-bot
$ choco-bot --token <your-discord-token>
Options
All options have the following order of priority.
<-- More Specific ------- Less Specific -->
Arguments > Environment Variables > Default
So if you specify an Argument and a Environment Variable, the argument wins.
Database URL
Description | Specify the Database Connection URL |
---|---|
Argument | --database-url |
Environment Variable | CHOCO_BOT_DATABASE_URL |
Default Value | sqlite://:memory |
Optional | Yes |
Discord Token
Description | The Discord Token |
---|---|
Argument | --discord-token |
Environment Variable | CHOCO_BOT_DISCORD_TOKEN |
Default Value | <null> |
Optional | Only if the platform isn't discord . |
XIV API Token
Description | The Token for XIV API |
---|---|
Argument | --xivapi-token |
Environment Variable | CHOCO_BOT_XIVAPI_TOKEN |
Default Value | <null> |
Optional | Yes (Throttles the number of requests) |
Platform
Description | The platform to run on. (shell or discord ) |
---|---|
Argument | --platform |
Environment Variable | CHOCO_BOT_PLATFORM |
Default Value | shell |
Optional | Yes |
Log Level
Description | The level of log output to provide. (trace , info , warn , error ) |
---|---|
Argument | --log-level |
Environment Variable | CHOCO_BOT_LOG_LEVEL |
Default Value | info |
Optional | Yes |