rvpacker-txt 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3cb24de9b95cae720c5577b90b49e3f3f817256841e8c877fa589db3e2255a
-  data.tar.gz: 857ae8378748e69e870fabd9ca7f0b148131250ed32fa932f2f002373eed43c2
+  metadata.gz: 0504a1427ffcd718aedc6a6db70bce63331ef54046b9e5abe0037d60ffbb0445
+  data.tar.gz: fa94b889274185fa2c6adfb1bd539ded6a8ecf7b1e05702bdf49a557376e9d7d
 SHA512:
-  metadata.gz: dd9df69240e9b738836ed8059324ff1617c09f54b1b9f057e0c1a7ed6d6016331d29310fb1b96a79b4c95e45ee09207ecd6bb001689bd715ebbbb2742819d0a6
-  data.tar.gz: fc7d6ab0e470b9eca55a90835367d721d8b694f1e5e581c8c95e5025bc2f3ef1f189a2e493ab26a9555ffe1f4c34d30e2376bf759052b630a46b23a3dc9919f5
+  metadata.gz: 9d16fa9c8cecf327cbc947250fe8b9f84b4cf0656a80d12caded68d74c2037f7971a8630469389542b8548b5737ff110aa2cdd0936eb34b822d646e3bc661a21
+  data.tar.gz: c0fb36404458b2fc15546c10782ca43841e9179d139e65ced2f12478345911e7d67ad2751e4f43ea7756490b032c43b34777493161f75187de51686fa7ee223d

data/README.md

@@ -20,6 +20,8 @@ Usage
 
 ```
 $ rvpacker-txt -h
+This tool allows to parse RPG Maker project to .txt files and back.
+
 Usage: rvpacker-txt COMMAND [options]
 
 COMMANDS:
@@ -29,15 +31,18 @@ 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.
-    -l, --log                        Log information while processing.
+        --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.
 ```
 
 For example, to read a RPG Maker VX Ace project in E:/Documents/RPGMakerGame to .txt files:
 
 ```
-$ rvpacker read --input-dir E:/Documents/RPGMakerGame
+$ rvpacker-txt read --input-dir E:/Documents/RPGMakerGame
 ```
 
 Program determines game engine automatically.
@@ -49,7 +54,7 @@ Lines from Scripts file will be parsed into translation/other/scripts.txt file a
 To write previously parsed project back to its initial form:
 
 ```
-$ rvpacker write --input-dir E:/Documents/RPGMakerGame
+$ rvpacker-txt write --input-dir E:/Documents/RPGMakerGame
 ```
 
 This will take all of translation lines from _trans files from the translation subdirectories and repack all of them

data/bin/rvpacker-txt

@@ -3,6 +3,8 @@ require 'RGSS'
 require 'optparse'
 
 $logging = false
+$no = [true, true, true, true] # 0 is whether to process maps, 1 is other, 2 is system, 3 is scripts
+
 opts = {}
 OptionParser.new do |options|
     options.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"
@@ -13,14 +15,33 @@ OptionParser.new do |options|
         opts[:input_dir] = dir
     end
 
-    options.on('-l', '--log', 'Log information while processing.') do
-        $logging = true
+    options.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] = false
+                when "other"
+                    $no[1] = false
+                when "system"
+                    $no[2] = false
+                when "scripts"
+                    $no[3] = false
+                else
+                    nil
+            end
+        end
     end
 
     options.on('-s', '--shuffle NUMBER', 'At value 1: Shuffles all lines in strings, at value 2: shuffles all lines and words in strings.') do |number|
         opts[:shuffle] = number
     end
 
+    options.on('-l', '--log', 'Log information while processing.') do
+        $logging = true
+    end
+    
     options.on_tail('-h', '--help', 'Show help message.') do
         puts options
         exit
@@ -44,20 +65,20 @@ project_types = { 'vx' => :vx, 'ace' => :ace, 'xp' => :xp }
 directory = opts[:input_dir]
 raise "#{directory} not found" unless File.exist?(directory)
 
-data_folder = Dir.foreach(directory).find { |filename| filename.downcase == 'original' }
-data_folder = Dir.foreach(directory).find { |filename| filename.downcase == 'data' } if data_folder.nil?
-raise '"Data" or "original" directory not found within input directory.' if data_folder.nil?
+original_directory = Dir.foreach(directory).find { |filename| filename.downcase == 'original' } ||
+    Dir.foreach(directory).find { |filename| filename.downcase == 'data' }
+raise '"Data" or "original" directory not found within input directory.' if original_directory.nil?
 
 types = %w[vx ace xp]
 
-type = types.find do |_type|
-    case _type
+type = types.find do |type_|
+    case type_
         when 'xp'
-            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rxdata'))
+            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rxdata'))
         when 'vx'
-            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata'))
+            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rvdata'))
         when 'ace'
-            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata2'))
+            break project_types[type_] if File.exist?(File.join(directory, original_directory, 'System.rvdata2'))
         else
             break nil
     end
@@ -65,4 +86,4 @@ end
 
 raise 'Couldn\'t determine project engine.' if type.nil?
 
-RGSS.serialize(type, opts[:action], directory)
+RGSS.serialize(type, opts[:action], directory, original_directory)

data/lib/RGSS/serialize.rb

@@ -50,6 +50,10 @@ class IndexedSet
     def length
         @index.length
     end
+
+    def empty?
+        @index.empty?
+    end
 end
 
 module RGSS
@@ -156,11 +160,9 @@ module RGSS
                                             lines[0].add(parsed) unless parsed.nil?
                                         end
                                     end
-                                elsif code == 356
-                                    if parameter.is_a?(String) && !parameter.empty?
-                                        parsed = parse_parameter(code, parameter)
-                                        lines[0].add(parsed.gsub(/\r?\n/, '\#')) unless parsed.nil?
-                                    end
+                                elsif code == 356 && parameter.is_a?(String) && !parameter.empty?
+                                    parsed = parse_parameter(code, parameter)
+                                    lines[0].add(parsed.gsub(/\r?\n/, '\#')) unless parsed.nil?
                                 end
                             end
                         end
@@ -172,9 +174,9 @@ module RGSS
         end
 
         File.write("#{output_path}/maps.txt", lines[0].join("\n"))
-        File.write("#{output_path}/maps_trans.txt", "\n" * (lines[0].length.positive? ? lines[0].length - 1 : 0))
+        File.write("#{output_path}/maps_trans.txt", "\n" * (!lines[0].empty? ? lines[0].length - 1 : 0))
         File.write("#{output_path}/names.txt", lines[1].join("\n"))
-        File.write("#{output_path}/names_trans.txt", "\n" * (lines[1].length.positive? ? lines[1].length - 1 : 0))
+        File.write("#{output_path}/names_trans.txt", "\n" * (!lines[1].empty? ? lines[1].length - 1 : 0))
     end
 
     def self.read_other(original_other_files, output_path)
@@ -250,7 +252,7 @@ module RGSS
             puts "Parsed #{filename}" if $logging
 
             File.write("#{output_path}/#{processed_filename}.txt", lines.join("\n"))
-            File.write("#{output_path}/#{processed_filename}_trans.txt", "\n" * (lines.length.positive? ? lines.length - 1 : 0))
+            File.write("#{output_path}/#{processed_filename}_trans.txt", "\n" * (!lines.empty? ? lines.length - 1 : 0))
         end
     end
 
@@ -292,21 +294,74 @@ module RGSS
         puts "Parsed #{filename}" if $logging
 
         File.write("#{output_path}/#{basename}.txt", lines.join("\n"), mode: 'wb')
-        File.write("#{output_path}/#{basename}_trans.txt", "\n" * (lines.length.positive? ? lines.length - 1 : 0),
+        File.write("#{output_path}/#{basename}_trans.txt", "\n" * (!lines.empty? ? lines.length - 1 : 0),
                    mode: 'wb')
     end
 
+    def self.extract_quoted_strings(input)
+        result = []
+        in_quotes = false
+        quote_type = nil
+        buffer = []
+
+        input.each_char.with_index do |char, index|
+            if char == '#' && (index == 0 || input[index - 1] == "\n")
+                index = input.index("\n", index) || input.length
+                next
+            end
+
+            if char == '"' || char == "'"
+                if in_quotes
+                    if char == quote_type
+                        result.push(buffer.join)
+                        buffer.clear
+                        in_quotes = false
+                        quote_type = nil
+                    else
+                        buffer.push(char)
+                    end
+                else
+                    in_quotes = true
+                    quote_type = char
+                end
+
+                next
+            end
+
+            if in_quotes
+                if char != "\r"
+                    if char == "\n"
+                        buffer.push('\#')
+                        next
+                    end
+
+                    buffer.push(char)
+                end
+            end
+        end
+
+        result
+    end
+
     def self.read_scripts(scripts_file_path, output_path)
         script_entries = Marshal.load(File.read(scripts_file_path, mode: 'rb'))
-        strings = []
+        strings = IndexedSet.new
 
         script_entries.each do |script|
             code = Zlib::Inflate.inflate(script[2]).force_encoding('UTF-8')
-            code.scan(/".*"/) { |string| strings.push(string) }
+
+            extract_quoted_strings(code).each do |string|
+                next if string.strip! || (string.empty? || string.delete('　　').empty?)
+
+                next if string.start_with?(/(#|\!?\$|@|(Graphics|Data|Audio|CG|Movies)\/)/) ||
+                    string.match?(/^\d+$|^(.)\1{2,}$|^false|true$|^(wb|rb)$|^[A-Za-z0-9\-]+$|^[\.\(\)\+\-:;\|\[\]\^~%&!\*\/→×？\?ｘ％▼]$|#\{|\\(?!#)|\+?=?=|\{|\}|_|r[vx]data|[<>]|\.split/) ||
+
+                    strings.add(string)
+            end
         end
 
         File.write("#{output_path}/scripts.txt", strings.join("\n"), mode: 'wb')
-        File.write("#{output_path}/scripts_trans.txt", "\n" * (strings.length.positive? ? strings.length - 1 : 0), mode: 'wb')
+        File.write("#{output_path}/scripts_trans.txt", "\n" * (!strings.empty? ? strings.length - 1 : 0), mode: 'wb')
     end
 
     def self.merge_seq(object_array)
@@ -363,7 +418,7 @@ module RGSS
             end
         end
 
-        return object
+        object
     end
 
     def self.merge_other(object_array)
@@ -386,6 +441,8 @@ module RGSS
                 object.instance_variable_set(:@list, merge_seq(list))
             end
         end
+
+        object_array
     end
 
     def self.get_translated(code, parameter, hashmap)
@@ -646,7 +703,7 @@ module RGSS
         File.write("#{output_path}/#{File.basename(scripts_file)}", Marshal.dump(script_entries), mode: 'wb')
     end
 
-    def self.serialize(engine, action, directory)
+    def self.serialize(engine, action, directory, original_directory)
         start_time = Time.now
 
         setup_classes(engine)
@@ -654,7 +711,7 @@ module RGSS
         absolute_path = File.realpath(directory)
 
         paths = {
-            original_path: File.join(absolute_path, 'Data'),
+            original_path: File.join(absolute_path, original_directory),
             translation_path: File.join(absolute_path, 'translation'),
             maps_path: File.join(absolute_path, 'translation/maps'),
             other_path: File.join(absolute_path, 'translation/other'),
@@ -690,15 +747,15 @@ module RGSS
         end
 
         if action == 'read'
-            read_map(maps_files, paths[:maps_path])
-            read_other(other_files, paths[:other_path])
-            read_system(system_file, paths[:other_path])
-            read_scripts(scripts_file, paths[:other_path])
+            read_map(maps_files, paths[:maps_path]) unless $no[0]
+            read_other(other_files, paths[:other_path]) unless $no[1]
+            read_system(system_file, paths[:other_path]) unless $no[2]
+            read_scripts(scripts_file, paths[:other_path]) unless $no[3]
         else
-            write_map(maps_files, paths[:maps_path], paths[:output_path])
-            write_other(other_files, paths[:other_path], paths[:output_path])
-            write_system(system_file, paths[:other_path], paths[:output_path])
-            write_scripts(scripts_file, paths[:other_path], paths[:output_path])
+            write_map(maps_files, paths[:maps_path], paths[:output_path]) unless $no[0]
+            write_other(other_files, paths[:other_path], paths[:output_path]) unless $no[1]
+            write_system(system_file, paths[:other_path], paths[:output_path]) unless $no[2]
+            write_scripts(scripts_file, paths[:other_path], paths[:output_path]) unless $no[3]
         end
 
         puts "Done in #{(Time.now - start_time)}"

data/lib/RGSS.rb

@@ -17,6 +17,7 @@ FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TOR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 =end
+
 class Table
     def initialize(bytes)
         @dim, @x, @y, @z, items, *@data = bytes.unpack('L5 S*')

data/rvpacker-txt.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
     spec.name = 'rvpacker-txt'
-    spec.version = '1.1.0'
+    spec.version = '1.2.0'
     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'

data/sig/rgss.rbs

@@ -21,7 +21,7 @@ module RGSS
 
     def self.read_scripts: (String, String) -> void
 
-    def self.serialize: (Symbol, String, String) -> void
+    def self.serialize: (Symbol, String, String, String) -> void
 
     def self.write_map: (Array[String], String, String) -> void
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvpacker-txt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Howard Jeng
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler