hamcha
/
strimertul
mirror of https://git.sr.ht/~ashkeel/strimertul
1
0
Fork 0
Code Actions

Update docs

This commit is contained in:
Ash Keel 2022-01-02 11:59:54 +01:00
parent fc4346ca64
commit ea87bfbaf3
No known key found for this signature in database
GPG Key ID: BAD8D93E7314ED3E
2 changed files with 1 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/modules.md
View File

@ -1,14 +0,0 @@
# Module configuration
Strimertul modules can be toggled on and off by setting flags in the `stul-meta/modules` key, which is a JSON object with the following schema:
```js
{
"configured": true, // Setting this to false will restore defaults at the next boot
"twitch": bool, // Twitch integration
"stulbe": bool, // Back-end integration
"loyalty": bool // Loyalty system
}
```
Currently modules are not turned on/off until the next time strimertul is restarted, this is a known bug and it's being tracked in [issue #8](https://github.com/strimertul/strimertul/issues/8).

1
docs/twitch.md
View File

@ -12,6 +12,7 @@ The Twitch integration can be configured via `twitch/config` using a JSON object
```js
{
"enabled": bool, // Enable Twitch module (required)
"enable_bot": bool, // Enable IRC bot
"api_client_id": string, // Twitch App Client ID
"api_client_secret": string // Twitch App Client Secret