Skip to content

Commit 424173b

Browse files
SnaveSutitSnaveSutit
committed
🚧 Internal data structure improvements
- Reduced overall complexity of internal `renderedRig` and `renderedAnimation` structures. - Normalized `snake_case` for most internal data structures and the plugin json export. - Reduced the complexity of plugin json export data. - Updated existing tech to use the updated data structures.
1 parent 995294b commit 424173b

File tree

13 files changed

+586
-719
lines changed

13 files changed

+586
-719
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,4 @@ dist
107107
.tern-port
108108
out/linecounter.txt
109109
out/linecounter.json
110+
testPluginExport.json

‎schemas/pluginJson.schema.json

Lines changed: 83 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"definitions": {
55
"jsonExport": {
66
"type": "object",
7-
"required": ["blueprint_settings", "resources", "rig", "animations"],
7+
"required": ["settings", "nodes", "variants", "textures", "animations"],
88
"properties": {
9-
"blueprint_settings": {
9+
"settings": {
1010
"type": "object",
1111
"required": [
1212
"export_namespace",
@@ -100,114 +100,39 @@
100100
"json_file": { "type": "string", "default": "", "description": "" }
101101
}
102102
},
103-
"resources": {
103+
"nodes": {
104104
"type": "object",
105-
"required": [
106-
"textureExportFolder",
107-
"modelExportFolder",
108-
"displayItemPath",
109-
"models",
110-
"variant_models",
111-
"textures"
112-
],
113-
"properties": {
114-
"textureExportFolder": { "type": "string", "default": "" },
115-
"modelExportFolder": { "type": "string", "default": "" },
116-
"displayItemPath": { "type": "string", "default": "" },
117-
"models": {
118-
"type": "object",
119-
"description": "A map of bone UUIDs to custom bone models. This will be empty if no custom models are used.",
120-
"additionalProperties": false,
121-
"patternProperties": {
122-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
123-
"$ref": "#/definitions/vanillaModel"
124-
}
125-
}
126-
},
127-
"variant_models": {
128-
"type": "object",
129-
"description": "A map of variant UUIDS to maps of models to use for each bone when that variant is applied. Note that this map only contains bones modified and not excluded by the variant.",
130-
"additionalProperties": false,
131-
"patternProperties": {
132-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
133-
"type": "object",
134-
"additionalProperties": false,
135-
"patternProperties": {
136-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
137-
"$ref": "#/definitions/variantModelContainer"
138-
}
139-
}
140-
}
141-
}
142-
},
143-
"textures": {
144-
"type": "object",
145-
"additionalProperties": false,
146-
"patternProperties": {
147-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
148-
"type": "object",
149-
"required": ["name", "expectedPath", "src"],
150-
"properties": {
151-
"name": { "type": "string" },
152-
"id": {
153-
"type": "string",
154-
"description": "The ID of the texture used when making vanilla models."
155-
},
156-
"expectedPath": {
157-
"type": "string",
158-
"description": "The path in the resource pack that the models that reference this texture expect the texture to be at."
159-
},
160-
"src": {
161-
"type": "string",
162-
"description": "A data URL containing the texture image."
163-
}
164-
}
165-
}
166-
}
105+
"additionalProperties": false,
106+
"patternProperties": {
107+
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
108+
"$ref": "#/definitions/node"
167109
}
168110
}
169111
},
170-
"rig": {
112+
"variants": {
171113
"type": "object",
172-
"required": ["node_map", "node_structure", "variants"],
173-
"properties": {
174-
"node_map": {
175-
"type": "object",
176-
"additionalProperties": false,
177-
"patternProperties": {
178-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
179-
"$ref": "#/definitions/node"
180-
}
181-
}
182-
},
183-
"node_structure": {
184-
"type": "object",
185-
"required": ["uuid", "children"],
186-
"properties": {
187-
"uuid": { "const": "root" },
188-
"children": {
189-
"type": "array",
190-
"items": { "$ref": "#/definitions/nodeStructure" }
191-
}
192-
}
193-
},
194-
"variants": {
195-
"type": "object",
196-
"additionalProperties": false,
197-
"description": "A map of variant UUIDs to variant objects.",
198-
"patternProperties": {
199-
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
200-
"$ref": "#/definitions/variant"
201-
}
202-
}
114+
"description": "The Rig's Variants",
115+
"additionalProperties": false,
116+
"patternProperties": {
117+
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
118+
"$ref": "#/definitions/variant"
119+
}
120+
}
121+
},
122+
"textures": {
123+
"type": "object",
124+
"additionalProperties": false,
125+
"patternProperties": {
126+
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
127+
"$ref": "#/definitions/texture"
203128
}
204129
}
205130
},
206131
"animations": { "$ref": "#/definitions/dynamicAnimations" }
207132
},
208133
"if": {
209134
"properties": {
210-
"blueprint_settings": {
135+
"settings": {
211136
"properties": {
212137
"baked_animations": { "const": true }
213138
}
@@ -294,24 +219,28 @@
294219
"texture": { "type": "string" }
295220
}
296221
},
222+
"variantModel": {
223+
"type": "object",
224+
"required": ["parent", "textures"],
225+
"properties": {
226+
"parent": { "type": "string" },
227+
"textures": {
228+
"type": "object",
229+
"patternProperties": { ".+": { "type": "string" } }
230+
}
231+
}
232+
},
297233
"variantModelContainer": {
298234
"type": "object",
299-
"required": ["model", "customModelData", "modelPath", "resourceLocation"],
235+
"required": ["model", "custom_model_data"],
300236
"properties": {
301237
"model": {
302-
"type": "object",
303-
"required": ["parent", "textures"],
304-
"properties": {
305-
"parent": { "type": "string" },
306-
"textures": {
307-
"type": "object",
308-
"patternProperties": { ".+": { "type": "string" } }
309-
}
310-
}
238+
"oneOf": [
239+
{ "$ref": "#/definitions/vanillaModel" },
240+
{ "$ref": "#/definitions/variantModel" }
241+
]
311242
},
312-
"customModelData": { "type": "integer" },
313-
"modelPath": { "type": "string" },
314-
"resourceLocation": { "type": "string" }
243+
"custom_model_data": { "type": "integer" }
315244
}
316245
},
317246
"nodeTransform": {
@@ -369,7 +298,7 @@
369298
},
370299
"node": {
371300
"type": "object",
372-
"required": ["type", "name", "uuid"],
301+
"required": ["type", "name", "default_transform"],
373302
"properties": {
374303
"type": {
375304
"type": "string",
@@ -384,9 +313,8 @@
384313
]
385314
},
386315
"name": { "type": "string" },
387-
"uuid": { "type": "string" },
388316
"parent": { "type": "string" },
389-
"defaultTransform": {
317+
"default_transform": {
390318
"$ref": "#/definitions/nodeTransform",
391319
"description": "The default transformation of the node."
392320
}
@@ -399,30 +327,17 @@
399327
}
400328
},
401329
"then": {
402-
"required": [
403-
"modelPath",
404-
"customModelData",
405-
"resourceLocation",
406-
"boundingBox",
407-
"configs",
408-
"baseScale"
409-
],
330+
"required": ["bounding_box", "configs"],
410331
"properties": {
411332
"modelPath": { "type": "string" },
412-
"customModelData": { "type": "integer" },
413-
"resourceLocation": { "type": "string" },
414-
"boundingBox": {
333+
"bounding_box": {
415334
"type": "object",
416335
"required": ["min", "max"],
417336
"properties": {
418337
"min": { "$ref": "#/definitions/vec3" },
419338
"max": { "$ref": "#/definitions/vec3" }
420339
}
421340
},
422-
"baseScale": {
423-
"type": "number",
424-
"description": "The base scale of the bone, used to offset any rescaling done to the bone's model due to exceeding the 3x3x3 model size limit."
425-
},
426341
"configs": {
427342
"type": "object",
428343
"patternProperties": {
@@ -472,28 +387,16 @@
472387
}
473388
},
474389
"then": {
475-
"required": [
476-
"text",
477-
"lineWidth",
478-
"backgroundColor",
479-
"backgroundAlpha",
480-
"align",
481-
"baseScale",
482-
"config"
483-
],
390+
"required": ["text", "align", "config"],
484391
"properties": {
485392
"text": {},
486-
"lineWidth": { "type": "number" },
487-
"backgroundColor": { "type": "string" },
488-
"backgroundAlpha": { "type": "number" },
393+
"line_width": { "type": "number" },
394+
"background_color": { "type": "string" },
395+
"background_alpha": { "type": "number" },
489396
"align": {
490397
"type": "string",
491398
"enum": ["left", "center", "right"]
492399
},
493-
"baseScale": {
494-
"type": "number",
495-
"description": "The base scale of the bone, used to offset any rescaling done to the bone's model due to exceeding the 3x3x3 model size limit."
496-
},
497400
"config": {
498401
"$ref": "#/definitions/boneConfig"
499402
}
@@ -507,13 +410,9 @@
507410
}
508411
},
509412
"then": {
510-
"required": ["config", "block", "baseScale"],
413+
"required": ["config", "block"],
511414
"properties": {
512415
"block": { "type": "string" },
513-
"baseScale": {
514-
"type": "number",
515-
"description": "The base scale of the bone, used to offset any rescaling done to the bone's model due to exceeding the 3x3x3 model size limit."
516-
},
517416
"config": {
518417
"$ref": "#/definitions/boneConfig"
519418
}
@@ -527,13 +426,9 @@
527426
}
528427
},
529428
"then": {
530-
"required": ["config", "item", "baseScale"],
429+
"required": ["config", "item"],
531430
"properties": {
532431
"item": { "type": "string" },
533-
"baseScale": {
534-
"type": "number",
535-
"description": "The base scale of the bone, used to offset any rescaling done to the bone's model due to exceeding the 3x3x3 model size limit."
536-
},
537432
"config": {
538433
"$ref": "#/definitions/boneConfig"
539434
}
@@ -590,21 +485,21 @@
590485
"type": "object",
591486
"required": [
592487
"name",
593-
"safeName",
488+
"safe_name",
594489
"duration",
595-
"loopDelay",
596-
"loopMode",
490+
"loop_delay",
491+
"loop_mode",
597492
"frames",
598-
"includedNodes"
493+
"modified_nodes"
599494
],
600495
"additionalProperties": false,
601496
"properties": {
602497
"name": { "type": "string" },
603-
"safeName": { "type": "string" },
498+
"safe_name": { "type": "string" },
604499
"duration": { "type": "number" },
605-
"loopDelay": { "type": "number" },
606-
"loopMode": { "type": "string", "enum": ["none", "loop", "ping-pong"] },
607-
"includedNodes": { "type": "array", "items": { "type": "string" } },
500+
"loop_delay": { "type": "number" },
501+
"loop_mode": { "type": "string", "enum": ["none", "loop", "ping-pong"] },
502+
"modified_nodes": { "type": "array", "items": { "type": "string" } },
608503
"frames": {
609504
"type": "array",
610505
"items": {
@@ -740,7 +635,7 @@
740635
"variant": {
741636
"type": "object",
742637
"description": "A variant of the rig. Variants are used to change the appearance of the rig by swapping out different textures at runtime.",
743-
"required": ["name", "display_name", "uuid", "texture_map", "excluded_nodes"],
638+
"required": ["name", "display_name", "models", "texture_map", "excluded_nodes"],
744639
"properties": {
745640
"name": {
746641
"type": "string",
@@ -750,7 +645,6 @@
750645
"type": "string",
751646
"description": "The display name of the variant. Only used for fancy display purposes such as UI elements."
752647
},
753-
"uuid": { "type": "string" },
754648
"texture_map": {
755649
"type": "object",
756650
"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.",
@@ -761,6 +655,15 @@
761655
}
762656
}
763657
},
658+
"models": {
659+
"type": "object",
660+
"additionalProperties": false,
661+
"patternProperties": {
662+
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": {
663+
"$ref": "#/definitions/variantModelContainer"
664+
}
665+
}
666+
},
764667
"excluded_nodes": {
765668
"type": "array",
766669
"description": "A list of node UUIDs that should be excluded / ignored when this variant is applied.",
@@ -808,6 +711,21 @@
808711
"easeOutBounce",
809712
"easeInOutBounce"
810713
]
714+
},
715+
"texture": {
716+
"type": "object",
717+
"required": ["name", "id", "src"],
718+
"properties": {
719+
"name": { "type": "string" },
720+
"id": {
721+
"type": "string",
722+
"description": "The ID of the texture used when making vanilla models."
723+
},
724+
"src": {
725+
"type": "string",
726+
"description": "A data URL containing the texture image."
727+
}
728+
}
811729
}
812730
}
813731
}

0 commit comments

Comments
 (0)