🚧 JSON Exporter

- Added the JSON Exporter.
- Added an option to toggle baked animations in the exported JSON file.

Author: SnaveSutit

TODO.md

@@ -111,6 +111,10 @@
 
 -   [x] Warn the user when they have custom elements in their model, but have disabled the resource pack export.
 
+# Plugin Exporter
+
+-   [x] Add an option to export a JSON file.
+
 # List of numbers to track
 
 -   [ ] Total exports

package.json

@@ -89,6 +89,7 @@
 		"svelte-awesome-color-picker": "^3.0.0-beta.7",
 		"svelte-preprocess": "^5.0.1",
 		"svelte-preprocess-esbuild": "^3.0.1",
+		"ts-json-schema-generator": "^2.3.0",
 		"typescript": "^4.5.5"
 	},
 	"dependencies": {

src/blockbenchTypeMods.d.ts

@@ -4,7 +4,7 @@ import type {
 	IBlueprintBoneConfigJSON,
 	IBlueprintLocatorConfigJSON,
 } from './blueprintFormat'
-import { blueprintSettingErrors } from './blueprintSettings'
+import { blueprintSettingErrors, defaultValues } from './blueprintSettings'
 import { openExportProgressDialog } from './interface/exportProgressDialog'
 import { openUnexpectedErrorDialog } from './interface/unexpectedErrorDialog'
 import { TextDisplay } from './outliner/textDisplay'
@@ -29,31 +29,7 @@ declare module 'three' {
 
 declare global {
 	interface ModelProject {
-		animated_java: {
-			export_namespace: string
-			show_bounding_box: boolean
-			auto_bounding_box: boolean
-			bounding_box: [number, number]
-			// Export Settings
-			enable_plugin_mode: boolean
-			enable_resource_pack: boolean
-			enable_data_pack: boolean
-			// Resource Pack Settings
-			display_item: string
-			customModelDataOffset: number
-			enable_advanced_resource_pack_settings: boolean
-			resource_pack: string
-			display_item_path: string
-			model_folder: string
-			texture_folder: string
-			// Data Pack Settings
-			enable_advanced_data_pack_settings: boolean
-			data_pack: string
-			summon_commands: string
-			interpolation_duration: number
-			teleportation_duration: number
-			use_storage_for_animation: boolean
-		}
+		animated_java: { [T in keyof typeof defaultValues]: (typeof defaultValues)[T] }
 		last_used_export_namespace: string
 		visualBoundingBox?: THREE.LineSegments
 		pluginMode: Valuable<boolean>

src/blueprintFormat.ts

@@ -198,7 +198,7 @@ export const BLUEPRINT_CODEC = new Blockbench.Codec('animated_java_blueprint', {
 		type: 'json',
 	},
 
-	// ANCHOR - Codec:load
+	// region > load
 	load(model: IBlueprintFormatJSON, file) {
 		console.log(`Loading Animated Java Blueprint from '${file.name}'...`)
 		model = process(model)
@@ -211,7 +211,7 @@ export const BLUEPRINT_CODEC = new Blockbench.Codec('animated_java_blueprint', {
 		console.log(`Successfully loaded Animated Java Blueprint`)
 	},
 
-	// ANCHOR - Codec:parse
+	// region > parse
 	// Takes the model file and injects it's data into the global Project
 	parse(model: IBlueprintFormatJSON, path) {
 		console.log(`Parsing Animated Java Blueprint from '${path}'...`)
@@ -369,7 +369,7 @@ export const BLUEPRINT_CODEC = new Blockbench.Codec('animated_java_blueprint', {
 		BLUEPRINT_CODEC.dispatchEvent('parsed', { model })
 	},
 
-	// ANCHOR - Codec:compile
+	// region > compile
 	compile(options) {
 		if (!options) options = {}
 		console.log(`Compiling Animated Java Blueprint from ${Project!.name}...`)
@@ -463,7 +463,7 @@ export const BLUEPRINT_CODEC = new Blockbench.Codec('animated_java_blueprint', {
 		return options.raw ? model : compileJSON(model)
 	},
 
-	// ANCHOR - Codec:export
+	// region > export
 	export() {
 		console.log(`Exporting Animated Java Blueprint for ${Project!.name}...`)
 		if (!Project) throw new Error('No project to export.')

src/blueprintSettings.ts

@@ -1,6 +1,6 @@
 import { Valuable } from './util/stores'
 
-export const defaultValues: ModelProject['animated_java'] = {
+export const defaultValues = {
 	export_namespace: 'blueprint',
 	show_bounding_box: false,
 	auto_bounding_box: true,
@@ -24,6 +24,9 @@ export const defaultValues: ModelProject['animated_java'] = {
 	interpolation_duration: 1,
 	teleportation_duration: 1,
 	use_storage_for_animation: false,
+	// Plugin Settings
+	baked_animations: true,
+	json_file: '',
 }
 
 export const blueprintSettingErrors = new Valuable<Record<string, string>>({})

src/components/blueprintSettingsDialog.svelte

@@ -43,6 +43,9 @@
 	export let interpolationDuration: Valuable<number>
 	export let teleportationDuration: Valuable<number>
 	export let useStorageForAnimation: Valuable<boolean>
+	// Plugin Export Settings
+	export let bakedAnimations: Valuable<boolean>
+	export let jsonFile: Valuable<string>
 
 	function exportNamespaceChecker(value: string): { type: string; message: string } {
 		if (value === '') {
@@ -256,6 +259,25 @@
 		}
 	}
 
+	function jsonFileChecker(value: string): { type: string; message: string } {
+		switch (true) {
+			case value === '':
+				return {
+					type: 'error',
+					message: translate(
+						'dialog.blueprint_settings.json_file.error.no_file_selected',
+					),
+				}
+			case fs.existsSync(value) && !fs.statSync(value).isFile():
+				return {
+					type: 'error',
+					message: translate('dialog.blueprint_settings.json_file.error.not_a_file'),
+				}
+			default:
+				return { type: 'success', message: '' }
+		}
+	}
+
 	function advancedResourcePackFolderChecker(value: string): { type: string; message: string } {
 		switch (true) {
 			case value === '':
@@ -351,6 +373,19 @@
 			bind:value={displayItem}
 			valueChecker={displayItemChecker}
 		/>
+
+		<Checkbox
+			label={translate('dialog.blueprint_settings.baked_animations.title')}
+			tooltip={translate('dialog.blueprint_settings.baked_animations.description')}
+			bind:checked={bakedAnimations}
+		/>
+
+		<FileSelect
+			label={translate('dialog.blueprint_settings.json_file.title')}
+			tooltip={translate('dialog.blueprint_settings.json_file.description')}
+			bind:value={jsonFile}
+			valueChecker={jsonFileChecker}
+		/>
 	{:else}
 		<Checkbox
 			label={translate('dialog.blueprint_settings.enable_resource_pack.title')}

src/interface/animatedJavaBarItem.ts

@@ -89,7 +89,7 @@ MenuBar.addAction(
 		category: 'animated_java',
 		name: translate('action.export.name'),
 		condition() {
-			return Format === BLUEPRINT_FORMAT && !Project?.animated_java.enable_plugin_mode
+			return Format === BLUEPRINT_FORMAT
 		},
 		click() {
 			void exportProject()

src/interface/blueprintSettingsDialog.ts

@@ -55,6 +55,9 @@ function getSettings() {
 		interpolationDuration: new Valuable(Project!.animated_java.interpolation_duration),
 		teleportationDuration: new Valuable(Project!.animated_java.teleportation_duration),
 		useStorageForAnimation: new Valuable(Project!.animated_java.use_storage_for_animation),
+		// Plugin Settings
+		bakedAnimations: new Valuable(Project!.animated_java.baked_animations),
+		jsonFile: new Valuable(Project!.animated_java.json_file),
 	}
 }
 
@@ -91,6 +94,9 @@ function setSettings(settings: ReturnType<typeof getSettings>) {
 	Project.animated_java.interpolation_duration = settings.interpolationDuration.get()
 	Project.animated_java.teleportation_duration = settings.teleportationDuration.get()
 	Project.animated_java.use_storage_for_animation = settings.useStorageForAnimation.get()
+	// Plugin Settings
+	Project.animated_java.baked_animations = settings.bakedAnimations.get()
+	Project.animated_java.json_file = settings.jsonFile.get()
 	console.log('Successfully saved project settings', Project)
 }
 

src/lang/en.yml

@@ -143,6 +143,18 @@ animated_java.dialog.blueprint_settings.use_storage_for_animation.description: |
     This will vastly reduce the number of functions in the generated Data Pack, but is 33% slower than the function method.
     WARNING: This animation method does not support cameras, or locators!
 
+# Plugin Settings
+animated_java.dialog.blueprint_settings.baked_animations.title: Baked Animations
+animated_java.dialog.blueprint_settings.baked_animations.description: |-
+    Whether or not to bake the exported animations.
+    Baked animations have their frames pre-calculated and stored in the exported JSON file, reducing the complexity of rendering the model in-game.
+    Some Plugins may require this to be enabled to function correctly.
+
+animated_java.dialog.blueprint_settings.json_file.title: JSON File
+animated_java.dialog.blueprint_settings.json_file.description: The path to the JSON file to export the project to.
+animated_java.dialog.blueprint_settings.json_file.error.no_file_selected: No file selected!
+animated_java.dialog.blueprint_settings.json_file.error.not_a_file: The selected path is not a file!
+
 ## Bone Config Dialog
 animated_java.dialog.bone_config.title: Bone Config
 

src/systems/exporter.ts

@@ -7,6 +7,7 @@ import { resolveEnvVariables } from '../util/misc'
 import { translate } from '../util/translation'
 import { hashAnimations, renderProjectAnimations } from './animationRenderer'
 import { compileDataPack } from './datapackCompiler'
+import { exportJSON } from './jsonExporter'
 import { compileResourcePack } from './resourcepackCompiler'
 import { renderRig, hashRig } from './rigRenderer'
 
@@ -25,9 +26,20 @@ async function actuallyExportProject(forceSave = true) {
 		const resourcePackFolder = resolveEnvVariables(aj.resource_pack)
 		const dataPackFolder = resolveEnvVariables(aj.data_pack)
 
-		console.log('Exporting to', resourcePackFolder, dataPackFolder)
-
-		if (aj.enable_advanced_resource_pack_settings) {
+		if (aj.enable_plugin_mode) {
+			modelExportFolder = PathModule.join(
+				'assets/animated_java/models/item/',
+				aj.export_namespace
+			)
+			textureExportFolder = PathModule.join(
+				'assets/animated_java/textures/item/',
+				aj.export_namespace
+			)
+			displayItemPath = PathModule.join(
+				'assets/minecraft/models/item/',
+				aj.display_item.split(':').at(-1)! + '.json'
+			)
+		} else if (aj.enable_advanced_resource_pack_settings) {
 			modelExportFolder = aj.model_folder
 			textureExportFolder = aj.texture_folder
 			displayItemPath = aj.display_item_path
@@ -69,23 +81,34 @@ async function actuallyExportProject(forceSave = true) {
 		const rigHash = hashRig(rig)
 		const animationHash = hashAnimations(animations)
 
-		if (aj.enable_resource_pack) {
-			compileResourcePack({
+		if (aj.enable_plugin_mode) {
+			exportJSON({
 				rig,
 				animations,
 				displayItemPath,
-				resourcePackFolder,
 				textureExportFolder,
 				modelExportFolder,
-				dataPackFolder,
 			})
+		} else {
+			if (aj.enable_resource_pack) {
+				compileResourcePack({
+					rig,
+					animations,
+					displayItemPath,
+					resourcePackFolder,
+					textureExportFolder,
+					modelExportFolder,
+					dataPackFolder,
+				})
+			}
+
+			if (aj.enable_data_pack) {
+				await compileDataPack({ rig, animations, dataPackFolder, rigHash, animationHash })
+			}
+
+			Project!.last_used_export_namespace = aj.export_namespace
 		}
 
-		if (aj.enable_data_pack) {
-			await compileDataPack({ rig, animations, dataPackFolder, rigHash, animationHash })
-		}
-
-		Project!.last_used_export_namespace = aj.export_namespace
 		console.timeEnd('Exporting project took')
 
 		if (forceSave) saveBlueprint()