Custom Commands

Each command can reply with plain text or an embed (including buttons).

Custom commands let you create server-specific commands triggered by a prefix.

Basic Configuration

In your config.yml, custom commands are configured under the CustomCommands section. Here are the two key settings:

Enable commands and set the prefix in your config.

config.yml

CommandsEnabled: true
CommandsPrefix: "!"

Examples

MongoDB Setup Command

This command provides users with links and information for setting up MongoDB. It includes rich embeds with detailed descriptions and action buttons for quick navigation.

CustomCommands (mongo)

CustomCommands:
  mongo:
    type: "EMBED"
    Embed:
      Title: "📊 MongoDB Setup Guide"
      Description:
        - "To get started with MongoDB, follow the detailed guide provided below. This guide will assist you in setting up MongoDB efficiently and correctly."
        - ""
        - "Need further assistance? Don't hesitate to open a support ticket."
      Footer:
        Text: "Aegis Development | MongoDB Setup"
        Icon: "https://i.imgur.com/SPsigbH.png"
      Color: "#1769FF"
    Roles:
      Whitelist: ["1272331356445347840", "1196187304008622101"]
    Options:
      DeleteTriggerMessage: false
      ReplyToUser: false
    Buttons:
      - Type: "LINK"
        Name: "MongoDB Setup"
        Emoji: "📑"
        Link: "https://docs.aegisdev.one/misc/mongodb-setup"
      - Type: "LINK"
        Name: "Wiki"
        Emoji: "📕"
        Link: "https://docs.aegisdev.one/"

Welcome Command

A welcoming command that dynamically greets new users, provides a quick start guide, and includes interactive buttons for further exploration.

CustomCommands (welcome)

CustomCommands:
  welcome:
    type: "EMBED"
    Embed:
      Title: "🎉 Welcome to Aegis Development!"
      Description:
        - "Hello {userMention}! We're glad you've joined our community of {memberCount} developers."
        - "Here's a quick guide to get you started:"
      Fields:
        - Name: "🚀 Quick Start"
          Value: "• Introduce yourself in #introductions\n• Set roles in #role-assignment\n• Check #announcements for updates"
          Inline: false
        - Name: "🆘 Need Help?"
          Value: "Visit #support or use `/ticket` for assistance."
          Inline: false
      Footer:
        Text: "Joined on {longTime}"
        Icon: "https://i.imgur.com/SPsigbH.png"
      Author:
        Text: "Aegis Development Team"
        Icon: "https://i.imgur.com/SPsigbH.png"
      Color: "#1769FF"
    Roles:
      Whitelist: []
    Options:
      DeleteTriggerMessage: true
      ReplyToUser: true
    Buttons:
      - Type: "LINK"
        Name: "Documentation"
        Emoji: "📚"
        Link: "https://docs.aegisdev.one"
      - Type: "REPLY"
        Name: "Quick Tour"
        Emoji: "🗺️"
        Style: "Primary"
        Reply:
          Type: "EMBED"
          Ephemeral: true
          Embed:
            Title: "🗺️ Quick Server Tour"
            Description:
              - "📢 #announcements — Latest news"
              - "💡 #ideas-and-feedback — Share suggestions"
              - "🤖 #bot-commands — Test our bots"
              - "🎓 #tutorials — Learn new skills"
            Footer:
              Text: "Enjoy your stay at Aegis Development!"
              Icon: "https://i.imgur.com/SPsigbH.png"
            Color: "#4CAF50"
            Thumbnail: "https://i.imgur.com/SPsigbH.png"

Additional Notes

Available placeholders

View placeholders

Placeholders

{guildName}, {guildId}, {userName}, {userId}, {userMention}, {channelName}, {channelId}, {channelMention}, {commandName}, {longTime}, {shortTime}, {memberCount}