mcutils:guide_book

Guide book item behavior.

Registering

Before you can use this component you need to register it.

import { system } from "@minecraft/server";
import { GuideBookComponent } from "@lpsmods/mc-utils";

system.beforeEvents.startup.subscribe((event) => {
  event.blockComponentRegistry.registerCustomComponent(GuideBookComponent.typeId, new GuideBookComponent());

  // Gives all players the book when they first enter the world.
  GuideBookComponent.setup("wiki:guide_book");
});

Component

Options

Examples

Guide Book

{
  "format_version": "1.21.100",
  "minecraft:item": {
    "description": {
      "identifier": "wiki:guide_book"
    },
    "components": {
      "wiki:guide_book": {
        "developer_mode": true,
        "default": "home",
        "translation_pattern": "guide.{NAMESPACE}:{KEY}",
        "mcutils:search": {
          "include_titles": true,
          "include_buttons": true
        },
        "back_button": {
          "icon": "textures/ui/arrowLeft.png"
        }
      }
    }
  }
}