🎉 Versioned Exporting

Allow the user to select a specific Minecraft version to target when exporting.

# Changes
- Created versioned data pack and resource pack compilers.
- Added a Target Minecraft Version blueprint setting.
- Added support for Minecraft 1.20.4.
- Added support for Minecraft 1.20.5.
- Added support for Minecraft 1.21.2.

# Fixes
- Fixed "default is not defined" error when attempting to export a newly converted blueprint.
- Disabled broken zip export modes (will re-enable when fixed).
- Fixed missing default values in locator config UI.
- Fixed bone config types to ensure they're considered optional.
- Updated the packager ESBuild plugin to only copy over prod builds.

Author: SnaveSutit

src/blockbenchTypeMods.d.ts

@@ -8,8 +8,8 @@ import { blueprintSettingErrors, defaultValues } from './blueprintSettings'
 import { openExportProgressDialog } from './interface/exportProgressDialog'
 import { openUnexpectedErrorDialog } from './interface/unexpectedErrorDialog'
 import { TextDisplay } from './outliner/textDisplay'
-import { compileDataPack } from './systems/datapackCompiler'
-import { compileResourcePack } from './systems/resourcepackCompiler'
+import datapackCompiler from './systems/datapackCompiler'
+import resourcepackCompiler from './systems/resourcepackCompiler'
 import { MINECRAFT_REGISTRY } from './systems/minecraft/registryManager'
 import { isDataPackPath, isResourcePackPath } from './util/minecraftUtil'
 import { Valuable } from './util/stores'
@@ -87,8 +87,8 @@ declare global {
 
 	const AnimatedJava: {
 		API: {
-			compileDataPack: typeof compileDataPack
-			compileResourcePack: typeof compileResourcePack
+			compileDataPack: typeof datapackCompiler
+			compileResourcePack: typeof resourcepackCompiler
 			Variant: typeof Variant
 			MINECRAFT_REGISTRY: typeof MINECRAFT_REGISTRY
 			openExportProgressDialog: typeof openExportProgressDialog

src/blueprintSettings.ts

@@ -1,3 +1,4 @@
+import { type MinecraftVersion } from './systems/datapackCompiler/mcbFiles'
 import { Valuable } from './util/stores'
 
 export type ExportMode = 'raw' | 'zip' | 'none'
@@ -11,6 +12,7 @@ export const defaultValues = {
 	enable_plugin_mode: false,
 	resource_pack_export_mode: 'raw' as ExportMode,
 	data_pack_export_mode: 'raw' as ExportMode,
+	target_minecraft_version: '1.21.2' as MinecraftVersion,
 	// Resource Pack Settings
 	display_item: 'minecraft:white_dye',
 	custom_model_data_offset: 0,

src/components/blueprintSettingsDialog.svelte

@@ -33,6 +33,7 @@
 
 <script lang="ts">
 	import { defaultValues } from '../blueprintSettings'
+	import mcbFiles from '../systems/datapackCompiler/mcbFiles'
 
 	export let blueprintName: Valuable<string>
 	export let textureSizeX: Valuable<number>
@@ -42,6 +43,7 @@
 	export let enablePluginMode: Valuable<boolean>
 	export let resourcePackExportMode: Valuable<string>
 	export let dataPackExportMode: Valuable<string>
+	export let targetMinecraftVersion: Valuable<string>
 	// Bounding Box
 	export let showBoundingBox: Valuable<boolean>
 	export let autoBoundingBox: Valuable<boolean>
@@ -560,12 +562,20 @@
 			valueChecker={jsonFileChecker}
 		/>
 	{:else}
+		<Select
+			label={translate('dialog.blueprint_settings.target_minecraft_version.title')}
+			tooltip={translate('dialog.blueprint_settings.target_minecraft_version.description')}
+			options={Object.fromEntries(Object.keys(mcbFiles).map(v => [v, v]))}
+			defaultOption={Object.keys(mcbFiles).at(-1) || '1.21.1'}
+			bind:value={targetMinecraftVersion}
+		/>
+
 		<Select
 			label={translate('dialog.blueprint_settings.resource_pack_export_mode.title')}
 			tooltip={translate('dialog.blueprint_settings.resource_pack_export_mode.description')}
 			options={{
 				raw: translate('dialog.blueprint_settings.resource_pack_export_mode.options.raw'),
-				zip: translate('dialog.blueprint_settings.resource_pack_export_mode.options.zip'),
+				// zip: translate('dialog.blueprint_settings.resource_pack_export_mode.options.zip'),
 				none: translate('dialog.blueprint_settings.resource_pack_export_mode.options.none'),
 			}}
 			defaultOption={'raw'}
@@ -577,7 +587,7 @@
 			tooltip={translate('dialog.blueprint_settings.data_pack_export_mode.description')}
 			options={{
 				raw: translate('dialog.blueprint_settings.data_pack_export_mode.options.raw'),
-				zip: translate('dialog.blueprint_settings.data_pack_export_mode.options.zip'),
+				// zip: translate('dialog.blueprint_settings.data_pack_export_mode.options.zip'),
 				none: translate('dialog.blueprint_settings.data_pack_export_mode.options.none'),
 			}}
 			defaultOption={'raw'}

src/components/locatorConfigDialog.svelte

@@ -47,6 +47,7 @@
 			label={translate('dialog.locator_config.use_entity.title')}
 			tooltip={translate('dialog.locator_config.use_entity.description')}
 			bind:checked={useEntity}
+			defaultValue={false}
 		/>
 
 		{#if $useEntity}
@@ -55,19 +56,22 @@
 				tooltip={translate('dialog.locator_config.entity_type.description')}
 				bind:value={entityType}
 				valueChecker={entityTypeValidator}
+				defaultValue="minecraft:item_display"
 			/>
 
 			<CodeInput
 				label={translate('dialog.locator_config.summon_commands.title')}
 				tooltip={translate('dialog.locator_config.summon_commands.description')}
 				bind:value={summonCommands}
+				defaultValue=""
 			/>
 		{/if}
 
 		<CodeInput
 			label={translate('dialog.locator_config.ticking_commands.title')}
 			tooltip={translate('dialog.locator_config.ticking_commands.description')}
 			bind:value={tickingCommands}
+			defaultValue=""
 		/>
 	{/if}
 </div>

src/index.ts

@@ -12,7 +12,7 @@ import './outliner/textDisplay'
 import './outliner/vanillaItemDisplay'
 import './outliner/vanillaBlockDisplay'
 // Compilers
-import { compileDataPack } from './systems/datapackCompiler'
+import datapackCompiler from './systems/datapackCompiler'
 // Minecraft Systems
 import './systems/minecraft/versionManager'
 import './systems/minecraft/registryManager'
@@ -23,19 +23,14 @@ import './systems/minecraft/fontManager'
 import { TRANSPARENT_TEXTURE, Variant } from './variants'
 import './systems/minecraft/registryManager'
 import { MINECRAFT_REGISTRY } from './systems/minecraft/registryManager'
-import { compileResourcePack } from './systems/resourcepackCompiler'
+import resourcepackCompiler from './systems/resourcepackCompiler'
 import { openExportProgressDialog } from './interface/exportProgressDialog'
-import { isDataPackPath, isResourcePackPath } from './util/minecraftUtil'
+import { isDataPackPath, isResourcePackPath, parseResourcePackPath } from './util/minecraftUtil'
 import { blueprintSettingErrors } from './blueprintSettings'
 import { openUnexpectedErrorDialog } from './interface/unexpectedErrorDialog'
 import { BLUEPRINT_CODEC, BLUEPRINT_FORMAT } from './blueprintFormat'
 import { TextDisplay } from './outliner/textDisplay'
 import { getLatestVersionClientDownloadUrl } from './systems/minecraft/assetManager'
-import {
-	hideLoadingPopup,
-	showLoadingPopup,
-	showOfflineError,
-} from './interface/animatedJavaLoadingPopup'
 import { getVanillaFont } from './systems/minecraft/fontManager'
 import * as assetManager from './systems/minecraft/assetManager'
 import * as itemModelManager from './systems/minecraft/itemModelManager'
@@ -46,13 +41,13 @@ import { BLOCKSTATE_REGISTRY } from './systems/minecraft/blockstateManager'
 import { exportProject } from './systems/exporter'
 import { openBlueprintLoadingDialog } from './interface/blueprintLoadingPopup'
 import { openInstallPopup } from './interface/installedPopup'
-import { createBlockbenchMod } from './util/moddingTools'
 
 // @ts-ignore
 globalThis.AnimatedJava = {
 	API: {
-		compileDataPack,
-		compileResourcePack,
+		parseResourcePackPath,
+		datapackCompiler,
+		resourcepackCompiler,
 		Variant,
 		MINECRAFT_REGISTRY,
 		openExportProgressDialog,

src/interface/blueprintSettingsDialog.ts

@@ -6,6 +6,7 @@ import { toSafeFuntionName } from '../util/minecraftUtil'
 import { defaultValues, ExportMode } from '../blueprintSettings'
 import { translate } from '../util/translation'
 import { updateBoundingBox } from '../blueprintFormat'
+import { MinecraftVersion } from '../systems/datapackCompiler/mcbFiles'
 
 function getSettings() {
 	return {
@@ -33,6 +34,9 @@ function getSettings() {
 			Project!.animated_java.resource_pack_export_mode as string
 		),
 		dataPackExportMode: new Valuable(Project!.animated_java.data_pack_export_mode as string),
+		targetMinecraftVersion: new Valuable(
+			Project!.animated_java.target_minecraft_version as string
+		),
 		// Resource Pack Settings
 		displayItem: new Valuable(Project!.animated_java.display_item, value => {
 			if (!value) {
@@ -86,6 +90,8 @@ function setSettings(settings: ReturnType<typeof getSettings>) {
 	Project.animated_java.resource_pack_export_mode =
 		settings.resourcePackExportMode.get() as ExportMode
 	Project.animated_java.data_pack_export_mode = settings.dataPackExportMode.get() as ExportMode
+	Project.animated_java.target_minecraft_version =
+		settings.targetMinecraftVersion.get() as MinecraftVersion
 	// Resource Pack Settings
 	Project.animated_java.display_item = settings.displayItem.get()
 	Project.animated_java.custom_model_data_offset = settings.customModelDataOffset.get()

src/lang/en.yml

@@ -91,6 +91,9 @@ animated_java.dialog.blueprint_settings.auto_bounding_box.description: |-
 animated_java.dialog.blueprint_settings.bounding_box.title: Bounding Box
 animated_java.dialog.blueprint_settings.bounding_box.description: Determines the culling box of the model. The model will stop rendering when this box is off-screen.
 
+animated_java.dialog.blueprint_settings.target_minecraft_version.title: Target Minecraft Version
+animated_java.dialog.blueprint_settings.target_minecraft_version.description: The version of Minecraft to target when exporting the project. This will determine the format of the exported Resource Pack and Data Pack.
+
 # Resource Pack Settings
 animated_java.dialog.blueprint_settings.resource_pack_settings.title: Resource Pack Settings