Config Element Definitions

Your config can either be defined inside the pack.mcmeta file under the catharsis:pack/v1 object or in a separate config.catharsis.json file in the root of your pack. The latter will override any config defined in the pack.mcmeta.

Each element in the config array must define a type. Elements that store values (like boolean or color) require a unique id.

Tab (tab)

Used to group related configuration options into separate navigation tabs.

• type: tab
• title: The display name of the tab.
• options: A list of config elements to display within this tab.

Boolean (boolean)

A toggle switch for on/off settings.

• type: boolean
• id: The unique key for this option.
• title: The display name.
• description: (Optional) A default description.
• descriptions: (Optional) A map of "true" or "false" to specific description components.
• default: The default toggle state, defaults to false.

Dropdown (dropdown)

A menu for selecting a single value from a list of options.

• type: dropdown
• id: The unique key for this option.
• title: The display name.
• description: (Optional) A default description.
• descriptions: (Optional) A map of option values to specific description components.
• options: A list of selectable values.
  • Dropdown Option:
    • value: The internal ID used for conditions.
    • text: The display label.
    • default: (Optional) Whether this option is selected by default.

Select (select)

A list based selection that can support single or multiple choices.

• type: select
• id: The unique key for this option.
• title: The display name.
• description: (Optional) A default description.
• single: (Optional) If true, only one item can be selected. Defaults to false.
• options: A list of selectable entries.
  • Select Entry:
    • value: The internal ID.
    • text: The label. Can be a string or an object with selected and unselected variants.
    • selected: (Optional) Whether the entry is checked by default. Defaults to false.

Color (color)

A color picker tool that stores the value as a decimal integer.

• type: color
• id: The unique key for this option.
• title: The display name.
• description: The description for the color picker.
• default: The default color as an integer.
• alpha: (Optional) Whether to enable transparency (RGBA) support. Defaults to false.

Custom Item Tints

Can be used to give tints to items:

List of tints inside an item model definition

• type: catharsis:config
• pack: The id of the pack to check the config entry for.
• id: The id of the color config entry to check.

Information (information)

A text block for text.

• type: information
• title: The header text.
• description: The body content.

Separator (separator)

A visual divider used to organize the menu, same as information just with a divider at the bottom.

• type: separator
• title: (Optional) Text displayed on the divider.
• description: (Optional) A description for the divider.