0.1.12 • Published 3 years ago

@team-choco/choco-bot v0.1.12

Weekly downloads
6
License
-
Repository
github
Last release
3 years ago

NOTE: THIS BOT IS CURRENTLY UNDER HEAVY DEVELOPMENT, USE AT YOUR OWN RISK

NPM Version NPM Downloads Coveralls CI

@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

DescriptionSpecify the Database Connection URL
Argument--database-url
Environment VariableCHOCO_BOT_DATABASE_URL
Default Valuesqlite://:memory
OptionalYes

Discord Token

DescriptionThe Discord Token
Argument--discord-token
Environment VariableCHOCO_BOT_DISCORD_TOKEN
Default Value<null>
OptionalOnly if the platform isn't discord.

XIV API Token

DescriptionThe Token for XIV API
Argument--xivapi-token
Environment VariableCHOCO_BOT_XIVAPI_TOKEN
Default Value<null>
OptionalYes (Throttles the number of requests)

Platform

DescriptionThe platform to run on. (shell or discord)
Argument--platform
Environment VariableCHOCO_BOT_PLATFORM
Default Valueshell
OptionalYes

Log Level

DescriptionThe level of log output to provide. (trace, info, warn, error)
Argument--log-level
Environment VariableCHOCO_BOT_LOG_LEVEL
Default Valueinfo
OptionalYes