rvpacker 1.0.0 → 1.2.0

data/.gitignore

@@ -1,34 +1,34 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rvpacker.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rvpacker.gemspec
+gemspec

data/LICENSE

@@ -1,17 +1,17 @@
-Copyright (c) 2013 Howard Jeng
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
-to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or
-substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
-FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
+Copyright (c) 2013 Howard Jeng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,78 @@
-# Rvpacker
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'rvpacker'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rvpacker
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/rvpacker/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+rvpacker
+======================
+
+A tool to unpack & pack RPGMaker data files into text so they can be version controlled & collaborated on
+
+rvpacker consists of 3 parts:
+
+* RPG library (stub classes for serialization of RPGMaker game data)
+* RGSS library (some more classes for RPGMaker serialization)
+* rvpacker (the script you call on the frontend)
+
+Credit to SiCrane
+=================
+
+The RPG and RGSS libraries were originally taken from SiCrane's YAML importer/exporter on the gamedev forums. I initially just put them in github so I wouldn't lose them, and added the rvpacker script frontend. They are starting to drift a bit, but SiCrane still gets original credit for the grand majority of the work that rvpacker does.
+
+http://www.gamedev.net/topic/646333-rpg-maker-vx-ace-data-conversion-utility/
+
+Installation
+============
+
+rvpacker is bundled as a rubygem
+
+    []$ gem install rvpacker
+
+... dependencies will be handled automatically.
+
+If you are a windows user and rvpacker complains about being unable to install psych, try downloading the rvpacker source and doing 'bundle install'. That, for some reason, works. (Don't ask me, I think ruby is retarded here.)
+
+Usage
+=====
+
+    $ rvpacker --help
+    Options:
+	    --action, -a <s>:   Action to perform on project (unpack|pack)
+	   --project, -d <s>:   RPG Maker Project directory
+		 --force, -f:   Update target even when source is older than target
+      --project-type, -t <s>:   Project type (vx|ace|xp)
+		  --help, -h:   Show this message
+
+For example, to unpack a RPG Maker VX Ace project in ~/Documents/RPGVXAce/Project1:
+
+    rvpacker --action unpack --project ~/Documents/RPGVXAce/Project1 --project-type ace
+
+... This will expand all Data/* files into (PROJECT)/YAML/ as YAML files (YAML is used because the object serialization data is retained, which ruby's YAML parser is very good at - otherwise I would have changed it to JSON). The Scripts will be unpacked as individual .rb files into (PROJECT)/Scripts/.
+
+To take a previously unpacked project, and pack it back up:
+
+    rvpacker --action pack --project ~/Documents/RPGVXAce/Project1 --project-type ace
+
+... This will take all of the yaml files in (PROJECT)/YAML and all the scripts in (PROJECT)/Scripts, and repack all of your (PROJECT)/Data/* files. You can trust this to completely reassemble your Data/ directory, so long as the Scripts/ and YAML/ directories remain intact.
+
+Workflow
+========
+
+This is great for teams that are collaborating on an RPG Maker project. Just add a few steps to your existing workflow:
+
+* Checkout the project from version control
+* Run 'rvpacker --action pack' on the project to repack it for the RPG Maker tool
+* Load up RPG Maker and do whatever you're going to do; save the project
+* Run 'rvpacker --action unpack' on the project
+* Commit everything to version control (ignore the Data directory since you don't need it anymore; use .gitignore or .hgignore or whatever)
+
+... Now your project can be forked/merged in a much more safe/sane way, and you don't have to have someone bottlenecking the entire process.
+
+Automatic ID generation
+=======================
+
+You can add new elements to the YAML files manually, and leave their 'id:' field set to 'null'. This will cause the rvpacker pack action to automatically assign them a new ID number at the end of the sequence (e.g., if you have 17 items, the new one becomes ID 18). This is mainly handy for adding new scripts to the project without having to open the RPG maker and paste the script in; just make the new script file, add its entry in YAML/Scripts.yaml, and the designer will have your script accessible the next time they repack and open the project.
+
+Also, the rvpacker tool sets the ID of script files to an autoincrementing integer. The scripts exist in the database with a magic number that I can't recreate, and nothing in the editor (RPG VX Ace anyway) seems to care if the magic number changes. It doesn't even affect the ordering. So in order to support adding new scripts with null IDs, like everything else, the magic numbers on scripts are disregarded and a new ID number is forced on the scripts when the rvpacker pack action occurs.
+
+Psych 2.0.0 Dependency
+======================
+
+From SiCrane:
+
+I used cygwin's ruby 1.9.3 and the Psych 2.0.0 ruby gem, which appears to be the most recent version. However, Psych 2.0.0 has some bugs that impacted the generated YAML (one major and one minor) which I monkey patched, and since I was already rewriting the Psych code, I added some functionality to make the generated YAML prettier. Long story short, this code probably won't work with any version of Psych but 2.0.0.

data/Rakefile

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

data/bin/rvpacker

@@ -10,6 +10,7 @@ opts = Trollop::options do
   opt :force, "Update target even when source is older than target", :short => "f"
   opt :project_type, "Project type (vx|ace|xp)", :short => "t", :type => String
   opt :verbose, "Print verbose information while processing", :short => "V"
+  opt :database, "Only work on the given database", :short => "D", :type => String
 end
 
 directions = {
@@ -28,7 +29,8 @@ RGSS.serialize(projecttypes[opts[:project_type]],
                opts[:project],
                { :force => (opts[:force] ? true : false),
                  :line_width => -1,
-                 :table_width => -1
+                 :table_width => -1,
+                 :database => opts[:database]
                }
                )
 

data/lib/RGSS.rb

@@ -1,320 +1,320 @@
-=begin
-Copyright (c) 2013 Howard Jeng
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
-to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or
-substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
-FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-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*')
-    raise "Size mismatch loading Table from data" unless items == @data.length
-    raise "Size mismatch loading Table from data" unless @x * @y * @z == items
-  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{|y| y.hex}}.flatten
-    items = @x * @y * @z
-    raise "Size mismatch loading Table from YAML" unless items == @data.length
-  end
-
-  def _dump(*ignored)
-    return [@dim, @x, @y, @z, @x * @y * @z, *@data].pack('L5 S*')
-  end
-
-  def self._load(bytes)
-    Table.new(bytes)
-    end
-end
-
-class Color
-  def initialize(bytes)
-    @r, @g, @b, @a = *bytes.unpack('D4')
-  end
-
-  def _dump(*ignored)
-    return [@r, @g, @b, @a].pack('D4')
-  end
-
-  def self._load(bytes)
-      Color.new(bytes)
-  end
-end
-
-class Tone
-  def initialize(bytes)
-    @r, @g, @b, @a = *bytes.unpack('D4')
-  end
-
-  def _dump(*ignored)
-    return [@r, @g, @b, @a].pack('D4')
-  end
-
-  def self._load(bytes)
-    Tone.new(bytes)
-  end
-end
-
-class Rect
-  def initialize(bytes)
-    @x, @y, @width, @height = *bytes.unpack('i4')
-  end
-
-  def _dump(*ignored)
-    return [@x, @y, @width, @height].pack('i4')
-  end
-
-  def self._load(bytes)
-    Rect.new(bytes)
-  end
-end
-
-module RGSS
-  def self.remove_defined_method(scope, name)
-    scope.send(:remove_method, name) if scope.instance_methods(false).include?(name)
-  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, sym, value)
-    scope.send(:remove_const, sym) if scope.const_defined?(sym)
-    scope.send(:const_set, sym, 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?
-    end
-    if arr.length > 0
-      last = arr.length - 1
-      h[last] = nil unless h.has_key?(last)
-    end
-    return h
-  end
-
-  def self.hash_to_array(hash)
-    arr = []
-    hash.each do |k, v|
-      arr[k] = v
-    end
-    return arr
-  end
-
-  require 'RGSS/BasicCoder'
-  require 'RPG'
-
-  # creates an empty class in a potentially nested scope
-  def self.process(root, name, *args)
-    if args.length > 0
-      process(root.const_get(name), *args)
-    else
-      root.const_set(name, Class.new) unless root.const_defined?(name, false)
-    end
-  end
-
-  # other classes that don't need definitions
-  [ # RGSS data structures
-   [:RPG, :Actor], [:RPG, :Animation], [:RPG, :Animation, :Frame],
-   [:RPG, :Animation, :Timing], [:RPG, :Area], [:RPG, :Armor], [:RPG, :AudioFile],
-   [:RPG, :BaseItem], [:RPG, :BaseItem, :Feature], [:RPG, :BGM], [:RPG, :BGS],
-   [:RPG, :Class], [:RPG, :Class, :Learning], [:RPG, :CommonEvent], [:RPG, :Enemy],
-   [:RPG, :Enemy, :Action], [:RPG, :Enemy, :DropItem], [:RPG, :EquipItem],
-   [:RPG, :Event], [:RPG, :Event, :Page], [:RPG, :Event, :Page, :Condition],
-   [:RPG, :Event, :Page, :Graphic], [:RPG, :Item], [:RPG, :Map],
-   [:RPG, :Map, :Encounter], [:RPG, :MapInfo], [:RPG, :ME], [:RPG, :MoveCommand],
-   [:RPG, :MoveRoute], [:RPG, :SE], [:RPG, :Skill], [:RPG, :State],
-   [:RPG, :System, :Terms], [:RPG, :System, :TestBattler], [:RPG, :System, :Vehicle],
-   [:RPG, :System, :Words], [:RPG, :Tileset], [:RPG, :Troop], [:RPG, :Troop, :Member],
-   [:RPG, :Troop, :Page], [:RPG, :Troop, :Page, :Condition], [:RPG, :UsableItem],
-   [:RPG, :UsableItem, :Damage], [:RPG, :UsableItem, :Effect], [: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]
-  ].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) {
-                               return nil if str.nil?
-                               stripped = str.strip
-                               return stripped.empty? ? nil : stripped
-                             })
-      # 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 12345678 })
-      reset_method(Game_System, :map_version, ->(ignored) { return 87654321 })
-    end
-  end
-
-  def self.setup_interpreter(version)
-    # 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
-  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_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')
-  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 {|pair|
-                    key, value = pair
-                    next ["%03d %03d %s" % key, value]
-                  }]
-    end
-
-    def decode(name, value)
-      return Hash[value.collect {|pair|
-                    key, value = pair
-                    next [key.scanf("%d %d %s"), value]
-                  }]
-    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'
-end
+=begin
+Copyright (c) 2013 Howard Jeng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+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*')
+    raise "Size mismatch loading Table from data" unless items == @data.length
+    raise "Size mismatch loading Table from data" unless @x * @y * @z == items
+  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{|y| y.hex}}.flatten
+    items = @x * @y * @z
+    raise "Size mismatch loading Table from YAML" unless items == @data.length
+  end
+
+  def _dump(*ignored)
+    return [@dim, @x, @y, @z, @x * @y * @z, *@data].pack('L5 S*')
+  end
+
+  def self._load(bytes)
+    Table.new(bytes)
+    end
+end
+
+class Color
+  def initialize(bytes)
+    @r, @g, @b, @a = *bytes.unpack('D4')
+  end
+
+  def _dump(*ignored)
+    return [@r, @g, @b, @a].pack('D4')
+  end
+
+  def self._load(bytes)
+      Color.new(bytes)
+  end
+end
+
+class Tone
+  def initialize(bytes)
+    @r, @g, @b, @a = *bytes.unpack('D4')
+  end
+
+  def _dump(*ignored)
+    return [@r, @g, @b, @a].pack('D4')
+  end
+
+  def self._load(bytes)
+    Tone.new(bytes)
+  end
+end
+
+class Rect
+  def initialize(bytes)
+    @x, @y, @width, @height = *bytes.unpack('i4')
+  end
+
+  def _dump(*ignored)
+    return [@x, @y, @width, @height].pack('i4')
+  end
+
+  def self._load(bytes)
+    Rect.new(bytes)
+  end
+end
+
+module RGSS
+  def self.remove_defined_method(scope, name)
+    scope.send(:remove_method, name) if scope.instance_methods(false).include?(name)
+  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, sym, value)
+    scope.send(:remove_const, sym) if scope.const_defined?(sym)
+    scope.send(:const_set, sym, 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?
+    end
+    if arr.length > 0
+      last = arr.length - 1
+      h[last] = nil unless h.has_key?(last)
+    end
+    return h
+  end
+
+  def self.hash_to_array(hash)
+    arr = []
+    hash.each do |k, v|
+      arr[k] = v
+    end
+    return arr
+  end
+
+  require 'RGSS/BasicCoder'
+  require 'RPG'
+
+  # creates an empty class in a potentially nested scope
+  def self.process(root, name, *args)
+    if args.length > 0
+      process(root.const_get(name), *args)
+    else
+      root.const_set(name, Class.new) unless root.const_defined?(name, false)
+    end
+  end
+
+  # other classes that don't need definitions
+  [ # RGSS data structures
+   [:RPG, :Actor], [:RPG, :Animation], [:RPG, :Animation, :Frame],
+   [:RPG, :Animation, :Timing], [:RPG, :Area], [:RPG, :Armor], [:RPG, :AudioFile],
+   [:RPG, :BaseItem], [:RPG, :BaseItem, :Feature], [:RPG, :BGM], [:RPG, :BGS],
+   [:RPG, :Class], [:RPG, :Class, :Learning], [:RPG, :CommonEvent], [:RPG, :Enemy],
+   [:RPG, :Enemy, :Action], [:RPG, :Enemy, :DropItem], [:RPG, :EquipItem],
+   [:RPG, :Event], [:RPG, :Event, :Page], [:RPG, :Event, :Page, :Condition],
+   [:RPG, :Event, :Page, :Graphic], [:RPG, :Item], [:RPG, :Map],
+   [:RPG, :Map, :Encounter], [:RPG, :MapInfo], [:RPG, :ME], [:RPG, :MoveCommand],
+   [:RPG, :MoveRoute], [:RPG, :SE], [:RPG, :Skill], [:RPG, :State],
+   [:RPG, :System, :Terms], [:RPG, :System, :TestBattler], [:RPG, :System, :Vehicle],
+   [:RPG, :System, :Words], [:RPG, :Tileset], [:RPG, :Troop], [:RPG, :Troop, :Member],
+   [:RPG, :Troop, :Page], [:RPG, :Troop, :Page, :Condition], [:RPG, :UsableItem],
+   [:RPG, :UsableItem, :Damage], [:RPG, :UsableItem, :Effect], [: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]
+  ].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) {
+                               return nil if str.nil?
+                               stripped = str.strip
+                               return stripped.empty? ? nil : stripped
+                             })
+      # 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 12345678 })
+      reset_method(Game_System, :map_version, ->(ignored) { return 87654321 })
+    end
+  end
+
+  def self.setup_interpreter(version)
+    # 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
+  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_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')
+  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 {|pair|
+                    key, value = pair
+                    next ["%03d %03d %s" % key, value]
+                  }]
+    end
+
+    def decode(name, value)
+      return Hash[value.collect {|pair|
+                    key, value = pair
+                    next [key.scanf("%d %d %s"), value]
+                  }]
+    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'
+end