Move to .patch.json system

Author: rtm516

README.md

@@ -23,9 +23,8 @@ Download: [GeyserOptionalPack.mcpack](https://download.geysermc.org/v2/projects/
 ### Manually compiling the pack
 
 1. Clone the repo to your computer
-2. Run `gradlew build`.
-3. Run the pack compiler using `java -jar build/libs/GeyserOptionalPackCompiler.jar`
-4. When it finishes compiling, it will output the `GeyserOptionalPack.mcpack`.
+2. Run `gradlew run`.
+3. When it finishes compiling, it will output the `GeyserOptionalPack.mcpack`.
 
 ### Legal
 

developer_documentation.md

@@ -26,6 +26,11 @@ The GeyserOptionalPack is compiled using a program written in Java. It contains
 
 Entity data and entity flags (known as queries in Molang) are pieces of metadata that store various pieces of information about an entity on the Bedrock Edition of Minecraft. You can query for an entity's health, for example (a number query or an entity data), and can query for if an entity is angry (an entity flag, which is either 1.0 or 0.0 in Molang). Not all entities use every query, but every entity has access to most queries, though Bedrock by default ignores these. These queries can be sent by Geyser and change how an entity looks. We use this to our advantage in this resource pack.
 
+### Patches
+There is a system within the compiler to apply patches to the vanilla Bedrock json files. This is done by placing a `.patch.json` in the `patches` resource folder, with the same path as the file you want to patch. The patch file will be merged with the original file, replacing any existing keys. This is useful for small changes to vanilla files, such as adding an extra texture to an entity.
+
+The source for these files is https://github.com/Mojang/bedrock-samples/tree/main/resource_pack with each patch being the same name and path as the original file but with `.json` replaced with `.patch.json`.
+
 ### Armor stands
 
 #### Part visibility and rotation encoding

src/main/java/org/geysermc/optionalpack/BedrockResourcesWrapper.java

@@ -6,10 +6,10 @@ public class BedrockResourcesWrapper {
     private static final String BEDROCK_RESOURCES_URL = "https://raw.githubusercontent.com/Mojang/bedrock-samples/refs/tags/v" + Constants.BEDROCK_TARGET_VERSION + "/resource_pack/%s";
 
     public static String getResourceAsString(String path) {
-        return HTTP.getAsString(BEDROCK_RESOURCES_URL.formatted(path));
+        return WebUtils.getAsString(BEDROCK_RESOURCES_URL.formatted(path));
     }
 
     public static InputStream getResource(String path) {
-        return HTTP.request(BEDROCK_RESOURCES_URL.formatted(path));
+        return WebUtils.request(BEDROCK_RESOURCES_URL.formatted(path));
     }
 }

src/main/java/org/geysermc/optionalpack/FileUtils.java

@@ -0,0 +1,62 @@
+package org.geysermc.optionalpack;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+public class FileUtils {
+    /**
+     * Delete a directory and all files within it
+     * From: https://www.geeksforgeeks.org/java/java-program-to-delete-a-directory/
+     *
+     * @param directory The directory to remove
+     */
+    public static void deleteDirectory(File directory) {
+        File[] files = directory.listFiles();
+        if (files != null) {
+            for (File subfile : directory.listFiles()) {
+                if (subfile.isDirectory()) {
+                    deleteDirectory(subfile);
+                }
+                subfile.delete();
+            }
+        }
+
+        directory.delete();
+    }
+
+    /**
+     * @see #deleteDirectory(File)
+     */
+    public static void deleteDirectory(Path directory) {
+        deleteDirectory(directory.toFile());
+    }
+
+    /**
+     * Zip a folder
+     * From: https://stackoverflow.com/a/57997601
+     *
+     * @param sourceFolderPath Folder to zip
+     * @param zipPath Output path for the zip
+     */
+    public static void zipFolder(Path sourceFolderPath, Path zipPath) throws Exception {
+        ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(zipPath.toFile()));
+        Files.walkFileTree(sourceFolderPath, new SimpleFileVisitor<>() {
+            @Override
+            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+                zos.putNextEntry(new ZipEntry(sourceFolderPath.relativize(file).toString()));
+                Files.copy(file, zos);
+                zos.closeEntry();
+                return FileVisitResult.CONTINUE;
+            }
+        });
+        zos.close();
+    }
+}

src/main/java/org/geysermc/optionalpack/JavaResources.java

@@ -27,6 +27,7 @@
 
 import javax.imageio.ImageIO;
 import java.awt.image.BufferedImage;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.Charset;
@@ -60,12 +61,15 @@ public static void extract(ZipFile clientJar) {
                 String assetFileName = Path.of(jarAssetPath).toFile().getName();
                 Path destination = OptionalPack.WORKING_PATH.resolve(destinationPath).resolve(assetFileName);
 
-                if (destination.toFile().mkdirs()) {
-                    Files.copy(asset, destination, StandardCopyOption.REPLACE_EXISTING);
-                }
-                else {
-                    OptionalPack.log("Could not make directories for copying " + jarAssetPath + " to " + destinationPath + "!");
+                File destinationFolder = OptionalPack.WORKING_PATH.resolve(destinationPath).toFile();
+                if (!destinationFolder.exists()) {
+                    if (!destinationFolder.mkdirs()) {
+                        OptionalPack.log("Could not make directories for copying " + jarAssetPath + " to " + destinationPath + "!");
+                        continue;
+                    }
                 }
+
+                Files.copy(asset, destination, StandardCopyOption.REPLACE_EXISTING);
             }
 
         } catch (IOException e) {

src/main/java/org/geysermc/optionalpack/LauncherMetaWrapper.java

@@ -1,7 +1,5 @@
 package org.geysermc.optionalpack;
 
-import com.google.gson.Gson;
-
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -16,15 +14,15 @@ public class LauncherMetaWrapper {
     public static Path getLatest() {
         OptionalPack.log("Downloading " + Constants.JAVA_TARGET_VERSION + " client.jar from Mojang...");
 
-        VersionManifest versionManifest = Constants.GSON.fromJson(HTTP.getAsString(LAUNCHER_META_URL), VersionManifest.class);
+        VersionManifest versionManifest = Constants.GSON.fromJson(WebUtils.getAsString(LAUNCHER_META_URL), VersionManifest.class);
 
         for (Version version : versionManifest.versions()) {
             if (version.id().equals(Constants.JAVA_TARGET_VERSION)) {
-                VersionInfo versionInfo = Constants.GSON.fromJson(HTTP.getAsString(version.url()), VersionInfo.class);
+                VersionInfo versionInfo = Constants.GSON.fromJson(WebUtils.getAsString(version.url()), VersionInfo.class);
                 VersionDownload client = versionInfo.downloads().get("client");
                 if (!Files.exists(CLIENT_JAR) || !client.sha1.equals(getSha1(CLIENT_JAR))) {
                     // Download the client jar
-                    try (InputStream in = HTTP.request(client.url())) {
+                    try (InputStream in = WebUtils.request(client.url())) {
                         Files.copy(in, CLIENT_JAR);
                     } catch (Exception e) {
                         throw new RuntimeException("Could not download client jar", e);

src/main/java/org/geysermc/optionalpack/OptionalPack.java

@@ -74,7 +74,7 @@ public static void main(String[] args) {
 
             log("Extracting pre-made optional pack data to folder...");
             // there are probably better ways to do this, but this is the way im doing it
-            unzipPack(Resources.get("optionalpack"), WORKING_PATH);
+            Resources.extractFolder("optionalpack", WORKING_PATH);
 
             // Step 2: Download the 1.21.8 client.jar and copy all files needed to working folder
             File jarFile = LauncherMetaWrapper.getLatest().toFile();
@@ -96,12 +96,12 @@ public static void main(String[] args) {
 
             // Step 4: Compile pack folder into a mcpack.
             log("Zipping as GeyserOptionalPack.mcpack...");
-            zipFolder(WORKING_PATH, Path.of("GeyserOptionalPack.mcpack"));
+            FileUtils.zipFolder(WORKING_PATH, Path.of("GeyserOptionalPack.mcpack"));
 
             // Step 5: Cleanup temporary folders and files
             log("Clearing temporary files...");
             clientJar.close();
-            deleteDirectory(WORKING_PATH.toFile());
+            FileUtils.deleteDirectory(WORKING_PATH);
 
             // Step 6: Finish!!
             DecimalFormat r3 = new DecimalFormat("0.000");
@@ -113,106 +113,6 @@ public static void main(String[] args) {
         }
     }
 
-    /**
-     * Delete a directory and all files within it
-     * From: https://www.geeksforgeeks.org/java/java-program-to-delete-a-directory/
-     *
-     * @param directory The directory to remove
-     */
-    public static void deleteDirectory(File directory) {
-        File[] files = directory.listFiles();
-        if (files != null) {
-            for (File subfile : directory.listFiles()) {
-                if (subfile.isDirectory()) {
-                    deleteDirectory(subfile);
-                }
-                subfile.delete();
-            }
-        }
-
-        directory.delete();
-    }
-
-    /**
-     * Zip a folder
-     * From: https://stackoverflow.com/a/57997601
-     *
-     * @param sourceFolderPath Folder to zip
-     * @param zipPath Output path for the zip
-     */
-    private static void zipFolder(Path sourceFolderPath, Path zipPath) throws Exception {
-        ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(zipPath.toFile()));
-        Files.walkFileTree(sourceFolderPath, new SimpleFileVisitor<>() {
-            @Override
-            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
-                zos.putNextEntry(new ZipEntry(sourceFolderPath.relativize(file).toString()));
-                Files.copy(file, zos);
-                zos.closeEntry();
-                return FileVisitResult.CONTINUE;
-            }
-        });
-        zos.close();
-    }
-
-    /**
-     * Extract a zip to a given directory
-     *
-     * @param file The zip to extract
-     * @param destDir THe destination to put all the files
-     */
-    private static void unzipPack(URL file, Path destDir) {
-        File dir = destDir.toFile();
-        // create output directory if it doesn't exist
-        if (!dir.exists()) dir.mkdirs();
-
-        try {
-            if (file.getProtocol().equals("file")) {
-                Path resourceDir = Paths.get(file.toURI());
-                Files.walk(resourceDir)
-                    .filter(Files::isRegularFile)
-                    .forEach(source -> {
-                        try {
-                            Path relative = resourceDir.relativize(source);
-                            Path target = destDir.resolve(relative);
-                            Files.createDirectories(target.getParent());
-                            Files.copy(source, target, StandardCopyOption.REPLACE_EXISTING);
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
-                        }
-                    });
-            } else {
-                byte[] buffer = new byte[1024];
-                FileInputStream fileStream = new FileInputStream(new File(file.toURI()));
-                ZipInputStream zipStream = new ZipInputStream(fileStream);
-                ZipEntry entry = zipStream.getNextEntry();
-                while (entry != null) {
-                    if (!entry.isDirectory()) {
-                        String fileName = entry.getName();
-                        File newFile = new File(destDir + File.separator + fileName);
-                        // create directories for subdirectories in zip
-                        new File(newFile.getParent()).mkdirs();
-                        FileOutputStream extractedFile = new FileOutputStream(newFile);
-                        int len;
-                        while ((len = zipStream.read(buffer)) > 0) {
-                            extractedFile.write(buffer, 0, len);
-                        }
-                        extractedFile.close();
-                    }
-                    // close this ZipEntry
-
-                    zipStream.closeEntry();
-                    entry = zipStream.getNextEntry();
-                }
-                // close the last ZipEntry
-                zipStream.closeEntry();
-                zipStream.close();
-                fileStream.close();
-            }
-        } catch (IOException | URISyntaxException e) {
-            throw new RuntimeException("Unable to unzip pack!", e);
-        }
-    }
-
     /**
      * Prints a message to the console.
      *

src/main/java/org/geysermc/optionalpack/Resources.java

@@ -27,10 +27,21 @@
 
 import javax.imageio.ImageIO;
 import java.awt.image.BufferedImage;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipInputStream;
 
 public class Resources {
     /**
@@ -89,4 +100,64 @@ public static BufferedImage getAsImage(String resourcePath) throws IOException {
         is.close();
         return image;
     }
+
+    /**
+     * Extract a resource folder to a given directory
+     *
+     * @param folder The resource folder to extract
+     * @param destDir The destination to put all the files
+     */
+    public static void extractFolder(String folder, Path destDir) {
+        URL file = get(folder);
+        File dir = destDir.toFile();
+        // create output directory if it doesn't exist
+        if (!dir.exists()) dir.mkdirs();
+
+        try {
+            if (file.getProtocol().equals("file")) {
+                Path resourceDir = Paths.get(file.toURI());
+                Files.walk(resourceDir)
+                    .filter(Files::isRegularFile)
+                    .forEach(source -> {
+                        try {
+                            Path relative = resourceDir.relativize(source);
+                            Path target = destDir.resolve(relative);
+                            Files.createDirectories(target.getParent());
+                            Files.copy(source, target, StandardCopyOption.REPLACE_EXISTING);
+                        } catch (IOException e) {
+                            throw new UncheckedIOException(e);
+                        }
+                    });
+            } else {
+                byte[] buffer = new byte[1024];
+                FileInputStream fileStream = new FileInputStream(new File(file.toURI()));
+                ZipInputStream zipStream = new ZipInputStream(fileStream);
+                ZipEntry entry = zipStream.getNextEntry();
+                while (entry != null) {
+                    if (!entry.isDirectory()) {
+                        String fileName = entry.getName();
+                        File newFile = new File(destDir + File.separator + fileName);
+                        // create directories for subdirectories in zip
+                        new File(newFile.getParent()).mkdirs();
+                        FileOutputStream extractedFile = new FileOutputStream(newFile);
+                        int len;
+                        while ((len = zipStream.read(buffer)) > 0) {
+                            extractedFile.write(buffer, 0, len);
+                        }
+                        extractedFile.close();
+                    }
+                    // close this ZipEntry
+
+                    zipStream.closeEntry();
+                    entry = zipStream.getNextEntry();
+                }
+                // close the last ZipEntry
+                zipStream.closeEntry();
+                zipStream.close();
+                fileStream.close();
+            }
+        } catch (IOException | URISyntaxException e) {
+            throw new RuntimeException("Unable to unzip pack!", e);
+        }
+    }
 }

…java/org/geysermc/optionalpack/HTTP.java …/org/geysermc/optionalpack/WebUtils.javasrc/main/java/org/geysermc/optionalpack/HTTP.java renamed to src/main/java/org/geysermc/optionalpack/WebUtils.java src/main/java/org/geysermc/optionalpack/HTTP.java renamed to src/main/java/org/geysermc/optionalpack/WebUtils.java

@@ -30,7 +30,7 @@
 import java.net.*;
 import java.nio.charset.StandardCharsets;
 
-public class HTTP {
+public class WebUtils {
 
     /**
      * Requests a URL and returns the InputStream.