rmxp_extractor 1.2

data/lib/rmxp_extractor/data_export.rb

@@ -0,0 +1,70 @@
+module RMXPExtractor
+  def self.export
+    STDERR.puts "No Data Directory!" unless Dir.exists? "./Data"
+    exit 1 unless Dir.exists? "./Data"
+
+    require "json"
+    require "ruby-progressbar"
+    require "fileutils"
+    require "pathname"
+    require "readline"
+    require_relative "classnames"
+    require_relative "script_handler"
+
+    window_size = (Readline.get_screen_size[1] - 1).clamp(0, 500)
+    progress = ProgressBar.create(
+      format: "%a /%e |%B| %p%% %c/%C %r files/sec %t",
+      starting_at: 0,
+      total: nil,
+      output: $stderr,
+      length: window_size,
+      title: "Exported",
+      remainder_mark: "\e[0;30m█\e[0m",
+      progress_mark: "█",
+      unknown_progress_animation_steps: ["==>", ">==", "=>="],
+    )
+    Dir.mkdir "./Data_JSON" unless Dir.exists? "./Data_JSON"
+    paths = Pathname.glob(("./Data/" + ("*" + ".rxdata")))
+    count = paths.size
+    progress.total = count
+    paths.each_with_index do |path, i|
+      content = Hash.new
+
+      name = path.basename(".rxdata")
+      rxdata = Marshal.load(path.read(mode: "rb"))
+      #puts name.to_s
+      case name.to_s
+      when "xScripts"
+        rpgscript("./", "./Scripts", true)
+        content[:version] = VERSION
+      when "Scripts"
+        content[:version] = VERSION
+      when "System"
+        content = rxdata.hash
+        content[:version] = VERSION
+      when "MapInfos"
+        content = { mapinfos: {} }
+        mapinfos = rxdata.sort_by { |key, value| value.order }.to_h
+        mapinfos.each do |key, value|
+          content[:mapinfos][key] = value.hash
+        end
+        content[:version] = VERSION
+      when /^Map\d+$/
+        content = rxdata.hash
+        content[:version] = VERSION
+      else
+        content[name.to_s.downcase] = []
+        rxdata.each_with_index do |value|
+          content[name.to_s.downcase] << value.hash unless value == nil
+        end
+        content[:version] = VERSION
+      end
+
+      json = File.open("./Data_JSON/" + name.sub_ext(".json").to_s, "wb")
+      #puts content
+      json.puts JSON.pretty_generate(content)
+
+      progress.increment
+    end
+  end
+end

data/lib/rmxp_extractor/data_import.rb

@@ -0,0 +1,82 @@
+module RMXPExtractor
+  def self.import
+    STDERR.puts "No Data_JSON Directory!" unless Dir.exists? "./Data_JSON"
+    exit 1 unless Dir.exists? "./Data_JSON"
+
+    require "oj"
+    require "ruby-progressbar"
+    require "fileutils"
+    require "pathname"
+    require "readline"
+    require_relative "classnames"
+    require_relative "script_handler"
+
+    window_size = (Readline.get_screen_size[1] - 1).clamp(0, 500)
+    progress = ProgressBar.create(
+      format: "%a /%e |%B| %p%% %c/%C %r files/sec %t",
+      starting_at: 0,
+      total: nil,
+      output: $stderr,
+      length: window_size,
+      title: "Imported",
+      remainder_mark: "\e[0;30m█\e[0m",
+      progress_mark: "█",
+      unknown_progress_animation_steps: ["==>", ">==", "=>="],
+    )
+    Dir.mkdir "./Data" unless Dir.exists? "./Data"
+    paths = Pathname.glob(("./Data_JSON/" + ("*" + ".json")))
+    count = paths.size
+    progress.total = count
+    paths.each_with_index do |path, i|
+      content = Hash.new
+
+      name = path.basename(".json")
+      json = Oj.load path.read(mode: "rb")
+
+      puts "\n\e[33;1mWARNING: Incompatible version format in #{name.to_s}!\e[0m\n" if json["version"] != VERSION
+
+      case name.to_s
+      when "xScripts"
+        rpgscript("./", "./Scripts")
+        progress.increment
+        return
+      when "Scripts"
+      when "System"
+        content = RPG::System.new(json)
+      when "MapInfos"
+        content = {}
+        json["mapinfos"].each do |key, value|
+          content[key.to_i] = RPG::MapInfo.new(value) unless key == "version"
+        end
+        #when "CommonEvents"
+      when /^Map\d+$/
+        content = RPG::Map.new json
+        #! All files that contain an array of subclasses start with nil since they start from 1, not 0
+      else
+        content = [nil]
+        json[name.to_s.downcase].each_with_index do |value, index|
+          eval("content << RPG::#{RMXPExtractor.singularize(name.to_s)}.new(value)")
+        end
+      end
+
+      rxdata = File.open("./Data/" + name.sub_ext(".rxdata").to_s, "wb")
+      rxdata.puts Marshal.dump(content)
+
+      progress.increment
+    end
+  end
+
+  def self.singularize(string)
+    if string.end_with? "ies"
+      string.delete_suffix("ies") + "y"
+    elsif string.end_with? "tes"
+      string.delete_suffix("s")
+    elsif string.end_with? "es"
+      string.delete_suffix("es")
+    elsif string.end_with? "s"
+      string.delete_suffix("s")
+    else
+      string
+    end
+  end
+end

data/lib/rmxp_extractor/script_handler.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby
+require "zlib"
+
+def rpgscript(game_dir, scripts_dir, extract = false)
+  # Determine version of game engine
+  game_data_dir = File.join(game_dir, "Data")
+  unless Dir.exist? game_data_dir
+    STDERR.puts "error: #{game_dir} does not have a Data subdirectory"
+    exit 1
+  end
+
+  target_path = nil
+  Dir.entries(game_data_dir).each do |e|
+    ext = File.extname(e)
+    if ext =~ /\.r[xv]data2?/
+      target_path = File.join(game_data_dir, "xScripts" + ext)
+      break
+    end
+  end
+
+  unless target_path
+    STDERR.puts "warning: could not determine game engine version, assuming XP"
+    target_path = File.join(game_data_dir, "xScripts.rxdata")
+  end
+
+  # Generate path of script list
+  list_path = File.join(scripts_dir, "_scripts.txt")
+
+  if extract
+    # Make sure the script directory exists
+    Dir.mkdir(scripts_dir) unless Dir.exists? scripts_dir
+
+    # Keep track of names of scripts extracted so we can warn about duplicates
+    names = Hash.new(0)
+
+    # Read scripts
+    File.open(target_path, "rb") do |fin|
+      File.open(list_path, "w") do |flist|
+        Marshal.load(fin).each_with_index do |script, index|
+          name = script[1].strip
+          data = Zlib::Inflate.inflate(script[2]).rstrip
+            .gsub(/[ \t]*(?:$|\r\n?)/, "\n")
+
+          # Make sure this file doesn't already exist
+          if name.empty?
+            if data.empty? || data == "\n"
+              flist.puts
+              next
+            else
+              name = "UNTITLED"
+            end
+          end
+
+          names[name] += 1
+          if names[name] > 1
+            name << " (#{names[name]})"
+          end
+
+          if data.empty? || data == "\n"
+            # Treat this like a comment
+            flist.puts("# " + name)
+          else
+            # Write to file order list
+            flist.puts(name)
+
+            # Write script file
+            File.open(File.join(scripts_dir, name + ".rb"), "wb") do |fout|
+              fout.write(data)
+            end
+          end
+        end
+      end
+    end
+    #puts "#{target_path} extracted."
+  else
+    # Write scripts
+    scripts = []
+
+    IO.foreach(list_path) do |name|
+      name.strip!
+      next if name.empty? || name.start_with?("#")
+
+      data = File.read(File.join(scripts_dir, name + ".rb")).rstrip.gsub("\n", "\r\n")
+
+      script = Array.new(3)
+      script[0] = 0
+      script[1] = name
+      script[2] = Zlib.deflate(data)
+      scripts << script
+    end
+
+    File.open(target_path, "wb") { |f| f.write(Marshal.dump(scripts)) }
+    #puts "#{target_path} written."
+  end
+end

data/lib/rmxp_extractor/version.rb

@@ -0,0 +1,3 @@
+module RMXPExtractor
+  VERSION = "1.2"
+end

data/rmxp_extractor.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/rmxp_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rmxp_extractor"
+  spec.version = RMXPExtractor::VERSION
+  spec.authors = ["Speak2Erase"]
+  spec.email = ["matthew@nowaffles.com"]
+
+  spec.summary = %q{A gem to dump *.rxdata files to JSON}
+  spec.description = %q{A gem to dump and import *.rxdata files to and from JSON}
+  spec.homepage = "https://rubygems.org/gems/rmxp_extractor"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Speak2Erase/RMXP-Extractor"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir["**/**"].grep_v(/.gem$/)
+
+  spec.executables = ["rmxp_extractor"]
+  spec.require_paths = ["lib"]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rmxp_extractor
+version: !ruby/object:Gem::Version
+  version: '1.2'
+platform: ruby
+authors:
+- Speak2Erase
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-25 00:00:00.000000000 Z
+dependencies: []
+description: A gem to dump and import *.rxdata files to and from JSON
+email:
+- matthew@nowaffles.com
+executables:
+- rmxp_extractor
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rmxp_extractor
+- bin/setup
+- lib/rmxp_extractor.rb
+- lib/rmxp_extractor/classnames.rb
+- lib/rmxp_extractor/data_export.rb
+- lib/rmxp_extractor/data_import.rb
+- lib/rmxp_extractor/script_handler.rb
+- lib/rmxp_extractor/version.rb
+- rmxp_extractor.gemspec
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/rmxp_extractor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/rmxp_extractor
+  source_code_uri: https://github.com/Speak2Erase/RMXP-Extractor
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A gem to dump *.rxdata files to JSON
+test_files: []