Skip to content

Forms

When a channel id is set in a form specified in your config, it is considered a Form channel by the bot. Any messages sent by members without the message manage permission will be automatically deleted.

Through the /post command, users can post a submission to either the current channel or the channel specified by the target parameter—afterward, a modal will popup for the user. After filling in the required fields, a message will be sent, accompanied by the abandon button and, if completable, the complete button. These two button components can be used by either the user or another user with the message manage permission.

Configuration

The outer most forms key has the following: - messages - See messages. - invalid-channel - Sent when user tries to use /post in a non-post channel. - malformed-input - Sent with the form modal input when user entered illegal content. - list - See below:

The following parameters are offered for each individual form:

  • name - The name that will display on the top of the modal.
  • channel - The id of the specified channel.
  • color - The embed color of the final message.
  • completeable - If the submission can be completable by the user.
  • forms-only - Should the bot delete all user messages (not including users with MESSAGE MANAGE permission)
  • fields - See below.

Each field offers:

  • size - The size of the text box in the modal. (Optional & SHORT)
  • LONG - A HTML <textarea> equivalent.
  • SHORT - A short box that doesn't allow new lines.
  • isTitle - Should the input of this field be the title of the embed message? Only one field with this true should be specified. If none is specified, the bot will default to Submission by {DiscordUser#0000}. (Optional)
  • name - The name of this field.
  • min & max - If isNumber is enabled, this will act as the number range, otherwise the letter count. Default 0 and 4000 respectively. (Optional)
  • inline - Whether this field will be displayed inline or not in the final embed. (Optional & false)
  • isImage - Should this field be an image url that will be set as the embed message's image? (Optional & false)
  • optional - Is this field optional? (Optional & false)

Example

forms:
  messages:
    invalid-channel:
      text: "You can only use this command in form channels!"
      malformed-input:
        text: "Hey! Fix ye stuff!"
  list:
    - channel: 759935175060094976
      name: "Paid Requests"
      color: "#000000"
      completable: true
      forms-only: true
      fields:
        - name: Subject
          min: 2
          max: 24
          is-title: true
        - name: Description
          size: LONG
        - name: Budget (USD)
          is-number: true
          min: 1
          max: 1000
        - name: Example picture
          optional: true
          is-image: true

Output

Example modal Example output Example completed output