Major improvements and fixes.

Author: KyouinDev

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.1.1
 
 - Effective Dart analysis improvements.
+- Major improvements and fixes.
 
 ## 0.1.0
 

README.md

@@ -22,4 +22,5 @@ some errors.
 
 ### 0.1.1
 
-- Effective Dart analysis improvements.
+- Effective Dart analysis improvements.
+- Major improvements and fixes.

appdef.json

@@ -1,36 +1,13 @@
 {
-  "replacements": [
-    {
-      "name": "new_line",
-      "pattern": "00",
-      "replace_with": "0A",
-      "skip_comparison": true
-    },
-    {
-      "name": "name_start",
-      "pattern": "81 79",
-      "replace_with": "5B 6E 61 6D 65 5D"
-    },
-    {
-      "name": "text_start",
-      "pattern": "81 7A",
-      "replace_with": "5B 74 65 78 74 5D"
-    },
-    {
-      "name": "line_break",
-      "pattern": "25 4E",
-      "replace_with": "5B 62 72 65 61 6B 5D",
-      "skip_comparison": true
-    },
-    {
-      "name": "line_end",
-      "pattern": "25 4B 25 50",
-      "replace_with": "5B 65 6E 64 5D"
-    },
-    {
-      "name": "line_end_choice",
-      "pattern": "25 4B 25 70",
-      "replace_with": "5B 63 68 6F 69 63 65 5D"
-    }
+  "replacements": {
+    "00": "0A",
+    "81 79": "5B 6E 61 6D 65 5D",
+    "81 7A": "5B 74 65 78 74 5D",
+    "25 4E": "5B 62 72 65 61 6B 5D",
+    "25 4B 25 50": "5B 65 6E 64 5D",
+    "25 4B 25 70": "5B 63 68 6F 69 63 65 5D"
+  },
+  "skip_comparison": [
+    "0A", "5B 62 72 65 61 6B 5D"
   ]
 }

bin/corpse_tools.dart

@@ -4,10 +4,11 @@ import 'package:args/command_runner.dart';
 import 'package:corpse_tools/commands.dart';
 
 void main(List<String> args) {
-  var desc = 'CorpseTools v0.1.1 made by Kyouin.\n'
+  var desc = 'CorpseTools v0.1.1 made by Kyouin '
+      '(https://github.com/KyouinDev/corpse_tools)\n'
       'Supported game(s):\n'
       ' - Corpse Party: Book of Shadows (PC)';
-  var runner = CommandRunner('corpse_tools', desc)
+  var runner = CommandRunner('corpse_tools.exe', desc)
     ..addCommand(ExtractTextCommand())
     ..addCommand(ReplaceTextCommand());
   runner.run(args).catchError((error) {

lib/app_def.dart

@@ -1,21 +1,23 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'entities/replacement.dart';
-
 class AppDef {
-  final List<Replacement> replacements;
+  final Map<String, String> replacements;
+  final List<String> skipComparison;
 
   static final AppDef _instance = _fromFile(File('appdef.json'));
 
-  AppDef._(this.replacements);
+  AppDef._(this.replacements, this.skipComparison);
 
   static AppDef _fromFile(File file) {
     return _fromJson(json.decode(file.readAsStringSync()));
   }
 
   static AppDef _fromJson(Map<String, dynamic> json) {
-    return AppDef._(Replacement.listFromJson(json['replacements']));
+    return AppDef._(
+      Map.from(json['replacements']),
+      List<String>.from(json['skip_comparison']),
+    );
   }
 
   factory AppDef() {

lib/commands/extract_text_command.dart

@@ -23,23 +23,20 @@ class ExtractTextCommand extends Command {
 
   @override
   void run() {
-    if (argResults?['input'] == null) {
-      print('Missing parameters. '
-          'Run "corpse_tools.exe help extract-text" for info.');
-      return;
-    }
-
-    var input = File(argResults?['input']);
-
-    if (!input.existsSync() || !input.path.endsWith('.BIN')) {
-      print('Input file does not exist or not a .BIN type.');
-      return;
-    }
-
-    var lastLine = getReadableLines(readFileAsHexString(input));
-    var formatLine = replaceSequences(lastLine);
-    var linesCount = formatLine.count(AppDef().replacements[0].replaceWith) + 1;
-    writeToFile(File(input.path.replaceAll('.BIN', '.txt')), formatLine);
-    print('Done successfully. Total lines extracted: $linesCount.');
+    var input = getFileFromArg(
+      arg: argResults!['input'],
+      command: 'extract-text',
+      expected: '.BIN',
+    );
+
+    if (input == null) return;
+
+    var time = DateTime.now();
+    var readableContent = getReadableContent(readFileAsHexString(input));
+    var replacedContent = replaceSequences(readableContent);
+    var count = replacedContent.count(AppDef().replacements.values.first) + 1;
+    writeToFile(File(input.path.replaceAll('.BIN', '.txt')), replacedContent);
+    print('Done successfully. Total lines extracted: $count.');
+    printElapsedTime(time);
   }
 }

lib/commands/replace_text_command.dart

@@ -1,5 +1,3 @@
-import 'dart:io';
-
 import 'package:args/command_runner.dart';
 
 import '../utils.dart';
@@ -28,45 +26,45 @@ class ReplaceTextCommand extends Command {
 
   @override
   void run() {
-    if (argResults?['original'] == null || argResults?['modified'] == null) {
-      print('Missing parameters. '
-          'Run "corpse_tools.exe help replace-text" for info.');
-      return;
-    }
-
-    var original = File(argResults?['original']);
-    var modified = File(argResults?['modified']);
+    var original = getFileFromArg(
+      arg: argResults!['original'],
+      command: 'replace-text',
+      expected: '.BIN',
+    );
 
-    if (!original.existsSync() || !original.path.endsWith('.BIN')) {
-      print('Original file does not exist or not a .BIN type.');
-      return;
-    }
+    if (original == null) return;
 
-    if (!modified.existsSync() || !modified.path.endsWith('.txt')) {
-      print('Modified file does not exist or not a .txt type.');
-      return;
-    }
+    var modified = getFileFromArg(
+      arg: argResults!['modified'],
+      command: 'replace-text',
+      expected: '.txt',
+    );
 
-    var modifiedLine = readFileAsHexString(modified);
-    var originalLine = getReadableLines(readFileAsHexString(original));
-    var result = compareEdit(replaceSequences(originalLine), modifiedLine);
+    if (modified == null) return;
 
-    if (result.success) {
-      if (result.changedLines == 0) {
-        print('No lines were changed.');
-        return;
-      }
+    var time = DateTime.now();
+    var modifContent = readFileAsHexString(modified);
+    var origHexString = readFileAsHexString(original);
+    var origContent = getReadableContent(origHexString);
+    var result = compareEdit(replaceSequences(origContent), modifContent);
 
-      var lines = getUnreadableLines(readFileAsHexString(original));
-      var replacedLines = replaceSequences(modifiedLine, extract: false);
-      writeToFile(original, '$lines $replacedLines');
-      print('Done successfully. Total lines replaced: ${result.changedLines}.');
-    } else {
+    if (!result.success) {
       print('Error while trying to replace modified text:');
+      printError(String s) => print(' - $s'); //aux function
+      result.messages.forEach(printError);
+      return;
+    }
 
-      for (var s in result.messages) {
-        print(' - $s');
-      }
+    if (result.changedLines == 0) {
+      print('No lines were changed.');
+      printElapsedTime(time);
+      return;
     }
+
+    var unreadable = getUnreadableContent(origHexString);
+    var modifReplacedContent = replaceSequences(modifContent, extract: false);
+    writeToFile(original, '$unreadable $modifReplacedContent');
+    print('Done successfully. Total lines replaced: ${result.changedLines}.');
+    printElapsedTime(time);
   }
 }

lib/entities/replacement.dart

@@ -1,34 +1,37 @@
 import '../app_def.dart';
 import '../entities/compare_result.dart';
-import '../entities/replacement.dart';
 import '../utils.dart';
 
-String getUnreadableLines(String hex) {
+String getUnreadableContent(String hex) {
   return hex.substring(0, hex.lastIndexOf('02') + 2);
 }
 
-String getReadableLines(String hex) {
+String getReadableContent(String hex) {
   return hex.substring(hex.lastIndexOf('02') + 3);
 }
 
 String replaceSequences(String hex, {bool extract = true}) {
-  for (var replacement in AppDef().replacements) {
+  for (var replacement in AppDef().replacements.entries) {
     if (extract) {
-      hex = hex.replaceAll(replacement.pattern, replacement.replaceWith);
+      hex = hex.replaceAll(replacement.key, replacement.value);
     } else {
-      hex = hex.replaceAll(replacement.replaceWith, replacement.pattern);
+      hex = hex.replaceAll(replacement.value, replacement.key);
     }
   }
 
   return hex;
 }
 
+int compareLine(String origLine, String modifLine, String sequence) {
+  return origLine.count(sequence) - modifLine.count(sequence);
+}
+
 CompareResult compareEdit(String original, String modified) {
-  var lineSeparator = AppDef().replacements[0].replaceWith;
-  var originalLines = original.split(lineSeparator);
-  var modifiedLines = modified.split(lineSeparator);
+  var separator = AppDef().replacements.values.first;
+  var origLines = original.split(separator);
+  var modifLines = modified.split(separator);
 
-  if (originalLines.length != modifiedLines.length) {
+  if (origLines.length != modifLines.length) {
     return CompareResult(
       success: false,
       messages: ['Number of lines does not match.'],
@@ -40,31 +43,31 @@ CompareResult compareEdit(String original, String modified) {
   var changedLines = 0;
   var success = true;
 
-  for (var i = 0; i < originalLines.length; i++) {
-    var originalLine = originalLines[i];
-    var modifiedLine = modifiedLines[i];
+  for (var i = 0; i < origLines.length; i++) {
+    var origLine = origLines[i];
+    var modifLine = modifLines[i];
 
-    for (var replacement in AppDef().replacements) {
-      var entity = replacement.replaceWith;
+    for (var toSkip in AppDef().skipComparison) {
+      origLine = origLine.replaceAll(toSkip, '');
+      modifLine = modifLine.replaceAll(toSkip, '');
+    }
 
-      if (replacement.skipComparison) {
-        originalLine = originalLine.replaceAll(entity, '');
-        modifiedLine = modifiedLine.replaceAll(entity, '');
-        continue;
-      }
+    var replacements = AppDef().replacements.entries.where((entry) {
+      return !AppDef().skipComparison.contains(entry.value);
+    }).map((entry) => entry.value);
 
-      var name = String.fromCharCodes(hexStringToIntList(entity));
-      var c1 = originalLine.count(entity);
-      var c2 = modifiedLine.count(entity);
+    for (var replacement in replacements) {
+      var compare = compareLine(origLine, modifLine, replacement);
+      var name = String.fromCharCodes(hexStringToIntList(replacement));
 
-      if (c1 != c2) {
-        messages.add('Line ${i + 1}: found ${c1 > c2 ? 'less' : 'more'}'
+      if (compare != 0) {
+        messages.add('Line ${i + 1}: found ${compare > 0 ? 'less' : 'more'}'
             ' $name than expected');
         success = false;
       }
     }
 
-    if (originalLine != modifiedLine) changedLines++;
+    if (origLine != modifLine) changedLines++;
   }
 
   return CompareResult(
@@ -74,6 +77,11 @@ CompareResult compareEdit(String original, String modified) {
   );
 }
 
+void printElapsedTime(DateTime from) {
+  var elapsed = DateTime.now().difference(from);
+  print('Elapsed time: ${elapsed.inMilliseconds} ms.');
+}
+
 extension SequenceCount on String {
   int count(Pattern pattern) => split(pattern).length - 1;
 }

lib/utils/app_utils.dart

@@ -2,6 +2,27 @@ import 'dart:io';
 
 import '../utils.dart';
 
+File? getFileFromArg({
+  required dynamic arg,
+  required String command,
+  required String expected,
+}) {
+  if (arg == null) {
+    print('Missing parameters. '
+        'Run "corpse_tools.exe help $command" for info.');
+    return null;
+  }
+
+  var file = File(arg);
+
+  if (!file.existsSync() || !file.path.endsWith(expected)) {
+    print('Input file does not exist or not a $expected type.');
+    return null;
+  }
+
+  return file;
+}
+
 String readFileAsHexString(File file) {
   var bytes = file.readAsBytesSync();
   return intListToHexString(bytes);