🚧 Reference Variants by UUID instead of name

- Changed `variantModels` keys to Variant UUIDs instead of names.
- Updated Plugin JSON schema to include the above change.
- Fixed Plugin JSON Schema including outdated blueprint setting definitions for `enable_resource_pack` and `enable_data_pack`.

Author: SnaveSutit

schemas/jsonExport.schema.json

@@ -14,8 +14,8 @@
 						"auto_bounding_box",
 						"bounding_box",
 						"enable_plugin_mode",
-						"enable_resource_pack",
-						"enable_data_pack",
+						"resource_pack_export_mode",
+						"data_pack_export_mode",
 						"display_item",
 						"custom_model_data_offset",
 						"enable_advanced_resource_pack_settings",
@@ -48,8 +48,16 @@
 							"maxItems": 2
 						},
 						"enable_plugin_mode": { "type": "boolean", "default": false },
-						"enable_resource_pack": { "type": "boolean", "default": true },
-						"enable_data_pack": { "type": "boolean", "default": true },
+						"resource_pack_export_mode": {
+							"type": "string",
+							"default": "raw",
+							"enum": ["raw", "zip", "none"]
+						},
+						"data_pack_export_mode": {
+							"type": "string",
+							"default": "raw",
+							"enum": ["raw", "zip", "none"]
+						},
 						"display_item": { "type": "string", "default": "minecraft:white_dye" },
 						"custom_model_data_offset": { "type": "integer", "default": 0 },
 						"enable_advanced_resource_pack_settings": {
@@ -102,7 +110,7 @@
 							"description": "A map of variant names to maps of models to use for each bone when that variant is applied. Note that this map only contains included, and modified bones.",
 							"additionalProperties": false,
 							"patternProperties": {
-								"[a-zA-Z0-9_\\.]+": {
+								"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
 									"type": "object",
 									"additionalProperties": false,
 									"patternProperties": {
@@ -176,6 +184,16 @@
 									"items": { "$ref": "#/definitions/nodeStructure" }
 								}
 							}
+						},
+						"variants": {
+							"type": "object",
+							"additionalProperties": false,
+							"description": "A map of variant UUIDs to variant objects.",
+							"patternProperties": {
+								"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
+									"$ref": "#/definitions/variant"
+								}
+							}
 						}
 					}
 				},
@@ -670,6 +688,37 @@
 				"repeat": { "type": "boolean" },
 				"repeat_frequency": { "type": "number", "min": 1 }
 			}
+		},
+		"variant": {
+			"type": "object",
+			"description": "A variant of the rig. Variants are used to change the appearance of the rig by swapping out different textures at runtime.",
+			"required": ["name", "display_name", "uuid", "texture_map", "excluded_nodes"],
+			"properties": {
+				"name": {
+					"type": "string",
+					"description": "The name of the variant."
+				},
+				"display_name": {
+					"type": "string",
+					"description": "The display name of the variant. Only used for fancy display purposes such as UI elements."
+				},
+				"uuid": { "type": "string" },
+				"texture_map": {
+					"type": "object",
+					"description": "A map of default texture UUID -> variant texture UUID. If a texture is not in this map, it will be assumed to be the same as the default texture.",
+					"patternProperties": {
+						"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
+							"type": "string",
+							"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+						}
+					}
+				},
+				"excluded_nodes": {
+					"type": "array",
+					"description": "A list of node UUIDs that should be excluded / ignored when this variant is applied.",
+					"items": { "type": "string" }
+				}
+			}
 		}
 	}
 }

src/systems/datapackCompiler/animation.mcb

@@ -656,10 +656,10 @@ dir <%export_namespace%> {
 							function *global/errors/function_not_executed_as_root_entity \
 								{'function_path': 'animated_java:<%export_namespace%>/variants/<%variant.name%>/apply'}
 						REPEAT (Object.values(rig.nodeMap)) as node {
-							IF (node.type === 'bone' && !Object.values(variant.excludedNodes).find(v => v.value === node.node.uuid) && (rig.variantModels[variant.name][node.node.uuid] !== undefined || node.configs.variants[variant.uuid])) {
+							IF (node.type === 'bone' && !Object.values(variant.excludedNodes).find(v => v.value === node.node.uuid) && (rig.variantModels[variant.uuid][node.node.uuid] !== undefined || node.configs.variants[variant.uuid])) {
 								execute on passengers if entity @s[tag=aj.<%export_namespace%>.bone.<%node.name%>] run {
-									IF (rig.variantModels[variant.name][node.node.uuid] !== undefined) {
-										data modify entity @s item.components.minecraft:custom_model_data set value <%rig.variantModels[variant.name][node.node.uuid].customModelData%>
+									IF (rig.variantModels[variant.uuid][node.node.uuid] !== undefined) {
+										data modify entity @s item.components.minecraft:custom_model_data set value <%rig.variantModels[variant.uuid][node.node.uuid].customModelData%>
 									}
 									IF (node.configs.variants[variant.uuid]) {
 										<%%

src/systems/exporter.ts

@@ -8,7 +8,7 @@ import { translate } from '../util/translation'
 import { Variant } from '../variants'
 import { hashAnimations, renderProjectAnimations } from './animationRenderer'
 import { compileDataPack } from './datapackCompiler'
-import { exportJSON } from './jsonExporter'
+import { exportJSON } from './jsonCompiler'
 import { compileResourcePack } from './resourcepackCompiler'
 import { renderRig, hashRig } from './rigRenderer'
 

src/systems/jsonExporter.ts renamed to src/systems/jsonCompiler.ts

@@ -2,9 +2,11 @@
 /// <reference path="D:/github-repos/snavesutit/blockbench-types/types/index.d.ts"/>
 /// <reference path="../global.d.ts"/>
 
+import { IBlueprintVariantJSON } from '../blueprintFormat'
 import { type defaultValues } from '../blueprintSettings'
 import { EasingKey } from '../util/easing'
 import { detectCircularReferences, scrubUndefined } from '../util/misc'
+import { Variant } from '../variants'
 import type { IAnimationNode, IRenderedAnimation, IRenderedFrame } from './animationRenderer'
 import type {
 	AnyRenderedNode,
@@ -82,6 +84,7 @@ export interface IExportedJSON {
 		default_pose: ExportedAnimationNode[]
 		node_map: Record<string, ExportedRenderedNode>
 		node_structure: INodeStructure
+		variants: Record<string, IBlueprintVariantJSON>
 	}
 	/**
 	 * If `blueprint_settings.baked_animations` is true, this will be an array of `ExportedAnimation` objects. Otherwise, it will be an array of `AnimationUndoCopy` objects, just like the `.bbmodel`'s animation list.
@@ -133,6 +136,9 @@ export function exportJSON(options: {
 				Object.entries(rig.nodeMap).map(([key, node]) => [key, serailizeRenderedNode(node)])
 			),
 			node_structure: rig.nodeStructure,
+			variants: Object.fromEntries(
+				Variant.all.map(variant => [variant.uuid, variant.toJSON()])
+			),
 		},
 		animations: aj.baked_animations
 			? animations.map(serializeAnimation)

src/systems/resourcepackCompiler.ts

@@ -1,6 +1,6 @@
 import { MAX_PROGRESS, PROGRESS, PROGRESS_DESCRIPTION } from '../interface/exportProgressDialog'
 import { isResourcePackPath, toSafeFuntionName } from '../util/minecraftUtil'
-import { TRANSPARENT_TEXTURE } from '../variants'
+import { TRANSPARENT_TEXTURE, Variant } from '../variants'
 import { IRenderedNodes, IRenderedRig } from './rigRenderer'
 import { sortObjectKeys, zip } from './util'
 
@@ -292,14 +292,22 @@ export async function compileResourcePack(options: {
 	)
 
 	// Variant Models
-	for (const [variantName, models] of Object.entries(rig.variantModels)) {
+	for (const [variantUUID, models] of Object.entries(rig.variantModels)) {
+		const variant = Variant.all.find(v => v.uuid === variantUUID)
+		if (!variant) {
+			console.error(
+				`Variant ${variantUUID} not found while exporting variant models:`,
+				models
+			)
+			continue
+		}
 		for (const [boneUuid, variantModel] of Object.entries(models)) {
 			const bone = rig.nodeMap[boneUuid] as IRenderedNodes['Bone']
 			variantModel.customModelData = displayItemModel.addOverride(
 				variantModel.resourceLocation
 			)
 			exportedFiles.set(
-				PathModule.join(modelExportFolder, variantName, bone.name + '.json'),
+				PathModule.join(modelExportFolder, variant.name, bone.name + '.json'),
 				autoStringify(variantModel.model)
 			)
 		}

src/systems/rigRenderer.ts

@@ -154,7 +154,7 @@ export interface IRenderedRig {
 	 */
 	models: Record<string, IRenderedModel>
 	/**
-	 * A map of variant names to maps of rendered models
+	 * A map of variant UUIDs to maps of rendered models
 	 */
 	variantModels: Record<string, Record<string, IRenderedBoneVariant>>
 	/**
@@ -729,7 +729,7 @@ export function renderRig(modelExportFolder: string, textureExportFolder: string
 
 	for (const variant of Variant.all) {
 		if (variant.isDefault) continue // Don't export the default variant, it's redundant data.
-		rig.variantModels[variant.name] = renderVariantModels(variant, rig)
+		rig.variantModels[variant.uuid] = renderVariantModels(variant, rig)
 	}
 
 	TEXTURE_RESOURCE_LOCATION_CACHE.clear()

src/variants.ts

@@ -136,8 +136,8 @@ export class Variant {
 
 	public toJSON(): IBlueprintVariantJSON {
 		return {
-			display_name: this.displayName,
 			name: this.name,
+			display_name: this.displayName,
 			uuid: this.uuid,
 			texture_map: Object.fromEntries(this.textureMap.map),
 			excluded_nodes: this.excludedNodes.map(item => item.value),

test_blueprints/armor_stand.ajblueprint

@@ -1,7 +1,7 @@
 {
 	"meta": {
 		"format": "animated_java_blueprint",
-		"format_version": "0.5.9",
+		"format_version": "0.5.10",
 		"uuid": "167b27cd-b559-3f13-a97c-0841fe21f1d1",
 		"save_location": "D:\\github-repos\\animated-java\\animated-java\\test_blueprints\\armor_stand.ajblueprint",
 		"last_used_export_namespace": "armor_stand"
@@ -11,7 +11,7 @@
 		"show_bounding_box": false,
 		"auto_bounding_box": true,
 		"bounding_box": [95, 32],
-		"enable_plugin_mode": false,
+		"enable_plugin_mode": true,
 		"resource_pack_export_mode": "raw",
 		"data_pack_export_mode": "raw",
 		"display_item": "minecraft:white_dye",
@@ -27,7 +27,7 @@
 		"interpolation_duration": 1,
 		"teleportation_duration": 1,
 		"use_storage_for_animation": false,
-		"baked_animations": true,
+		"baked_animations": false,
 		"json_file": "D:\\github-repos\\animated-java\\animated-java\\dist\\test.json",
 		"customModelDataOffset": 0,
 		"custom_summon_commands": ""
@@ -1594,16 +1594,16 @@
 	],
 	"variants": {
 		"default": {
-			"display_name": "Default",
 			"name": "default",
+			"display_name": "Default",
 			"uuid": "99583e4c-1e3a-b03f-a802-1b5212a6eedb",
 			"texture_map": {},
 			"excluded_nodes": []
 		},
 		"list": [
 			{
-				"display_name": "no_armor",
 				"name": "no_armor",
+				"display_name": "no_armor",
 				"uuid": "5417306e-2c69-3f36-1e3c-edd904034a36",
 				"texture_map": {
 					"240844f3-f615-fe51-0ada-d208791fbdc0": "797174ae-5c58-4a83-a630-eefd51007c80",
@@ -1612,8 +1612,8 @@
 				"excluded_nodes": []
 			},
 			{
-				"display_name": "no_baseplate",
 				"name": "no_baseplate",
+				"display_name": "no_baseplate",
 				"uuid": "bf2a6915-ec63-7ccf-3844-ea8be00b97e6",
 				"texture_map": {
 					"eb6c49b8-8e8e-a039-9a6f-ef6a06bc7924": "797174ae-5c58-4a83-a630-eefd51007c80"
@@ -1633,8 +1633,8 @@
 				]
 			},
 			{
-				"display_name": "colors",
 				"name": "colors",
+				"display_name": "colors",
 				"uuid": "49521f4b-b970-e4bd-b594-2e05d2d46027",
 				"texture_map": {},
 				"excluded_nodes": []