Setting up gathering notifications¶
A moderator turns on gathering notifications and sets the notification channel, the notification role, the restricted role and the cooldown between notifications. Then game participants call new players with the “Notify gathering” button, and you come back here when the bot stops sending notifications.
What you need¶
Before you start, prepare three things:
- Moderator permissions — the notification commands can be run by the server owner, a member with the Discord “Administrator” permission or a member with the server's moderator role; see Players, moderators and admins.
- A text channel — the bot will send notifications there; in it the bot needs the permissions “View Channel”, “Send Messages” and “Embed Links”.
- A notification role, if you need one — the bot mentions it above each notification; the role must be mentionable, or the bot must have the “Mention Everyone” permission in the channel.
Steps¶
- Run the setup command. Type
/guild notifications configureand pick the notification channel in thechanneloption. Discord offers only text channels here. You can leave out the other options; they are covered in the section What else you can set up. Check: the bot replies “Gathering notifications configured.”, and below it is a line like “#game-search · None · None · 15 min”. If the bot lacks permissions in the channel, it lists them and saves nothing. - Check the status. Type
/guild notifications status. Check: under the line with your settings it says “Ready”. - Try it on a real gathering. When a gathering needs more players, press the “Notify gathering” button on the gathering card and confirm the dialog; a moderator can do this in any gathering on the server. The bot mentions the role if one is set, and the cooldown for this game starts. Check: you see “Gathering notification sent.”, and a card with a title like “+3 FFA6 Gathering” appears in the notification channel. If the event log is on, it gets an entry “📣 Gathering Notification”. See Gathering notification and Event log.
Reply language
Only you see the replies to the notification commands, in the language of your Discord client. The bot writes the card in the notification channel in the server's language. See Bot language.
What else you can set up¶
The /guild notifications configure command has three more options, all optional: the notification role, the restricted role and the cooldown. The full command looks like this:
/guild notifications configure channel:#game-search cooldown_minutes:20 role:@Players restricted_role:@No-notifications
Give all options every time
The /guild notifications configure command sets all the settings from scratch every time. Without role or restricted_role, the bot removes that role from the settings, and without cooldown_minutes the cooldown goes back to 15 min. Before you change one option, look at the rest with /guild notifications status and repeat them. See How to check settings.
Notification role¶
The role option sets the role the bot mentions above each notification. Without it, the card appears in the channel with no mention. The bot mentions only this role. If a player mentions someone with @ in the “Add a message” field, that mention notifies nobody.
The bot doesn't accept the @everyone role. The role must be mentionable, or the bot must have the “Mention Everyone” permission in the notification channel. If the check fails, the bot saves nothing and explains what is wrong.
Restricted role¶
The restricted_role option sets a role whose members can't send notifications. The bot replies to people who have it with “Users with the configured restricted role cannot send notifications.” The restriction applies to moderators too. Other game participants send notifications as usual.
Cooldown between notifications¶
The cooldown_minutes option sets a cooldown of 3 to 60 min, and without it the cooldown is 15 min. Discord doesn't let you enter a number outside these limits. The cooldown counts for each game separately: the next notification for this game can be sent only after it ends. The server's other gatherings don't depend on it.
The cooldown is shared by all participants of the game and the moderators. It starts only after a notification is sent. While the cooldown lasts, the bot replies “This game can notify again …” and shows how much time is left. The new value applies from the next notification; a cooldown that is already running still uses the old value.
How to check settings¶
The /guild notifications status command shows the settings and whether the bot can send notifications. The reply starts with a line of settings, and below it comes the status:
- The settings line — the channel, the notification role, the restricted role and the cooldown, for example “#game-search · @Players · None · 15 min”. “None” appears when a role isn't set or the role that was set has been deleted. If the notification channel was deleted, the bot shows a number in its place.
- The status — “Ready” if everything is fine, or a list of problems, each on a new line.
If notifications aren't set up or are turned off, the bot replies “Gathering notifications are disabled.”
| Problem | What it means | What to do |
|---|---|---|
| “The configured notification channel is unavailable.” | The bot can't find the notification channel, for example because it was deleted | Run /guild notifications configure with a new channel |
| “The configured notification role is unavailable.” | The notification role or the restricted role was deleted | Run /guild notifications configure with the roles that exist |
| “The bot needs View Channel permission.” | The bot can't see the notification channel | Give the bot this permission in the channel settings |
| “The bot needs Send Messages permission.” | The bot can't write in the notification channel | Give the bot this permission in the channel settings |
| “The bot needs Embed Links permission.” | The bot can't send the notification card | Give the bot this permission in the channel settings |
| “The role must be mentionable or the bot needs Mention Everyone permission.” | The bot can't mention the role | Let everyone mention the role, or give the bot the “Mention Everyone” permission in the channel |
How to turn off notifications¶
The /guild notifications disable command turns off notifications on the server. The bot replies “Gathering notifications disabled.” and removes the channel, the notification role and the restricted role.
The “Notify gathering” button stays on gathering cards. But the bot now replies “Gathering notifications are not configured.” to those who send a notification. Notifications that were already sent stay in the channel. To turn notifications on again, run /guild notifications configure with all the options you need.
What can go wrong¶
- The bot says “You are not allowed to perform this action.” Only moderators run the notification commands. Ask a server admin to give you the moderator role. See Players, moderators and admins.
- The bot says “The bot needs … permission.” and saves nothing. The bot doesn't have the named permission in the notification channel. Give it to the bot in the channel settings and repeat the command.
- The bot says “The @everyone role cannot be used for notifications.” A mention needs a separate role. Pick another role in the
roleoption or leave it out. - The bot says the role must be mentionable. The role is closed to mentions, and the bot doesn't have the “Mention Everyone” permission. Let everyone mention the role in its settings, or give the bot this permission in the channel. Then repeat the command.
- Players see “Gathering notifications are not configured.” The notification channel isn't set, or notifications are turned off. Run
/guild notifications configure. - Players see that the channel or role is unavailable, or that the bot lacks a permission. For example, “The configured notification channel is unavailable.”, “The configured notification role is unavailable.”, “The configured role cannot be mentioned in the notification channel.” or “The bot needs Send Messages permission in the notification channel.” The notification channel, the notification role or the bot's permissions changed after the setup. Run
/guild notifications status: under the settings line the bot lists what exactly is wrong. - The notification role disappeared, and the cooldown is 15 min again. The
/guild notifications configurecommand was run withoutroleorcooldown_minutes. Repeat it with all the options. - A moderator can't send a notification. The bot replies “Users with the configured restricted role cannot send notifications.” The restricted role applies to moderators too. Ask a game participant without this role to send the notification.
Related¶
- Gathering notification
- Creating a game and gathering players
- Event log
- Adding CivBot to a server
- Players, moderators and admins
- Bot commands
- Limits and timers
- Bot language
This page was translated with AI and checked against the bot's terms.