mirror of
https://github.com/Luzifer/twitch-bot.git
synced 2024-12-20 20:01:17 +00:00
38 lines
2.4 KiB
Markdown
38 lines
2.4 KiB
Markdown
[](https://goreportcard.com/report/github.com/Luzifer/twitch-bot)
|
|
|
|
|
|
|
|
|
|
|
|
# Luzifer / twitch-bot
|
|
|
|
Twitch-Bot is intended as an alternative to having a bot managed by Streamlabs or Streamelements and therefore having more control over it, the availability and how it works.
|
|
|
|
At the moment it is a work-in-progress and does not yet implment all features it shall in the future.
|
|
|
|
## Configuration
|
|
|
|
Please see the [Wiki](https://github.com/Luzifer/twitch-bot/wiki) for documentation of the configuration file.
|
|
|
|
```console
|
|
# twitch-bot --help
|
|
Usage of twitch-bot:
|
|
--base-url string External URL of the config-editor interface (set to enable EventSub support)
|
|
--command-timeout duration Timeout for command execution (default 30s)
|
|
-c, --config string Location of configuration file (default "./config.yaml")
|
|
--log-level string Log level (debug, info, warn, error, fatal) (default "info")
|
|
--plugin-dir string Where to find and load plugins (default "/usr/lib/twitch-bot")
|
|
--rate-limit duration How often to send a message (default: 20/30s=1500ms, if your bot is mod everywhere: 100/30s=300ms, different for known/verified bots) (default 1.5s)
|
|
--storage-encryption-pass string Passphrase to encrypt secrets inside storage (defaults to twitch-client:twitch-client-secret)
|
|
--storage-file string Where to store the data (default "./storage.json.gz")
|
|
--twitch-client string Client ID to act as
|
|
--twitch-client-secret string Secret for the Client ID
|
|
--twitch-token string OAuth token valid for client (fallback if no token was set in interface)
|
|
-v, --validate-config Loads the config, logs any errors and quits with status 0 on success
|
|
--version Prints current version and exits
|
|
# twitch-bot help
|
|
Supported sub-commands are:
|
|
actor-docs Generate markdown documentation for available actors
|
|
api-token <name> <scope...> Generate an api-token to be entered into the config
|
|
help Prints this help message
|
|
```
|