mirror of
https://github.com/Luzifer/twitch-bot.git
synced 2024-09-07 20:39:07 +00:00
Self-hosted alternative to one of the big bots managed by big companies…
|
||
---|---|---|
.github/workflows | ||
ci | ||
docs | ||
editor | ||
internal | ||
pkg | ||
plugins | ||
src | ||
.dockerignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.golangci.yml | ||
action_script.go | ||
actions.go | ||
actorDocs.go | ||
actorDocs.tpl | ||
auth.go | ||
authBackends.go | ||
authMiddleware.go | ||
automessage.go | ||
botEditor.go | ||
chatcommands.go | ||
cli_actorDocs.go | ||
cli_apiToken.go | ||
cli_migrateDatabase.go | ||
cli_resetSecrets.go | ||
cli_tplDocs.go | ||
cli_validateConfig.go | ||
cli.go | ||
config_test.go | ||
config.go | ||
configEditor_automessage.go | ||
configEditor_dev.go | ||
configEditor_general.go | ||
configEditor_global.go | ||
configEditor_prod.go | ||
configEditor_rules.go | ||
configEditor.go | ||
configRemoteUpdate.go | ||
configwatch.go | ||
cors.go | ||
default_config.yaml | ||
Dockerfile | ||
events.go | ||
fields.go | ||
functions_irc.go | ||
functions_test.go | ||
functions.go | ||
git.go | ||
go.mod | ||
go.sum | ||
helpers.go | ||
History.md | ||
hooker.go | ||
irc.go | ||
LICENSE | ||
main_test.go | ||
main.go | ||
Makefile | ||
msgformatter.go | ||
package-lock.json | ||
package.json | ||
plugins_core.go | ||
plugins_unsupported.go | ||
plugins.go | ||
README.md | ||
scopes.go | ||
status.go | ||
swagger.go | ||
swagger.html | ||
tplDocs_test.go | ||
tplDocs.go | ||
tplDocs.tpl | ||
twitchWatcher.go | ||
wrNoOpCloser.go |
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 refer to the Documentation how to setup and configure the bot.
# twitch-bot --help
Usage of twitch-bot:
--base-url string External URL of the config-editor interface (used to generate auth-urls)
--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)
--sentry-dsn string Sentry / GlitchTip DSN for error reporting
--storage-conn-string string Connection string for the database (default "./storage.db")
--storage-conn-type string One of: mysql, postgres, sqlite (default "sqlite")
--storage-encryption-pass string Passphrase to encrypt secrets inside storage (defaults to twitch-client:twitch-client-secret)
--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
--wait-for-selfcheck duration Maximum time to wait for the self-check to respond when behind load-balancers (default 1m0s)
# twitch-bot help
Supported sub-commands are:
actor-docs Generate markdown documentation for available actors
api-token <token-name> <scope> [...scope] Generate an api-token to be entered into the config
copy-database <target storage-type> <target DSN> Copies database contents to a new storage DSN i.e. for migrating to a new DBMS
reset-secrets Remove encrypted data to reset encryption passphrase
tpl-docs Generate markdown documentation for available template functions
validate-config Try to load configuration file and report errors if any
Database Connection Strings
Currently these databases are supported and need their corresponding connection strings:
MySQL
[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...¶mN=valueN]
Recommended parameters:
?charset=utf8mb4&parseTime=True&loc=Local
- Create your database as follows:
CREATE DATABASE twbot_tezrian DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
- Start your bot:
# twitch-bot \ --storage-conn-type mysql \ --storage-conn-string 'tezrian:mypass@tcp(mariadb:3306)/twbot_tezrian?charset=utf8mb4&parseTime=True&loc=Local' \ ...
See driver documentation for more details on parameters.
Postgres
host=localhost port=5432 dbname=mydb connect_timeout=10
See Postgres documentation for more details in paramters.
SQLite
storage.db
Just pass the filename you want to use.
- Start your bot:
# twitch-bot \ --storage-conn-type sqlite \ --storage-conn-string 'storage.db' \ ...