rvpacker-txt 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be60b9ca7d30b5ba65f22b5c71b2051cddc357d0793e5040bddddb4b940f7aec
-  data.tar.gz: a62fc90e814c94a9eeb0d56299c6a9211311263589d6d55b0ef5367a74a281ae
+  metadata.gz: 2b69421e26d7a2a85ce60f482712d941e23946887a3e9b8640752dd4441b4cea
+  data.tar.gz: 66fdd2d16bbd06ae1210105684805c9ec4a2beefef7f859568ae1faa37f6051e
 SHA512:
-  metadata.gz: 58e86a866916217af89835096794ecdcaef8803eadc695f24347790179e5e3fda42510d5ce968a904e6d86e84c88602cbbd7fdf7411d2294b253c2a4d225b63b
-  data.tar.gz: 4a6b9e66cc383defab76c9d6216afdfcc45f16de09530ebec498b2401faf4fac16dd3d1aa1843ecc6992585116f22f750f123a9df4d76dd1e1cacbede6ca2705
+  metadata.gz: '068699415ee5fe5faa764a20f66f60b6d359610503aff909dda3b62b42f78c83abfe7e5049cc8aab03b7c4e5f3ff3e77a879ff43f6a059ad021bb97beed0d74d'
+  data.tar.gz: e78c574fcf21bef8a4216f856ceeea67481281fe20047e78fd7a007c2b274e2e525a5a84a98c7bfcc1db8e4113c11b71837f6cd3f756002fde0c1ad4321811e3

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,17 @@ 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.
+    -i, --input-dir DIR              Input directory of RPG Maker project
+    -o, --output-dir DIR             Output directory of parsed/written files
+        --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_processing  Disables built-in custom parsing/writing for some games
+    -l, --log                        Log information while processing
+    -f, --force                      Force rewrite all files. Cannot be used with --append.
+                                     USE WITH CAUTION!
+    -a, --append                     When you update the rvpacker-txt, you probably should re-read your files with append, as some new text might be added to parser.
+                                     Cannot be used with --force
+    -h, --help                       Show help message
 ```
 
 For example, to read a RPG Maker VX Ace project in E:/Documents/RPGMakerGame to .txt files:
@@ -49,7 +52,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 +84,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,88 +1,159 @@
 #!/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
+
+        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
 
-$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
-$disable_custom_parsing = false
-
-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('--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_processing', 'Disables built-in custom parsing/writing for some games') do
+            options[:disable_custom_processing] = true
+        end
+
+        cmd.on('-l', '--log', 'Log information while processing') do
+            options[:logging] = true
+        end
 
-    command.on('--disable-custom-parsing',
-               'Disables built-in custom parsing for some games, which may improperly parse/write some games.')
+        cmd.on('-f', '--force', 'Force rewrite all files. Cannot be used with --append.', 'USE WITH CAUTION!') do
+            options[:force] = true
+        end
 
-    command.on('-l',
-               '--log',
-               'Log information while processing.') { $logging = true }
+        cmd.on('-a', '--append', 'When you update the rvpacker-txt, you probably should re-read your files with append, as some new text might be added to parser.', 'Cannot be used with --force') do
+            raise '--append cannot be used beside --force.' if options[:force]
+            options[:append] = true
+        end
 
-    command.on_tail('-h',
-                    '--help',
-                    'Show help message.') { puts command; exit }
-end.parse!(ARGV)
+        cmd.on('-h', '--help', 'Show help message') do
+            puts cmd
+            exit
+        end
+    end.parse!
+
+    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. Use rvpacker-txt -h for help.'
-    exit
+    options
 end
 
-options[:action] = ARGV.shift
+def self.get_game_type(system_file_path)
+    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
 
-unless %w[read write].include?(options[:action])
-    puts 'Invalid command. Allowed commands are: read, write.'
-    exit
+start_time = Time.now
+
+options = parse_options
+input_dir = options[:input_dir]
+output_dir = options[:output_dir]
+disable_custom_processing = options[:disable_custom_processing]
+shuffle_level = options[:shuffle_level]
+logging = options[:logging]
+disable_processing = options[:disable_processing]
+force = options[:force]
+append = options[:append]
+
+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.")
+
+files = Dir.glob("#{paths[:original_path]}/*#{extensions[engine]}")
+
+maps_files_paths = []
+other_files_paths = []
+system_file_path = nil
+scripts_file_path = nil
+
+files.each do |file|
+    basename = File.basename(file)
+
+    if basename.start_with?(/Map[0-9]/)
+        maps_files_paths.push(file)
+    elsif !basename.start_with?(/Map|Tilesets|Animations|System|Scripts|Areas/)
+        other_files_paths.push(file)
+    elsif basename.start_with?('System')
+        system_file_path = file
+    elsif basename.start_with?('Scripts')
+        scripts_file_path = file
+    end
 end
 
-directory = options[:input_dir]
-raise "#{directory} not found" unless File.exist?(directory)
-directory = File.realpath(directory)
+ini_file_path = File.join(input_dir, "Game.ini")
+
+game_type = disable_custom_processing ? nil : get_game_type(system_file_path)
+
+wait_time = 0
+processing_type = if force
+                      wait_time_start = Time.now
+
+                      puts "WARNING! You\'re about to forcefully rewrite all your translation files, including _trans files.\nIf you really want to do it, make sure you've made a backup of your _trans files, if you made some changes in them already.\nInput 'Y' to continue."
+                      exit unless gets.chomp == 'Y'
 
-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?
+                      wait_time = Time.now - wait_time_start
+                      'force'
+                  else
+                      append ? 'append' : 'default'
+                  end
+
+puts 'Custom processing for this game is enabled. Use --disable-custom-processing to disable it.' unless game_type.nil?
+
+if options[:action] == 'read'
+    read_map(maps_files_paths, paths[:maps_path], logging, game_type, processing_type) unless disable_processing[0]
+    read_other(other_files_paths, paths[:other_path], logging, game_type, processing_type) unless disable_processing[1]
+    read_system(system_file_path, ini_file_path, paths[:other_path], logging, processing_type) unless disable_processing[2]
+    read_scripts(scripts_file_path, paths[:other_path], logging, processing_type) unless disable_processing[3]
+else
+    write_map(maps_files_paths, paths[:maps_path], paths[:output_path], shuffle_level, logging, game_type, processing_type) unless disable_processing[0]
+    write_other(other_files_paths, paths[:other_path], paths[:output_path], shuffle_level, logging, game_type, processing_type) unless disable_processing[1]
+    write_system(system_file_path, ini_file_path, paths[:other_path], paths[:output_path], shuffle_level, logging, processing_type) unless disable_processing[2]
+    write_scripts(scripts_file_path, paths[:other_path], paths[:output_path], logging, processing_type) unless disable_processing[3]
+end
 
-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
+$wait_time = 0 if $wait_time.nil?
+end_time = Time.now - start_time - wait_time - $wait_time
 
-RGSS.serialize(engine, options[:action], directory, original_directory,)
+puts "Done in #{end_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 IndexSet
+    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
 
@@ -146,5 +181,3 @@ module RGSS
         process(Object, *symbol_array)
     end
 end
-
-require 'serialize'