Recipe book config

Guide how to generate the recipe book.

The plugin comes with an integrated smart recipe book. It supports (infinitely deep) categories. An additional feature is when you click on an item in a recipe ingredient matrix that is craftable by another recipe in the plugin, it will take the player to that recipe when the player clicks on the ingredient.

The categories are defined in the recipe_book.yml file. Every category has:

id: Unique ID of the category. Used in the /recipes open-category command.
files: List of blueprint files whose recipes should be in this category. The path is relative to the blueprints folder, without the .yml extension (for example aurora/_example or vanilla/furnace/_example).
recipes: List of recipe IDs to put in this category. You can use it in combination with the files option. Recipes listed here come first, in the order you list them.
menu: The title of the category menu and the item that represents the category in the parent menu.
categories: Subcategories. A category with subcategories shows its subcategories instead of recipes.

Here is the default category configuration:

categories:
  - id: custom_recipes
    files:
      - "aurora/_example"
    menu:
      title: "Custom recipes"
      item:
        material: diamond
        name: "&6Custom recipes"
        slot: 10
  - id: vanilla_recipes
    menu:
      title: "Vanilla recipes"
      item:
        material: emerald
        name: "&6Vanilla recipes"
        slot: 11
    categories:
      - id: my_smithing_recipes
        files:
          - "vanilla/smithing_table/_example"
        menu:
          title: "Smithing recipes"
          item:
            material: smithing_table
            name: "&6Smithing recipes"
            slot: 10
      - id: my_crafting_recipes
        files:
          - "vanilla/crafting_table/_example"
        menu:
          title: "Crafting recipes"
          item:
            material: crafting_table
            name: "&6Crafting recipes"
            slot: 11
      - id: my_furnace_recipes
        files:
          - "vanilla/furnace/_example"
        menu:
          title: "Furnace recipes"
          item:
            material: furnace
            name: "&6Furnace recipes"
            slot: 12
      - id: my_blast_furnace_recipes
        files:
          - "vanilla/blast_furnace/_example"
        menu:
          title: "Blast furnace recipes"
          item:
            material: blast_furnace
            name: "&6Blast furnace recipes"
            slot: 13
      - id: my_smoker_recipes
        files:
          - "vanilla/smoker/_example"
        menu:
          title: "Smoker recipes"
          item:
            material: smoker
            name: "&6Smoker recipes"
            slot: 14
      - id: my_campfire_recipes
        files:
          - "vanilla/campfire/_example"
        menu:
          title: "Campfire recipes"
          item:
            material: campfire
            name: "&6Campfire recipes"
            slot: 15
      - id: my_stone_cutter_recipes
        files:
          - "vanilla/stone_cutter/_example"
        menu:
          title: "Stonecutter recipes"
          item:
            material: stonecutter
            name: "&6Stonecutter recipes"
            slot: 20
      - id: my_cauldron_recipes
        files:
          - "vanilla/cauldron/_example"
        menu:
          title: "Cauldron recipes"
          item:
            material: cauldron
            name: "&6Cauldron recipes"
            slot: 16
      - id: my_brewing_recipes
        files:
          - "vanilla/brewing_stand/_example"
        menu:
          title: "Brewing recipes"
          item:
            material: brewing_stand
            name: "&6Brewing recipes"
            slot: 19

Recipe book menus

The look of the recipe book is configured in the menus folder:

menus/recipe_book.yml - The main recipe book menu (opened with /recipes). Options: title, rows, append-lore (lines added to every category item), filler and custom-items.
menus/recipe_book_category.yml - The menu of a category that lists its subcategories or recipes. Options: rows, category-icon (shows the category item in the given slot), append-lore (lines added to every recipe item), display-area (slots where the recipes/subcategories are shown), secret-recipe-display, filler, items (back, next-page, previous-page, current-page) and custom-items.
menus/vanilla_recipe_view/*.yml - The recipe view menus for recipes of vanilla workstations (crafting table, smithing table, furnace, blast furnace, smoker, campfire, stonecutter, cauldron and brewing stand). Here you can change the title, rows, slots of the ingredients/result/next/previous buttons and the items.

The recipe view of custom workbench recipes is configured in the recipe-book section of the workbench config.

If secret-recipe-display is enabled, recipes that the player hasn't unlocked yet (no permission) are shown with the configured item instead of the recipe, and the locked-lore of the recipe is added to it:

secret-recipe-display:
  enabled: true
  item:
    name: "&c???"
    material: gray_dye
    lore:
      - "&7You have not unlocked this recipe yet."

If it is disabled, locked recipes are displayed normally, with the locked-lore of the recipe (from display-options) added to the item lore.