Suggestions

In your suggestions.yml, navigate to the SuggestionSettings section.

Key settings:

  • UseQuestionModal Must be set to true to enable modal-based suggestions.

  • AdditionalModalInputs Defines up to 4 extra fields in your suggestion modal. Fields can be either:

    • TextInput → Free text fields

    • StringSelect → Dropdown menus with predefined options

🔧 AdditionalModalInputs Structure (Direct link to heading: https://docsaegisdev.one/core-features/suggestions#additionalmodalinputs-structure)

Each input requires the properties shown below depending on its type.

1

Text Inputs

(Direct link to heading: https://docs.aegisdev.one/core-features/suggestions#id-1.-text-inputs)

Example configuration for a TextInput:

TextInput example
1: # Additional details text input
  Type: "TextInput"
  ID: "details" # {modal_details}
  Question: "Additional Details (Optional)"
  Placeholder: "Any extra context, examples, or details about your suggestion..."
  Style: "Paragraph" # Short + Paragraph
  Required: false
  maxLength: 2000

Notes:

  • Use Style to choose between short (single-line) and paragraph (multi-line).

  • maxLength controls the maximum allowed characters.

2

StringSelect Dropdowns

(Direct link to heading: https://docs.aegisdev.one/core-features/suggestions#id-2.-stringselect-dropdowns)

Example configuration for a StringSelect:

StringSelect example
2: # Product selection dropdown
  Type: "StringSelect"
  ID: "product" # Available as: {modal_product}, {modal_product_formatted}, {modal_product_label}, {modal_product_emoji}
  Label: "Product Selection"
  Description: "Which product is this suggestion for?"
  Placeholder: "Choose a product..."
  Required: true
  Options:
    - Label: "Aegis Bot"
      Value: "aegis_bot"
      Description: "Multi-purpose Discord bot"
      Emoji: "🤖"
    - Label: "Aegis Tickets"
      Value: "aegis_tickets"
      Description: "Advanced ticket management system"
      Emoji: "🎫"
    - Label: "Discord Platform"
      Value: "discord"
      Description: "General Discord platform suggestions"
      Emoji: "💬"
    - Label: "Other"
      Value: "other"
      Description: "Other products or services"
      Emoji: "📦"

Notes:

  • Maximum 25 options per dropdown (Discord limitation).

  • Each option supports Label, Value, optional Description, and optional Emoji.

  • Selected values are available via multiple placeholders (see below).

📝 Example Configuration (Direct link to heading: https://docs.aegisdev.one/core-features/suggestions#example-configuration)

Here’s a complete example with a mix of inputs:

suggestions.yml — Example
SuggestionSettings:
  UseQuestionModal: true
  AdditionalModalInputs:
    1: # Product field
      Type: "TextInput"
      ID: "product"
      Question: "Which product is this suggestion for?"
      Placeholder: "Aegis Bot, Aegis Tickets, Discord"
      Style: "Short"
      Required: true

    2: # Priority dropdown
      Type: "StringSelect"
      ID: "priority"
      Label: "Suggestion Priority"
      Placeholder: "Choose a priority..."
      Required: true
      Options:
        - Label: "🟢 Low Priority"
          Value: "low"
        - Label: "🟡 Medium Priority"
          Value: "medium"
        - Label: "🔴 High Priority"
          Value: "high"

    3: # Category dropdown
      Type: "StringSelect"
      ID: "category"
      Label: "Suggestion Category"
      Required: false
      Options:
        - Label: "🐛 Bug Fix"
          Value: "bug"
        - Label: "✨ New Feature"
          Value: "feature"
        - Label: "⚡ Improvement"
          Value: "improvement"

🏷️ Using Placeholders in Embeds (Direct link to heading: https://docs.aegisdev.one/core-features/suggestions#using-placeholders-in-embeds)

Placeholders you can use inside your SuggestionEmbed:

  • {modal_[ID]} → raw value (e.g., low)

  • {modal_[ID]_formatted} → formatted with emoji if provided (e.g., 🟢 Low Priority)

  • {modal_[ID]_label} → label without emoji (e.g., Low Priority)

  • {modal_[ID]_emoji} → emoji only (e.g., 🟢)

Example Embed configuration:

⚙️ Important Notes (Direct link to heading: https://docs.aegisdev.one/core-features/suggestions#important-notes)

  • Maximum 4 inputs per modal (Discord limitation)

  • Maximum 25 options per dropdown

  • Labels and values must each be ≤ 100 characters

Direct links referenced:

  • AdditionalModalInputs Structure: https://docs.aegisdev.one/core-features/suggestions#additionalmodalinputs-structure

  • Text Inputs: https://docs.aegisdev.one/core-features/suggestions#id-1.-text-inputs

  • StringSelect Dropdowns: https://docs.aegisdev.one/core-features/suggestions#id-2.-stringselect-dropdowns

  • Example Configuration: https://docsaegisdev.one/core-features/suggestions#example-configuration

  • Using Placeholders in Embeds: https://docs.aegisdev.one/core-features/suggestions#using-placeholders-in-embeds

  • Example Embed: https://docs.aegisdev.one/core-features/suggestions#example-embed

  • Important Notes: https://docs.aegisdev.one/core-features/suggestions#important-notes

Last updated 1 month ago

PreviousMongoDB SetupNextGiveaways

Last updated