In-game manuals

QMAW is the in-game contextual manual. Hover an item in an inventory or recipe viewer and press the manual key (F1 by default). Native fluid entries in JEI and REI also offer their matching manuals. Left Shift selects the alternate action.

Pages and triggers are server datapack data. The server sends its catalog on join and after /reload. Panel textures, item models and sounds are client resources.

See the workshop manual example for a complete pack.

Files, IDs and overridesCopy Anchor Link

Put a page at data/<namespace>/qmaw/<path>.json. Its page ID is <namespace>:<path>.

• Add your own page with a new namespace/path.
• Replace an existing page by using its exact path in a higher-priority datapack. Overrides replace the entire record.
• The built-in copper page is data/hbm/qmaw/material/copper.json, with ID hbm:material/copper.

Page fieldsCopy Anchor Link

Locale keys are lowercase, such as en_us, ru_ru and zh_cn. For title and body independently, the client selects its locale, falls back to en_us, then displays the missing-localization message. Provide en_us for fallback text.

A body can insert another page's body with {{Page Name}}. The name resolves within the current page's namespace; {{namespace:page/path}} addresses a page ID directly. Each inserted page selects its own translation for the client's locale, then its en_us body. A missing page name displays as plain text without the braces, matching the 1.7 manual. Composition cycles fail when the page opens.

Names and aliases must be unique within a namespace. Pack priority resolves same-ID overrides before the uniqueness check.

Item predicates and selectionCopy Anchor Link

Each trigger uses the vanilla item-predicate fields items, count, components and predicates:

{
  "items": ["minecraft:paper", "minecraft:book"],
  "count": {"min": 2, "max": 16}
}

• items accepts one item ID, one #tag, or a list of item IDs. Use a standalone #tag for tag matching.
• count accepts an exact nonnegative integer or an object with optional min/max. Bounds must be exact nonnegative integers and min cannot exceed max. Omitted count, or {}, leaves the count unrestricted.
• components matches exact component values. predicates uses registered partial component predicates. Their component payloads retain their own native codecs; see Ingredients and Components.
• A deliberately empty predicate {} matches every nonempty stack.

Highest priority wins. At the same priority, a component-qualified match precedes an item-only match. Remaining ties use lexical page ID order.

Native fluid help queries the same predicates using that fluid's hbm:fluid_icon representation. To match a fluid regardless of quantity, pressure or display tint:

{
  "items": "hbm:fluid_icon",
  "predicates": {"hbm:fluid_content": "hbm:oil"}
}

This predicate matches fluid type. The built-in oil pages use this form; matching a foreign fluid requires an explicit predicate.

Text and linksCopy Anchor Link

<br> starts a line; use <br><br> for a paragraph break. Text wraps to the panel width, including long words and CJK text.

A target containing : is a page ID. Names and aliases are case-sensitive. Unresolved targets appear red and remain non-clickable.

Reloads and rejected dataCopy Anchor Link

On successful /reload, connected clients receive a new catalog. An open page updates its text and title, removes invalid history entries, and closes if its page ID has disappeared. Disconnect clears the received catalog.

Schema errors identify the resource file; duplicate cross-page names identify both IDs.