Settings

The Settings tab is the place for server administrators to configure the way Architus interacts with their server, allowing them to set specific limits/assignments/etc. for various modules of the bot. To make this possible, settings are dynamically rendered, consumed, and validated based off of a JSON schema as detailed below.

Gets the settings schema data for the current server.

At the highest level, the Settings schema is composed of an array of category definitions, each of which contain one or more settings cards:

{
  "categories": [
    ...
  ]
}

The reasoning behind having a top-level organization scheme of the category is to support a view that looks something like the following mockup, where multiple vertical sections would be possible, enabling large collections of settings to be effectively categorized.

Each card is configured individually, representing a collection of individual settings that fall under a given topic.

{
  "title": "Gulag",
  "width": 5,
  "settings": [
    {
      "id": "gulag_command",
      "label": "Command",
      "input_type": "string",
      "default": "gulag"
    },
    ...
  ]
}

In order to be consumed on both the backend and the frontend, each Setting object contains a variety of information related to each setting entry.

The values for each field are stored in a separate object, which is a flat dictionary mapping entry IDs to their corresponding value. This allows the client or server to update the values of the settings without resending the entire schema.

{
  "id": "starboard_threshold",
  "label": "Starboard Threshold",
  "input_type": "numeric",
  "default": 5,
  "value": 6,
  "properties": {
    "min": 0,
    "integer": true
  },
  "validation_steps": [
    "isNumber",
    "isInteger",
    { "key": "isInRange", "min": 0 }
  ],
  "cli": {
    "name": "Starboard Threshold",
    "emoji": "⭐",
    "message": "⭐ This is the number of reacts a message...",
    "input_mode": "replace"
  }
}

Validating the data is important on both the backend (for data safeguarding) and the frontend (for UX), so a processing chain model is used to allow for symmetry in validation logic. Each validation entry can either be a simple string, in which case this value represents the same thing as its expanded object form. For example, "isArray" is equivalent to:

{
  "key": "isArray"
}

{
  "key": "any",
  "of": [
    [
      {
        "key": "matchesRegex",
        "regex": "^$"
      }
    ],
    [
      {
        "key": "matchesRegex",
        "regex": "(?:^@.+$)|^(?:^[0-9]{7,20}$)"
      },
      "isRole"
    ]
  ]
}

• any(current: any, { of: Array<Array<ValidationObject>> })
  • Passes if any of the validation chains in the of array pass, starting from index 0. Note that not all validation chains may be called if an earlier one passes
• matchesRegex(current: string, { regex: String })
  • Passes if the current value tests positively to the given regex (only will work with strings)
• isInRange(current: number, { min?: Number, max?: Number })
  • Passes if the current value is greater than the minimum (if specified), and less than the maximum (if specified)
• isArray(current: any)
  • Passes if the current value is an array type (note: a serialized array string won’t be parsed)
• isBoolean(current: any)
  • Passes if the current value is a boolean type (note: a serialized boolean string won’t be parsed)
• isNumber(current: any)
  • Passes if the current value is a float/integer/number type (note: a serialized float string won’t be parsed)
• isInteger(current: number)
  • Passes if the current value has no decimal segment (whether the type is a true integer or not)
• allPass(current: array<any>, { steps: array<ValidationObject> })
  • Passes if each element in the current value array passes the specified validation chain (as individual elements)

Each of the following functions works with Discord entities, and examines whether they exist in the context of the current guild. The objects can be resolved by either their snowflake ID or their serialized forms (see below)

• isRole(current: string)
  • Serialized form: @{name}
• isUser(current: string)
  • Serialized form: @{username}
• isChannel(current: string)
  • Serialized form: #{name}
• isEmoji(current: string)
  • Serialized form: :{shortcode}: or {unicode_emoji}

Last modified 2 years ago Edit this page on GitHub