rvpacker-txt 1.8.4 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61d150da547df7d50d3920d89812ccbd4f238fd49b17524693ac78870018818
-  data.tar.gz: 8bdcf3ec6fef656d1b8e883a485f29d9ff56466c53bfbb1d5208adee13fb218d
+  metadata.gz: 4be9adddaac27a84654c48292e0fa8949daf9b48a6b97520585e5bc9678c4593
+  data.tar.gz: a108f9445ec1e2151c39eeda9f262c2505e763efbbc790b8c7a788bf9ffdd1bf
 SHA512:
-  metadata.gz: 6fe8e5c012762b40c85b843f428b966d24fadd5129fce757ce8f164f0779c27affda5959e85914f0d3e98dd920a85c4b50a4384004685558e6d2bd032b3916eb
-  data.tar.gz: b36cd1b4af5a0ec1e0fccfd520472ecc4596ac6a93bc88d30c51170f690d4269bd8bb0d9d0414b26b16e3301fec7b78943202b826bd2d91f6cff4faafc24d815
+  metadata.gz: 318bedbdef111ee55225cb8cc71c5cb9f0751c186daa314722f6f09900e69ee2ffaedf11850185d484189c7879630c900d19a586dad6b0c948daa023991c8d45
+  data.tar.gz: ffb4a43103686e875a3de87964c53f2d7ae81b1d64f06433164992bc25a7f31a603837a8358a8e33b7b84be9fb3343e4690f5f9c901d1c50cfbe9c3192bdc243

data/bin/rvpacker-txt

@@ -9,19 +9,28 @@ 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.find_index(file)
@@ -29,25 +38,36 @@ def self.parse_options
             end
         end
 
-        cmd.on('-s', '--shuffle NUM', Integer, 'Shuffle level when writing (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 the rvpacker-txt or the game which files you've parsed receives an update,",
+        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') do
+               'Cannot be used with --force',
+               '[Read flag]') do
             raise '--append cannot be used with --force.' if options[:force]
             options[:append] = true
         end

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,6 +99,7 @@ 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?(/(^#? ?<.*>\.?$)|^$/) }
@@ -618,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/rvpacker-txt.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.8.4'
+    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.4
+  version: 1.8.5
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 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: []