categories.yml

Browse categories and the wildcard material, name and custom model data rules that sort items into them.

Categories filter the main board. Each one is a list of item rules; a listing shows in a category when it matches any of them. After editing, run /ahadmin reload.

A category’s button is not in this file. It lives in guis/category-menu.yml, where each button names a category id.

File format

Enabled: true

Categories:
  all:
    Display-Name: "All Items"
    Items:
      - Material: "*"

  armor:
    Display-Name: "Armor"
    Items:
      - Material: "*_HELMET"
      - Material: "*_CHESTPLATE"
      - Material: "*_LEGGINGS"
      - Material: "*_BOOTS"
      - Material: "ELYTRA"

Key	Default	Description
`Enabled`	`true`	`false` turns categories off: clicking the Category button on the board then clears the filter instead of opening the category menu.
`Categories`	required	One section per category. The key is its id (case insensitive).
`<id>.Display-Name`	the id	What `{category}` shows while the category is selected.
`<id>.Items`	required	At least one rule, see below.

With Enabled: true at least one category must exist, or the load fails.

Rules

Each entry under Items is one rule with up to three conditions:

Condition	Matches
`Material`	The material name, e.g. `DIAMOND_SWORD`.
`Name`	The item’s display name without colors. Items without a custom name use their material name with spaces (`diamond sword`).
`Custom-Model-Data`	An exact custom model data number.

Inside one rule, every condition you set must match (AND).
Between rules, any rule is enough (OR).
A rule needs at least one condition.

Material and Name are case insensitive and support * at the start, the end or both:

Pattern	Matches
`*`	Everything.
`*_SWORD`	Ends with `_SWORD`.
`DIAMOND_*`	Starts with `DIAMOND_`.
`Booster`	Contains `Booster`.
`ELYTRA`	Exactly `ELYTRA`.

A * in the middle of a pattern is not a wildcard.

  boosters:
    Display-Name: "Boosters"
    Items:
      - Material: "PAPER"
        Name: "*Booster*"        # paper named "...Booster..."
      - Custom-Model-Data: 1001  # or anything with model data 1001

The all category

all is special: selecting it in the category menu clears the filter and shows every listing, and {category} then shows the All-Items label from config.yml. Keep the all category if your category menu has an “All Items” button that points at it.

Shipped categories

Id	Display name	Rules
`all`	All Items	Everything.
`blocks`	Blocks	`_ORE`, `_BLOCK`, `_LOG`, `_PLANKS`, stone, cobblestone, dirt, sand.
`armor`	Armor	Helmets, chestplates, leggings, boots, elytra.
`tools`	Tools	Pickaxes, axes, shovels, hoes, shears, fishing rod.
`weapons`	Weapons	Swords, `BOW` (bow and crossbow), trident, shield, `ARROW`.
`resources`	Resources	Ingots, nuggets, diamond, emerald, coal, redstone, lapis, quartz, amethyst shard, ancient debris.
`custom`	Custom	Player heads, nether stars, and items named `Cube` or `Booster`.

Adding a category

Add a section under Categories with an id, a Display-Name and its rules.
Add a button for it in guis/category-menu.yml with Category: <id> (see category menu).
Run /ahadmin reload.

A button that names an id missing from this file throws an error when clicked, so keep the two files in step.