rvpacker-txt 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d385ac1a1e31fb6b845b028746ca52e58c882aed04ffd23721dfe513934451
-  data.tar.gz: 138b367cdd190e4edfbc8f1449b7b5129f03d2d614e8f17f7dbb9599c7c3aeb9
+  metadata.gz: af3cb24de9b95cae720c5577b90b49e3f3f817256841e8c877fa589db3e2255a
+  data.tar.gz: 857ae8378748e69e870fabd9ca7f0b148131250ed32fa932f2f002373eed43c2
 SHA512:
-  metadata.gz: c1273a05232251e539300f9c5cef0c1b082c041e5ecd3e7f4284f933ea5df29641808395d08e344dcd825f8cca727701e3f8e61fb9280016e47d60eecc8f2dfb
-  data.tar.gz: bd29920e41d1fd3871879d4a541863b078329f57338adfcc12fe08aeee6970b4e36b568747a06d0105388ae280482365039c98f8ee6bdf43e05550359fda0d17
+  metadata.gz: dd9df69240e9b738836ed8059324ff1617c09f54b1b9f057e0c1a7ed6d6016331d29310fb1b96a79b4c95e45ee09207ecd6bb001689bd715ebbbb2742819d0a6
+  data.tar.gz: fc7d6ab0e470b9eca55a90835367d721d8b694f1e5e581c8c95e5025bc2f3ef1f189a2e493ab26a9555ffe1f4c34d30e2376bf759052b630a46b23a3dc9919f5

data/bin/rvpacker-txt

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
-require('RGSS')
-require('optparse')
+require 'RGSS'
+require 'optparse'
 
+$logging = false
 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"
@@ -13,7 +14,7 @@ OptionParser.new do |options|
     end
 
     options.on('-l', '--log', 'Log information while processing.') do
-        opts[:log] = true
+        $logging = true
     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|
@@ -39,22 +40,21 @@ unless %w[read write].include?(opts[:action])
 end
 
 project_types = { 'vx' => :vx, 'ace' => :ace, 'xp' => :xp }
-$logging = opts[:log]
 
 directory = opts[:input_dir]
 raise "#{directory} not found" unless File.exist?(directory)
 
 data_folder = Dir.foreach(directory).find { |filename| filename.downcase == 'original' }
 data_folder = Dir.foreach(directory).find { |filename| filename.downcase == 'data' } if data_folder.nil?
-raise '"Data" directory not found within input directory.' if data_folder.nil?
+raise '"Data" or "original" directory not found within input directory.' if data_folder.nil?
 
-types = %i[vx ace xp]
+types = %w[vx ace xp]
 
 type = types.find do |_type|
     case _type
-        when 'vx'
-            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rxdata'))
         when 'xp'
+            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rxdata'))
+        when 'vx'
             break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata'))
         when 'ace'
             break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata2'))
@@ -65,12 +65,4 @@ end
 
 raise 'Couldn\'t determine project engine.' if type.nil?
 
-RGSS.serialize(
-    type,
-    opts[:action],
-    directory,
-    {
-        line_width: -1,
-        table_width: -1,
-    }
-)
+RGSS.serialize(type, opts[:action], directory)

data/lib/RGSS/BasicCoder.rb

@@ -1,51 +1,28 @@
 module RGSS
     module BasicCoder
-        def encode_with(coder)
-            ivars.each do |var|
-                name = var.to_s.sub(/^@/, '')
-                value = instance_variable_get(var)
-                coder[name] = encode(name, value)
-            end
-        end
-
-        def encode(name, value)
-            return value
-        end
-
-        def init_with(coder)
-            coder.map.each do |key, value|
-                sym = "@#{key}".to_sym
-                instance_variable_set(sym, decode(key, value))
-            end
-        end
-
-        def decode(name, value)
-            return value
-        end
-
         def ivars
-            return instance_variables
+            instance_variables
         end
 
         INCLUDED_CLASSES = []
 
-        def self.included(mod)
-            INCLUDED_CLASSES.push(mod)
+        def self.included(module_)
+            INCLUDED_CLASSES.push(module_)
         end
 
-        def self.set_ivars_methods(version)
-            INCLUDED_CLASSES.each do |c|
+        def self.ivars_methods_set(version)
+            INCLUDED_CLASSES.each do |class_|
                 if version == :ace
                     RGSS.reset_method(
-                        c,
+                        class_,
                         :ivars,
-                        -> { return instance_variables }
+                        -> { instance_variables }
                     )
                 else
                     RGSS.reset_method(
-                        c,
+                        class_,
                         :ivars,
-                        -> { return instance_variables.sort }
+                        -> { instance_variables.sort }
                     )
                 end
             end

data/lib/RGSS/serialize.rb

@@ -68,13 +68,13 @@ module RGSS
         nil
     end
 
-    def parse_parameter(code, parameter)
+    def self.parse_parameter(code, parameter)
         case code
             when 401, 405
                 case $game_type
                     when "lisa"
-                        match = parameter.match(/^\\et\[[0-9]+\]|\\nbt/)
-                        parameter = parameter[match[0].length..] if match
+                        match = parameter.scan(/^\\et\[[0-9]+\]|\\nbt/)
+                        parameter = parameter.slice(match[0].length) if match
                     else
                         nil
                 end
@@ -278,6 +278,12 @@ module RGSS
 
         terms.instance_variables.each do |variable|
             value = terms.instance_variable_get(variable)
+
+            if value.is_a?(String)
+                lines.add(value) unless value.empty?
+                next
+            end
+
             value.each { |string| lines.add(string) unless string.is_a?(String) && string.empty? }
         end
 
@@ -599,9 +605,14 @@ module RGSS
         terms.instance_variables.each do |variable|
             value = terms.instance_variable_get(variable)
 
-            value.each_with_index do |string, i|
-                translated = system_translation_map[string]
-                value[i] = translated unless translated.nil?
+            if value.is_a?(String)
+                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
             end
 
             terms.instance_variable_set(variable, value)
@@ -635,18 +646,10 @@ module RGSS
         File.write("#{output_path}/#{File.basename(scripts_file)}", Marshal.dump(script_entries), mode: 'wb')
     end
 
-    def self.serialize(version, action, directory, options = {})
+    def self.serialize(engine, action, directory)
         start_time = Time.now
 
-        setup_classes(version, options)
-
-        options = options.clone
-        options[:sort] = true if %i[vx xp].include?(version)
-        options[:flow_classes] = [Color, Tone, RPG::BGM, RPG::BGS, RPG::MoveCommand, RPG::SE].freeze
-        options[:line_width] ||= 130
-
-        table_width = options[:table_width]
-        RGSS.reset_const(Table, :MAX_ROW_LENGTH, table_width || 20)
+        setup_classes(engine)
 
         absolute_path = File.realpath(directory)
 
@@ -665,14 +668,14 @@ module RGSS
         files = (
             Dir
                 .children(paths[:original_path])
-                .select { |filename| File.extname(filename) == extensions[version] }
+                .select { |filename| File.extname(filename) == extensions[engine] }
                 .map { |filename| "#{paths[:original_path]}/#{filename}" }
         )
 
         maps_files = []
         other_files = []
-        system_file = "#{paths[:original_path]}/System#{extensions[version]}"
-        scripts_file = "#{paths[:original_path]}/Scripts#{extensions[version]}"
+        system_file = "#{paths[:original_path]}/System#{extensions[engine]}"
+        scripts_file = "#{paths[:original_path]}/Scripts#{extensions[engine]}"
 
         $game_type = get_game_type(system_file)
 

data/lib/RGSS.rb

@@ -17,63 +17,17 @@ FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TOR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 =end
-
-require 'scanf'
-
 class Table
     def initialize(bytes)
         @dim, @x, @y, @z, items, *@data = bytes.unpack('L5 S*')
-        unless items == @data.length
-            raise 'Size mismatch loading Table from data'
-        end
-        unless @x * @y * @z == items
-            raise 'Size mismatch loading Table from data'
-        end
-    end
 
-    MAX_ROW_LENGTH = 20
-
-    def encode_with(coder)
-        coder.style = Psych::Nodes::Mapping::BLOCK
-
-        coder['dim'] = @dim
-        coder['x'] = @x
-        coder['y'] = @y
-        coder['z'] = @z
-
-        if @x * @y * @z > 0
-            stride = @x < 2 ? (@y < 2 ? @z : @y) : @x
-            rows = @data.each_slice(stride).to_a
-            if MAX_ROW_LENGTH != -1 && stride > MAX_ROW_LENGTH
-                block_length = (stride + MAX_ROW_LENGTH - 1) / MAX_ROW_LENGTH
-                row_length = (stride + block_length - 1) / block_length
-                rows =
-                    rows
-                        .collect { |x| x.each_slice(row_length).to_a }
-                        .flatten(1)
-            end
-            rows = rows.collect { |x| x.collect { |y| '%04x' % y }.join(' ') }
-            coder['data'] = rows
-        else
-            coder['data'] = []
-        end
-    end
-
-    def init_with(coder)
-        @dim = coder['dim']
-        @x = coder['x']
-        @y = coder['y']
-        @z = coder['z']
-        @data =
-            coder['data'].collect { |x| x.split(' ').collect(&:hex) }.flatten
-        items = @x * @y * @z
-        unless items == @data.length
-            raise 'Size mismatch loading Table from YAML'
+        unless items == @data.length && @x * @y * @z == items
+            raise 'Size mismatch loading Table from data'
         end
     end
 
-    def _dump(*ignored)
-        return [@dim, @x, @y, @z, @x * @y * @z, *@data].pack('L5 S*')
+    def _dump(*_ignored)
+        [@dim, @x, @y, @z, @x * @y * @z, *@data].pack('L5 S*')
     end
 
     def self._load(bytes)
@@ -86,8 +40,8 @@ class Color
         @r, @g, @b, @a = *bytes.unpack('D4')
     end
 
-    def _dump(*ignored)
-        return [@r, @g, @b, @a].pack('D4')
+    def _dump(*_ignored)
+        [@r, @g, @b, @a].pack('D4')
     end
 
     def self._load(bytes)
@@ -100,8 +54,8 @@ class Tone
         @r, @g, @b, @a = *bytes.unpack('D4')
     end
 
-    def _dump(*ignored)
-        return [@r, @g, @b, @a].pack('D4')
+    def _dump(*_ignored)
+        [@r, @g, @b, @a].pack('D4')
     end
 
     def self._load(bytes)
@@ -114,8 +68,8 @@ class Rect
         @x, @y, @width, @height = *bytes.unpack('i4')
     end
 
-    def _dump(*ignored)
-        return [@x, @y, @width, @height].pack('i4')
+    def _dump(*_ignored)
+        [@x, @y, @width, @height].pack('i4')
     end
 
     def self._load(bytes)
@@ -135,28 +89,31 @@ module RGSS
         scope.send(:define_method, name, method)
     end
 
-    def self.reset_const(scope, sym, value)
-        scope.send(:remove_const, sym) if scope.const_defined?(sym)
-        scope.send(:const_set, sym, value)
+    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(arr, &block)
-        h = {}
-        arr.each_with_index do |val, index|
-            r = block_given? ? block.call(val) : val
-            h[index] = r unless r.nil?
+    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
-        if arr.length > 0
-            last = arr.length - 1
-            h[last] = nil unless h.has_key?(last)
+
+        unless array.empty?
+            last = array.length - 1
+            hash[last] = nil unless hash.has_key?(last)
         end
-        return h
+
+        hash
     end
 
     def self.hash_to_array(hash)
-        arr = []
-        hash.each { |k, v| arr[k] = v }
-        return arr
+        array = []
+        hash.each { |key, value| array[key] = value }
+        array
     end
 
     require 'RGSS/BasicCoder'
@@ -164,7 +121,7 @@ module RGSS
 
     # creates an empty class in a potentially nested scope
     def self.process(root, name, *args)
-        if args.length > 0
+        if !args.empty?
             process(root.const_get(name), *args)
         else
             unless root.const_defined?(name, false)
@@ -245,43 +202,35 @@ module RGSS
         [:Game_Screen],
         [:Game_Vehicle],
         [:Interpreter]
-    ].each { |x| process(Object, *x) }
-
-    def self.setup_system(version, options)
-        # convert variable and switch name arrays to a hash when serialized
-        # if round_trip isn't set change version_id to fixed number
-        if options[:round_trip]
-            iso = ->(val) { return val }
-            reset_method(RPG::System, :reduce_string, iso)
-            reset_method(RPG::System, :map_version, iso)
-            reset_method(Game_System, :map_version, iso)
-        else
-            reset_method(
-                RPG::System,
-                :reduce_string,
-                ->(str) do
-                    return nil if str.nil?
-                    stripped = str.strip
-                    return stripped.empty? ? nil : stripped
-                end
-            )
+    ].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) { return 12_345_678 }
-            )
-            reset_method(
-                Game_System,
-                :map_version,
-                ->(ignored) { return 87_654_321 }
-            )
-        end
-    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 }
+        )
 
-    def self.setup_interpreter(version)
         # Game_Interpreter is marshalled differently in VX Ace
         if version == :ace
             reset_method(Game_Interpreter, :marshal_dump, -> { return @data })
@@ -294,115 +243,36 @@ module RGSS
             remove_defined_method(Game_Interpreter, :marshal_dump)
             remove_defined_method(Game_Interpreter, :marshal_load)
         end
-    end
 
-    def self.setup_event_command(version, options)
-        # format event commands to flow style for the event codes that aren't move commands
-        if options[:round_trip]
-            reset_method(RPG::EventCommand, :clean, -> {})
-        else
-            reset_method(
-                RPG::EventCommand,
-                :clean,
-                -> { @parameters[0].rstrip! if @code == 401 }
-            )
-        end
+        reset_method(
+            RPG::EventCommand,
+            :clean,
+            -> { @parameters[0].rstrip! if @code == 401 }
+        )
+
         reset_const(
             RPG::EventCommand,
             :MOVE_LIST_CODE,
             version == :xp ? 209 : 205
         )
-    end
-
-    def self.setup_classes(version, options)
-        setup_system(version, options)
-        setup_interpreter(version)
-        setup_event_command(version, options)
-        BasicCoder.set_ivars_methods(version)
-    end
 
-    FLOW_CLASSES = [Color, Tone, RPG::BGM, RPG::BGS, RPG::MoveCommand, RPG::SE]
-
-    SCRIPTS_BASE = 'Scripts'
-
-    ACE_DATA_EXT = '.rvdata2'
-    VX_DATA_EXT = '.rvdata'
-    XP_DATA_EXT = '.rxdata'
-    YAML_EXT = '.yaml'
-    RUBY_EXT = '.rb'
-
-    def self.get_data_directory(base)
-        return File.join(base, 'Data')
-    end
-
-    def self.get_yaml_directory(base)
-        return File.join(base, 'YAML')
-    end
-
-    def self.get_script_directory(base)
-        return File.join(base, 'Scripts')
+        BasicCoder.ivars_methods_set(version)
     end
 
     class Game_Switches
         include RGSS::BasicCoder
-
-        def encode(name, value)
-            return array_to_hash(value)
-        end
-
-        def decode(name, value)
-            return hash_to_array(value)
-        end
     end
 
     class Game_Variables
         include RGSS::BasicCoder
-
-        def encode(name, value)
-            return array_to_hash(value)
-        end
-
-        def decode(name, value)
-            return hash_to_array(value)
-        end
     end
 
     class Game_SelfSwitches
         include RGSS::BasicCoder
-
-        def encode(name, value)
-            return(
-                Hash[
-                    value.collect do |pair|
-                        key, value = pair
-                        next ['%03d %03d %s' % key, value]
-                    end
-                ]
-            )
-        end
-
-        def decode(name, value)
-            return(
-                Hash[
-                    value.collect do |pair|
-                        key, value = pair
-                        next [key.scanf('%d %d %s'), value]
-                    end
-                ]
-            )
-        end
     end
 
     class Game_System
         include RGSS::BasicCoder
-
-        def encode(name, value)
-            if name == 'version_id'
-                return map_version(value)
-            else
-                return value
-            end
-        end
     end
 
     require 'RGSS/serialize'

data/lib/RPG.rb

@@ -2,54 +2,8 @@ require 'RGSS'
 module RPG
     class System
         include RGSS::BasicCoder
-        HASHED_VARS = %w[variables switches]
-    end
-
-    def self.array_to_hash(arr, &block)
-        h = {}
-        arr.each_with_index do |val, index|
-            r = block_given? ? block.call(val) : val
-            h[index] = r unless r.nil?
-        end
-        if arr.length > 0
-            last = arr.length - 1
-            h[last] = nil unless h.has_key?(last)
-        end
-        return h
-    end
-
-    def encode(name, value)
-        if HASHED_VARS.include?(name)
-            return array_to_hash(value) { |val| reduce_string(val) }
-        elsif name == 'version_id'
-            return map_version(value)
-        else
-            return value
-        end
-    end
-
-    def decode(name, value)
-        if HASHED_VARS.include?(name)
-            return hash_to_array(value)
-        else
-            return value
-        end
     end
 
     class EventCommand
-        def encode_with(coder)
-            case @code
-                when MOVE_LIST_CODE
-                    # move list
-                    coder.style = Psych::Nodes::Mapping::BLOCK
-                else
-                    coder.style = Psych::Nodes::Mapping::FLOW
-            end
-            coder['i'], coder['c'], coder['p'] = @indent, @code, @parameters
-        end
-
-        def init_with(coder)
-            @indent, @code, @parameters = coder['i'], coder['c'], coder['p']
-        end
     end
 end

data/rvpacker-txt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.0.0'
+    spec.version = '1.1.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'
@@ -15,5 +15,4 @@ Gem::Specification.new do |spec|
 
     spec.add_development_dependency 'bundler', '>= 2.5.14'
     spec.add_development_dependency 'rake', '>= 13.0.6'
-    spec.add_dependency 'scanf', '>= 1.0.0'
 end

data/sig/rgss.rbs

@@ -21,11 +21,11 @@ module RGSS
 
     def self.read_scripts: (String, String) -> void
 
-    def self.serialize: (Symbol, string, string, Hash[untyped, untyped]) -> void
+    def self.serialize: (Symbol, String, String) -> void
 
-    def self.write_map: (String, Array[String], String) -> void
+    def self.write_map: (Array[String], String, String) -> void
 
-    def self.write_other: (String, Array[String], String) -> void
+    def self.write_other: (Array[String], String, String) -> void
 
     def self.write_system: (String, String, String) -> void
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,20 +42,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: scanf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 description:
 email:
 - savannstm@gmail.com
@@ -73,7 +59,6 @@ files:
 - lib/RGSS/BasicCoder.rb
 - lib/RGSS/serialize.rb
 - lib/RPG.rb
-- lib/rvpacker/version.rb
 - rvpacker-txt.gemspec
 - sig/rgss.rbs
 homepage: https://github.com/savannstm/rvpacker-txt

data/lib/rvpacker/version.rb

@@ -1,3 +0,0 @@
-module RVPACKER
-    VERSION = '1.3.2'.freeze
-end