🚧 Version warning

Added a warning when loading AJ data packs in versions they weren't exported for.

Author: SnaveSutit

.eslintrc.json

@@ -47,6 +47,7 @@
 		"@typescript-eslint/consistent-indexed-object-style": ["warn", "record"],
 		"@typescript-eslint/consistent-generic-constructors": "warn",
 		"@typescript-eslint/no-namespace": "off",
+		"@typescript-eslint/restrict-template-expressions": "off",
 		"@typescript-eslint/naming-convention": [
 			"warn",
 			{

src/components/blueprintSettingsDialog.svelte

@@ -575,7 +575,6 @@
 			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'),
 				none: translate('dialog.blueprint_settings.resource_pack_export_mode.options.none'),
 			}}
 			defaultOption={'raw'}
@@ -587,7 +586,6 @@
 			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'),
 				none: translate('dialog.blueprint_settings.data_pack_export_mode.options.none'),
 			}}
 			defaultOption={'raw'}

src/systems/datapackCompiler/index.ts

@@ -8,11 +8,11 @@ import { Variant } from '../../variants'
 import { NbtByte, NbtCompound, NbtFloat, NbtInt, NbtList, NbtString } from 'deepslate/lib/nbt'
 import {
 	arrayToNbtFloatArray,
+	getFunctionNamespace,
 	matrixToNbtFloatArray,
 	replacePathPart,
 	sortObjectKeys,
 	transformationToNbt,
-	zip,
 } from '../util'
 import { BoneConfig, TextDisplayConfig } from '../../nodeConfigs'
 import {
@@ -26,7 +26,6 @@ import {
 import { JsonText } from '../minecraft/jsonText'
 import { MAX_PROGRESS, PROGRESS, PROGRESS_DESCRIPTION } from '../../interface/exportProgressDialog'
 import { eulerFromQuaternion, floatToHex, roundTo, tinycolorToDecimal } from '../../util/misc'
-import { setTimeout } from 'timers'
 import { MSLimiter } from '../../util/msLimiter'
 
 const BONE_TYPES = ['bone', 'text_display', 'item_display', 'block_display']
@@ -616,7 +615,9 @@ export default async function compileDataPack(options: {
 	animationHash: string
 }) {
 	console.time('Data Pack Compilation took')
-	const { rig, animations, rigHash, animationHash } = options
+	const { rig, animations, rigHash, animationHash, dataPackFolder } = options
+	const overrideFolder = PathModule.join(dataPackFolder, 'animated_java')
+
 	const aj = Project!.animated_java
 	console.log('Compiling Data Pack...', options)
 	const compiler = new Compiler('src/', {
@@ -635,10 +636,10 @@ export default async function compileDataPack(options: {
 	let ajmeta: DataPackAJMeta | null = null
 	if (aj.data_pack_export_mode === 'raw') {
 		ajmeta = new DataPackAJMeta(
-			PathModule.join(options.dataPackFolder, 'data.ajmeta'),
+			PathModule.join(dataPackFolder, 'data.ajmeta'),
 			aj.export_namespace,
 			Project!.last_used_export_namespace,
-			options.dataPackFolder
+			dataPackFolder
 		)
 		ajmeta.read()
 
@@ -698,7 +699,7 @@ export default async function compileDataPack(options: {
 	function createSyncIO(): SyncIo {
 		const io = new SyncIo()
 		io.write = (localPath, content) => {
-			const writePath = PathModule.join(options.dataPackFolder, localPath)
+			const writePath = PathModule.join(overrideFolder, localPath)
 			exportedFiles.set(writePath, content)
 			if (ajmeta) ajmeta.files.add(writePath)
 		}
@@ -753,56 +754,98 @@ export default async function compileDataPack(options: {
 
 	PROGRESS_DESCRIPTION.set('Compiling Data Pack...')
 	PROGRESS.set(0)
-	await new Promise(resolve => setTimeout(resolve, 2000 / framespersecond))
+	await new Promise(resolve => requestAnimationFrame(resolve))
 	console.time('MC-Build Compiler took')
 	const tokens = Tokenizer.tokenize(mcbFile, 'src/animated_java.mcb')
 	compiler.addFile('src/animated_java.mcb', Parser.parseMcbFile(tokens))
 	compiler.compile(VariableMap.fromObject(variables))
 	console.timeEnd('MC-Build Compiler took')
 
+	// Incorrect version warning
+	const functionNamespace = getFunctionNamespace(aj.target_minecraft_version)
+	const invalidVersionMessage = new JsonText([
+		TELLRAW_ERROR_PREFIX(),
+		[
+			{
+				text: 'Attempting to load an Animated Java Data Pack that was exported for ',
+				color: 'red',
+			},
+			{ text: `Minecraft ${aj.target_minecraft_version}`, color: 'aqua' },
+			{ text: ' in an different version!', color: 'red' },
+			{
+				text: '\n Please ensure that the data pack is loaded in the correct version, or that your blueprint settings are configured to target the correct version(s) of Minecraft.',
+				color: 'yellow',
+			},
+		],
+		TELLRAW_SUFFIX(),
+	])
+	exportedFiles.set(
+		PathModule.join(
+			dataPackFolder,
+			`data/animated_java/${functionNamespace}/global/on_load.mcfunction`
+		),
+		`tellraw @a ${invalidVersionMessage}`
+	)
+	exportedFiles.set(
+		PathModule.join(dataPackFolder, `data/minecraft/tags/${functionNamespace}/load.json`),
+		autoStringify({
+			replace: false,
+			values: ['animated_java:global/on_load'],
+		})
+	)
+
+	interface IPackMeta {
+		pack?: {
+			pack_format?: number
+			description?: string
+		}
+		overlays?: {
+			entries?: Array<{
+				directory?: string
+				formats?: number | number[] | { min_inclusive: number; max_inclusive: number }
+			}>
+		}
+	}
+
+	// pack.mcmeta
+	const packMetaPath = PathModule.join(dataPackFolder, 'pack.mcmeta')
+	let packMeta = {} as IPackMeta
+	if (fs.existsSync(packMetaPath)) {
+		try {
+			const content = fs.readFileSync(packMetaPath, 'utf-8')
+			packMeta = JSON.parse(content)
+		} catch (e) {
+			console.error('Failed to parse pack.mcmeta:', e)
+		}
+	}
+	packMeta.pack ??= {}
+	packMeta.pack.pack_format = getDataPackFormat(aj.target_minecraft_version)
+	packMeta.pack.description ??= `Animated Java Data Pack for ${aj.target_minecraft_version}`
+	packMeta.overlays ??= {}
+	packMeta.overlays.entries ??= []
+	const overlay = packMeta.overlays.entries.find(e => e.directory === 'animated_java')
+	if (!overlay) {
+		packMeta.overlays.entries.push({
+			directory: 'animated_java',
+			formats: getDataPackFormat(aj.target_minecraft_version),
+		})
+	} else {
+		overlay.formats = getDataPackFormat(aj.target_minecraft_version)
+	}
+
+	exportedFiles.set(PathModule.join(dataPackFolder, 'pack.mcmeta'), autoStringify(packMeta))
+
 	PROGRESS_DESCRIPTION.set('Writing Data Pack...')
 	if (aj.data_pack_export_mode === 'raw') {
 		console.time('Writing Files took')
-		await writeFiles(exportedFiles, options.dataPackFolder)
+		await writeFiles(exportedFiles, overrideFolder)
 		console.timeEnd('Writing Files took')
 		ajmeta!.write()
-	} else if (aj.data_pack_export_mode === 'zip') {
-		exportedFiles.set(
-			PathModule.join(options.dataPackFolder, 'pack.mcmeta'),
-			autoStringify({
-				pack: {
-					pack_format: 48,
-					description: `${Project!.name}. Generated with Animated Java`,
-				},
-			})
-		)
-
-		const exportPath =
-			options.dataPackFolder + (options.dataPackFolder.endsWith('.zip') ? '' : '.zip')
-		console.time('Writing Zip took')
-		await writeZip(exportedFiles, exportPath)
-		console.timeEnd('Writing Zip took')
 	}
 
 	console.timeEnd('Data Pack Compilation took')
 }
 
-async function writeZip(map: Map<string, string>, dataPackPath: string) {
-	const data: Record<string, Uint8Array> = {}
-
-	for (const [path, content] of map) {
-		const relativePath = PathModule.relative(dataPackPath, path)
-		if (typeof content === 'string') {
-			data[relativePath] = Buffer.from(content)
-		} else {
-			data[relativePath] = content
-		}
-	}
-
-	const zipped = await zip(data, {})
-	await fs.promises.writeFile(dataPackPath, zipped)
-}
-
 async function writeFiles(map: Map<string, string>, dataPackFolder: string) {
 	PROGRESS.set(0)
 	MAX_PROGRESS.set(map.size)
@@ -829,10 +872,7 @@ async function writeFiles(map: Map<string, string>, dataPackFolder: string) {
 				const value = typeof v === 'string' ? v : v.id
 				const isTag = value.startsWith('#')
 				const location = parseResourceLocation(isTag ? value.substring(1) : value)
-				// If the target version is 1.21.0 or higher, use the 'function' namespace instead of 'functions'
-				const functionNamespace = compareVersions(aj.target_minecraft_version, '1.21.0')
-					? 'function'
-					: 'functions'
+				const functionNamespace = getFunctionNamespace(aj.target_minecraft_version)
 				console.log('Checking:', value, location, functionNamespace)
 				const vPath = PathModule.join(
 					dataPackFolder,

src/systems/util.ts

@@ -108,3 +108,8 @@ export function isCubeValid(cube: Cube) {
 	}
 	return false
 }
+
+export function getFunctionNamespace(version: string): 'function' | 'functions' {
+	// If the target version is 1.21.0 or higher, use the 'function' namespace instead of 'functions'
+	return compareVersions(version, '1.21.0') ? 'function' : 'functions'
+}

test_blueprints/armor_stand.ajblueprint

@@ -14,17 +14,17 @@
 		"enable_plugin_mode": false,
 		"resource_pack_export_mode": "raw",
 		"data_pack_export_mode": "raw",
-		"target_minecraft_version": "1.21.4",
+		"target_minecraft_version": "1.20.4",
 		"display_item": "minecraft:white_dye",
 		"custom_model_data_offset": 0,
 		"enable_advanced_resource_pack_settings": false,
 		"enable_advanced_resource_pack_folders": false,
-		"resource_pack": "C:\\Users\\SnaveSutit\\AppData\\Roaming\\.modrinth\\profiles\\Animated Java Dev\\resourcepacks\\resourcepack",
+		"resource_pack": "C:\\Users\\SnaveSutit\\AppData\\Roaming\\.modrinth\\profiles\\AJ Tests 1.20.4\\resourcepacks\\resourcepack",
 		"display_item_path": "",
 		"model_folder": "",
 		"texture_folder": "",
 		"enable_advanced_data_pack_settings": false,
-		"data_pack": "C:\\Users\\SnaveSutit\\AppData\\Roaming\\.modrinth\\profiles\\Animated Java Dev\\saves\\Animated Java Dev\\datapacks\\datapack",
+		"data_pack": "C:\\Users\\SnaveSutit\\AppData\\Roaming\\.modrinth\\profiles\\AJ Tests 1.20.4\\saves\\AJ Tests 1_21_4\\datapacks\\datapack",
 		"summon_commands": "",
 		"ticking_commands": "",
 		"interpolation_duration": 1,
@@ -1502,7 +1502,7 @@
 		"default": {
 			"name": "default",
 			"display_name": "Default",
-			"uuid": "76aede3a-8293-ba9b-f2ca-247a75dc1ea6",
+			"uuid": "b3c20335-1d42-762c-f9a7-2d7abaec2ece",
 			"texture_map": {},
 			"excluded_nodes": [],
 			"is_default": true