rvpacker-txt 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0504a1427ffcd718aedc6a6db70bce63331ef54046b9e5abe0037d60ffbb0445
-  data.tar.gz: fa94b889274185fa2c6adfb1bd539ded6a8ecf7b1e05702bdf49a557376e9d7d
+  metadata.gz: 2b17d69aea817f8b41bc154daf4a4f6c6f4c2a0200427cefefadf593c8fae715
+  data.tar.gz: 79a5a1f73df2a44a7571df5fb47bb76c234ecf774946cbdeb51d6a23265a7e13
 SHA512:
-  metadata.gz: 9d16fa9c8cecf327cbc947250fe8b9f84b4cf0656a80d12caded68d74c2037f7971a8630469389542b8548b5737ff110aa2cdd0936eb34b822d646e3bc661a21
-  data.tar.gz: c0fb36404458b2fc15546c10782ca43841e9179d139e65ced2f12478345911e7d67ad2751e4f43ea7756490b032c43b34777493161f75187de51686fa7ee223d
+  metadata.gz: 5ef9f467c491d122c582f0af55ded8757de79e1bc41eb92b9fdb40617a83b8b06d0cb57dae3d8ae7fc5e397004977b308d303b4489446654022b19ba79279d91
+  data.tar.gz: 00fa12e46f27a7c225bf76179431f4e680d9e4da2c85c48ff0e2355b257254eab80c31d5e07e9be1681982c450d4bfbb3d8d48d41e9e1ab2343af9e7872bcb20

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rvpacker-txt.gemspec
-gemspec
+gemspec
+gem 'rubocop', group: 'development', require: false

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/bin/rvpacker-txt

@@ -1,51 +1,55 @@
 #!/usr/bin/env ruby
-require 'RGSS'
+require 'classes'
 require 'optparse'
 
 $logging = false
-$no = [true, true, true, true] # 0 is whether to process maps, 1 is other, 2 is system, 3 is scripts
+$shuffle = 0
+$no = [false, false, false, false] # 0 is whether to NOT process maps, 1 is other, 2 is system, 3 is scripts
 
-opts = {}
-OptionParser.new do |options|
-    options.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"
+options = {}
+OptionParser.new do |command|
+    command.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"
 
-    options.on('-d', '--input-dir DIRECTORY', 'Input directory of RPG Maker project.',
+    command.on('-d',
+               '--input-dir DIRECTORY',
+               'Input directory of RPG Maker project.',
                'Must contain "Data" or "original" folder to read,',
-               'and additionally "translation" with "maps" and  "other" subdirectories to write.') do |dir|
-        opts[:input_dir] = dir
-    end
+               'and additionally "translation" with "maps" and  "other" subdirectories to write.') { |dir| options[:input_dir] = dir }
 
-    options.on('--no', "Don't process specified files.", 'Takes multiple values separated by a comma.', 'Allowed values: maps, other, system, plugins') do |files|
+    command.on('--no',
+               "Don't process specified files.",
+               'Takes multiple values separated by a comma.',
+               'Allowed values: maps, other, system, plugins') do |files|
         actual_files = files.split(',')
 
         actual_files.each do |file|
             case file
                 when "maps"
-                    $no[0] = false
+                    $no[0] = true
                 when "other"
-                    $no[1] = false
+                    $no[1] = true
                 when "system"
-                    $no[2] = false
+                    $no[2] = true
                 when "scripts"
-                    $no[3] = false
+                    $no[3] = true
                 else
-                    nil
+                    puts "Wrong value for no argument: #{file}.\nAllowed values: maps, other, system, plugins"
+                    exit
             end
         end
     end
 
-    options.on('-s', '--shuffle NUMBER', 'At value 1: Shuffles all lines in strings, at value 2: shuffles all lines and words in strings.') do |number|
-        opts[:shuffle] = number
-    end
+    command.on('-s',
+               '--shuffle NUMBER',
+               'At value 1: Shuffles all lines in strings, at value 2: shuffles all lines and words in strings.') { |number| $shuffle = number }
 
-    options.on('-l', '--log', 'Log information while processing.') do
-        $logging = true
-    end
-    
-    options.on_tail('-h', '--help', 'Show help message.') do
-        puts options
-        exit
-    end
+    command.on('-l',
+               '--log',
+               'Log information while processing.') { $logging = true }
+
+    command.on_tail('-h',
+                    '--help',
+                    'Show help message.') { puts command; exit }
 end.parse!(ARGV)
 
 if ARGV.empty?
@@ -53,37 +57,27 @@ if ARGV.empty?
     exit
 end
 
-opts[:action] = ARGV.shift
+options[:action] = ARGV.shift
 
-unless %w[read write].include?(opts[:action])
+unless %w[read write].include?(options[:action])
     puts 'Invalid command. Allowed commands are: read, write.'
     exit
 end
 
-project_types = { 'vx' => :vx, 'ace' => :ace, 'xp' => :xp }
-
-directory = opts[:input_dir]
+directory = options[:input_dir]
 raise "#{directory} not found" unless File.exist?(directory)
 
-original_directory = Dir.foreach(directory).find { |filename| filename.downcase == 'original' } ||
-    Dir.foreach(directory).find { |filename| filename.downcase == 'data' }
+original_directory = Dir.foreach(directory).find { |dirname| dirname.downcase == 'original' || dirname.downcase == 'data' }
 raise '"Data" or "original" directory not found within input directory.' if original_directory.nil?
 
-types = %w[vx ace xp]
-
-type = types.find do |type_|
-    case type_
-        when 'xp'
-            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rxdata'))
-        when 'vx'
-            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rvdata'))
-        when 'ace'
-            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rvdata2'))
-        else
-            break nil
-    end
-end
-
-raise 'Couldn\'t determine project engine.' if type.nil?
-
-RGSS.serialize(type, opts[:action], directory, original_directory)
+engine = if File.exist?(File.join(directory, original_directory, 'System.rxdata'))
+             :xp
+         elsif File.exist?(File.join(directory, original_directory, 'System.rvdata'))
+             :vx
+         elsif File.exist?(File.join(directory, original_directory, 'System.rvdata2'))
+             :ace
+         else
+             raise "Couldn't determine project engine."
+         end
+
+RGSS.serialize(engine, options[:action], directory, original_directory,)

data/lib/{RGSS.rb → classes.rb}

@@ -78,48 +78,10 @@ class Rect
     end
 end
 
-module RGSS
-    def self.remove_defined_method(scope, name)
-        if scope.instance_methods(false).include?(name)
-            scope.send(:remove_method, name)
-        end
-    end
-
-    def self.reset_method(scope, name, method)
-        remove_defined_method(scope, name)
-        scope.send(:define_method, name, method)
-    end
-
-    def self.reset_const(scope, symbol, value)
-        scope.send(:remove_const, symbol) if scope.const_defined?(symbol)
-        scope.send(:const_set, symbol, value)
-    end
-
-    def self.array_to_hash(array, &block)
-        hash = {}
-
-        array.each_with_index do |value, index|
-            r = block_given? ? block.call(value) : value
-            hash[index] = r unless r.nil?
-        end
-
-        unless array.empty?
-            last = array.length - 1
-            hash[last] = nil unless hash.has_key?(last)
-        end
-
-        hash
-    end
-
-    def self.hash_to_array(hash)
-        array = []
-        hash.each { |key, value| array[key] = value }
-        array
-    end
-
-    require 'RGSS/BasicCoder'
-    require 'RPG'
+module RPG
+end
 
+module RGSS
     # creates an empty class in a potentially nested scope
     def self.process(root, name, *args)
         if !args.empty?
@@ -156,6 +118,7 @@ module RGSS
         %i[RPG Event Page],
         %i[RPG Event Page Condition],
         %i[RPG Event Page Graphic],
+        %i[RPG EventCommand],
         %i[RPG Item],
         %i[RPG Map],
         %i[RPG Map Encounter],
@@ -166,6 +129,7 @@ module RGSS
         %i[RPG SE],
         %i[RPG Skill],
         %i[RPG State],
+        %i[RPG System],
         %i[RPG System Terms],
         %i[RPG System TestBattler],
         %i[RPG System Vehicle],
@@ -178,103 +142,8 @@ module RGSS
         %i[RPG UsableItem],
         %i[RPG UsableItem Damage],
         %i[RPG UsableItem Effect],
-        %i[RPG Weapon],
-        # Script classes serialized in save game files
-        [:Game_ActionResult],
-        [:Game_Actor],
-        [:Game_Actors],
-        [:Game_BaseItem],
-        [:Game_BattleAction],
-        [:Game_CommonEvent],
-        [:Game_Enemy],
-        [:Game_Event],
-        [:Game_Follower],
-        [:Game_Followers],
-        [:Game_Interpreter],
-        [:Game_Map],
-        [:Game_Message],
-        [:Game_Party],
-        [:Game_Picture],
-        [:Game_Pictures],
-        [:Game_Player],
-        [:Game_System],
-        [:Game_Timer],
-        [:Game_Troop],
-        [:Game_Screen],
-        [:Game_Vehicle],
-        [:Interpreter]
+        %i[RPG Weapon]
     ].each { |symbol_array| process(Object, *symbol_array) }
-
-    def self.setup_classes(version)
-        # change version_id to fixed number
-        reset_method(
-            RPG::System,
-            :reduce_string,
-            ->(string) do
-                return nil if string.nil?
-
-                stripped = string.strip
-                stripped.empty? ? nil : stripped
-            end
-        )
-
-        # These magic numbers should be different. If they are the same, the saved version
-        # of the map in save files will be used instead of any updated version of the map
-        reset_method(
-            RPG::System,
-            :map_version,
-            ->(_ignored) { 12_345_678 }
-        )
-
-        reset_method(
-            Game_System,
-            :map_version,
-            ->(_ignored) { 87_654_321 }
-        )
-
-        # Game_Interpreter is marshalled differently in VX Ace
-        if version == :ace
-            reset_method(Game_Interpreter, :marshal_dump, -> { return @data })
-            reset_method(
-                Game_Interpreter,
-                :marshal_load,
-                ->(obj) { @data = obj }
-            )
-        else
-            remove_defined_method(Game_Interpreter, :marshal_dump)
-            remove_defined_method(Game_Interpreter, :marshal_load)
-        end
-
-        reset_method(
-            RPG::EventCommand,
-            :clean,
-            -> { @parameters[0].rstrip! if @code == 401 }
-        )
-
-        reset_const(
-            RPG::EventCommand,
-            :MOVE_LIST_CODE,
-            version == :xp ? 209 : 205
-        )
-
-        BasicCoder.ivars_methods_set(version)
-    end
-
-    class Game_Switches
-        include RGSS::BasicCoder
-    end
-
-    class Game_Variables
-        include RGSS::BasicCoder
-    end
-
-    class Game_SelfSwitches
-        include RGSS::BasicCoder
-    end
-
-    class Game_System
-        include RGSS::BasicCoder
-    end
-
-    require 'RGSS/serialize'
 end
+
+require 'serialize'

data/lib/{RGSS/serialize.rb → serialize.rb}

@@ -65,8 +65,8 @@ module RGSS
 
         game_title.downcase!
 
-        if game_title.include?("lisa")
-            return "lisa"
+        if game_title.include?('lisa')
+            return 'lisa'
         end
 
         nil
@@ -76,9 +76,9 @@ module RGSS
         case code
             when 401, 405
                 case $game_type
-                    when "lisa"
-                        match = parameter.scan(/^\\et\[[0-9]+\]|\\nbt/)
-                        parameter = parameter.slice(match[0].length) if match
+                    when 'lisa'
+                        match = parameter.scan(/^(\\et\[[0-9]+\]|\\nbt)/)
+                        parameter = parameter.slice((match[0].length)..) if match
                     else
                         nil
                 end
@@ -98,7 +98,7 @@ module RGSS
             variable = variable.gsub(/\r?\n/, '\#')
 
             case $game_type
-                when "lisa"
+                when 'lisa'
                     unless variable.split('\#').all? { |line| line.match?(/^<.*>\.?$/) || line.length.nil? }
                         return nil
                     end
@@ -119,7 +119,7 @@ module RGSS
 
         object_map.each do |filename, object|
             display_name = object.instance_variable_get(:@display_name)
-            lines[1].add(display_name) unless display_name.nil? || display_name.empty?
+            lines[1].add(display_name) if display_name.is_a?(String) && !display_name.empty?
 
             events = object.instance_variable_get(:@events)
             next if events.nil?
@@ -174,14 +174,18 @@ module RGSS
         end
 
         File.write("#{output_path}/maps.txt", lines[0].join("\n"))
-        File.write("#{output_path}/maps_trans.txt", "\n" * (!lines[0].empty? ? lines[0].length - 1 : 0))
+        File.write("#{output_path}/maps_trans.txt", "\n" * (lines[0].empty? ? 0 : lines[0].length - 1))
         File.write("#{output_path}/names.txt", lines[1].join("\n"))
-        File.write("#{output_path}/names_trans.txt", "\n" * (!lines[1].empty? ? lines[1].length - 1 : 0))
+        File.write("#{output_path}/names_trans.txt", "\n" * (lines[1].empty? ? 0 : lines[1].length - 1))
     end
 
     def self.read_other(original_other_files, output_path)
         object_array_map = Hash[original_other_files.map do |filename|
-            [File.basename(filename), Marshal.load(File.read(filename, mode: 'rb'))]
+            basename = File.basename(filename)
+            object = Marshal.load(File.read(filename, mode: 'rb'))
+            object = merge_other(object).slice(1..) if basename.start_with?(/Common|Troops/)
+
+            [basename, object]
         end]
 
         object_array_map.each do |filename, object_array|
@@ -252,7 +256,7 @@ module RGSS
             puts "Parsed #{filename}" if $logging
 
             File.write("#{output_path}/#{processed_filename}.txt", lines.join("\n"))
-            File.write("#{output_path}/#{processed_filename}_trans.txt", "\n" * (!lines.empty? ? lines.length - 1 : 0))
+            File.write("#{output_path}/#{processed_filename}_trans.txt", "\n" * (lines.empty? ? 0 : lines.length - 1))
         end
     end
 
@@ -294,47 +298,58 @@ module RGSS
         puts "Parsed #{filename}" if $logging
 
         File.write("#{output_path}/#{basename}.txt", lines.join("\n"), mode: 'wb')
-        File.write("#{output_path}/#{basename}_trans.txt", "\n" * (!lines.empty? ? lines.length - 1 : 0),
+        File.write("#{output_path}/#{basename}_trans.txt", "\n" * (lines.empty? ? 0 : lines.length - 1),
                    mode: 'wb')
     end
 
-    def self.extract_quoted_strings(input)
+    def self.shuffle_words(array)
+        array.map do |string|
+            re = /\S+/
+            words = string.scan(re)
+            words.shuffle
+
+            (0..(words.length)).each do |i|
+                string.sub!(string[i], words[i])
+            end
+
+            string
+        end
+    end
+
+    def self.extract_quoted_strings(string)
         result = []
+
+        skip_block = false
         in_quotes = false
         quote_type = nil
         buffer = []
 
-        input.each_char.with_index do |char, index|
-            if char == '#' && (index == 0 || input[index - 1] == "\n")
-                index = input.index("\n", index) || input.length
-                next
-            end
+        string.each_line(chomp: true) do |line|
+            line.strip!
+            next if line[0] == '#' || line.start_with?(/(Win|Lose)|_Fanfare/)
 
-            if char == '"' || char == "'"
-                if in_quotes
-                    if char == quote_type
-                        result.push(buffer.join)
-                        buffer.clear
-                        in_quotes = false
-                        quote_type = nil
-                    else
-                        buffer.push(char)
-                    end
-                else
-                    in_quotes = true
-                    quote_type = char
-                end
+            skip_block = true if line.start_with?('=begin')
+            skip_block = false if line.start_with?('=end')
 
-                next
-            end
+            next if skip_block
+
+            buffer.push('\#') if in_quotes
 
-            if in_quotes
-                if char != "\r"
-                    if char == "\n"
-                        buffer.push('\#')
+            line.each_char do |char|
+                if char == "'" || char == '"'
+                    unless quote_type.nil? || char == quote_type
+                        buffer.push(char)
                         next
                     end
 
+                    quote_type = char
+                    in_quotes = !in_quotes
+                    result.push(buffer.join)
+                    buffer.clear
+                    next
+                end
+
+                if in_quotes
                     buffer.push(char)
                 end
             end
@@ -346,22 +361,49 @@ module RGSS
     def self.read_scripts(scripts_file_path, output_path)
         script_entries = Marshal.load(File.read(scripts_file_path, mode: 'rb'))
         strings = IndexedSet.new
+        codes = []
 
         script_entries.each do |script|
             code = Zlib::Inflate.inflate(script[2]).force_encoding('UTF-8')
+            codes.push(code)
 
             extract_quoted_strings(code).each do |string|
-                next if string.strip! || (string.empty? || string.delete('　　').empty?)
-
-                next if string.start_with?(/(#|\!?\$|@|(Graphics|Data|Audio|CG|Movies)\/)/) ||
-                    string.match?(/^\d+$|^(.)\1{2,}$|^false|true$|^(wb|rb)$|^[A-Za-z0-9\-]+$|^[\.\(\)\+\-:;\|\[\]\^~%&!\*\/→×？\?ｘ％▼]$|#\{|\\(?!#)|\+?=?=|\{|\}|_|r[vx]data|[<>]|\.split/) ||
-
-                    strings.add(string)
+                string.strip!
+
+                next if string.empty? || string.delete('　　').empty?
+
+                # Maybe this mess will remove something that mustn't be removed, but it needs to be tested
+                next if string.start_with?(/([#!?$@]|(\.\/)?(Graphics|Data|Audio|CG|Movies|Save)\/)/) ||
+                    string.match?(/^\d+$/) ||
+                    string.match?(/^(.)\1{2,}$/) ||
+                    string.match?(/^(false|true)$/) ||
+                    string.match?(/^[wr]b$/) ||
+                    string.match?(/^(?=.*\d)[A-Za-z0-9\-]+$/) ||
+                    string.match?(/^[A-Z\-()\/ +'&]*$/) ||
+                    string.match?(/^[a-z\-()\/ +'&]*$/) ||
+                    string.match?(/^[A-Za-z]+[+-]$/) ||
+                    string.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼|]$/) ||
+                    string.match?(/^Tile.*[A-Z]$/) ||
+                    string.match?(/^:?%.*[ds][:%]*?$/) ||
+                    string.match?(/^[a-zA-Z]+([A-Z][a-z]*)+$/) ||
+                    string.match?(/^Cancel Action$|^Invert$|^End$|^Individual$|^Missed File$|^Bitmap$|^Audio$/) ||
+                    string.match?(/\.(mp3|ogg|jpg|png|ini)$/) ||
+                    string.match?(/\/(\d.*)?$/) ||
+                    string.match?(/FILE$/) ||
+                    string.match?(/#\{/) ||
+                    string.match?(/\\(?!#)/) ||
+                    string.match?(/\+?=?=/) ||
+                    string.match?(/[}{_<>]/) ||
+                    string.match?(/r[vx]data/) ||
+                    string.match?(/No such file or directory|level \*\*|Courier New|Comic Sans|Lucida|Verdana|Tahoma|Arial|Player start location|Common event call has exceeded|se-|Start Pos|An error has occurred|Define it first|Process Skill|Wpn Only|Don't Wait|Clear image|Can Collapse/)
+
+                strings.add(string)
             end
         end
 
+        File.write("#{output_path}/scripts_plain.txt", codes.join("\n"), mode: 'wb')
         File.write("#{output_path}/scripts.txt", strings.join("\n"), mode: 'wb')
-        File.write("#{output_path}/scripts_trans.txt", "\n" * (!strings.empty? ? strings.length - 1 : 0), mode: 'wb')
+        File.write("#{output_path}/scripts_trans.txt", "\n" * (strings.empty? ? 0 : strings.length - 1), mode: 'wb')
     end
 
     def self.merge_seq(object_array)
@@ -385,7 +427,7 @@ module RGSS
             elsif i.positive? && in_sequence && !first.nil? && !number.negative?
                 parameters = object_array[first].instance_variable_get(:@parameters)
                 parameters[0] = string_array.join("\n")
-                object_array[first].instance_variable_set(parameters)
+                object_array[first].instance_variable_set(:@parameters, parameters)
 
                 start_index = first + 1
                 items_to_delete = start_index + number
@@ -434,6 +476,8 @@ module RGSS
 
                     page.instance_variable_set(:@list, merge_seq(list))
                 end
+
+                object.instance_variable_set(:@pages, pages)
             else
                 list = object.instance_variable_get(:@list)
                 next unless list.is_a?(Array)
@@ -446,12 +490,15 @@ module RGSS
     end
 
     def self.get_translated(code, parameter, hashmap)
+        lisa_start = nil
+
         case code
             when 401, 356, 405
                 case $game_type
-                    when "lisa"
-                        match = parameter.scan(/^\\et\[[0-9]+\]/) || parameter.scan(/^\\nbt/)
-                        parameter = parameter.slice(match[0].length) unless match.nil?
+                    when 'lisa'
+                        match = parameter.scan(/^(\\et\[[0-9]+\]|\\nbt)/)
+                        lisa_start = match[0]
+                        parameter = parameter.slice((match[0].length)..) unless match.nil?
                     else
                         nil
                 end
@@ -461,7 +508,16 @@ module RGSS
                 nil
         end
 
-        return hashmap[parameter]
+        gotten = hashmap[parameter]
+
+        case $game_type
+            when 'lisa'
+                gotten = lisa_start + gotten unless lisa_start.nil?
+            else
+                nil
+        end
+
+        gotten
     end
 
     def self.get_variable_translated(variable, hashmap)
@@ -489,6 +545,16 @@ module RGSS
             line.gsub('\#', "\n")
         end
 
+        if $shuffle > 0
+            maps_translated_text.shuffle!
+            names_translated_text.shuffle!
+
+            if $shuffle == 2
+                maps_translated_text = shuffle_words(maps_translated_text)
+                names_translated_text = shuffle_words(names_translated_text)
+            end
+        end
+
         maps_translation_map = Hash[maps_original_text.zip(maps_translated_text)].freeze
         names_translation_map = Hash[names_original_text.zip(names_translated_text)].freeze
 
@@ -496,7 +562,8 @@ module RGSS
 
         object_map.each do |filename, object|
             display_name = object.instance_variable_get(:@display_name)
-            object.instance_variable_set(:@display_name, names_translation_map[display_name]) if names_translation_map.key?(display_name)
+            display_name_gotten = names_translation_map[display_name]
+            object.instance_variable_set(:@display_name, display_name_gotten) unless display_name_gotten.nil?
 
             events = object.instance_variable_get(:@events)
             next if events.nil?
@@ -546,7 +613,7 @@ module RGSS
         object_array_map = Hash[original_files.map do |filename|
             basename = File.basename(filename)
             object = Marshal.load(File.read(filename, mode: 'rb'))
-            object = merge_other(object)[1..] if basename.start_with?(/Common|Troops/)
+            object = merge_other(object).slice(1..) if basename.start_with?(/Common|Troops/)
 
             [basename, object]
         end]
@@ -556,29 +623,40 @@ module RGSS
         object_array_map.each do |filename, object_array|
             processed_filename = File.basename(filename, '.*').downcase
 
-            other_original_text = File.read("#{File.join(other_path, processed_filename)}.txt").split("\n").map do
-            |line|
-                line.gsub('\#', "\n")
-            end
+            other_original_text = File.read("#{File.join(other_path, processed_filename)}.txt")
+                                      .split("\n")
+                                      .map { |line| line.gsub('\#', "\n") }
+                                      .freeze
+
+            other_translated_text = File.read("#{File.join(other_path, processed_filename)}_trans.txt")
+                                        .split("\n")
+                                        .map { |line| line.gsub('\#', "\n") }
+
+            if $shuffle > 0
+                other_translated_text.shuffle!
 
-            other_translated_text = File.read("#{File.join(other_path, processed_filename)}_trans.txt").split("\n")
-                                        .map do
-            |line|
-                line.gsub('\#', "\n")
+                if $shuffle == 2
+                    other_translated_text = shuffle_words(other_translated_text)
+                end
             end
 
-            other_translation_map = Hash[other_original_text.zip(other_translated_text)]
+            other_translation_map = Hash[other_original_text.zip(other_translated_text)].freeze
 
             if !filename.start_with?(/Common|Troops/)
                 object_array.each do |object|
                     next if object.nil?
 
-                    name = object.instance_variable_get(:@name)
-                    nickname = object.instance_variable_get(:@nickname)
-                    description = object.instance_variable_get(:@description)
-                    note = object.instance_variable_get(:@note)
+                    variables_symbols = %i[@name @nickname @description @note].freeze
 
-                    [[:@name, name], [:@nickname, nickname], [:@description, description], [:@note, note]].each do |symbol, variable|
+                    name = object.instance_variable_get(variables_symbols[0])
+                    nickname = object.instance_variable_get(variables_symbols[1])
+                    description = object.instance_variable_get(variables_symbols[2])
+                    note = object.instance_variable_get(variables_symbols[3])
+
+                    [[variables_symbols[0], name],
+                     [variables_symbols[1], nickname],
+                     [variables_symbols[2], description],
+                     [variables_symbols[3], note]].each do |symbol, variable|
                         if variable.is_a?(String) && !variable.empty?
                             translated = get_variable_translated(variable, other_translation_map)
                             object.instance_variable_set(symbol, variable) unless translated.nil?
@@ -606,7 +684,7 @@ module RGSS
                                         parameters[i] = translated unless translated.nil?
                                     end
                                 elsif parameter.is_a?(Array)
-                                    parameter.each_with_index.map do |subparameter, j|
+                                    parameter.each_with_index do |subparameter, j|
                                         if subparameter.is_a?(String) && !subparameter.empty?
                                             translated = get_translated(code, subparameter, other_translation_map)
                                             parameters[i][j] = translated unless translated.nil?
@@ -631,33 +709,42 @@ module RGSS
         basename = File.basename(system_file_path)
         object = Marshal.load(File.read(system_file_path, mode: 'rb'))
 
-        system_original_text = File.read("#{other_path}/system.txt").split("\n")
-        system_translated_text = File.read("#{other_path}/system_trans.txt").split("\n")
+        system_original_text = File.read("#{other_path}/system.txt")
+                                   .split("\n")
+                                   .freeze
+        system_translated_text = File.read("#{other_path}/system_trans.txt")
+                                     .split("\n")
 
-        system_translation_map = Hash[system_original_text.zip(system_translated_text)]
+        if $shuffle > 0
+            system_translated_text.shuffle!
 
-        symbols = %i[@elements @skill_types @weapon_types @armor_types]
-        elements = object.instance_variable_get(:@elements)
-        skill_types = object.instance_variable_get(:@skill_types)
-        weapon_types = object.instance_variable_get(:@weapon_types)
-        armor_types = object.instance_variable_get(:@armor_types)
-        currency_unit = object.instance_variable_get(:@currency_unit)
-        terms = object.instance_variable_get(:@terms) || object.instance_variable_get(:@words)
-        game_title = object.instance_variable_get(:@game_title)
+            if $shuffle == 2
+                system_translated_text = shuffle_words(system_translated_text)
+            end
+        end
 
-        [elements, skill_types, weapon_types, armor_types].each_with_index.each do |array, i|
-            next if array.nil?
+        system_translation_map = Hash[system_original_text.zip(system_translated_text)].freeze
 
-            array.each_with_index do |string, j|
-                translated = system_translation_map[string]
-                array[j] = translated unless translated.nil?
-            end
+        symbols = %i[@elements @skill_types @weapon_types @armor_types @currency_unit @terms @words @game_title].freeze
+
+        elements = object.instance_variable_get(symbols[0])
+        skill_types = object.instance_variable_get(symbols[1])
+        weapon_types = object.instance_variable_get(symbols[2])
+        armor_types = object.instance_variable_get(symbols[3])
+        currency_unit = object.instance_variable_get(symbols[4])
+        terms = object.instance_variable_get(symbols[5]) || object.instance_variable_get(symbols[6])
+        game_title = object.instance_variable_get(symbols[7])
+
+        [elements, skill_types, weapon_types, armor_types].each_with_index.each do |array, i|
+            next unless array.is_a?(Array)
 
+            array.map! { |string| system_translation_map[string] || string }
             object.instance_variable_set(symbols[i], array)
         end
 
-        instance_variable_set(:@currency_unit, system_translation_map[currency_unit]) if !currency_unit.nil? &&
-            system_translation_map.key?(currency_unit)
+        currency_unit_translated = system_translation_map[currency_unit]
+        object.instance_variable_set(symbols[4], currency_unit_translated) if currency_unit.is_a?(String) &&
+            !currency_unit_translated.nil?
 
         terms.instance_variables.each do |variable|
             value = terms.instance_variable_get(variable)
@@ -666,37 +753,48 @@ module RGSS
                 translated = system_translation_map[value]
                 value = translated unless translated.nil?
             elsif value.is_a?(Array)
-                value.each_with_index do |string, i|
-                    translated = system_translation_map[string]
-                    value[i] = translated unless translated.nil?
-                end
+                value.map! { |string| system_translation_map[string] || string }
             end
 
             terms.instance_variable_set(variable, value)
         end
 
-        object.instance_variable_defined?(:@terms) ? object.instance_variable_set(:@terms, terms) : object
-                                                                                                        .instance_variable_set(:@words, terms)
+        object.instance_variable_defined?(symbols[5]) ?
+            object.instance_variable_set(symbols[5], terms) :
+            object.instance_variable_set(symbols[6], terms)
 
-        object.instance_variable_set(:@game_title, system_translation_map[game_title]) if !currency_unit.nil? &&
-            system_translation_map
-                .key?(game_title)
+        game_title_translated = system_translation_map[game_title]
+        object.instance_variable_set(symbols[7], game_title_translated) if currency_unit.is_a?(String) && !game_title_translated.nil?
 
         puts "Written #{basename}" if $logging
 
-        File.write("#{output_path}/#{basename}", Marshal.dump(object), mode: 'wb')
+        File.write("#{output_path}/ #{basename}", Marshal.dump(object), mode: 'wb')
     end
 
     def self.write_scripts(scripts_file, other_path, output_path)
         script_entries = Marshal.load(File.read(scripts_file, mode: 'rb'))
-        strings_original = File.read("#{other_path}/scripts.txt", mode: 'rb').split("\n").map { |line| line.gsub('\#', "\r\n") }
-        strings = File.read("#{other_path}/scripts_trans.txt", mode: 'rb').split("\n").map { |line| line.gsub('\#', "\r\n") }
 
-        scripts_translation_map = Hash[strings_original.zip(strings)]
+        scripts_original_text = File.read("#{other_path}/scripts.txt", mode: 'rb')
+                                    .force_encoding('UTF-8')
+                                    .split("\n")
+                                    .map { |line| line.gsub('\#', "\r\n") }
+                                    .freeze
+
+        scripts_translated_text = File.read("#{other_path}/scripts_trans.txt", mode: 'rb')
+                                      .force_encoding('UTF-8')
+                                      .split("\n")
+                                      .map { |line| line.gsub('\#', "\r\n") }
+                                      .freeze
 
-        script_entries.each_with_index do |script, i|
+        # Shuffle can possibly break the game in scripts, so no shuffling
+
+        script_entries.each do |script|
             code = Zlib::Inflate.inflate(script[2]).force_encoding('UTF-8')
-            code.gsub(/".*"/, scripts_translation_map[strings[i]]) if scripts_translation_map.key?(strings[i])
+
+            scripts_original_text.zip(scripts_translated_text).each do |original, translated|
+                code.gsub!(original, translated) unless translated.nil?
+            end
+
             script[2] = Zlib::Deflate.deflate(code, Zlib::BEST_COMPRESSION)
         end
 
@@ -706,9 +804,7 @@ module RGSS
     def self.serialize(engine, action, directory, original_directory)
         start_time = Time.now
 
-        setup_classes(engine)
-
-        absolute_path = File.realpath(directory)
+        absolute_path = File.realpath(directory).freeze
 
         paths = {
             original_path: File.join(absolute_path, original_directory),
@@ -720,21 +816,19 @@ module RGSS
 
         paths.each_value { |path| FileUtils.mkdir_p(path) }
 
-        extensions = { ace: '.rvdata2', vx: '.rvdata', xp: '.rxdata' }
+        extensions = { ace: '.rvdata2', vx: '.rvdata', xp: '.rxdata' }.freeze
 
-        files = (
-            Dir
-                .children(paths[:original_path])
-                .select { |filename| File.extname(filename) == extensions[engine] }
-                .map { |filename| "#{paths[:original_path]}/#{filename}" }
-        )
+        files = Dir.children(paths[:original_path])
+                   .select { |filename| File.extname(filename) == extensions[engine] }
+                   .map { |filename| "#{paths[:original_path]}/#{filename}" }
+                   .freeze
 
         maps_files = []
         other_files = []
-        system_file = "#{paths[:original_path]}/System#{extensions[engine]}"
-        scripts_file = "#{paths[:original_path]}/Scripts#{extensions[engine]}"
+        system_file = "#{paths[:original_path]}/System#{extensions[engine]}".freeze
+        scripts_file = "#{paths[:original_path]}/Scripts#{extensions[engine]}".freeze
 
-        $game_type = get_game_type(system_file)
+        $game_type = get_game_type(system_file).freeze
 
         files.each do |file|
             basename = File.basename(file)
@@ -758,6 +852,6 @@ module RGSS
             write_scripts(scripts_file, paths[:other_path], paths[:output_path]) unless $no[3]
         end
 
-        puts "Done in #{(Time.now - start_time)}"
+        puts "Done in #{Time.now - start_time}"
     end
 end

data/rvpacker-txt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.2.0'
+    spec.version = '1.3.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'
@@ -8,11 +8,12 @@ Gem::Specification.new do |spec|
     spec.license = 'MIT'
     spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
+    spec.metadata = { 'homepage_uri' => 'https://github.com/savannstm/rvpacker-txt' }
+
     spec.files = `git ls-files -z`.split("\x0")
     spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-    spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
     spec.require_paths = ['lib']
 
-    spec.add_development_dependency 'bundler', '>= 2.5.14'
-    spec.add_development_dependency 'rake', '>= 13.0.6'
+    spec.add_development_dependency 'bundler', '~> 2.5'
+    spec.add_development_dependency 'rake', '~> 13.0'
 end

data/sig/global_variables.rbs

@@ -0,0 +1,4 @@
+$logging: bool
+$shuffle: Integer
+$no: Array[bool]
+$game_type: String | nil

data/sig/rgss.rbs

@@ -1,14 +1,18 @@
 module RGSS
+    def self.extract_quoted_strings: (String) -> Array[String]
+
     def self.get_game_type: (String) -> (String | nil)
 
     def self.get_translated: (Integer, String, Hash[String, String]) -> (String | nil)
 
-    def self.get_variable_translated: (String) -> (String | nil)
+    def self.get_variable_translated: (String, Hash[String, String]) -> (String | nil)
 
     def self.merge_map: (Object) -> Object
 
     def self.merge_other: (Array[Object]) -> Array[Object]
 
+    def self.merge_seq: (Array[Object]) -> Array[Object]
+
     def self.parse_parameter: (Integer, String) -> (String | nil)
 
     def self.parse_variable: (String) -> (String | nil)
@@ -23,6 +27,8 @@ module RGSS
 
     def self.serialize: (Symbol, String, String, String) -> void
 
+    def self.shuffle_words: (Array[String]) -> Array[String]
+
     def self.write_map: (Array[String], String, String) -> void
 
     def self.write_other: (Array[String], String, String) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,36 +12,36 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.14
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.14
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
 description:
 email:
 - savannstm@gmail.com
@@ -55,16 +55,16 @@ files:
 - README.md
 - Rakefile
 - bin/rvpacker-txt
-- lib/RGSS.rb
-- lib/RGSS/BasicCoder.rb
-- lib/RGSS/serialize.rb
-- lib/RPG.rb
+- lib/classes.rb
+- lib/serialize.rb
 - rvpacker-txt.gemspec
+- sig/global_variables.rbs
 - sig/rgss.rbs
 homepage: https://github.com/savannstm/rvpacker-txt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/savannstm/rvpacker-txt
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/RGSS/BasicCoder.rb

@@ -1,31 +0,0 @@
-module RGSS
-    module BasicCoder
-        def ivars
-            instance_variables
-        end
-
-        INCLUDED_CLASSES = []
-
-        def self.included(module_)
-            INCLUDED_CLASSES.push(module_)
-        end
-
-        def self.ivars_methods_set(version)
-            INCLUDED_CLASSES.each do |class_|
-                if version == :ace
-                    RGSS.reset_method(
-                        class_,
-                        :ivars,
-                        -> { instance_variables }
-                    )
-                else
-                    RGSS.reset_method(
-                        class_,
-                        :ivars,
-                        -> { instance_variables.sort }
-                    )
-                end
-            end
-        end
-    end
-end

data/lib/RPG.rb

@@ -1,9 +0,0 @@
-require 'RGSS'
-module RPG
-    class System
-        include RGSS::BasicCoder
-    end
-
-    class EventCommand
-    end
-end