rvpacker-txt 1.5.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8d16cb7960ca2c4494b2b2e1c414114404403dac94acd7a7adeac4e7c24e12
-  data.tar.gz: dc10d4e2abdcbd70b8f4af452215d1540a5e7ab0775202fdca04ee28726c1e7c
+  metadata.gz: b723edca892d423ad6b4dcd7800a904244fddfa8e7a68bfc823db6be676c0c82
+  data.tar.gz: 2acde66ea3d5f6643ed0e5a81ab12f66ec066952f8bc797d13337d0499db764d
 SHA512:
-  metadata.gz: 9921e7a66d63e4784b5679329b0c7d02112396976c2ea9febbae7b21eff78e951dcb47f4ecf4eddc8b133af0790005f7acd50ccb49c1a1663662daa4b71eb7a2
-  data.tar.gz: 823cfe0171387ff3001b7bc6876fac636817d1b67cf6b0d5b23afe860b69635c7e2fe796ae24e7e1da7b7816c3e51daf4098cbb13a16b07801f99640bcd7c131
+  metadata.gz: 7ba34d8ca913bc93073b322cf3c19d2492438e57cac203161df3c9332176f7b4078e8f229607986a109f4baa3d72470c6491b87825e6f0baf86d927bd3fc4209
+  data.tar.gz: 3e3f67a08e881777ea7057d7545253262746d9875f3bef1c2bd7ac21db52f4b7862881223405ca304dc794b369402f4726747a73bd984e2b11c3ac535733ca28

data/README.md

@@ -31,13 +31,14 @@ COMMANDS:
 OPTIONS:
     -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)
+        --disable-processing FILES   Don't process specified files (maps, other, system, scripts)
     -s, --shuffle NUM                Shuffle level (1: lines, 2: lines and words)
-        --disable_custom_processing  Disables built-in custom parsing/writing for some games
+        --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.
+    -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.
+    -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
 ```

data/bin/rvpacker-txt

@@ -5,11 +5,9 @@ require 'optparse'
 require 'fileutils'
 
 require 'classes'
-require 'read'
-require 'write'
 
 def self.parse_options
-    options = { disable_processing: Array.new(4, false) }
+    options = { disable_processing: {}, input_dir: './', output_dir: './', shuffle_level: 0 }
 
     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"
@@ -23,10 +21,11 @@ def self.parse_options
             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|
+        cmd.on('--disable-processing FILES', Array, "Don't process specified files (maps, other, system, scripts)") do |files|
             files.each do |file|
-                index = %w[maps other system scripts].index(file)
-                options[:disable_processing][index] = true if index
+                files = %w[maps other system scripts]
+                index = files.index(file)
+                options[:disable_processing][files[index]] = true if index
             end
         end
 
@@ -46,7 +45,8 @@ def self.parse_options
             options[:force] = true
         end
 
-        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
+        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
@@ -64,6 +64,8 @@ def self.parse_options
     options
 end
 
+# @param [String] system_file_path
+# @return [String, nil]
 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
@@ -82,26 +84,22 @@ disable_processing = options[:disable_processing]
 force = options[:force]
 append = options[:append]
 
-extensions = { xp: '.rxdata', vx: 'rvdata', ace: 'rvdata2' }
+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')
-}
+maps_path = File.join(input_dir, 'translation', 'maps')
+other_path = File.join(input_dir, 'translation', 'other')
 
-paths.each_value { |path| FileUtils.mkdir_p(path) }
+FileUtils.mkdir_p(maps_path)
+FileUtils.mkdir_p(other_path)
 
-engine = extensions.find do |symbol, extension|
-    symbol if File.exist?(File.join(paths[:original_path], "System.#{extension}"))
+engine = extensions.each do |symbol, extension|
+    break symbol if File.exist?(File.join(original_directory, "System.#{extension}"))
 end || (raise "Couldn't determine project engine.")
 
-files = Dir.glob("#{paths[:original_path]}/*#{extensions[engine]}")
+files = Dir.glob("#{original_directory}/*#{extensions[engine]}")
 
 maps_files_paths = []
 other_files_paths = []
@@ -110,6 +108,7 @@ scripts_file_path = nil
 
 files.each do |file|
     basename = File.basename(file)
+    next unless basename.end_with?(extensions[engine])
 
     if basename.start_with?(/Map[0-9]/)
         maps_files_paths.push(file)
@@ -122,7 +121,7 @@ files.each do |file|
     end
 end
 
-ini_file_path = File.join(input_dir, "Game.ini")
+ini_file_path = File.join(input_dir, 'Game.ini')
 
 game_type = disable_custom_processing ? nil : get_game_type(system_file_path)
 
@@ -130,30 +129,35 @@ 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."
+                      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'
 
                       wait_time = Time.now - wait_time_start
-                      'force'
+                      :force
                   else
-                      append ? 'append' : 'default'
+                      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]
+    require 'read'
+    read_map(maps_files_paths, maps_path, logging, game_type, processing_type) unless disable_processing[:maps]
+    read_other(other_files_paths, other_path, logging, game_type, processing_type) unless disable_processing[:other]
+    read_system(system_file_path, ini_file_path, other_path, logging, processing_type) unless disable_processing[:system]
+    read_scripts(scripts_file_path, other_path, logging, processing_type) unless disable_processing[:scripts]
 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]
+    require 'write'
+    output_path = File.join(output_dir, 'output')
+    FileUtils.mkdir_p(output_path)
+
+    write_map(maps_files_paths, maps_path, output_path, shuffle_level, logging, game_type) unless disable_processing[:maps]
+    write_other(other_files_paths, other_path, output_path, shuffle_level, logging, game_type) unless disable_processing[:other]
+    write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, logging) unless disable_processing[:system]
+    write_scripts(scripts_file_path, other_path, output_path, logging) unless disable_processing[:scripts]
 end
 
 $wait_time = 0 if $wait_time.nil?
-end_time = Time.now - start_time - wait_time - $wait_time
+elapsed_time = Time.now - start_time - wait_time - $wait_time
 
-puts "Done in #{end_time}"
+puts "Done in #{elapsed_time}"

data/lib/classes.rb

@@ -21,7 +21,6 @@ DEALINGS IN THE SOFTWARE.
 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 && @x * @y * @z == items
     end
 
@@ -114,6 +113,69 @@ class IndexSet
 end
 
 module RPG
+    class Map
+        attr_accessor :display_name, :events
+    end
+
+    class Event
+        attr_accessor :pages
+
+        class Page
+            attr_accessor :list
+        end
+    end
+
+    class EventCommand
+        attr_accessor :code, :parameters
+    end
+
+    class Actor
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Armor
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Class
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Enemy
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Item
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Skill
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class State
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class Weapon
+        attr_accessor :name, :nickname, :description, :note
+    end
+
+    class CommonEvent
+        attr_accessor :pages, :list
+    end
+
+    class Troop
+        attr_accessor :pages
+
+        class Page
+            attr_accessor :list
+        end
+    end
+
+    class System
+        attr_accessor :elements, :skill_types, :weapon_types, :armor_types, :currency_unit, :terms, :words, :game_title
+    end
 end
 
 module RGSS