Skip to content

Detailed Config Reference

builderpepc edited this page Mar 3, 2022 · 1 revision

Target Roles

"Target roles" refers to roles that will be specifically changed by the bot during lockdowns. By default, the @everyone role will always be affected (View Channels will be disabled in the role settings). When you add roles to the list of target roles, those roles will be affected in the same way. Individual channel permissions for roles will still be affected if View Channel(s) is enabled, unless the role is added to the ignored roles list. The target roles list specifically relates to server-wide role permissions. This is recommended for any "Member" or "Verified" roles in your server, or other roles that grant most of your members permissions.

/config target-roles list

Lists the roles in the target roles list.

/config target-roles add (role: Role)

Adds a role to the target roles list.

/config target-roles remove (role: Role)

Removes a role from the target roles list.

Ignored Roles

"Ignored roles" refers to roles whose channel-specific permissions overwrites will not be affected by lockdowns. This does not relate to server-wide permissions for the roles. By default, all overwrites which have View Channel(s) enabled will be switched during lockdowns; adding a role to the ignored roles list will prevent this behavior for overwrites for that particular role, in all channels.

/config ignored-roles list

Lists the roles in the ignored roles list.

/config ignored-roles add (role: Role)

Adds a role to the ignored roles list.

/config ignored-roles remove (role: Role)

Removes a role from the ignored roles list.

Ignored Channels

"Ignored channels" refers to channels whose overwrites will not be affected at all during lockdowns. This means channels added to this list may be visible to server members while the server is locked down. Note that while this command is often used for text channels, it can work for any kind of channel; this includes voice channels, stage channels, announcement channels, etc. This also includes categories, but adding a category to the ignored channels list will not directly affect the channels within the category (only the overwrites of the category itself, which the channels may or may not inherit depending on whether they are "synced").

/config ignored-channels list

Lists the roles in the ignored channels list.

/config ignored-channels ignore (channel: Channel | Category)

Adds a role to the ignored channels list.

/config ignored-channels unignore (role: Channel | Category)

Removes a role from the ignored channels list.

Ignore Neutral Overwrites

By default, CurfewBot will not edit channel overwrites for View Channel(s) if they are set to neutral. If your permissions system is configured neatly, this should not be an issue. Otherwise, you can disable this behavior to force the bot to set all overwrites to False for View Channel(s) in each channel.

/config ignore-neutral-overwrites

Toggles whether or not neutral overwrites are ignored.

Logging

CurfewBot has the ability to log lockdown and reopen events to a log channel, which includes report files that may be useful if something goes wrong.

/config logs setchannel (channel: Text Channel)

Sets the log channel to the provided channel. Logs will still not be posted unless logging is enabled.

/config logs toggle

Toggles whether logs are enabled. Logs will still not be posted unless a log channel is set.

/config logs get

Displays the current logging settings.

Synced Calendar

The usage of the synced calendar is part of the main purpose of the bot. If this option is enabled, the bot will aut lock down and reopen your server according to the school calendar and schedule. The bot is aware of special occasions (such as holidays or half days) and adjusts or removes the lockdown intervals accordingly. This behavior is disabled by default so that you can enable it once everything else is configured.

/config calendar toggle

Toggles whether the bot will use the automatic lockdown system for your server.

/config calendar get

Displays the current calendar settings.