rvpacker-txt 1.8.3 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ce1335835077b4b76bf730aa575ea20154820b5b559f7d61380c79411b7e38
-  data.tar.gz: 0c3541e70ccd8e19a0b76bbc664dab7a4b577b9f6aea1c7cfa40347b4ddc7740
+  metadata.gz: 4be9adddaac27a84654c48292e0fa8949daf9b48a6b97520585e5bc9678c4593
+  data.tar.gz: a108f9445ec1e2151c39eeda9f262c2505e763efbbc790b8c7a788bf9ffdd1bf
 SHA512:
-  metadata.gz: 2d2fe0d75f34329cf4d81c7b8dea7d10c7cd428e0a95940d076cc3c792bfe5038df069ed2736a067defa80548baf96b541b6b457a51f4637d96279a7f90bec36
-  data.tar.gz: 7dc34c760e8d68817446552bd9930c3900ebe43bfac68bec9a5fa68ff23edceef0c6adcce353ea1f0554343994fbb6184f19fe0cf783dfca02d38e61dc938725
+  metadata.gz: 318bedbdef111ee55225cb8cc71c5cb9f0751c186daa314722f6f09900e69ee2ffaedf11850185d484189c7879630c900d19a586dad6b0c948daa023991c8d45
+  data.tar.gz: ffb4a43103686e875a3de87964c53f2d7ae81b1d64f06433164992bc25a7f31a603837a8358a8e33b7b84be9fb3343e4690f5f9c901d1c50cfbe9c3192bdc243

data/bin/rvpacker-txt

@@ -9,45 +9,66 @@ require 'classes'
 def self.parse_options
     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"
-
-        cmd.on('-i', '--input-dir DIR', String, 'Input directory of RPG Maker project') do |dir|
+    read_command_description = 'Parses files from "original" or "data" folders of input directory to "translation" folder of output directory.'
+    write_command_description = 'Writes translated files using original files from "original" or "data" folder of input directory and writes results to "output" folder of output directory.'
+    banner_text = "This tool allows to parse RPG Maker games to .txt files and write them back to their initial form.\n\nUsage: rvpacker-txt COMMAND [options]\n\nCOMMANDS:\n    read - #{read_command_description}\n    write - #{write_command_description}\nOPTIONS:\n"
+
+    OptionParser.new(banner_text) do |cmd|
+        cmd.on('-i', '--input-dir PATH', String,
+               'When reading: Input directory, containing folders "original" or "data" with original game files.',
+               'When writing: Input directory, containing folders "original" or "data" and "translation" with original game files and .txt files with translation respectively.') 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|
+        cmd.on('-o', '--output-dir PATH', String,
+               'When reading: Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.',
+               'When writing: Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.') 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, scripts)") do |files|
+        cmd.on('--disable-processing FILES', Array,
+               'Skips processing the specified files.',
+               'Example: --disable-processing=maps,other,system.',
+               '[Allowed values: maps, other, system, scripts]') do |files|
             files.each do |file|
                 files = %w[maps other system scripts]
-                index = files.index(file)
+                index = files.find_index(file)
                 options[:disable_processing][files[index]] = true if index
             end
         end
 
-        cmd.on('-s', '--shuffle NUM', Integer, 'Shuffle level (1: lines, 2: lines and words)') do |num|
+        cmd.on('-s', '--shuffle-level NUMBER', Integer,
+               'With value 1, shuffles all translation lines. With value 2, shuffles all words and lines in translation text.',
+               'Example: --shuffle-level 1.',
+               '[Allowed values: 0, 1, 2]',
+               '[Default value: 0]',
+               '[Write flag]') do |num|
+            raise 'Allowed values: 0, 1, 2' if num > 2
             options[:shuffle_level] = num
         end
 
-        cmd.on('--disable-custom-processing', 'Disables built-in custom parsing/writing for some games') do
+        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
+        cmd.on('-l', '--log', 'Enables logging.') do
             options[:logging] = true
         end
 
-        cmd.on('-f', '--force', 'Force rewrite all files. Cannot be used with --append', 'USE WITH CAUTION!') do
+        cmd.on('-f', '--force',
+               'Force rewrite all files. Cannot be used with --append.',
+               'USE WITH CAUTION!',
+               '[Read flag]') do
             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
-            raise '--append cannot be used beside --force.' if options[:force]
+        cmd.on('-a', '--append',
+               "When the rvpacker-txt or the game which files you've parsed receives an update,",
+               'you probably should re-read game files with --append, which will append any new text to your files without overwriting the progress',
+               'Cannot be used with --force',
+               '[Read flag]') do
+            raise '--append cannot be used with --force.' if options[:force]
             options[:append] = true
         end
 
@@ -95,9 +116,8 @@ other_path = File.join(input_dir, 'translation', 'other')
 FileUtils.mkdir_p(maps_path)
 FileUtils.mkdir_p(other_path)
 
-engine = extensions.each do |symbol, extension|
-    break symbol if File.exist?(File.join(original_directory, "System.#{extension}"))
-end || (raise "Couldn't determine project engine.")
+engine = extensions.each { |sym, ext| break sym if File.exist?(File.join(original_directory, "System.#{ext}")) } ||
+    (raise "Couldn't determine project engine.")
 
 files = Dir.glob("#{original_directory}/*#{extensions[engine]}")
 
@@ -129,7 +149,9 @@ 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.",
+                           "If 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.",
+                           "Input 'Y' to continue."
                       exit unless gets.chomp == 'Y'
 
                       wait_time = Time.now - wait_time_start

data/lib/read.rb

@@ -70,6 +70,8 @@ end
 # @param [String] game_type
 # @return [String]
 def self.parse_parameter(code, parameter, game_type)
+    return nil if parameter.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼| ]+$/)
+
     unless game_type.nil?
         case code
             when 401, 405
@@ -97,7 +99,9 @@ end
 # @param [String] _game_type
 # @return [String]
 def self.parse_variable(variable, _game_type)
+    return nil if parameter.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼| ]+$/)
     variable = variable.gsub(/\r?\n/, '\#') if variable.count("\n").positive?
+
     return nil if variable.split('\#').all? { |line| line.strip.match?(/(^#? ?<.*>\.?$)|^$/) }
     return nil if variable.match?(/^[+-]?[0-9]*$/) ||
         variable.match?(/---/) ||
@@ -122,9 +126,7 @@ def self.read_map(maps_files_paths, output_path, logging, game_type, processing_
         return
     end
 
-    maps_object_map = Hash[maps_files_paths.map do |filename|
-        [File.basename(filename), Marshal.load(File.binread(filename))]
-    end]
+    maps_object_map = Hash[maps_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     maps_lines = IndexSet.new
     names_lines = IndexSet.new
@@ -266,9 +268,7 @@ end
 # @param [String] game_type
 # @param [String] processing_type
 def self.read_other(other_files_paths, output_path, logging, game_type, processing_type)
-    other_object_array_map = Hash[other_files_paths.map do |filename|
-        [File.basename(filename), Marshal.load(File.binread(filename))]
-    end]
+    other_object_array_map = Hash[other_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     inner_processing_type = processing_type
     # 401 - dialogue lines
@@ -510,20 +510,18 @@ def self.read_system(system_file_path, ini_file_path, output_path, logging, proc
 
                 system_lines.add(value)
             end
+        elsif value.is_a?(Array)
+            value.each do |string|
+                next unless string.is_a?(String)
 
-            next
-        end
+                string = string.strip
+                next if string.empty?
 
-        value.each do |string|
-            next unless string.is_a?(String)
+                system_translation_map.insert_at_index(system_lines.length, string, '') if processing_type == :append &&
+                    !system_translation_map.include?(string)
 
-            string = string.strip
-            next if string.empty?
-
-            system_translation_map.insert_at_index(system_lines.length, string, '') if processing_type == :append &&
-                !system_translation_map.include?(string)
-
-            system_lines.add(string)
+                system_lines.add(string)
+            end
         end
     end
 
@@ -623,7 +621,7 @@ def self.read_scripts(scripts_file_path, output_path, logging, processing_type)
                 string.match?(/^(?=.*\d)[A-Za-z0-9\-]+$/) ||
                 string.match?(/^[a-z\-()\/ +'&]*$/) ||
                 string.match?(/^[A-Za-z]+[+-]$/) ||
-                string.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼|]$/) ||
+                string.match?(/^[.()+-:;\[\]^~%&!*\/→×？?ｘ％▼| ]+$/) ||
                 string.match?(/^Tile.*[A-Z]$/) ||
                 string.match?(/^[a-zA-Z][a-z]+([A-Z][a-z]*)+$/) ||
                 string.match?(/^Cancel Action$|^Invert$|^End$|^Individual$|^Missed File$|^Bitmap$|^Audio$/) ||

data/lib/write.rb

@@ -3,7 +3,7 @@
 require 'zlib'
 
 # @param [String] string A parsed scripts code string, containing raw Ruby code
-# @return [[Array<String>, Array<Integer>]] Hash of parsed from code strings and their start indices
+# @return [Array<Array<String, Integer>>] Hash of parsed from code strings and their start indices
 def self.extract_quoted_strings(string)
     strings_array = []
     indices_array = []
@@ -129,9 +129,7 @@ end
 # @param [Boolean] logging
 # @param [String] game_type
 def self.write_map(original_files_paths, maps_path, output_path, shuffle_level, logging, game_type)
-    maps_object_map = Hash[original_files_paths.map do |filename|
-        [File.basename(filename), Marshal.load(File.binread(filename))]
-    end]
+    maps_object_map = Hash[original_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     maps_original_text = File.readlines(File.join(maps_path, 'maps.txt'), encoding: 'UTF-8', chomp: true).map do |line|
         line.gsub('\#', "\n").strip
@@ -270,9 +268,7 @@ end
 # @param [Boolean] logging
 # @param [String] game_type
 def self.write_other(original_files_paths, other_path, output_path, shuffle_level, logging, game_type)
-    other_object_array_map = Hash[original_files_paths.map do |filename|
-        [File.basename(filename), Marshal.load(File.binread(filename))]
-    end]
+    other_object_array_map = Hash[original_files_paths.map { |f| [File.basename(f), Marshal.load(File.binread(f))] }]
 
     # 401 - dialogue lines
     # 405 - credits lines
@@ -424,9 +420,7 @@ end
 # @param [String] translated
 def self.write_ini_title(ini_file_path, translated)
     file_lines = File.readlines(ini_file_path, chomp: true)
-    title_line_index = file_lines.each_with_index do |line, i|
-        break i if line.downcase.start_with?('title')
-    end
+    title_line_index = file_lines.each_with_index { |line, i| break i if line.downcase.start_with?('title') }
 
     file_lines[title_line_index] = translated
     File.binwrite(ini_file_path, file_lines.join("\n"))
@@ -522,9 +516,8 @@ def self.write_system(system_file_path, ini_file_path, other_path, output_path,
         write_ini_title(ini_file_path, game_title_translated)
     end
 
-    puts "Written #{system_basename}" if logging
-
     File.binwrite(File.join(output_path, system_basename), Marshal.dump(system_object))
+    puts "Written #{system_basename}" if logging
 end
 
 # @param [String] scripts_file_path Path to Scripts.*data file

data/rvpacker-txt.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.8.3'
+    spec.version = '1.8.5'
     spec.authors = ['Howard Jeng', 'Andrew Kesterson', 'Solistra', 'Darkness9724', 'savannstm']
     spec.email = ['savannstm@gmail.com']
-    spec.summary = 'Reads or writes RPG Maker XP/VX/VXAce game text to .txt files'
+    spec.summary = 'Reads RPG Maker XP/VX/VXAce game text to .txt files and writes them to their initial form.'
     spec.homepage = 'https://github.com/savannstm/rvpacker-txt'
     spec.license = 'MIT'
     spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.5
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -53,5 +53,6 @@ requirements: []
 rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
-summary: Reads or writes RPG Maker XP/VX/VXAce game text to .txt files
+summary: Reads RPG Maker XP/VX/VXAce game text to .txt files and writes them to their
+  initial form.
 test_files: []