mirror of
https://github.com/Luzifer/discord-community.git
synced 2024-11-09 23:50:04 +00:00
2.9 KiB
2.9 KiB
Config format
---
bot_token: '...'
guild_id: '...'
module_configs:
- type: module-type
attributes:
key: value
...
Modules
Type: liverole
Adds live-role to certain group of users if they are streaming on Twitch
Attribute | Req. | Type | Default Value | Description |
---|---|---|---|---|
role_streamers_live |
✅ | string | Role ID to assign to live streamers | |
twitch_client_id |
✅ | string | Twitch client ID the token was issued for | |
twitch_client_secret |
✅ | string | Secret for the Twitch app identified with twitch_client_id | |
role_streamers |
string | Only take members with this role into account |
Type: presence
Updates the presence status of the bot to display the next stream
Attribute | Req. | Type | Default Value | Description |
---|---|---|---|---|
fallback_text |
✅ | string | What to set the text to when no stream is found (playing <text> ) |
|
twitch_channel_id |
✅ | string | ID (not name) of the channel to fetch the schedule from | |
twitch_client_id |
✅ | string | Twitch client ID the token was issued for | |
twitch_token |
✅ | string | Token for the user the twitch_channel_id belongs to |
|
cron |
string | * * * * * |
When to execute the module | |
schedule_past_time |
duration | 15m |
How long in the past should the schedule contain an entry |
Type: schedule
Posts stream schedule derived from Twitch schedule as embed in Discord channel
Attribute | Req. | Type | Default Value | Description |
---|---|---|---|---|
discord_channel_id |
✅ | string | ID of the Discord channel to post the message to | |
embed_title |
✅ | string | Title of the embed (used to find the managed post, must be unique for that channel) | |
twitch_channel_id |
✅ | string | ID (not name) of the channel to fetch the schedule from | |
twitch_client_id |
✅ | string | Twitch client ID the token was issued for | |
twitch_token |
✅ | string | Token for the user the twitch_channel_id belongs to |
|
cron |
string | */10 * * * * |
When to execute the schedule transfer | |
embed_color |
int64 | 3066993 |
Integer representation of the hex color for the embed (default is #2ECC71) | |
embed_description |
string | Description for the embed block | ||
embed_thumbnail_height |
int64 | Height of the thumbnail | ||
embed_thumbnail_url |
string | Publically hosted image URL to use as thumbnail | ||
embed_thumbnail_width |
int64 | Width of the thumbnail | ||
schedule_entries |
int64 | 5 |
How many schedule entries to add to the embed as fields | |
schedule_past_time |
duration | 15m |
How long in the past should the schedule contain an entry |