Syntax

Below you can find the syntax for the JSON recipe.

Recipe Schema

{
  "$schema": "https://legopitstop.github.io/Minecraft-Recipe-Display/schema.json"
}

Root

Name	Required	Type	Description
description	No	Description	Data that may be needed.
resources	No	Resources	A list of resrouce locations for tags, textures, and lang files.
recipes	Yes	ArrayRecipes	A list of recipes to add to the document.

Description

Name	Required	Default	Type	Description
id	Yes		Enum: recipe	The id that will be used to apply the recipes. You must have an empty div that matches this id inside the HTML.
theme	No	light	Enum: light, dark	The theme to use for the GUI.
title	No	Minecraft Recipe Display	String	The tab title in the browser. Will end with '| recipes'
msgbox	No		msgbox	A msg box to display text to the user

Resources

Where to get different resources depending on the item namespace ID.

Name	Required	Type
textures	Yes	Textures
langs	Yes	Langs
links	Yes	Links

Examples

• default.json
• recipes.json

{
  "resrouces": {
    "textures": {
      "minecraft": {
        "type": "spritesheet",
        "file": ""
      }
    },
    "langs": {
      "minecraft": ""
    },
    "links": {
      "minecraft": "https://minecraft.wiki/w/${NAME.WIKI}"
    }
  }
}

---

Textures

A map of the namespace id and the file location/url to grab the texture from

Name	Default	Type	Description
minecraft	"file":"https://cdn.jsdelivr.net/gh/legopitstop/Javascript/libs/Sprite/minecraft/sprite.json"	Object or String	Built-in location to get textures
<namespace>		Object or String	The location to get the textures

Examples

{
  "textures": {
    "minecraft": {
      "type": "spritesheet",
      "file": "https://cdn.jsdelivr.net/gh/legopitstop/Javascript/libs/Sprite/minecraft/sprite.json"
    }
  }
}

---

Langs

A map of the namespace id and the file location/url to grab the lang from.

Name	Default	Type	Description
minecraft	/assets/1.17/assets/${NAMESPACEID}/lang/en_us.json	String	Built-in location to get langs
<namespace>		String	The location to get the langs

Examples

{
  "langs": {
    "minecraft": "/assets/1.17/assets/${NAMESPACEID}/lang/en_us.json"
  }
}

---

Links

A map of the namespace id and the file location/url to link to.

Name	Default	Type	Description
minecraft	https://minecraft.wiki/w/${NAME.WIKI}	String	Built-in location to get langs
<namespace>		String	The location to get the langs

Examples

{
  "links": {
    "minecraft": "https://minecraft.wiki/w/${NAME.WIKI}"
  }
}

---

Varables

A list of variables that will get replaced in the string.

Varable	Description	Example
${NAME}	The name of the item	stone_bricks
${NAMESPACE}	The namespace of the item	minecraft
${WIKINAME}	The name of the itme in WIKI format	Stone_Bricks
${LANG}	The lang of the page &lang=<lang> at the end of url	en_us

---

Recipes

Recipe schema is similar to Minecraft Java Edition's

Required	Name	Default	Type	Description
No	description		String	The description of the recipe. Supports markdown formatting!
Yes	identifier		String	It is recomnded to include an id for your recipe, It can be useful for debuging if you are missing a required key.
Yes	type		Enum	The type of recipe to use.
No	group		String	The group to place this recipe in.

Recipe Type

Allowed Values
minecraft:crafting_shaped
minecraft:crafting_shapeless
minecraft:smelting
minecraft:blasting
minecraft:smoking
minecraft:campfire_cooking
minecraft:stonecutting
minecraft:smithing

---

Crafting Shapeless

Additional properties

Required	Name	Type	Description
Yes	identifier	String	The id of the recipe
No	description	RAW JSON	The description of the recipe
Yes	ingredients	Array	A list of ingredients
Yes	result	Object	The resulting recipe.

Example

{
  "identifier": "minecraft:flint_and_steel",
  "ingredients": [
    {
      "item": "minecraft:flint",
      "count": 1
    },
    {
      "item": "minecraft:iron_ingot",
      "count": 1
    }
  ],
  "result": {
    "item": "minecraft:flint_and_steel",
    "count": 1
  }
}

---

Crafting Shaped

Additional properties

Required	Name	Type	Description
Yes	identifier	String	The id of the recipe
No	description	RAW JSON	The description of the recipe
Yes	pattern	Array	The pattern to insert the keys.
Yes	key	Object	Contains the keys for the pattern.
Yes	result	Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone_brick_wall",
  "pattern": ["###", "###"],
  "key": {
    "#": {
      "item": "minecraft:stone_bricks"
    }
  },
  "result": {
    "item": "minecraft:stone_brick_wall",
    "count": 6
  }
}

---

Smelting

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	ingredients		Object	A list of ingredients
No	experience	0.1	Number	The amount of experiance you get from smelting an item.
No	cookingtime	200	Number	The number of ticks it takes to cook this item.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone",
  "ingredients": {
    "item": "minecraft:stone"
  },
  "experience": 0.1,
  "cookingtime": 200,
  "result": {
    "item": "minecraft:stone"
  }
}

---

Blasting

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	ingredients		Object	A list of ingredients
No	experience	0.1	Number	The amount of experiance you get from smelting an item.
No	cookingtime	200	Number	The number of ticks it takes to cook this item.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone",
  "ingredients": {
    "item": "minecraft:stone"
  },
  "experience": 0.1,
  "cookingtime": 200,
  "result": {
    "item": "minecraft:stone"
  }
}

---

Smoking

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	ingredients		Object	A list of ingredients
No	experience	0.1	Number	The amount of experiance you get from smelting an item.
No	cookingtime	200	Number	The number of ticks it takes to cook this item.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone",
  "ingredients": {
    "item": "minecraft:stone"
  },
  "experience": 0.1,
  "cookingtime": 200,
  "result": {
    "item": "minecraft:stone"
  }
}

---

Campfire Cooking

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	ingredients		Object	A list of ingredients
No	experience	0.1	Number	The amount of experiance you get from smelting an item.
No	cookingtime	200	Number	The number of ticks it takes to cook this item.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone",
  "ingredients": {
    "item": "minecraft:stone"
  },
  "experience": 0.1,
  "cookingtime": 200,
  "result": {
    "item": "minecraft:stone"
  }
}

---

Stonecutting

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	ingredients		Object	A list of ingredients
No	count	1	Integer [1-64]	The number of items to give.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:stone_brick_wall_from_stonecutter",
  "ingredients": {
    "item": "minecraft:stone_bricks"
  },
  "result": {
    "item": "minecraft:stone_brick_wall"
  },
  "count": 1
}

---

Smithing

Additional properties

Required	Name	Default	Type	Description
Yes	identifier		String	The id of the recipe
No	description		RAW JSON	The description of the recipe
Yes	base		Object	The base item
Yes	addition		Object	The item that you add to the base item.
Yes	result		Object	The resulting recipe.

Example

{
  "identifier": "minecraft:netherite_pickaxe",
  "base": {
    "item": "minecraft:diamond_pickaxe"
  },
  "addition": {
    "item": "minecraft:netherite_ingot"
  },
  "result": {
    "item": "minecraft:netherite_pickaxe"
  }
}

---

Item Count

Required	Name	Default	Type	Description
Yes	item		String	The item to give.
No	count	1	Integer [1-64]	The number of items to give.

Example

{
  "item": "minecraft:stone",
  "count": 2
}

---

Item

Required	Name	Default	Type	Description
Yes	item		String	The item to give.

Example

"item": "minecraft:stone"

---

Pattern

pattern is an array (1-3) items. Values inside array match the values in key max of 3 characters per item. Use a space as an empty slot.

Examples

{
  "pattern": ["###", "###"]
}

{
  "pattern": ["#"]
}

{
  "pattern": ["###", "###", "###"]
}

---

Key

key defines the characters inside pattern.

Examples

{
  "key": {
    "#": {
      "item": "minecraft:stone"
    }
  }
}

---

Msgbox

Required	Name	Default	Type	Description
No	icon		String	The image to use as a icon.
No	color		String	The color for the msgbox. Must be a 6 digit hex
Yes	contents		RAW JSON	The contents of the msgbox, supports RAW JSON

Examples

{
  "icon": "./assets/favicon.png",
  "color": "#ff0000",
  "contents": {
    "text": "A msg box",
    "bold": true,
    "underlined": true
  }
}