rvpacker-txt 1.8.4 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61d150da547df7d50d3920d89812ccbd4f238fd49b17524693ac78870018818
-  data.tar.gz: 8bdcf3ec6fef656d1b8e883a485f29d9ff56466c53bfbb1d5208adee13fb218d
+  metadata.gz: 23fd06cbc05cc7bb17005d3cdd79cae36a36256007eade05eef6570e157bcf68
+  data.tar.gz: b8e3e4f7088a6d9e1ef00818b4dc5a8684a51d49e76c40c8fe5076bc9d6a4cae
 SHA512:
-  metadata.gz: 6fe8e5c012762b40c85b843f428b966d24fadd5129fce757ce8f164f0779c27affda5959e85914f0d3e98dd920a85c4b50a4384004685558e6d2bd032b3916eb
-  data.tar.gz: b36cd1b4af5a0ec1e0fccfd520472ecc4596ac6a93bc88d30c51170f690d4269bd8bb0d9d0414b26b16e3301fec7b78943202b826bd2d91f6cff4faafc24d815
+  metadata.gz: 580408d4e6e8ae3b0e2d615d522d9a6f78e223e82f8bc5a735e1bd3868f5d0e7a0d7372406c011a7e3f03c18def481b61d00747d6f18d5c354b54568bdf7ee45
+  data.tar.gz: 6bb93fb3096248a63cba3147a0e9d0bc1b418d98cdae67479eacbbb6d255739c412d28fe3fa301a331b83dc98ababae7c0e850190a8241a4244e663b00043ef2

data/README.md

@@ -21,26 +21,27 @@ You can get a help message on usage using `rvpacker-txt -h`.
 
 ```
 $ rvpacker-txt -h
-This tool allows to parse RPG Maker project to .txt files and back.
+This tool allows to parse RPG Maker games to .txt files and write them back to their initial form.
 
-Usage: rvpacker-txt COMMAND [options]
+Usage: rvpacker-txt COMMAND [OPTIONS]
 
 COMMANDS:
-    read - Parses RPG Maker game files to .txt
-    write - Writes parsed files back to their initial form
+    read - Parses files from "original" or "data" folders of input directory to "translation" folder of output directory.
+    write - Writes translated files using original files from "original" or "data" folder of input directory and writes results to "output" folder of output directory.
 OPTIONS:
-    -i, --input-dir DIR              Input directory of RPG Maker project
-    -o, --output-dir DIR             Output directory of parsed/written files
-        --disable-processing FILES   Don't process specified files (maps, other, system, scripts)
-    -s, --shuffle NUM                Shuffle level (1: lines, 2: lines and words)
-        --disable-custom-processing  Disables built-in custom parsing/writing for some games
-    -l, --log                        Log information while processing
-    -f, --force                      Force rewrite all files. Cannot be used with --append
-                                     USE WITH CAUTION!
-    -a, --append                     When you update the rvpacker-txt, you probably should re-read
-                                     your files with append, as some new text might be added to parser
-                                     Cannot be used with --force
-    -h, --help                       Show help message
+    -i, --input-dir PATH             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.
+    -o, --output-dir PATH            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.
+        --disable-processing FILES   Skips processing specified files.
+                                     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.
+    -l, --log                        Enables logging.
+    -h, --help                       Prints the program's help message or for the entered subcommand.
 ```
 
 For example, to read a RPG Maker VX Ace project in E:/Documents/RPGMakerGame to .txt files:

data/bin/rvpacker-txt

@@ -7,21 +7,81 @@ require 'fileutils'
 require 'classes'
 
 def self.parse_options
-    options = { disable_processing: {}, input_dir: './', output_dir: './', shuffle_level: 0 }
+    options = { action: nil,
+                input_path: './',
+                output_path: './',
+                disable_processing: {
+                    maps: false,
+                    other: false,
+                    system: false,
+                    scripts: false
+                },
+                disable_custom_processing: false,
+                romanize_string: false,
+                logging: false,
+                force: false,
+                append: false,
+                shuffle_level: 0 }
+
+    options[:action] = ARGV[0]
+
+    unless %w[read write].include?(options[:action])
+        if %w[-h --help].include?(options[:action])
+            options[:action] = 'none'
+        elsif options[:action].nil?
+            raise 'COMMAND argument is required. Use rvpacker-txt -h for help.'
+        else
+            raise 'Invalid command. Allowed commands: read, write.'
+        end
+    end
 
-    OptionParser.new do |cmd|
-        cmd.banner = "This tool allows to parse RPG Maker project to .txt files and back.\n\nUsage: rvpacker-txt COMMAND [options]\n\nCOMMANDS:\n    read - Parses RPG Maker game files to .txt\n    write - Writes parsed files back to their initial form\nOPTIONS:\n"
+    read_command_description = 'Parses files from "original" or "data" folders of input directory to "translation" folder of output directory.'
+    write_command_description = 'Writes translated files using original files from "original" or "data" folder of input directory and writes results to "output" folder of output directory.'
+    banner_text = "This tool allows to parse RPG Maker games to .txt files and write them back to their initial form.\n\nUsage: rvpacker-txt COMMAND [OPTIONS]\n\nCOMMANDS:\n    read - #{read_command_description}\n    write - #{write_command_description}\nOPTIONS:"
+
+    banner,
+        input_dir_description,
+        output_dir_description,
+        romanize_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.']]
+            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.',]]
+            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.']]
+        end
 
-        cmd.on('-i', '--input-dir DIR', String, 'Input directory of RPG Maker project') do |dir|
-            options[:input_dir] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
-            options[:output_dir] = options[:input_dir]
+    OptionParser.new(banner) do |cmd|
+        cmd.on('-i', '--input-dir PATH', String,
+               *input_dir_description) do |dir|
+            options[:input_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+            options[:output_path] = options[:input_path]
         end
 
-        cmd.on('-o', '--output-dir DIR', String, 'Output directory of parsed/written files') do |dir|
-            options[:output_dir] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+        cmd.on('-o', '--output-dir PATH', String,
+               *output_dir_description) do |dir|
+            options[:output_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
         end
 
-        cmd.on('--disable-processing FILES', Array, "Don't process specified files (maps, other, system, scripts)") do |files|
+        cmd.on('--disable-processing FILES', Array,
+               'Skips processing specified files.',
+               'Example: --disable-processing=maps,other,system.',
+               '[Allowed values: maps, other, system, scripts]') do |files|
             files.each do |file|
                 files = %w[maps other system scripts]
                 index = files.find_index(file)
@@ -29,39 +89,51 @@ def self.parse_options
             end
         end
 
-        cmd.on('-s', '--shuffle NUM', Integer, 'Shuffle level when writing (1: lines, 2: lines and words)') do |num|
-            options[:shuffle_level] = num
-        end
-
-        cmd.on('--disable-custom-processing', 'Disables built-in custom parsing/writing for some games') do
+        cmd.on('--disable-custom-processing',
+               'Disables built-in custom parsing/writing for some games.') do
             options[:disable_custom_processing] = true
         end
 
-        cmd.on('-l', '--log', 'Log information while processing') do
-            options[:logging] = true
+        cmd.on('-r', '--romanize',
+               *romanize_description) do
+            options[:romanize_string] = true
         end
 
-        cmd.on('-f', '--force', 'Force rewrite all files. Cannot be used with --append', 'USE WITH CAUTION!') do
-            options[:force] = true
+        if options[:action] == 'read'
+            cmd.on('-f', '--force',
+                   'Force rewrite all files. Cannot be used with --append.',
+                   'USE WITH CAUTION!') do
+                options[:force] = true
+            end
+
+            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.',
+                   'Cannot be used with --force.') do
+                raise '--append cannot be used with --force.' if options[:force]
+                options[:append] = true
+            end
+        elsif options[:action] == 'write'
+            cmd.on('-s', '--shuffle-level NUMBER', Integer,
+                   'With value 1, shuffles all translation lines. With value 2, shuffles all words and lines in translation text.',
+                   'Example: --shuffle-level 1.',
+                   '[Allowed values: 0, 1, 2]',
+                   '[Default value: 0]') do |num|
+                raise 'Allowed values: 0, 1, 2.' if num > 2
+                options[:shuffle_level] = num
+            end
         end
 
-        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',
-               'Cannot be used with --force') do
-            raise '--append cannot be used with --force.' if options[:force]
-            options[:append] = true
+        cmd.on('-l', '--log', 'Enables logging.') do
+            options[:logging] = true
         end
 
-        cmd.on('-h', '--help', 'Show help message') do
+        cmd.on('-h', '--help', "Prints the program's help message or for the entered subcommand.") do
             puts cmd
             exit
         end
     end.parse!
 
-    options[:action] = ARGV.shift
-    raise 'COMMAND argument is required. Use rvpacker-txt -h for help.' if options[:action].nil?
-    raise 'Invalid command. Allowed commands are: read, write.' unless %w[read write].include?(options[:action])
-
     options
 end
 
@@ -69,34 +141,44 @@ end
 # @return [String, nil]
 def self.get_game_type(system_file_path)
     object = Marshal.load(File.binread(system_file_path))
-    game_title = object.instance_variable_get(:@game_title).to_s.downcase
+    game_title = object.game_title.to_s.downcase
     game_title.include?('lisa') ? 'lisa' : nil
 end
 
 start_time = Time.now
 
 options = parse_options
-input_dir = options[:input_dir]
-output_dir = options[:output_dir]
+# @type [String]
+input_path = options[:input_path]
+# @type [String]
+output_path = options[:output_path]
+# @type [Boolean]
 disable_custom_processing = options[:disable_custom_processing]
+# @type [Integer]
 shuffle_level = options[:shuffle_level]
+# @type [Boolean]
 logging = options[:logging]
+# @type [Hash{Symbol => Boolean}]
 disable_processing = options[:disable_processing]
+# @type [Boolean]
 force = options[:force]
+# @type [Boolean]
 append = options[:append]
+# @type [Boolean]
+romanize = options[:romanize_string]
 
 extensions = { xp: 'rxdata', vx: 'rvdata', ace: 'rvdata2' }
 
-original_directory = Dir.glob(File.join(input_dir, '{data,original}'), File::FNM_CASEFOLD).first
+original_directory = Dir.glob(File.join(input_path, '{data,original}'), File::FNM_CASEFOLD).first
 raise '"Data" or "original" directory not found within input directory.' unless original_directory
 
-maps_path = File.join(input_dir, 'translation', 'maps')
-other_path = File.join(input_dir, 'translation', 'other')
+maps_path = File.join(input_path, 'translation', 'maps')
+other_path = File.join(input_path, 'translation', 'other')
 
 FileUtils.mkdir_p(maps_path)
 FileUtils.mkdir_p(other_path)
 
-engine = extensions.each { |sym, ext| break sym if File.exist?(File.join(original_directory, "System.#{ext}")) } ||
+engine = extensions.each_pair { |sym, ext| break sym if File.exist?(File.join(original_directory, "System.#{ext}")) } ||
     (raise "Couldn't determine project engine.")
 
 files = Dir.glob("#{original_directory}/*#{extensions[engine]}")
@@ -121,45 +203,47 @@ files.each do |file|
     end
 end
 
-ini_file_path = File.join(input_dir, 'Game.ini')
+ini_file_path = File.join(input_path, 'Game.ini')
 
 game_type = disable_custom_processing ? nil : get_game_type(system_file_path)
 
-wait_time = 0
-processing_type = if force
-                      wait_time_start = Time.now
-
-                      puts "WARNING! You're about to forcefully rewrite all your translation files, including _trans files.",
-                           "If you really want to do it, make sure you've made a backup of your _trans files, if you made some changes in them already.",
-                           "Input 'Y' to continue."
-                      exit unless gets.chomp == 'Y'
-
-                      wait_time = Time.now - wait_time_start
-                      :force
-                  else
-                      append ? :append : :default
-                  end
-
 puts 'Custom processing for this game is enabled. Use --disable-custom-processing to disable it.' unless game_type.nil?
 
+$wait_time = 0
+
 if options[:action] == 'read'
     require 'read'
-    read_map(maps_files_paths, maps_path, logging, game_type, processing_type) unless disable_processing[:maps]
-    read_other(other_files_paths, other_path, logging, game_type, processing_type) unless disable_processing[:other]
-    read_system(system_file_path, ini_file_path, other_path, logging, processing_type) unless disable_processing[:system]
-    read_scripts(scripts_file_path, other_path, logging, processing_type) unless disable_processing[:scripts]
+
+    processing_type = if force
+                          wait_time_start = Time.now
+
+                          puts "WARNING! You're about to forcefully rewrite all your translation files, including _trans files.",
+                               "If you really want to do it, make sure you've made a backup of your _trans files, if you made some changes in them already.",
+                               "Input 'Y' to continue."
+                          exit unless $stdin.gets.chomp == 'Y'
+
+                          $wait_time += Time.now - wait_time_start
+                          :force
+                      elsif append
+                          :append
+                      else
+                          :default
+                      end
+
+    read_map(maps_files_paths, maps_path, romanize, logging, game_type, processing_type) unless disable_processing[:maps]
+    read_other(other_files_paths, other_path, romanize, logging, game_type, processing_type) unless disable_processing[:other]
+    read_system(system_file_path, ini_file_path, other_path, romanize, logging, processing_type) unless disable_processing[:system]
+    read_scripts(scripts_file_path, other_path, romanize, logging, processing_type) unless disable_processing[:scripts]
 else
     require 'write'
-    output_path = File.join(output_dir, 'output')
+
+    output_path = File.join(output_path, 'output')
     FileUtils.mkdir_p(output_path)
 
-    write_map(maps_files_paths, maps_path, output_path, shuffle_level, logging, game_type) unless disable_processing[:maps]
-    write_other(other_files_paths, other_path, output_path, shuffle_level, logging, game_type) unless disable_processing[:other]
-    write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, logging) unless disable_processing[:system]
-    write_scripts(scripts_file_path, other_path, output_path, logging) unless disable_processing[:scripts]
+    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]
+    write_scripts(scripts_file_path, other_path, output_path, romanize, logging) unless disable_processing[:scripts]
 end
 
-$wait_time = 0 if $wait_time.nil?
-elapsed_time = Time.now - start_time - wait_time - $wait_time
-
-puts "Done in #{elapsed_time}"
+puts "Done in #{Time.now - start_time - $wait_time}"

data/lib/classes.rb

@@ -83,7 +83,7 @@ class IndexSet
 
     def add(item)
         return if @hash.include?(item)
-        @hash[item] = hash.size
+        @hash[item] = @hash.size
         @hash
     end
 

data/lib/read.rb

@@ -2,6 +2,9 @@
 
 require 'zlib'
 
+STRING_IS_ONLY_SYMBOLS_RE = /^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼| ]+$/
+APPEND_FLAG_OMIT_MSG = "Files aren't already parsed. Continuing as if --append flag was omitted."
+
 class Hash
     def insert_at_index(index, key, value)
         return self[key] = value if index >= size
@@ -12,6 +15,51 @@ class Hash
     end
 end
 
+# @param [String] string
+# @return [String]
+def self.romanize_string(string)
+    string.each_char.each_with_index do |char, i|
+        case char
+            when '。'
+                string[i] = '.'
+            when '、'
+                string[i] = ','
+            when '・'
+                string[i] = '·'
+            when '゠'
+                string[i] = '–'
+            when '＝'
+                string[i] = '—'
+            when '…'
+                string[i, 3] = '...'
+            when '「', '」', '〈', '〉'
+                string[i] = "'"
+            when '『', '』', '《', '》'
+                string[i] = '"'
+            when '（', '〔', '｟', '〘'
+                string[i] = '('
+            when '）', '〕', '｠', '〙'
+                string[i] = ')'
+            when '｛'
+                string[i] = '{'
+            when '｝'
+                string[i] = '}'
+            when '［', '【', '〖', '〚'
+                string[i] = '['
+            when '］', '】', '〗', '〛'
+                string[i] = ']'
+            when '〜'
+                string[i] = '~'
+            when '？'
+                string[i] = '?'
+            else
+                nil
+        end
+    end
+
+    string
+end
+
 # @param [String] string A parsed scripts code string, containing raw Ruby code
 # @return [IndexSet<String>] Set of extracted strings
 def self.extract_quoted_strings(string)
@@ -49,16 +97,16 @@ def self.extract_quoted_strings(string)
                 next
             end
 
-            if in_quotes
-                if char == "\r"
-                    next
-                elsif char == "\n"
-                    buffer.push('\#')
-                    next
-                end
+            next unless in_quotes
 
-                buffer.push(char)
+            if char == "\r"
+                next
+            elsif char == "\n"
+                buffer.push('\#')
+                next
             end
+
+            buffer.push(char)
         end
     end
 
@@ -70,6 +118,8 @@ end
 # @param [String] game_type
 # @return [String]
 def self.parse_parameter(code, parameter, game_type)
+    return nil if parameter.match?(STRING_IS_ONLY_SYMBOLS_RE)
+
     unless game_type.nil?
         case code
             when 401, 405
@@ -97,6 +147,7 @@ end
 # @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?
 
     return nil if variable.split('\#').all? { |line| line.strip.match?(/(^#? ?<.*>\.?$)|^$/) }
@@ -109,10 +160,11 @@ end
 
 # @param [Array<String>] maps_files_paths
 # @param [String] output_path
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] game_type
 # @param [String] processing_type
-def self.read_map(maps_files_paths, output_path, logging, game_type, processing_type)
+def self.read_map(maps_files_paths, output_path, romanize, logging, game_type, processing_type)
     maps_output_path = File.join(output_path, 'maps.txt')
     names_output_path = File.join(output_path, 'names.txt')
     maps_trans_output_path = File.join(output_path, 'maps_trans.txt')
@@ -138,7 +190,7 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
             names_translation_map = Hash[File.readlines(names_output_path, chomp: true)
                                              .zip(File.readlines(names_trans_output_path, chomp: true))]
         else
-            puts "Files aren't already parsed. Continuing as if --append flag was omitted."
+            puts APPEND_FLAG_OMIT_MSG
             processing_type = :default
         end
     end
@@ -155,6 +207,8 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
             display_name = display_name.strip
 
             unless display_name.empty?
+                display_name = romanize_string(display_name) if romanize
+
                 names_translation_map.insert_at_index(names_lines.length, display_name, '') if processing_type == :append &&
                     !names_translation_map.include?(display_name)
 
@@ -184,13 +238,17 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
                             joined = line.join('\#').strip
                             parsed = parse_parameter(401, joined, game_type)
 
-                            maps_translation_map.insert_at_index(maps_lines.length, parsed, '') if processing_type == :append &&
-                                !maps_translation_map.include?(parsed)
+                            unless parsed.nil?
+                                parsed = romanize_string(parsed) if romanize
 
-                            maps_lines.add(parsed)
+                                maps_translation_map.insert_at_index(maps_lines.length, parsed, '') if processing_type == :append &&
+                                    !maps_translation_map.include?(parsed)
 
-                            line.clear
-                            in_sequence = false
+                                maps_lines.add(parsed)
+
+                                line.clear
+                                in_sequence = false
+                            end
                         end
                         next
                     end
@@ -212,6 +270,8 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
                             parsed = parse_parameter(code, subparameter, game_type)
                             next if parsed.nil?
 
+                            parsed = romanize_string(parsed) if romanize
+
                             maps_translation_map.insert_at_index(maps_lines.length, parsed, '') if processing_type == :append &&
                                 !maps_translation_map.include?(parsed)
 
@@ -225,6 +285,7 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
                         next if parsed.nil?
 
                         parsed = parsed.gsub(/\r?\n/, '\#')
+                        parsed = romanize_string(parsed) if romanize
 
                         maps_translation_map.insert_at_index(maps_lines.length, parsed, '') if processing_type == :append &&
                             !maps_translation_map.include?(parsed)
@@ -261,10 +322,11 @@ end
 
 # @param [Array<String>] other_files_paths
 # @param [String] output_path
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] game_type
 # @param [String] processing_type
-def self.read_other(other_files_paths, output_path, logging, game_type, processing_type)
+def self.read_other(other_files_paths, output_path, romanize, logging, game_type, processing_type)
     other_object_array_map = Hash[other_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     inner_processing_type = processing_type
@@ -294,7 +356,7 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                 other_translation_map = Hash[File.readlines(other_output_path, chomp: true)
                                                  .zip(File.readlines(other_trans_output_path, chomp: true))]
             else
-                puts "Files aren't already parsed. Continuing as if --append flag was omitted."
+                puts APPEND_FLAG_OMIT_MSG
                 inner_processing_type = :default
             end
         end
@@ -318,6 +380,7 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                     next if parsed.nil?
 
                     parsed = parsed.gsub(/\r?\n/, '\#')
+                    parsed = romanize_string(parsed) if romanize
 
                     other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
                         !other_translation_map.include?(parsed)
@@ -347,13 +410,17 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                                 joined = line.join('\#').strip
                                 parsed = parse_parameter(401, joined, game_type)
 
-                                other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
-                                    !other_translation_map.include?(parsed)
+                                unless parsed.nil?
+                                    parsed = romanize_string(parsed) if romanize
 
-                                other_lines.add(parsed)
+                                    other_translation_map.insert_at_index(other_lines.length, parsed, '') if inner_processing_type == :append &&
+                                        !other_translation_map.include?(parsed)
 
-                                line.clear
-                                in_sequence = false
+                                    other_lines.add(parsed)
+
+                                    line.clear
+                                    in_sequence = false
+                                end
                             end
                             next
                         end
@@ -372,6 +439,8 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                                 subparameter = subparameter.strip
                                 next if subparameter.empty?
 
+                                subparameter = romanize_string(subparameter) if romanize
+
                                 other_translation_map.insert_at_index(other_lines.length, subparameter, '') if inner_processing_type == :append &&
                                     !other_translation_map.include?(subparameter)
 
@@ -382,6 +451,7 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                             next if parameter.empty?
 
                             parameter = parameter.gsub(/\r?\n/, '\#')
+                            parameter = romanize_string(parameter) if romanize
 
                             other_translation_map.insert_at_index(other_lines.length, parameter, '') if inner_processing_type == :append &&
                                 !other_translation_map.include?(parameter)
@@ -392,6 +462,7 @@ def self.read_other(other_files_paths, output_path, logging, game_type, processi
                             next if parameter.empty?
 
                             parameter = parameter.gsub(/\r?\n/, '\#')
+                            parameter = romanize_string(parameter) if romanize
 
                             other_translation_map.insert_at_index(other_lines.length, parameter, '') if inner_processing_type == :append &&
                                 !other_translation_map.include?(parameter)
@@ -432,9 +503,10 @@ end
 # @param [String] system_file_path
 # @param [String] ini_file_path
 # @param [String] output_path
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] processing_type
-def self.read_system(system_file_path, ini_file_path, output_path, logging, processing_type)
+def self.read_system(system_file_path, ini_file_path, output_path, romanize, logging, processing_type)
     system_filename = File.basename(system_file_path)
     system_basename = File.basename(system_file_path, '.*').downcase
 
@@ -456,7 +528,7 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
             system_translation_map = Hash[File.readlines(system_output_path, chomp: true)
                                               .zip(File.readlines(system_trans_output_path, chomp: true))]
         else
-            puts "Files aren't already parsed. Continuing as if --append flag was omitted."
+            puts APPEND_FLAG_OMIT_MSG
             processing_type = :default
         end
     end
@@ -477,6 +549,8 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
             string = string.strip
             next if string.empty?
 
+            string = romanize_string(string) if romanize
+
             system_translation_map.insert_at_index(system_lines.length, string, '') if processing_type == :append &&
                 !system_translation_map.include?(string)
 
@@ -488,6 +562,8 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
         currency_unit = currency_unit.strip
 
         unless currency_unit.empty?
+            currency_unit = romanize_string(currency_unit) if romanize
+
             system_translation_map.insert_at_index(system_lines.length, currency_unit, '') if processing_type == :append &&
                 !system_translation_map.include?(currency_unit)
 
@@ -502,6 +578,8 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
             value = value.strip
 
             unless value.empty?
+                value = romanize_string(string) if romanize
+
                 system_translation_map.insert_at_index(system_lines.length, value, '') if processing_type == :append &&
                     !system_translation_map.include?(value)
 
@@ -514,6 +592,8 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
                 string = string.strip
                 next if string.empty?
 
+                string = romanize_string(string) if romanize
+
                 system_translation_map.insert_at_index(system_lines.length, string, '') if processing_type == :append &&
                     !system_translation_map.include?(string)
 
@@ -525,6 +605,7 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
     # Game title from System file and ini file may differ, but requesting user request to determine which line do they want is LAME
     # So just throw that ini ass and continue
     ini_game_title = read_ini_title(ini_file_path).strip
+    ini_game_title = romanize_string(ini_game_title) if romanize
 
     system_translation_map.insert_at_index(system_lines.length, ini_game_title, '') if processing_type == :append &&
         !system_translation_map.include?(ini_game_title)
@@ -547,9 +628,10 @@ end
 
 # @param [String] scripts_file_path
 # @param [String] output_path
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] processing_type
-def self.read_scripts(scripts_file_path, output_path, logging, processing_type)
+def self.read_scripts(scripts_file_path, output_path, romanize, logging, processing_type)
     scripts_filename = File.basename(scripts_file_path)
     scripts_basename = File.basename(scripts_file_path, '.*').downcase
 
@@ -572,7 +654,7 @@ def self.read_scripts(scripts_file_path, output_path, logging, processing_type)
             scripts_translation_map = Hash[File.readlines(scripts_output_path, chomp: true)
                                                .zip(File.readlines(scripts_trans_output_path, chomp: true))]
         else
-            puts "Files aren't already parsed. Continuing as if --append flag was omitted."
+            puts APPEND_FLAG_OMIT_MSG
             processing_type = :default
         end
     end
@@ -618,7 +700,7 @@ def self.read_scripts(scripts_file_path, output_path, logging, processing_type)
                 string.match?(/^(?=.*\d)[A-Za-z0-9\-]+$/) ||
                 string.match?(/^[a-z\-()\/ +'&]*$/) ||
                 string.match?(/^[A-Za-z]+[+-]$/) ||
-                string.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼|]$/) ||
+                string.match?(STRING_IS_ONLY_SYMBOLS_RE) ||
                 string.match?(/^Tile.*[A-Z]$/) ||
                 string.match?(/^[a-zA-Z][a-z]+([A-Z][a-z]*)+$/) ||
                 string.match?(/^Cancel Action$|^Invert$|^End$|^Individual$|^Missed File$|^Bitmap$|^Audio$/) ||
@@ -645,6 +727,8 @@ def self.read_scripts(scripts_file_path, output_path, logging, processing_type)
                 string.match?(/Clear image/) ||
                 string.match?(/Can Collapse/)
 
+            string = romanize_string(string) if romanize
+
             scripts_translation_map.insert_at_index(scripts_lines.length, string, '') if processing_type == :append &&
                 !scripts_translation_map.include?(string)
 

data/lib/write.rb

@@ -2,6 +2,49 @@
 
 require 'zlib'
 
+# @param [String] string
+# @return [String]
+def self.romanize_string(string)
+    string.each_char.each_with_index do |char, i|
+        case char
+            when '。'
+                string[i] = '.'
+            when '、'
+                string[i] = ','
+            when '・'
+                string[i] = '·'
+            when '゠'
+                string[i] = '–'
+            when '＝'
+                string[i] = '—'
+            when '…'
+                string[i, 3] = '...'
+            when '「', '」', '〈', '〉'
+                string[i] = "'"
+            when '『', '』', '《', '》'
+                string[i] = '"'
+            when '（', '〔', '｟', '〘'
+                string[i] = '('
+            when '）', '〕', '｠', '〙'
+                string[i] = ')'
+            when '｛'
+                string[i] = '{'
+            when '｝'
+                string[i] = '}'
+            when '［', '【', '〖', '〚'
+                string[i] = '['
+            when '］', '】', '〗', '〛'
+                string[i] = ']'
+            when '〜'
+                string[i] = '~'
+            else
+                nil
+        end
+    end
+
+    string
+end
+
 # @param [String] string A parsed scripts code string, containing raw Ruby code
 # @return [Array<Array<String, Integer>>] Hash of parsed from code strings and their start indices
 def self.extract_quoted_strings(string)
@@ -126,9 +169,10 @@ end
 # @param [String] maps_path
 # @param [String] output_path
 # @param [Integer] shuffle_level
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] game_type
-def self.write_map(original_files_paths, maps_path, output_path, shuffle_level, logging, game_type)
+def self.write_map(original_files_paths, maps_path, output_path, shuffle_level, romanize, logging, game_type)
     maps_object_map = Hash[original_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     maps_original_text = File.readlines(File.join(maps_path, 'maps.txt'), encoding: 'UTF-8', chomp: true).map do |line|
@@ -192,6 +236,8 @@ def self.write_map(original_files_paths, maps_path, output_path, shuffle_level,
                     unless allowed_codes.include?(code)
                         if in_sequence
                             joined = line.join('\#').strip
+                            joined = romanize_string(joined) if romanize
+
                             translated = get_parameter_translated(401, joined, maps_translation_map, game_type)
 
                             unless translated.nil? || translated.empty?
@@ -225,6 +271,8 @@ def self.write_map(original_files_paths, maps_path, output_path, shuffle_level,
                             subparameter = subparameter.strip
                             next if subparameter.empty?
 
+                            subparameter = romanize_string(subparameter) if romanize
+
                             translated = get_parameter_translated(code, subparameter, maps_translation_map, game_type)
                             parameters[0][sp] = translated unless translated.nil? || translated.empty?
                         end
@@ -232,12 +280,16 @@ def self.write_map(original_files_paths, maps_path, output_path, shuffle_level,
                         parameter = parameters[0].strip
                         next if parameter.empty?
 
+                        parameter = romanize_string(parameter) if romanize
+
                         translated = get_parameter_translated(code, parameter, maps_translation_map, game_type)
                         parameters[0] = translated unless translated.nil? || translated.empty?
                     elsif parameters[1].is_a?(String)
                         parameter = parameters[1].strip
                         next if parameter.empty?
 
+                        parameter = romanize_string(parameter) if romanize
+
                         translated = get_parameter_translated(code, parameter, maps_translation_map, game_type)
                         parameters[1] = translated unless translated.nil? || translated.empty?
                     end
@@ -265,9 +317,10 @@ end
 # @param [String] other_path
 # @param [String] output_path
 # @param [Integer] shuffle_level
+# @param [Boolean] romanize
 # @param [Boolean] logging
 # @param [String] game_type
-def self.write_other(original_files_paths, other_path, output_path, shuffle_level, logging, game_type)
+def self.write_other(original_files_paths, other_path, output_path, shuffle_level, romanize, logging, game_type)
     other_object_array_map = Hash[original_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     # 401 - dialogue lines
@@ -309,6 +362,8 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                     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)
 
                     unless translated.nil? || translated.empty?
@@ -345,6 +400,8 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                         unless allowed_codes.include?(code)
                             if in_sequence
                                 joined = line.join('\#').strip
+                                joined = romanize_string(joined) if romanize
+
                                 translated = get_parameter_translated(401, joined, other_translation_map, game_type)
 
                                 unless translated.nil? || translated.empty?
@@ -378,6 +435,8 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                                 subparameter = subparameter.strip
                                 next if subparameter.empty?
 
+                                subparameter = romanize_string(subparameter) if romanize
+
                                 translated = get_parameter_translated(code, subparameter, other_translation_map, game_type)
                                 parameters[0][sp] = translated unless translated.nil? || translated.empty?
                             end
@@ -385,12 +444,16 @@ def self.write_other(original_files_paths, other_path, output_path, shuffle_leve
                             parameter = parameters[0].strip
                             next if parameter.empty?
 
+                            parameter = romanize_string(parameter) if romanize
+
                             translated = get_parameter_translated(code, parameter, other_translation_map, game_type)
                             parameters[0] = translated unless translated.nil? || translated.empty?
                         elsif parameters[1].is_a?(String)
                             parameter = parameters[1].strip
                             next if parameter.empty?
 
+                            parameter = romanize_string(parameter) if romanize
+
                             translated = get_parameter_translated(code, parameter, other_translation_map, game_type)
                             parameters[1] = translated unless translated.nil? || translated.empty?
                         end
@@ -421,6 +484,7 @@ end
 def self.write_ini_title(ini_file_path, translated)
     file_lines = File.readlines(ini_file_path, chomp: true)
     title_line_index = file_lines.each_with_index { |line, i| break i if line.downcase.start_with?('title') }
+    return if title_line_index.is_a?(Array)
 
     file_lines[title_line_index] = translated
     File.binwrite(ini_file_path, file_lines.join("\n"))
@@ -431,8 +495,9 @@ end
 # @param [String] other_path
 # @param [String] output_path
 # @param [Integer] shuffle_level
+# @param [Boolean] romanize
 # @param [Boolean] logging
-def self.write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, logging)
+def self.write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, romanize, logging)
     system_basename = File.basename(system_file_path)
     system_object = Marshal.load(File.binread(system_file_path))
 
@@ -455,7 +520,7 @@ def self.write_system(system_file_path, ini_file_path, other_path, output_path,
     weapon_types = system_object.weapon_types
     armor_types = system_object.armor_types
     currency_unit = system_object.currency_unit
-    terms = system_object.terms || system_object.words
+    terms_vocabulary = system_object.terms || system_object.words
 
     [elements, skill_types, weapon_types, armor_types].each_with_index do |array, i|
         next unless array.is_a?(Array)
@@ -464,6 +529,8 @@ def self.write_system(system_file_path, ini_file_path, other_path, output_path,
             string = string.strip
             next if string.empty?
 
+            string = romanize_string(string) if romanize
+
             translated = system_translation_map[string]
             array[i] = translated unless translated.nil? || translated.empty?
         end
@@ -479,35 +546,42 @@ def self.write_system(system_file_path, ini_file_path, other_path, output_path,
         end
     end
 
+    currency_unit = romanize_string(currency_unit) if romanize
     currency_unit_translated = system_translation_map[currency_unit]
     system_object.currency_unit = currency_unit_translated if currency_unit.is_a?(String) &&
         (!currency_unit_translated.nil? && !currency_unit_translated.empty?)
 
-    terms.instance_variables.each do |variable|
-        value = terms.instance_variable_get(variable)
+    terms_vocabulary.instance_variables.each do |variable|
+        value = terms_vocabulary.instance_variable_get(variable)
 
         if value.is_a?(String)
-            stripped = value.strip
+            value = value.strip
             next if value.empty?
 
-            translated = system_translation_map[stripped]
+            value = romanize_string(value) if romanize
+
+            translated = system_translation_map[value]
             value = translated unless translated.nil? || translated.empty?
         elsif value.is_a?(Array)
             value.each_with_index do |string, i|
                 string = string.strip
                 next if string.empty?
 
+                string = romanize_string(string) if romanize
+
                 translated = system_translation_map[string]
                 value[i] = translated unless translated.nil? || translated.empty?
             end
         end
 
-        terms.instance_variable_set(variable, value)
+        terms_vocabulary.instance_variable_set(variable, value)
     end
 
-    system_object.terms.nil? ?
-        system_object.words = terms :
-        system_object.terms = terms
+    if system_object.terms.nil?
+        system_object.words = terms_vocabulary
+    else
+        system_object.terms = terms_vocabulary
+    end
 
     game_title_translated = system_translated_text[-1]
 
@@ -523,8 +597,9 @@ end
 # @param [String] scripts_file_path Path to Scripts.*data file
 # @param [String] other_path Path to translation/other directory containing .txt files
 # @param [String] output_path Path to the output directory
+# @param [Boolean] romanize
 # @param [Boolean] logging Whether to log
-def self.write_scripts(scripts_file_path, other_path, output_path, logging)
+def self.write_scripts(scripts_file_path, other_path, output_path, romanize, logging)
     scripts_basename = File.basename(scripts_file_path)
     script_entries = Marshal.load(File.binread(scripts_file_path))
 
@@ -564,6 +639,8 @@ def self.write_scripts(scripts_file_path, other_path, output_path, logging)
             string = string.strip.delete('　')
             next if string.empty? || !scripts_translation_map.include?(string)
 
+            string = romanize_string(string) if romanize
+
             gotten = scripts_translation_map[string]
             code[index - string.length, string.length] = gotten unless gotten.nil? || gotten.empty?
         end

data/rvpacker-txt.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.8.4'
+    spec.version = '1.9.0'
     spec.authors = ['Howard Jeng', 'Andrew Kesterson', 'Solistra', 'Darkness9724', 'savannstm']
     spec.email = ['savannstm@gmail.com']
-    spec.summary = 'Reads or writes RPG Maker XP/VX/VXAce game text to .txt files'
+    spec.summary = 'Reads RPG Maker XP/VX/VXAce game text to .txt files and writes them to their initial form.'
     spec.homepage = 'https://github.com/savannstm/rvpacker-txt'
     spec.license = 'MIT'
     spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.9.0
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -53,5 +53,6 @@ requirements: []
 rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
-summary: Reads or writes RPG Maker XP/VX/VXAce game text to .txt files
+summary: Reads RPG Maker XP/VX/VXAce game text to .txt files and writes them to their
+  initial form.
 test_files: []