Skip to content
This repository has been archived by the owner on Aug 18, 2024. It is now read-only.

Latest commit

 

History

History
279 lines (209 loc) · 8.03 KB

README.md

File metadata and controls

279 lines (209 loc) · 8.03 KB
Raw

Azalea Moderation Bot

This file serves as documentation for the Roblox Discord's moderation bot.

Prerequisites

Before you start, you must ensure that you have the following installed:

  • Bun: You need to have bun installed on your machine. See bun.sh for more information.

Installation

  1. Clone the repository

    git clone https://github.com/Rodis-Infrastructure/Azalea.git

  2. Navigate to the project directory

    cd Azalea

  3. Install the project dependencies using a package manager of your choice. For example, if you are using npm, run the following command:

    npm install

  4. Initiate the database before starting the bot. This will create the database and all the required tables.

    npm run db:init

  5. Start the bot by running the following command:

    npm start

Please note that a .env file is required to run the bot. See the .env.example file for an example of what variables need to be set.

Docker

The bot can also be run using Docker. To build and containerize the image, run the following command:

docker-compose up --build -d

Only steps 1 and 2 from the Installation section are required when using Docker.

Configuration

All configuration files must be located in the config directory and their name must use the following format: <guild-id>.yaml or <guild-id>.yml.

For a full example of the configuration, you can view the example.yaml file.

Message Deletion on Ban

The deleteMessageSecondsOnBan field determines the period of time (in second) over which the banned user's messages will be deleted. If set to 0, the bot will not delete any messages.

deleteMessageSecondsOnBan: 0

Media Channels

Channels that only allow messages with at least one attachment to be sent (excludes guild staff).

mediaChannels:
  - "channel-id"

Nickname Censorship

Associated with the /censor-nickname command. The allowedRoles field determines which roles users must have to be able to be censored (at least one). The excludedRoles field determines which roles users must have to be excluded from censorship (at least one). The embed field determines the embed that will be sent to the user when their nickname is censored.

nicknameCensorship:
  allowedRoles:
    - "role-id"
  excludedRoles:
    - "role-id"
  embed:
    title: "embed-title"
    description: "embed-description"
    color: 0x000000 # Optional

For more information on what embed attributes can be passed, see Discord documentation.

Allowed Proof Channels

Require all message links in infraction evidence to be from specific channels. If set to an empty array, all channels will be allowed.

allowedProofChannelIds:
  - "channel-id"

Role Requests

The roleRequests section allows you to configure which roles can be requested by permitted users (managed in interaction permissions). The duration field indicates how long the role will be given to the user for, if not duration is specified, the role will be given to the user indefinitely.

roleRequests:
  channelId: "channel-id"
  roles:
    - roleId: "role-id"
    - roleId: "role-id"
      duration: 600000 # ms

Auto Reactions

The autoReactions section allows you to configure which reactions the bot will add to every message sent in a specified channel.

autoReactions:
  - channelId: "channel-id"
    reactions:
      - "emoji"

Channel Configuration

The channels section allows you to configure which channels the bot will perform certain actions in.

channels:
  banRequestQueue: "channel-id"
  muteRequestQueue: "channel-id"
  mediaConversion: "channel-id"
  notifications: "channel-id"

Custom Commands

The commands section allows you to configure custom commands that can be used by the bot.

commands:
  - name: "command-name"
    value: "command-value" # Cannot have whitespace
    embed:
      title: "embed-title"
      description: "embed-description"
      color: 0x000000 # Optional

For more information on what embed attributes can be passed, see Discord documentation.

Request Notices

A reminder/notice will be sent in the specified channel whenever there is a certain number of unhandled requests over specified period of time.

notices:
  banRequests: # or muteRequests
      enabled: true
      channelId: "channel-id"
      threshold: 25
      cron: "0 * * * *" # Every hour
      mentionedRoles: ["role-id"]

Scheduled Messages

The scheduledMessages section allows you to configure messages that will be sent in the specified channel at a

scheduledMessages:
  - channelId: "channel-id"
    cron: "0 0 * * *" # Every day at midnight
    message: MessagePayload

See discord.js documentation on what can be parsed to TextChannel.send() for more information on the message field.

Custom Emojis

The emojis section enables you to customize the emojis used for the bot's responses. The fields listed below are the emojis that can currently be configured for different types of responses.

emojis:
  success: "👌"
  error: "<:emoji-name:emoji-id>"
  quickMute30: "<:emoji-name:emoji-id>"
  quickMute60: "<:emoji-name:emoji-id>"
  purgeMessages: "<:emoji-name:emoji-id>"
  approveRequest: "<:emoji-name:emoji-id>"
  denyRequest: "<:emoji-name:emoji-id>"

Ephemeral Responses

The ephemeralResponses section controls the behavior of the bot's interaction responses. If enabled, all interaction responses used outside excluded categories/channels will have an ephemeral response, even if an InteractionResponseType is specified.

ephemeralResponses:
  enabled: true
  excludedCategories: []
  excludedChannels: []

User Flags

When the configuration is set, the /info command now includes the names of the flags associated with the user in its response.

userFlags:
  - name: "flag-name"
    roleIds:
      - "role-id"

Permission Configuration

The roles and groups sections allow you to configure which roles have access to specific message components and modals.

  • guildStaff - Prevents the user from being given an infraction.
  • manageInfractions - Allows the user to modify or delete any infraction.
  • viewModerationActivity - Allows the user to view the number of infractions a staff member has given out.
  • manageBanRequests - Allows the user to approve or deny ban requests.
  • manageMuteRequests - Allows the user to approve or deny mute requests.
  • autoMuteBanRequests - Automatically mutes the user a ban requested was submitted for
permissions:
  - id: "role-id"
    guildStaff: false
    manageInfractions: false
    viewModerationActivity: false
    manageBanRequests: false
    manageMuteRequests: false
    autoMuteBanRequests: false
    selectMenus: []
    buttons: []
    modals: []
    reactions: []

Logging Configuration

The logging section controls all the logging events. Below is a list of supported logging events (excluded category/channel configuration does not apply to moderation infraction logging):

  • interactionUsage - Triggered when an interaction is used, whether it is a command, button, modal, or select menu.
  • infractions - Triggered when a user is given an infraction.
  • messages - Triggered when a message is updated, deleted, or deleted in bulk.
  • media - The bot's storage for attachments.
  • voice - Triggered when a user joins, leaves, or moves voice channels.
  • threads - Triggered when a thread is created, updated, or deleted.
logging:
  enabled: true
  excludedCategories: []
  excludedChannels: []

  loggingEvent:
    enabled: true
    channelId: "channel-id"
    excludedCategories: []
    excludedChannels: []