Skip to content

Announcement Channels

mldchan edited this page Sep 25, 2024 · 1 revision

Announcement Channels

Announcement Channels is a feature in the Akabot Discord bot, primarily used in the public instance of the bot, to publish update announcements to all subscribed channels.

Usage

  • /announcement_channels subscribe - Subscribe to Akabot announcements

    • Parameters:
      • channel parameter: a Text Channel to send the announcements to.
    • Result (English):
      • I don't have permission to send messages in that channel.: The bot doesn't have permissions to send messages in the channel. Check your guild permissions and check channel overrides.
      • Subscribed to announcements in channel.: Successfully subscribed to announcements in the channel.
      • You do not have permission to use this command. Missing permissions: You are missing permissions to add the channel to the announcement channels list.
  • /announcement_channels unsubscribe - Unsubscribe a channel from Akabot announcements

    • Parameters:
      • channel parameter: a Text Channel to unsubscribe announcements from.
    • Result (English):
      • Not subscribed to announcements in channel.: The channel isn't subscribed to announcements.
      • Unsubscribed from announcements in channel.: Successfully unsubscribed to announcements in the channel.
      • You do not have permission to use this command. Missing permissions: You are missing permissions to add the channel to the announcement channels list.
  • /announcement_channels list - List all channels subscribed to Akabot announcements

    • Parameters: None
    • Result (English):
      • No channels are subscribed to announcements.: There are no channels subscribed to announcements.
      • list of channels: A list of channels that are subscribed to Akabot announcements.

Usage for Bot Maintainers

  • /admin create_announcement - Announce something to all subscribed channels
    • Parameters:
      • announcement_file: A Markdown formatted file to send out as an announcement.
      • extra_attachment: An extra attachment to post alongside the Markdown file.
    • Returns (English):
      • No announcement message set.: There is no default announcement channel set. This is configured inside of config.conf.
      • Announcement Channel configured in config.conf not found.: The channel configured inside of config.conf wasn't found. To fix this, change the channel ID in config.conf to the ID of a valid channel.
      • The message is too long. Please shorten it.: The Markdown file that was sent is too big to send in one Discord message. Please shorten it.
      • Creating announcement...: The creation has began, please wait for it to complete.
      • Sent to main server, now sending to rest of the servers.: The announcement was announced in the main channel, which is always the first one. Announcing to other servers is done in the background.
      • Sent to progress servers out of count.: Announcement was sent to progress channels out of count.
      • Announcement sent.: Announcement sending was finished.