rvpacker-txt 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b17d69aea817f8b41bc154daf4a4f6c6f4c2a0200427cefefadf593c8fae715
-  data.tar.gz: 79a5a1f73df2a44a7571df5fb47bb76c234ecf774946cbdeb51d6a23265a7e13
+  metadata.gz: 90b4214a5f31ca357f08bb57ab08a8fdfeeed37aff4674d73dc2c866bdb3f30e
+  data.tar.gz: d35c5da8a2755b486ef5b98f9c9091f682b8d3143f3dde0f2adafa4348fc71e7
 SHA512:
-  metadata.gz: 5ef9f467c491d122c582f0af55ded8757de79e1bc41eb92b9fdb40617a83b8b06d0cb57dae3d8ae7fc5e397004977b308d303b4489446654022b19ba79279d91
-  data.tar.gz: 00fa12e46f27a7c225bf76179431f4e680d9e4da2c85c48ff0e2355b257254eab80c31d5e07e9be1681982c450d4bfbb3d8d48d41e9e1ab2343af9e7872bcb20
+  metadata.gz: db1067185a2c07d44c96393d9d4b1c63bd27d424d946558e23a9bd4c6f8f6a9f4961cbddba5f8ce32ac5d1074d15aa2cc6cf64a45d3a10400ac753cc8380b26d
+  data.tar.gz: 8a696a3a4cb22ac06425207218f8aedebbe1bc730fc36a474d589a6dd0d1b9c8320d270beb67235f7d75666caf35edc5fd7a83f5245ffe798aa76f50b29fa099

data/Gemfile

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

data/README.md

@@ -5,9 +5,9 @@ port of Ruby 1.9.x's rvpacker to Ruby 3.x to use .txt files instead of YAML, and
 
 rvpacker consists of 3 parts:
 
-* RPG library (stub classes for serialization of RPGMaker game data)
-* RGSS library (some more classes for RPGMaker serialization)
-* rvpacker-txt (the script you call on the frontend)
+* classes.rb library - all necessary classes to properly load and dump RPG Maker files
+* read.rb library - all necessary functions for reading and parsing RPG Maker files to text
+* write.rb library - all necessary functions for writing parsed RPG Maker files back to their initial form.
 
 # Installation
 
@@ -15,8 +15,9 @@ rvpacker consists of 3 parts:
 $ gem install rvpacker-txt
 ```
 
-Usage
-=====
+# Usage
+
+You can get a help message on usage using `rvpacker-txt -h`.
 
 ```
 $ rvpacker-txt -h
@@ -28,15 +29,12 @@ COMMANDS:
     read - Parses RPG Maker game files to .txt
     write - Writes parsed files back to their initial form
 OPTIONS:
-    -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.
-        --no                         Don't process specified files.
-                                     Takes multiple values separated by a comma.
-                                     Allowed values: maps, other, system, plugins
-    -s, --shuffle NUMBER             At value 1: Shuffles all lines in strings, at value 2: shuffles all lines and words in strings.
-    -l, --log                        Log information while processing.
-    -h, --help                       Show help message.
+    -d, --input-dir DIR              Input directory of RPG Maker project
+        --disable-processing FILES   Don't process specified files (maps, other, system, plugins)
+    -s, --shuffle NUM                Shuffle level (1: lines, 2: lines and words)
+        --disable-custom-parsing     Disables built-in custom parsing for some games
+    -l, --log                        Log information while processing
+    -h, --help                       Show help message
 ```
 
 For example, to read a RPG Maker VX Ace project in E:/Documents/RPGMakerGame to .txt files:
@@ -49,7 +47,8 @@ Program determines game engine automatically.
 
 This will parse all text from Data/* files into translation/maps and translation/other directories as files without
 _trans postfix that contain original text and files with _trans postfix that contain empty lines for translation.
-Lines from Scripts file will be parsed into translation/other/scripts.txt file as plain text.
+Lines from Scripts file will be parsed into translation/other/scripts.txt file as plain text, and
+also into a scripts_plain.txt file that contains scripts contents as a whole - that's just for convenience.
 
 To write previously parsed project back to its initial form:
 
@@ -80,4 +79,4 @@ https://github.com/ymaxkrapzv/rvpacker
 
 Darkness9724 forked rvpacker to rvpacker-ng, ported it to Ruby 3.x and updated dependencies.
 
-https://gitlab.com/Darkness9724/rvpacker-ng
+https://gitlab.com/Darkness9724/rvpacker-ng

data/bin/rvpacker-txt

@@ -1,83 +1,130 @@
 #!/usr/bin/env ruby
-require 'classes'
+# frozen_string_literal: true
+
 require 'optparse'
+require 'fileutils'
+
+require 'classes'
+require 'read'
+require 'write'
+
+def self.parse_options
+    options = { disable_processing: Array.new(4, false) }
+
+    OptionParser.new do |cmd|
+        cmd.banner = "This tool allows to parse RPG Maker project to .txt files and back.\n\nUsage: rvpacker-txt COMMAND [options]\n\nCOMMANDS:\n    read - Parses RPG Maker game files to .txt\n    write - Writes parsed files back to their initial form\nOPTIONS:\n"
+
+        cmd.on('-i', '--input-dir DIR', String, 'Input directory of RPG Maker project') do |dir|
+            options[:input_dir] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+            options[:output_dir] = options[:input_dir]
+        end
 
-$logging = false
-$shuffle = 0
-$no = [false, false, false, false] # 0 is whether to NOT process maps, 1 is other, 2 is system, 3 is scripts
-
-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"
-
-    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.') { |dir| options[:input_dir] = dir }
-
-    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] = true
-                when "other"
-                    $no[1] = true
-                when "system"
-                    $no[2] = true
-                when "scripts"
-                    $no[3] = true
-                else
-                    puts "Wrong value for no argument: #{file}.\nAllowed values: maps, other, system, plugins"
-                    exit
+        cmd.on('-o', '--output-dir DIR', String, 'Output directory of parsed/written files') do |dir|
+            options[:output_dir] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+        end
+
+        cmd.on('--disable-processing FILES', Array, 'Don\'t process specified files (maps, other, system, plugins)') do |files|
+            files.each do |file|
+                index = %w[maps other system scripts].index(file)
+                options[:disable_processing][index] = true if index
             end
         end
-    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 }
+        cmd.on('-s', '--shuffle NUM', Integer, 'Shuffle level (1: lines, 2: lines and words)') do |num|
+            options[:shuffle_level] = num
+        end
+
+        cmd.on('--disable-custom-parsing', 'Disables built-in custom parsing for some games') do
+            options[:disable_custom_parsing] = true
+        end
+
+        cmd.on('-l', '--log', 'Log information while processing') do
+            options[:logging] = true
+        end
 
-    command.on('-l',
-               '--log',
-               'Log information while processing.') { $logging = true }
+        cmd.on('-h', '--help', 'Show help message') do
+            puts cmd
+            exit
+        end
+    end.parse!
 
-    command.on_tail('-h',
-                    '--help',
-                    'Show help message.') { puts command; exit }
-end.parse!(ARGV)
+    options[:action] = ARGV.shift
+    raise 'COMMAND argument is required. Use rvpacker-txt -h for help.' if options[:action].nil?
+    raise 'Invalid command. Allowed commands are: read, write.' unless %w[read write].include?(options[:action])
 
-if ARGV.empty?
-    puts 'COMMAND argument is required.'
-    exit
+    options
 end
 
-options[:action] = ARGV.shift
+def self.get_game_type(system_file_path, disable_custom_parsing)
+    return nil if disable_custom_parsing
 
-unless %w[read write].include?(options[:action])
-    puts 'Invalid command. Allowed commands are: read, write.'
-    exit
+    object = Marshal.load(File.binread(system_file_path))
+    game_title = object.instance_variable_get(:@game_title).to_s.downcase
+    game_title.include?('lisa') ? 'lisa' : nil
 end
 
-directory = options[:input_dir]
-raise "#{directory} not found" unless File.exist?(directory)
+start_time = Time.now
+
+options = parse_options
+input_dir = options[:input_dir]
+output_dir = options[:output_dir]
+disable_custom_parsing = options[:disable_custom_parsing]
+shuffle_level = options[:shuffle_level]
+logging = options[:logging]
+disable_processing = options[:disable_processing]
+
+extensions = { xp: '.rxdata', vx: 'rvdata', ace: 'rvdata2' }
+
+original_directory = Dir.glob(File.join(input_dir, '{data,original}'), File::FNM_CASEFOLD).first
+raise '"Data" or "original" directory not found within input directory.' unless original_directory
+
+paths = {
+    original_path: original_directory,
+    translation_path: File.join(input_dir, 'translation'),
+    maps_path: File.join(input_dir, 'translation', 'maps'),
+    other_path: File.join(input_dir, 'translation', 'other'),
+    output_path: File.join(output_dir, 'output')
+}
+
+paths.each_value { |path| FileUtils.mkdir_p(path) }
+
+engine = extensions.find do |symbol, extension|
+    symbol if File.exist?(File.join(paths[:original_path], "System.#{extension}"))
+end || (raise "Couldn't determine project engine.")
 
-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?
+files = Dir.glob("#{paths[:original_path]}/*#{extensions[engine]}")
 
-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
+maps_files = []
+other_files = []
+system_file = nil
+scripts_file = nil
+
+files.each do |file|
+    basename = File.basename(file)
+
+    if basename.start_with?(/Map[0-9]/)
+        maps_files.push(file)
+    elsif !basename.start_with?(/Map|Tilesets|Animations|System|Scripts|Areas/)
+        other_files.push(file)
+    elsif basename.start_with?('System')
+        system_file = file
+    elsif basename.start_with?('Scripts')
+        scripts_file = file
+    end
+end
+
+game_type = get_game_type(system_file, disable_custom_parsing)
+
+if options[:action] == 'read'
+    read_map(maps_files, paths[:maps_path], logging, game_type) unless disable_processing[0]
+    read_other(other_files, paths[:other_path], logging, game_type) unless disable_processing[1]
+    read_system(system_file, paths[:other_path], logging) unless disable_processing[2]
+    read_scripts(scripts_file, paths[:other_path], logging) unless disable_processing[3]
+else
+    write_map(maps_files, paths[:maps_path], paths[:output_path], shuffle_level, logging, game_type) unless disable_processing[0]
+    write_other(other_files, paths[:other_path], paths[:output_path], shuffle_level, logging, game_type) unless disable_processing[1]
+    write_system(system_file, paths[:other_path], paths[:output_path], shuffle_level, logging) unless disable_processing[2]
+    write_scripts(scripts_file, paths[:other_path], paths[:output_path], logging) unless disable_processing[3]
+end
 
-RGSS.serialize(engine, options[:action], directory, original_directory,)
+puts "Done in #{Time.now - start_time}"

data/lib/classes.rb

@@ -22,9 +22,7 @@ class Table
     def initialize(bytes)
         @dim, @x, @y, @z, items, *@data = bytes.unpack('L5 S*')
 
-        unless items == @data.length && @x * @y * @z == items
-            raise 'Size mismatch loading Table from data'
-        end
+        raise 'Size mismatch loading Table from data' unless items == @data.length && @x * @y * @z == items
     end
 
     def _dump(*_ignored)
@@ -32,7 +30,7 @@ class Table
     end
 
     def self._load(bytes)
-        Table.new(bytes)
+        new(bytes)
     end
 end
 
@@ -46,7 +44,7 @@ class Color
     end
 
     def self._load(bytes)
-        Color.new(bytes)
+        new(bytes)
     end
 end
 
@@ -60,7 +58,7 @@ class Tone
     end
 
     def self._load(bytes)
-        Tone.new(bytes)
+        new(bytes)
     end
 end
 
@@ -74,7 +72,44 @@ class Rect
     end
 
     def self._load(bytes)
-        Rect.new(bytes)
+        new(bytes)
+    end
+end
+
+# Fuck using an array with set, that's just straight dumb and not efficient
+class IndexedSet
+    def initialize
+        @hash = Hash.new
+    end
+
+    def add(item)
+        return if @hash.include?(item)
+        @hash[item] = hash.size
+        @hash
+    end
+
+    def include?(item)
+        @hash.include?(item)
+    end
+
+    def each(&block)
+        @hash.each_key(&block)
+    end
+
+    def to_a
+        @hash.dup
+    end
+
+    def join(delimiter = '')
+        @hash.keys.join(delimiter)
+    end
+
+    def length
+        @hash.size
+    end
+
+    def empty?
+        @hash.empty?
     end
 end
 
@@ -84,17 +119,14 @@ end
 module RGSS
     # creates an empty class in a potentially nested scope
     def self.process(root, name, *args)
-        if !args.empty?
-            process(root.const_get(name), *args)
+        if args.empty?
+            root.const_set(name, Class.new) unless root.const_defined?(name, false)
         else
-            unless root.const_defined?(name, false)
-                root.const_set(name, Class.new)
-            end
+            process(root.const_get(name), *args)
         end
     end
 
-    # other classes that don't need definitions
-    [
+    classes_nested_array = [
         # RGSS data structures
         %i[RPG Actor],
         %i[RPG Animation],
@@ -143,7 +175,9 @@ module RGSS
         %i[RPG UsableItem Damage],
         %i[RPG UsableItem Effect],
         %i[RPG Weapon]
-    ].each { |symbol_array| process(Object, *symbol_array) }
-end
+    ].freeze
 
-require 'serialize'
+    classes_nested_array.each do |symbol_array|
+        process(Object, *symbol_array)
+    end
+end