Heracles Embeds

Heracles Embeds

Heracles Embeds is a client-side add-on for Heracles/Odyssey Quests on Minecraft 1.20.1. It adds rich content tags to the display.description field of quest JSON files.

It does not use JEI, REI, or EMI. Recipe data comes from Minecraft's client-side RecipeManager, which is synchronized by the server when the player joins.

Description tags

Each tag must be its own description line. Because the description is JSON, double quotes inside a tag must be escaped as \".

"description": [
  "Bring three diamonds:",
  "<embed-item id=\"minecraft:diamond\" count=\"3\" show-name=\"true\"/>",
  "<embed-entity type=\"minecraft:armor_stand\" scale=\"1.2\"/>",
  "<embed-mob type=\"minecraft:zombie\"/>",
  "<embed-recipe id=\"minecraft:diamond_pickaxe\"/>"
]

The add-on also accepts the shorter aliases item, entity, entity-model, mob, recipe, and crafting-recipe.

Items

<embed-item id="minecraft:diamond" count="3" scale="1.5" show-name="true"/>

Supported attributes: id, count, scale, align, show-name, label, tooltip, tag, and nbt. Alignment can be left, middle, or right. Item tooltips are enabled by default.

Entity models and mobs

<embed-entity type="minecraft:armor_stand" scale="1.2" show-name="true"/>
<embed-mob type="minecraft:creeper" scale="1.0"/>

Both tags render a live LivingEntity model that follows the cursor. embed-mob shows the entity name by default, while embed-entity does not. Supported attributes: type, scale, align, show-name, label, tag/nbt, width, height, and vshift.

Recipes

<embed-recipe id="minecraft:diamond_pickaxe" grid-width="3" show-name="true"/>

The renderer is recipe-type agnostic: it displays the ingredients and result exposed by any recipe registered and synchronized by Minecraft, including modded recipes. Ingredient alternatives rotate once per second. Supported attributes: id, grid-width, align, show-name, and label.

NBT in JSON/XML

Simple SNBT does not need nested quotes:

"<embed-item id=\"minecraft:diamond_sword\" nbt=\"{Damage:10}\"/>"

For SNBT containing quoted strings, XML-encode the inner quotes as ":

"<embed-mob type=\"minecraft:zombie\" nbt=\"{CustomName:'{"text":"Bob"}'}\"/>"

Building

Java 17 is required.

./gradlew build

The remapped jars are written to fabric/build/libs and forge/build/libs.

The project compiles against the official Heracles 1.1.10 Maven artifact and targets runtime versions 1.1.10 through 1.1.13. Heracles 1.1.13 is the recommended runtime version.