Update CLI, GUI, Java API and docs to match version 0.3.0-beta.3

Author: misieur

README.md

@@ -15,10 +15,10 @@ Usage: packobf_cli [OPTIONS] --input-file <FILE> --output-file <FILE>
 Options:
   -i, --input-file <FILE>                        
   -o, --output-file <FILE>                       
-  -p, --preset <PRESET>                          [possible values: fastest, fast, normal, best, ultra]
+  -p, --preset <PRESET>                          [possible values: fast, normal, best]
   -l, --log-level <LOG_LEVEL>                    [default: info] [possible values: info, warning, error, none]
       --cache-file <CACHE_FILE>                  
-  -c, --compression <COMPRESSION>                [default: normal] [possible values: fastest, fast, normal, best, ultra]
+  -c, --compression <COMPRESSION>                [default: normal] [possible values: fast, normal]
       --shader-compression <SHADER_COMPRESSION>  [default: minify] [possible values: none, minify, minify-and-obfuscate]
       --rename-files                             
       --block-unzipping                          
@@ -30,7 +30,7 @@ Options:
 ```
 
 > [!TIP]
-> Using `--preset` is a good choice when trying PackOBF for the first time, possible values are: `fastest`, `fast`, `normal`, `best`, `ultra`.
+> Using `--preset` is a good choice when trying PackOBF for the first time, possible values are: `fast`, `normal`, and `best`.
 
 ~~Alternatively, you can use PackOBF in your browser at https://packobf.misieur.me/ however, it will be way slower than the native app 
 because of internet browser restrictions.~~ PackOBF on internet browsers is deprecated.
@@ -42,22 +42,22 @@ because of internet browser restrictions.~~ PackOBF on internet browsers is depr
 
 ### JSON Files
 PackOBF will parse JSON files into memory and will know for JSON files in `items`, `models`, `blockstates`, `fonts`, `sound_definitions`, and `atlas` folders
-which fields exist, which one are required, their value type (string, integer, etc.) and their default value.
+which fields exist, which ones are required, their type (string, integer, etc.) and their default value.
 With all of this data, PackOBF is able to remove fields that are unknown by Minecraft, values that are
-already the default one, spaces and new lines.
+already the default one, spaces and line breaks.
 > [!NOTE]
 > For any other JSON file, PackOBF will only simplify them, remove spaces, newlines, `.0` for numbers, etc.
 
 ### PNG Files
-PackOBF uses [oxipng](https://github.com/oxipng/oxipng) to minimize losslessly PNG files.  
+PackOBF uses [an oxipng fork](https://github.com/PackOBF/oxipng) to losslessly minimize PNG files.  
 Moreover, if you enable the *Corrupt PNG Files* option (`--corrupt-png-files`), your PNG images will be
 corrupted and unreadable for a lof of image software but Minecraft and will remove some bytes from your PNG images.
 
 ### Resource pack file
-PackOBF has its own way of writing ZIP files, which will not work with some popular ZIP file extractors,
+PackOBF has its own way of writing ZIP files, which will not work with some popular ZIP file extractors 
 but does work with Minecraft. This way of writing ZIP files is not conventional, but it allows saving file size
 when duplicated files are in the resource pack and does not write useless data like folders and other fields on the ZIP file.
-PackOBF by itself will break some file software however the `jar -xf output.zip` command from Java will still be able to unzip it.
+PackOBF by itself will break some file software, however, the `jar -xf output.zip` command from Java will still be able to unzip it.
 By enabling the *Block resource pack from unzipping* option (`--block-unzipping`), it will totally block Java and a lot of software
 (including JD-GUI, Minecraft mods) from unzipping your resource pack while Minecraft can still load it.
 
@@ -66,7 +66,7 @@ PackOBF is able to rename resource pack overlays, models, textures and sounds th
 (example: `assets/_/textures/i/a.png` instead of `assets/minecraft/textures/item/my_cool_item.png`) while keeping everything working.
 
 ### Core Shaders (Experimental)
-PackOBF is able to parse core shaders, minify them, rename variables and functions to short names, it can be enabled using the
+PackOBF is able to parse core shaders, minify them, rename variables and functions to short names. It can be enabled using the
 `--shader-compression [none, minify, minify-and-obfuscate]` option, `minify-and-obfuscate` will rename variables and functions
 which might break your shaders, while `minify` does not.
 

docs/usage/OPTIONS.md

@@ -16,13 +16,10 @@
 
 Used for any file in the resource pack and PNG images before being compressed in the resource pack.
 
-| Compression level | Description                                                                                                                                 |
-|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| Fastest           | Uses libdeflate level 6                                                                                                                     |
-| Fast              | Uses libdeflate level 12                                                                                                                    |
-| Normal            | Pre-processes data with libdeflate level 9 and based on the results chooses zopfli options that would give the best time/compression ratio. |
-| Best              | Same as Normal but with higher zopfli compression.                                                                                          |
-| Ultra             | Zopfli with 40 iteration_count, 40 iterations_without_improvement and 25 maximum_block_splits                                               |
+| Compression level | Description                                      |
+|-------------------|--------------------------------------------------|
+| Fast              | Uses libdeflate level 6 and fast oxipng options  |
+| Normal            | Uses libdeflate level 12 and slow oxipng options |
 
 > [!NOTE]
 > You may not want to use the Ultra compression level if it's not for testing/benchmarking

java/rust/src/lib.rs

@@ -128,11 +128,7 @@ pub extern "system" fn Java_dev_misieur_packobf_Native_optimizeZip<'caller>(
                                 index: i,
                                 total: t,
                             } => (3, i as i32, t as i32, Some(s)),
-                            Progress::Building {
-                                current: s,
-                                index: i,
-                                total: t,
-                            } => (4, i as i32, t as i32, Some(s)),
+                            Progress::Finishing => (4, 0, 0, None),
                             Progress::Done => (5, 0, 0, None),
                         };
 

java/src/main/java/dev/misieur/packobf/Native.java

@@ -14,7 +14,7 @@ private Native() {
 
     static class Options {
 
-        public Options(int compression, int shaderCompression, boolean renameFiles, boolean blockUnzipping, boolean corruptPngFiles, int numThreads, int targetVersion) {
+        Options(int compression, int shaderCompression, boolean renameFiles, boolean blockUnzipping, boolean corruptPngFiles, int numThreads, int targetVersion) {
             this.compression = compression;
             this.shaderCompression = shaderCompression;
             this.renameFiles = renameFiles;
@@ -24,13 +24,13 @@ public Options(int compression, int shaderCompression, boolean renameFiles, bool
             this.targetVersion = targetVersion;
         }
 
-        public int compression;
-        public int shaderCompression;
-        public boolean renameFiles;
-        public boolean blockUnzipping;
-        public boolean corruptPngFiles;
-        public int numThreads;
-        public int targetVersion;
+        int compression;
+        int shaderCompression;
+        boolean renameFiles;
+        boolean blockUnzipping;
+        boolean corruptPngFiles;
+        int numThreads;
+        int targetVersion;
     }
 
     interface LogCallback {

java/src/main/java/dev/misieur/packobf/PackOBF.java

@@ -71,7 +71,7 @@ public static byte[] optimizeZip(
                         case 1 -> progressCallback.onProgress(new ReadingZipProgress(current, total));
                         case 2 -> progressCallback.onProgress(new ParsingProgress(currentString));
                         case 3 ->
-                                progressCallback.onProgress(new BuildingProgress(total, new BuildingProgress.Current(currentString, current)));
+                                progressCallback.onProgress(new FinishingProgress());
                         case 4 -> progressCallback.onProgress(new DoneProgress());
                         default -> {
                         }

java/src/main/java/dev/misieur/packobf/options/Compression.java

@@ -1,11 +1,8 @@
 package dev.misieur.packobf.options;
 
 public enum Compression {
-    FASTEST(0),
-    FAST(1),
-    NORMAL(2),
-    BEST(3),
-    ULTRA(4);
+    FAST(0),
+    NORMAL(1);
 
     private final int value;
 

java/src/main/java/dev/misieur/packobf/options/Options.java

@@ -12,17 +12,6 @@ public record Options(@NotNull Compression compression,
                       @NotNull Optional<Integer> numThreads,
                       @NotNull Optional<MinecraftVersion> targetVersion
 ) {
-    public static Options fastest() {
-        return new Options(
-                Compression.FASTEST,
-                ShaderCompression.NONE,
-                false,
-                false,
-                false,
-                Optional.empty(),
-                Optional.empty()
-        );
-    }
 
     public static Options fast() {
         return new Options(
@@ -51,7 +40,7 @@ public static Options normal() {
 
     public static Options best() {
         return new Options(
-                Compression.BEST,
+                Compression.NORMAL,
                 ShaderCompression.NONE,
                 true,
                 true,
@@ -60,17 +49,4 @@ public static Options best() {
                 Optional.empty()
         );
     }
-
-
-    public static Options ultra() {
-        return new Options(
-                Compression.ULTRA,
-                ShaderCompression.MINIFY_AND_OBFUSCATE,
-                true,
-                true,
-                true,
-                Optional.empty(),
-                Optional.empty()
-        );
-    }
 }

java/src/main/java/dev/misieur/packobf/progress/BuildingProgress.java

@@ -0,0 +1,17 @@
+package dev.misieur.packobf.progress;
+
+/**
+ * No fields
+ */
+public final class FinishingProgress extends Progress {
+    public FinishingProgress() {
+    }
+
+    @Override
+    public State state() {
+        return State.FINISHING;
+    }
+
+    public record Current(String name, int index) {
+    }
+}

java/src/main/java/dev/misieur/packobf/progress/FinishingProgress.java

@@ -1,6 +1,6 @@
 package dev.misieur.packobf.progress;
 
-public abstract sealed class Progress permits IdleProgress, ReadingZipProgress, ParsingProgress, OptimizingProgress, BuildingProgress, DoneProgress {
+public abstract sealed class Progress permits IdleProgress, ReadingZipProgress, ParsingProgress, OptimizingProgress, FinishingProgress, DoneProgress {
     private State state;
 
     public abstract State state();
@@ -10,7 +10,7 @@ public enum State {
         READING_ZIP(1),
         PARSING(2),
         OPTIMIZING(3),
-        BUILDING(4),
+        FINISHING(4),
         DONE(5);
 
         private final int value;