Document role hierarchy

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2021-08-24 18:02:06 +02:00
parent 3e3af3a645
commit 35888b0abd
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
2 changed files with 2 additions and 2 deletions

View file

@ -50,7 +50,7 @@ func (m *modLiveRole) Initialize(id string, crontab *cron.Cron, discord *discord
func (m modLiveRole) Setup() error { return nil } func (m modLiveRole) Setup() error { return nil }
func (m modLiveRole) addLiveStreamerRole(guildID, userID string, presentRoles []string) error { func (m modLiveRole) addLiveStreamerRole(guildID, userID string, presentRoles []string) error {
// @attr role_streamers_live required string "" Role ID to assign to live streamers // @attr role_streamers_live required string "" Role ID to assign to live streamers (make sure the bot [can assign](https://support.discord.com/hc/en-us/articles/214836687-Role-Management-101) this role)
roleID := m.attrs.MustString("role_streamers_live", nil) roleID := m.attrs.MustString("role_streamers_live", nil)
if roleID == "" { if roleID == "" {
return errors.New("empty live-role-id") return errors.New("empty live-role-id")

View file

@ -90,7 +90,7 @@ Adds live-role to certain group of users if they are streaming on Twitch
| Attribute | Req. | Type | Default Value | Description | | Attribute | Req. | Type | Default Value | Description |
| --------- | :--: | ---- | ------------- | ----------- | | --------- | :--: | ---- | ------------- | ----------- |
| `role_streamers_live` | ✅ | string | | Role ID to assign to live streamers | | `role_streamers_live` | ✅ | string | | Role ID to assign to live streamers (make sure the bot [can assign](https://support.discord.com/hc/en-us/articles/214836687-Role-Management-101) this role) |
| `twitch_client_id` | ✅ | string | | Twitch client ID the token was issued for | | `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 | | `twitch_client_secret` | ✅ | string | | Secret for the Twitch app identified with twitch_client_id |
| `role_streamers` | | string | | Only take members with this role ID into account | | `role_streamers` | | string | | Only take members with this role ID into account |