rvpacker-txt 1.9.4 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57413528c8aa902963d9df851562c6dab33d8edbcdd8e19ef2c5dd0a3f5fbf0
-  data.tar.gz: 0aec862409028ee0f116a2ea98d08104c97bd3027969dd3ac830dbdbcf576c88
+  metadata.gz: 5d581405430f6d78e8269bc9f3310903bdc76e889d38c59a67ec6726a6927d33
+  data.tar.gz: 8492c8a320492902c0d8696dfcdf9bb1b2191fb6567c92e6086ee143ea6c25a5
 SHA512:
-  metadata.gz: 7a31f9ba7db0bd30345637c7701282191d842d053ccf38355331e1375f270fb6558fbfae4b2378174655c8968f5edba97354c2cee05ff580760c260db149c8e9
-  data.tar.gz: 2af993afb94e8d29705014bba95f655c26eec161da56f5715f9e7a069231e57456cd37b01678bd8de1148ac5f2d5858ff6c5b759902916eeb151569c2de9cc41
+  metadata.gz: 3b1cdf8a790a950a7669206356542f41697d3c0389df088ba1482fdd4fa83051c15be5883520d5c26a12f0098563545abc4af3e36970e1c5760d63abda493177
+  data.tar.gz: 13a78b005d438e8c3d67543de90bb1c5fccb7bfd7845b7b81f10d7487fcad43d71a61588e494e53e3ce8a4a4f4804f92a95f42932a502ab9129c6b22ec5376d0

data/README.md

@@ -37,9 +37,7 @@ OPTIONS:
                                      Example: --disable-processing=maps,other,system.
                                      [Allowed values: maps, other, system, scripts]
         --disable-custom-processing  Disables built-in custom parsing/writing for some games.
-    -r, --romanize                   When reading: If you parsing text from a Japanese game, that contains symbols like 「」,
-                                     which are just the Japanese quotation marks, it automatically replaces these symbols by their roman equivalents.
-                                     When writing: Use to correctly write files back if you have parsed them with --romanize flag.
+                                     This flag will automatically be used when writing if you parsed game text with it.
     -l, --log                        Enables logging.
     -h, --help                       Prints the program's help message or for the entered subcommand.
 ```

data/bin/rvpacker-txt

@@ -43,29 +43,22 @@ def self.parse_options
 
     banner,
         input_dir_description,
-        output_dir_description,
-        romanize_description =
+        output_dir_description, =
         case options[:action]
             when 'read'
                 ["#{read_command_description}\n\nOPTIONS:\n",
                  ['Input directory, containing folders "original" or "data" with original game files.'],
-                 ['Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.'],
-                 ['If you parsing text from a Japanese game, that contains symbols like 「」, which are just the Japanese quotation marks,',
-                  'it automatically replaces these symbols by their roman equivalents.']]
+                 ['Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.']]
             when 'write'
                 ["#{write_command_description}\n\nOPTIONS:\n",
                  ['Input directory, containing folders "original" or "data" and "translation" with original game files and .txt files with translation respectively.'],
-                 ['Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.'],
-                 ['Use to correctly write files back if you have parsed them with --romanize flag.']]
+                 ['Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.']]
             else
                 [banner_text,
                  ['When reading: Input directory, containing folders "original" or "data" with original game files.',
                   'When writing: Input directory, containing folders "original" or "data" and "translation" with original game files and .txt files with translation respectively.'],
                  ['When reading: Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.',
-                  'When writing: Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.'],
-                 ['When reading: If you parsing text from a Japanese game, that contains symbols like 「」,',
-                  'which are just the Japanese quotation marks, it automatically replaces these symbols by their roman equivalents.',
-                  'When writing: Use to correctly write files back if you have parsed them with --romanize flag.']]
+                  'When writing: Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.']]
         end
 
     OptionParser.new(banner) do |cmd|
@@ -92,16 +85,19 @@ def self.parse_options
         end
 
         cmd.on('--disable-custom-processing',
-               'Disables built-in custom parsing/writing for some games.') do
+               'Disables built-in custom parsing/writing for some games.',
+               'This flag will automatically be used when writing if you parsed game text with it.') do
             options[:disable_custom_processing] = true
         end
 
-        cmd.on('-r', '--romanize',
-               *romanize_description) do
-            options[:romanize] = true
-        end
-
         if options[:action] == 'read'
+            cmd.on('-r', '--romanize',
+                   'If you parsing text from a Japanese game, that contains symbols like 「」,',
+                   'which are just the Japanese quotation marks, it automatically replaces these symbols by their roman equivalents.',
+                   'This flag will automatically be used when writing if you parsed game text with it.') do
+                options[:romanize] = true
+            end
+
             cmd.on('-f', '--force',
                    'Force rewrite all files. Cannot be used with --append.',
                    'USE WITH CAUTION!') do
@@ -110,7 +106,7 @@ def self.parse_options
 
             cmd.on('-a', '--append',
                    "When the rvpacker-txt or the game which files you've parsed receives an update, you probably should re-read game files with --append,",
-                   ' which will append any new text to your files without overwriting the progress.',
+                   'which will append any new text to your files without overwriting the progress.',
                    'Cannot be used with --force.') do
                 raise '--append cannot be used with --force.' if options[:force]
                 options[:append] = true
@@ -170,6 +166,7 @@ force = options[:force]
 append = options[:append]
 # @type [Boolean]
 romanize = options[:romanize]
+# @type [Boolean]
 silent = options[:silent]
 
 extensions = { xp: 'rxdata', vx: 'rvdata', ace: 'rvdata2' }
@@ -179,6 +176,7 @@ raise '"Data" or "original" directory not found within input directory.' unless
 
 maps_path = File.join(input_path, 'translation', 'maps')
 other_path = File.join(input_path, 'translation', 'other')
+metadata_file_path = File.join(input_path, 'translation', '.rvpacker-txt-metadata.marshal')
 
 FileUtils.mkdir_p(maps_path)
 FileUtils.mkdir_p(other_path)
@@ -220,7 +218,7 @@ if options[:action] == 'read'
     require 'read'
 
     processing_mode = if force
-                          unless options[:silent]
+                          unless silent
                               wait_time_start = Time.now
 
                               puts "WARNING! You're about to forcefully rewrite all your translation files, including _trans files.",
@@ -237,6 +235,8 @@ if options[:action] == 'read'
                           :default
                       end
 
+    File.binwrite(metadata_file_path, Marshal.dump({ romanize: romanize, disable_custom_processing: disable_custom_processing }))
+
     read_map(maps_files_paths, maps_path, romanize, logging, game_type, processing_mode) unless disable_processing[:maps]
     read_other(other_files_paths, other_path, romanize, logging, game_type, processing_mode) unless disable_processing[:other]
     read_system(system_file_path, ini_file_path, other_path, romanize, logging, processing_mode) unless disable_processing[:system]
@@ -247,6 +247,20 @@ else
     output_path = File.join(output_path, 'output')
     FileUtils.mkdir_p(output_path)
 
+    if File.exist?(metadata_file_path)
+        metadata = Marshal.load(File.binread(metadata_file_path))
+
+        if metadata[:romanize]
+            puts 'Enabling romanize according to the metadata from previous read.'
+            romanize = metadata[:romanize]
+        end
+
+        if metadata[:disable_custom_processing] && !game_type.nil?
+            puts 'Disabling custom parsing according to the metadata from previous read.'
+            game_type = nil
+        end
+    end
+
     write_map(maps_files_paths, maps_path, output_path, shuffle_level, romanize, logging, game_type) unless disable_processing[:maps]
     write_other(other_files_paths, other_path, output_path, shuffle_level, romanize, logging, game_type) unless disable_processing[:other]
     write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, romanize, logging) unless disable_processing[:system]

data/lib/extensions.rb

@@ -7,13 +7,13 @@ def self.romanize_string(string)
         case char
             when '。'
                 string[i] = '.'
-            when '、'
+            when '、', '，'
                 string[i] = ','
             when '・'
                 string[i] = '·'
             when '゠'
                 string[i] = '–'
-            when '＝'
+            when '＝', 'ー'
                 string[i] = '—'
             when '…', '‥'
                 string[i, 3] = '...'
@@ -41,6 +41,72 @@ def self.romanize_string(string)
                 string[i] = ':'
             when '！'
                 string[i] = '!'
+            when '※'
+                string[i] = '*'
+            when 'Ⅰ'
+                string[i] = 'I'
+            when 'ⅰ'
+                string[i] = 'i'
+            when 'Ⅱ'
+                string[i, 2] = 'II'
+            when 'ⅱ'
+                string[i, 2] = 'ii'
+            when 'Ⅲ'
+                string[i, 3] = 'III'
+            when 'ⅲ'
+                string[i, 3] = 'iii'
+            when 'Ⅳ'
+                string[i, 2] = 'IV'
+            when 'ⅳ'
+                string[i, 2] = 'iv'
+            when 'Ⅴ'
+                string[i] = 'V'
+            when 'ⅴ'
+                string[i] = 'v'
+            when 'Ⅵ'
+                string[i, 2] = 'VI'
+            when 'ⅵ'
+                string[i, 2] = 'vi'
+            when 'Ⅶ'
+                string[i, 3] = 'VII'
+            when 'ⅶ'
+                string[i, 3] = 'vii'
+            when 'Ⅷ'
+                string[i, 4] = 'VIII'
+            when 'ⅷ'
+                string[i, 4] = 'viii'
+            when 'Ⅸ'
+                string[i, 2] = 'IX'
+            when 'ⅸ'
+                string[i, 2] = 'ix'
+            when 'Ⅹ'
+                string[i] = 'X'
+            when 'ⅹ'
+                string[i] = 'x'
+            when 'Ⅺ'
+                string[i, 2] = 'XI'
+            when 'ⅺ'
+                string[i, 2] = 'xi'
+            when 'Ⅻ'
+                string[i, 3] = 'XII'
+            when 'ⅻ'
+                string[i, 3] = 'xii'
+            when 'Ⅼ'
+                string[i] = 'L'
+            when 'ⅼ'
+                string[i] = 'l'
+            when 'Ⅽ'
+                string[i] = 'C'
+            when 'ⅽ'
+                string[i] = 'c'
+            when 'Ⅾ'
+                string[i] = 'D'
+            when 'ⅾ'
+                string[i] = 'd'
+            when 'Ⅿ'
+                string[i] = 'M'
+            when 'ⅿ'
+                string[i] = 'm'
             else
                 nil
         end

data/lib/read.rb

@@ -3,7 +3,7 @@
 require 'zlib'
 require_relative 'extensions'
 
-STRING_IS_ONLY_SYMBOLS_RE = /^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼| ]+$/
+STRING_IS_ONLY_SYMBOLS_RE = /^[.()+\-:;\[\]^~%&!№$@`*\/→×？?ｘ％▼|♥♪！：〜『』「」〽。…‥＝゠、，【】［］｛｝（）〔〕｟｠〘〙〈〉《》・\\#'"<>=_ー※▶ⅠⅰⅡⅱⅢⅲⅣⅳⅤⅴⅥⅵⅦⅶⅧⅷⅨⅸⅩⅹⅪⅺⅫⅻⅬⅼⅭⅽⅮⅾⅯⅿ\s]+$/
 APPEND_FLAG_OMIT_MSG = "Files aren't already parsed. Continuing as if --append flag was omitted."
 
 class Hash
@@ -76,41 +76,65 @@ end
 def self.parse_parameter(code, parameter, game_type)
     return nil if parameter.match?(STRING_IS_ONLY_SYMBOLS_RE)
 
+    ends_with_if = parameter[/ if\(.*\)$/]
+    parameter = parameter.chomp(ends_with_if) if ends_with_if
+
     unless game_type.nil?
-        case code
-            when 401, 405
-                case game_type
-                    when 'lisa'
-                        match = parameter.scan(/^\\et\[[0-9]+\]/)
-                        match = parameter.scan(/^\\nbt/) if match.empty?
-                        parameter = parameter[match[0].length..] unless match.empty?
+        case game_type
+            when 'lisa'
+                case code
+                    when 401, 405
+                        prefix = parameter[/^(\\et\[[0-9]+\]|\\nbt)/]
+                        parameter = parameter.sub(prefix, '') if prefix
+                    when 102
+                        # Implement some custom parsing
+                    when 356
+                        # Implement some custom parsing
                     else
-                        nil
+                        return nil
                 end
-            when 102
-                # Implement some custom parsing
-            when 356
-                # Implement some custom parsing
+                # Implement cases for other games
             else
-                return nil
+                nil
         end
+
     end
 
     parameter
 end
 
 # @param [String] variable
+# @param [Integer] type
 # @param [String] _game_type
 # @return [String]
-def self.parse_variable(variable, _game_type)
-    return nil if variable.match?(STRING_IS_ONLY_SYMBOLS_RE)
-    variable = variable.gsub(/\r?\n/, '\#') if variable.count("\n").positive?
+def self.parse_variable(variable, type, _game_type)
+    variable = variable.gsub(/\r?\n/, '\#')
+    return nil if variable.match?(STRING_IS_ONLY_SYMBOLS_RE) # for some reason it returns true if multi-line string contains carriage returns (wtf?)
+
+    only_html_elements = true
+
+    variable.split('\#').each do |line|
+        unless line.strip.match?(/^(#? ?<.*>\.?)$|^$/)
+            only_html_elements = false
+            break
+        end
+    end
+
+    return nil if only_html_elements
 
-    return nil if variable.split('\#').all? { |line| line.strip.match?(/(^#? ?<.*>\.?$)|^$/) }
     return nil if variable.match?(/^[+-]?[0-9]*$/) ||
         variable.match?(/---/) ||
         variable.match?(/restrict eval/)
 
+    case type
+        when 0 # name
+        when 1 # nickname
+        when 2 # description
+        when 3 # note
+        else
+            nil
+    end
+
     variable
 end
 
@@ -326,13 +350,13 @@ def self.read_other(other_files_paths, output_path, romanize, logging, game_type
                 description = object.description
                 note = object.note
 
-                [name, nickname, description, note].each do |variable|
+                [name, nickname, description, note].each_with_index do |variable, type|
                     next unless variable.is_a?(String)
 
                     variable = variable.strip
                     next if variable.empty?
 
-                    parsed = parse_variable(variable, game_type)
+                    parsed = parse_variable(variable, type, game_type)
                     next if parsed.nil?
 
                     parsed = parsed.gsub(/\r?\n/, '\#')
@@ -395,35 +419,44 @@ def self.read_other(other_files_paths, output_path, romanize, logging, game_type
                                 subparameter = subparameter.strip
                                 next if subparameter.empty?
 
-                                subparameter = romanize_string(subparameter) if romanize
+                                parsed = parse_parameter(code, subparameter, game_type)
+                                next if parsed.nil?
+
+                                parsed = romanize_string(parsed) if romanize
 
-                                other_translation_map.insert_at_index(other_lines.length, subparameter, '') if inner_processing_type == :append &&
-                                    !other_translation_map.include?(subparameter)
+                                other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
+                                    !other_translation_map.include?(parsed)
 
-                                other_lines.add(subparameter)
+                                other_lines.add(parsed)
                             end
                         elsif parameters[0].is_a?(String)
                             parameter = parameters[0].strip
                             next if parameter.empty?
 
-                            parameter = parameter.gsub(/\r?\n/, '\#')
-                            parameter = romanize_string(parameter) if romanize
+                            parsed = parse_parameter(code, parameter, game_type)
+                            next if parsed.nil?
 
-                            other_translation_map.insert_at_index(other_lines.length, parameter, '') if inner_processing_type == :append &&
-                                !other_translation_map.include?(parameter)
+                            parsed = parsed.gsub(/\r?\n/, '\#')
+                            parsed = romanize_string(parsed) if romanize
 
-                            other_lines.add(parameter)
+                            other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
+                                !other_translation_map.include?(parsed)
+
+                            other_lines.add(parsed)
                         elsif parameters[1].is_a?(String)
                             parameter = parameters[1].strip
                             next if parameter.empty?
 
-                            parameter = parameter.gsub(/\r?\n/, '\#')
-                            parameter = romanize_string(parameter) if romanize
+                            parsed = parse_parameter(code, parameter, game_type)
+                            next if parsed.nil?
+
+                            parsed = parsed.gsub(/\r?\n/, '\#')
+                            parsed = romanize_string(parsed) if romanize
 
-                            other_translation_map.insert_at_index(other_lines.length, parameter, '') if inner_processing_type == :append &&
-                                !other_translation_map.include?(parameter)
+                            other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
+                                !other_translation_map.include?(parsed)
 
-                            other_lines.add(parameter)
+                            other_lines.add(parsed)
                         end
                     end
                 end
@@ -653,7 +686,7 @@ def self.read_scripts(scripts_file_path, output_path, romanize, logging, process
                 string.match?(/^(.)\1{2,}$/) ||
                 string.match?(/^(false|true)$/) ||
                 string.match?(/^[wr]b$/) ||
-                string.match?(/^(?=.*\d)[A-Za-z0-9\-]+$/) ||
+                string.match?(/^(?=.*\d)[A-Za-z0-9-]+$/) ||
                 string.match?(/^[a-z\-()\/ +'&]*$/) ||
                 string.match?(/^[A-Za-z]+[+-]$/) ||
                 string.match?(STRING_IS_ONLY_SYMBOLS_RE) ||

data/lib/write.rb

@@ -74,52 +74,58 @@ end
 # @param [Hash{String => String}] hashmap Translation hashmap (as everything in Ruby passed by reference, this pass is free!)
 # @param [String] game_type
 def self.get_parameter_translated(code, parameter, hashmap, game_type)
+    ends_with_if = parameter[/ if\(.*\)$/]
+    parameter = parameter.chomp(ends_with_if) if ends_with_if
+
     unless game_type.nil?
-        lisa_start = nil
-
-        case code
-            when 401, 405
-                case game_type
-                    when 'lisa'
-                        match = parameter.scan(/^\\et\[[0-9]+\]/)
-                        match = parameter.scan(/^\\nbt/) if match.empty?
-
-                        unless match.empty?
-                            lisa_start = match[0]
-                            parameter = parameter.slice((match[0].length)..)
-                        end
+        case game_type
+            when 'lisa'
+                case code
+                    when 401, 405
+                        prefix = parameter[/^(\\et\[[0-9]+\]|\\nbt)/]
+                        parameter = parameter.sub(prefix, '') if prefix
+
+                        translated = hashmap[parameter]
+                        return nil if translated.nil? || translated.empty?
+
+                        translated = prefix + translated if prefix
+                        return translated
+                    when 102, 402
+                        # Implement some custom parsing
+                    when 356
+                        # Implement some custom parsing
                     else
                         nil
                 end
-            when 102, 402
-                # Implement some custom parsing
-            when 356
-                # Implement some custom parsing
-            else
-                nil
-        end
-
-        gotten = hashmap[parameter]
-        return nil if gotten.nil?
-
-        case game_type
-            when 'lisa'
-                gotten = lisa_start + gotten unless lisa_start.nil?
+                # Implement cases for other games
             else
                 nil
         end
-
-        return gotten
     end
 
-    hashmap[parameter]
+    translated = hashmap[parameter]
+    return nil if translated.nil? || translated.empty?
+    translated += ends_with_if if ends_with_if
+    translated
 end
 
 # @param [String] variable
+# # @param [Integer] type
 # @param [Hash{String => String}] hashmap Translation hashmap (as everything in Ruby passed by reference, this pass is free!)
 # @param [String] _game_type
 # @return [String]
-def self.get_variable_translated(variable, hashmap, _game_type)
+def self.get_variable_translated(variable, type, hashmap, _game_type)
+    variable = variable.gsub(/\r?\n/, "\n")
+
+    case type
+        when 0 # name
+        when 1 # nickname
+        when 2 # description
+        when 3 # note
+        else
+            nil
+    end
+
     hashmap[variable]
 end
 
@@ -208,7 +214,9 @@ def self.write_map(original_files_paths, maps_path, output_path, shuffle_level,
                                     list[index].parameters[0] = i < split_length ? split[i] : ''
                                 end
 
-                                list[item_indices.last].parameters[0] = split[line_length..].join("\n") if split_length > line_length
+                                if split_length > line_length
+                                    list[item_indices.last].parameters[0] = split[line_length..].join("\n")
+                                end
                             end
                         end
                         next
@@ -313,23 +321,21 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                 description = object.description
                 note = object.note
 
-                [name, nickname, description, note].each_with_index do |variable, i|
+                [name, nickname, description, note].each_with_index do |variable, type|
                     next unless variable.is_a?(String)
 
                     variable = variable.strip
                     next if variable.empty?
 
-                    variable = variable.gsub(/\r\n/, "\n")
                     variable = romanize_string(variable) if romanize
-
-                    translated = get_variable_translated(variable, other_translation_map, game_type)
+                    translated = get_variable_translated(variable, type, other_translation_map, game_type)
 
                     unless translated.nil? || translated.empty?
-                        if i.zero?
+                        if type.zero?
                             object.name = translated
-                        elsif i == 1
+                        elsif type == 1
                             object.nickname = translated if object.is_a?(RPG::Actor)
-                        elsif i == 2
+                        elsif type == 2
                             object.description = translated
                         else
                             object.note = translated
@@ -372,7 +378,9 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                                         list[index].parameters[0] = i < split_length ? split[i] : ''
                                     end
 
-                                    list[item_indices.last].parameters[0] = split[line_length..].join("\n") if split_length > line_length
+                                    if split_length > line_length
+                                        list[item_indices.last].parameters[0] = split[line_length..].join("\n")
+                                    end
                                 end
                             end
                             next

data/rvpacker-txt.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.9.4'
+    spec.version = '1.10.0'
     spec.authors = ['Howard Jeng', 'Andrew Kesterson', 'Solistra', 'Darkness9724', 'savannstm']
     spec.email = ['savannstm@gmail.com']
     spec.summary = 'Reads RPG Maker XP/VX/VXAce game text to .txt files and writes them to their initial form.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.9.4
+  version: 1.10.0
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-07-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email: