Added toggleable compression (#59)

* Added toggleable compression * Set default compression to false
HarbourMasters · Jun 1, 2024 · c1be413 · c1be413
1 parent 5f296ac
commit c1be413
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 17 deletions.
diff --git a/lib/arc/arc.dart b/lib/arc/arc.dart
@@ -111,17 +111,21 @@ class Arc {
     return files;
   }
 
-  void _addMPQFile(String path, Uint8List data) {
+  void _addMPQFile(String path, Uint8List data, bool compress) {
     final mpqArchive = handle as MPQArchive;
     final timestamp = DateTime.now().millisecondsSinceEpoch ~/ 1000;
-    mpqArchive.createFile(path, timestamp, data.length, 0, 0)
-      ..write(data, data.length, MPQ_COMPRESSION_ZLIB)
+    mpqArchive.createFile(path, timestamp, data.length, 0, compress ? MPQ_FILE_COMPRESS : 0)
+      ..write(data, data.length, compress ? MPQ_COMPRESSION_ZLIB : 0)
       ..finish();
   }
 
-  void _addZipFile(String path, Uint8List data) {
+  void _addZipFile(String path, Uint8List data, bool compress) {
     final archive = handle as Archive;
-    archive.addFile(ArchiveFile(path, data.length, data));
+    if(compress) {
+      archive.addFile(ArchiveFile(path, data.length, data));
+    } else {
+      archive.addFile(ArchiveFile.noCompress(path, data.length, data));
+    }
   }
 
   void _closeMPQ() {
@@ -147,11 +151,11 @@ class Arc {
     }
   }
 
-  void addFile(String path, Uint8List data) {
+  void addFile(String path, Uint8List data, { bool compress = false }) {
     if(handle is MPQArchive) {
-      return _addMPQFile(path, data);
+      return _addMPQFile(path, data, compress);
     } else {
-      return _addZipFile(path, data);
+      return _addZipFile(path, data, compress);
     }
   }
 

diff --git a/lib/features/create/create_finish/create_finish_viewmodel.dart b/lib/features/create/create_finish/create_finish_viewmodel.dart
@@ -28,6 +28,7 @@ class CreateFinishViewModel with ChangeNotifier {
   bool isEphemeralBarExpanded = false;
   bool isGenerating = false;
   bool prependAlt = false;
+  bool compressFiles = false;
   int totalFiles = 0;
   int filesProcessed = 0;
 
@@ -46,6 +47,11 @@ class CreateFinishViewModel with ChangeNotifier {
     notifyListeners();
   }
 
+  Future<void> onToggleCompressFiles(bool newCompressFilesValue) async {
+    compressFiles = newCompressFilesValue;
+    notifyListeners();
+  }
+
   void reset() {
     currentState = AppState.none;
     totalFiles = 0;
@@ -166,7 +172,7 @@ class CreateFinishViewModel with ChangeNotifier {
 
     isGenerating = true;
     notifyListeners();
-    await createGenerationIsolate(entries, outputFile, prependAlt);
+    await createGenerationIsolate(entries, outputFile, prependAlt, compressFiles);
     // await compute(generateOTR, Tuple2(entries, outputFile));
     isGenerating = false;
     notifyListeners();
@@ -176,11 +182,11 @@ class CreateFinishViewModel with ChangeNotifier {
   }
 
   Future createGenerationIsolate(HashMap<String, StageEntry> entries,
-      String outputFile, bool shouldPrependAlt) async {
+      String outputFile, bool shouldPrependAlt, bool shouldCompress) async {
     final receivePort = ReceivePort();
     await Isolate.spawn(
       generateOTR,
-      Tuple4(entries, outputFile, receivePort.sendPort, shouldPrependAlt),
+      Tuple5(entries, outputFile, receivePort.sendPort, shouldPrependAlt, shouldCompress),
       onExit: receivePort.sendPort,
       onError: receivePort.sendPort,
     );
@@ -212,8 +218,9 @@ class CreateFinishViewModel with ChangeNotifier {
   }
 }
 
-Future<void> generateOTR(Tuple4<HashMap<String, StageEntry>, String, SendPort, bool> params) async {
+Future<void> generateOTR(Tuple5<HashMap<String, StageEntry>, String, SendPort, bool, bool> params) async {
   try {
+    final compress = params.item5;
     final arcFile = Arc(params.item2);
 
     for (final entry in params.item1.entries) {
@@ -222,15 +229,15 @@ Future<void> generateOTR(Tuple4<HashMap<String, StageEntry>, String, SendPort, b
           final fileData = await file.readAsBytes();
           final fileName =
               "${entry.key}/${p.normalize(file.path).split("/").last}";
-          arcFile.addFile(fileName, fileData);
+          arcFile.addFile(fileName, fileData, compress: compress);
           params.item3.send(1);
         }
       } else if (entry.value is CustomSequencesEntry) {
         for (final pair in (entry.value as CustomSequencesEntry).pairs) {
           final sequence = await compute(Sequence.fromSeqFile, pair);
           final fileName = '${entry.key}/${sequence.path}';
           final data = sequence.build();
-          arcFile.addFile(fileName, data);
+          arcFile.addFile(fileName, data, compress: compress);
           params.item3.send(1);
         }
       } else if (entry.value is CustomTexturesEntry) {
@@ -248,7 +255,7 @@ Future<void> generateOTR(Tuple4<HashMap<String, StageEntry>, String, SendPort, b
             continue;
           }
 
-          arcFile.addFile(texture.item1, texture.item2!);
+          arcFile.addFile(texture.item1, texture.item2!, compress: compress);
         }
       }
     }

diff --git a/lib/features/create/create_replace_textures/components/folder_content_view.dart b/lib/features/create/create_replace_textures/components/folder_content_view.dart
@@ -33,6 +33,7 @@ Widget FolderContent(
             style: ElevatedButton.styleFrom(minimumSize: const Size(100, 50)),
             child: Text(i18n.folderContentView_selectButton),)
       ],),
+      const SizedBox(height: 10),
       Row(children: [
         Switch(
           activeColor: Colors.blue,
@@ -43,6 +44,16 @@ Widget FolderContent(
         ),
         Text(i18n.folderContentView_prependAltToggle),
       ],),
+      Row(children: [
+        Switch(
+          activeColor: Colors.blue,
+          value: finishViewModel.compressFiles,
+          onChanged: (value) {
+            finishViewModel.onToggleCompressFiles(value);
+          },
+        ),
+        Text(i18n.folderContentView_compressToggle),
+      ],),
       if (viewModel.processedFiles.isEmpty && viewModel.isProcessing == false)
         const Spacer(),
       if (viewModel.processedFiles.isNotEmpty || viewModel.isProcessing)

diff --git a/lib/l10n/app_de.arb b/lib/l10n/app_de.arb
@@ -26,6 +26,7 @@
     "otrContentView_processing": "Verarbeite...",
     "folderContentView_customTexturePath": "Benutzeridentifizierter Austausch-Texturen Ordner",
     "folderContentView_prependAltToggle": "Füge einen `alt/` Dies ermöglicht es den Spielern, Assets im Spiel zu aktivieren oder zu deaktivieren.",
+    "folderContentView_compressToggle": "Dateien komprimieren. Dadurch wird die Größe der OTR / O2R reduziert.",
     "folderContentView_selectButton": "Wähle",
     "folderContentView_stageTextures": "Texturen indexieren",
     "createCustomSequences_addCustomSequences": "Füge benutzeridentifizierte Sequenzen hinzu",

diff --git a/lib/l10n/app_en.arb b/lib/l10n/app_en.arb
@@ -26,6 +26,7 @@
     "otrContentView_processing": "Processing...",
     "folderContentView_customTexturePath": "Custom Texture Replacements Folder",
     "folderContentView_prependAltToggle": "Prepend `alt/`. This will allow players to toggle these assets on-the-fly in game.",
+    "folderContentView_compressToggle": "Compress Files. This will reduce the size of the OTR / O2R.",
     "folderContentView_selectButton": "Select",
     "folderContentView_stageTextures": "Stage Textures",
     "createCustomSequences_addCustomSequences": "Add Custom Sequences",

diff --git a/lib/l10n/app_es.arb b/lib/l10n/app_es.arb
@@ -26,6 +26,7 @@
     "otrContentView_processing": "Procesando...",
     "folderContentView_customTexturePath": "Carpeta de reemplazos de texturas personalizadas",
     "folderContentView_prependAltToggle": "Agregar en `alt/`. Esto permitirá a los jugadores cambiar los recursos durante el juego.",
+    "folderContentView_compressToggle": "Comprimir archivos, esto puede reducir el tamaño del OTR / O2R",
     "folderContentView_selectButton": "Seleccionar",
     "folderContentView_stageTextures": "Agregar texturas",
     "createCustomSequences_addCustomSequences": "Agregar secuencias personalizadas",

diff --git a/lib/l10n/app_fr.arb b/lib/l10n/app_fr.arb
@@ -26,6 +26,7 @@
     "otrContentView_processing": "Traitement en cours...",
     "folderContentView_customTexturePath": "Dossier de remplacements de textures personnalisées",
     "folderContentView_prependAltToggle": "Ajouter un dossier `alt/` à votre OTR / O2R. Permet aux joueurs d'activer ou désactiver les assets en jeu.",
+    "folderContentView_compressToggle": "Compresser les fichiers. Cela réduira la taille de l'OTR / O2R.",
     "folderContentView_selectButton": "Sélectionner",
     "folderContentView_stageTextures": "Indexer les textures",
     "createCustomSequences_addCustomSequences": "Ajouter des séquences personnalisées",

diff --git a/lib/l10n/app_nl.arb b/lib/l10n/app_nl.arb
@@ -25,7 +25,8 @@
     "otrContentView_step5": "5. We genereren een OTR / O2R met de gewijzigde textures! 🚀",
     "otrContentView_processing": "Verwerken...",
     "folderContentView_customTexturePath": "Vervangende Texture Map",
-    "folderContentView_prependAltToggle": "Prepend `alt/`. This will allow players to toggle these assets on-the-fly in game.",
+    "folderContentView_prependAltToggle": "Voeg 'alt/' toe aan het begin. Dit stelt spelers in staat om deze assets tijdens het spel direct aan en uit te zetten.",
+    "folderContentView_compressToggle": "Bestanden comprimeren. Dit zal de grootte van de OTR / O2R verkleinen.",
     "folderContentView_selectButton": "Selecteer",
     "folderContentView_stageTextures": "Stage-Textures",
     "createCustomSequences_addCustomSequences": "Voeg aangepaste composities toe",

diff --git a/lib/ui/components/ephemeral_bar.dart b/lib/ui/components/ephemeral_bar.dart
@@ -95,7 +95,7 @@ class _EphemeralBarState extends State<EphemeralBar>
               child: Row(
                 mainAxisAlignment: MainAxisAlignment.end,
                 children: [
-                  Text('Retro: 0.1.0', style: textTheme.bodyMedium!.copyWith(
+                  Text('Retro: 0.1.1', style: textTheme.bodyMedium!.copyWith(
                     color: colorScheme.onSurface,),
                   ),
                   if (!isExpanded)