rvpacker-txt 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be6dfc912a9d15dd4be7c37ecee0c316d650ca10f89eb99af19d5baf38addf2
-  data.tar.gz: a0ed09eac3d11c36db6d9014e4c0bc6ffa2408ac8c4a78f55fdfbb08285b759a
+  metadata.gz: 306650077c0c96134cd8f4f1d76c3c5fc7d7b3e7745ad1ddd4a998d75b2635fe
+  data.tar.gz: f1ca20dfdcfd2392887d670aa6d9627dbdef790c33e914885e1e408f13c13204
 SHA512:
-  metadata.gz: bfc00222eff1dc676c73e62bc9048a89a4ea01fdce63eda1e7373a8d4f5a4d9975418111844704127cae24f2d01848d8486ba544f8f2de409346801f9563325c
-  data.tar.gz: 473d0707b8359f54dd49ed665addf7cbfedf4a80ccadfaf6f7d997db9e4f691ae05a4882187a5dad3c8a6dc37231c11efb6e997a573bd89a70bc3f366f6e8695
+  metadata.gz: e7c3d64504ea05478e5dbe30c6658a1c9ce7bfb6534769c4030cc2397b1288985bccb60fd88f3f8e22775d5e7abe9f8c9f749f8e256c563fab5d25d6ec99d79c
+  data.tar.gz: 101c1fd97bcd7e9e91c86e0ac7bf5746e0dc53450eebc5d518542b26a9133c8f53f7e849892a64afc32ad48a3241212bd77efc10ead33d835c52269aadf38087

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 
 gemspec
 gem 'rubocop', group: 'development', require: false
+gem 'syntax_tree', group: 'development', require: false

data/README.md

@@ -1,25 +1,25 @@
 # rvpacker-txt
 
+**This project won't longer be maintained. Consider looking into my other projects: [Rust implementation of Marshal](https://github.com/savannstm/marshal-rs) and [TypeScript implementation of Marshal](https://github.com/savannstm/marshal)**
+
 A tool to read RPG Maker data files to .txt files and write them back to the initial form. It's a port of Darkness9724's
 port of Ruby 1.9.x's rvpacker to Ruby 3.x to use .txt files instead of YAML, and overall improve the code quality.
 
-rvpacker consists of 3 parts:
+rvpacker-txt consists of 3 parts:
 
-* 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.
+-   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
+## Installation
 
-```
-$ gem install rvpacker-txt
-```
+`gem install rvpacker-txt`
 
-# Usage
+## Usage
 
 You can get a help message on usage using `rvpacker-txt -h`.
 
-```
+```text
 $ rvpacker-txt -h
 This tool allows to parse RPG Maker games to .txt files and write them back to their initial form.
 
@@ -47,44 +47,40 @@ OPTIONS:
 
 For example, to read a RPG Maker VX Ace project in E:/Documents/RPGMakerGame to .txt files:
 
-```
-$ rvpacker-txt read --input-dir E:/Documents/RPGMakerGame
-```
+`$ rvpacker-txt read --input-dir E:/Documents/RPGMakerGame`
 
 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.
+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, 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:
 
-```
-$ rvpacker-txt 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
+This will take all of translation lines from \_trans files from the translation subdirectories and repack all of them
 to their initial form in output directory.
 
-## General
+### General
 
 This is great for collaborating on translations and have clean version control.
 You can easily push .txt files and easily merge them.
 
 Now your translation can be forked/merged in an extremely easy way.
 
-## Credit to previous authors
+### Credit to previous authors
 
 The RPG and RGSS libraries were originally taken from SiCrane's YAML importer/exporter on the gamedev forums.
 
-http://www.gamedev.net/topic/646333-rpg-maker-vx-ace-data-conversion-utility/
+<http://www.gamedev.net/topic/646333-rpg-maker-vx-ace-data-conversion-utility/>
 
 akesterson, ymaxkrapzv and BigBlueHat created an original rvpacker repository with the initial frontend for SiCrane's
 YAML importer/exporter.
 
-https://github.com/ymaxkrapzv/rvpacker
+<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

@@ -7,25 +7,27 @@ require 'fileutils'
 require 'classes'
 
 def self.parse_options
-    options = { action: nil,
-                input_path: './',
-                output_path: './',
-                disable_processing: {
-                    maps: false,
-                    other: false,
-                    system: false,
-                    scripts: false
-                },
-                disable_custom_processing: false,
-                romanize: false,
-                logging: false,
-                force: false,
-                append: false,
-                shuffle_level: 0,
-                silent: false }
+    options = {
+        action: nil,
+        input_path: './',
+        output_path: './',
+        disable_processing: {
+            maps: false,
+            other: false,
+            system: false,
+            scripts: false,
+        },
+        disable_custom_processing: false,
+        romanize: false,
+        logging: false,
+        force: false,
+        append: false,
+        shuffle_level: 0,
+        silent: false,
+    }
 
     options[:action] = ARGV[0]
-    options[:silent] = true unless ARGV.delete('--silent').nil?
+    options[:silent] = true if ARGV.delete('--silent')
 
     unless %w[read write].include?(options[:action])
         if %w[-h --help].include?(options[:action])
@@ -37,102 +39,136 @@ def self.parse_options
         end
     end
 
-    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:"
-
-    banner,
-        input_dir_description,
-        output_dir_description, =
+    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:"
+
+    banner, input_dir_description, output_dir_description, =
         case options[:action]
-            when 'read'
-                ["#{read_command_description}\n\nOPTIONS:\n",
-                 ['Input directory, containing folders "original" or "data" with original game files.'],
-                 ['Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.']]
-            when 'write'
-                ["#{write_command_description}\n\nOPTIONS:\n",
-                 ['Input directory, containing folders "original" or "data" and "translation" with original game files and .txt files with translation respectively.'],
-                 ['Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.']]
-            else
-                [banner_text,
-                 ['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.'],
-                 ['When reading: Output directory, where a "translation" folder will be created, containing parsed .txt files with the text from the game.',
-                  'When writing: Output directory, where an "output" folder will be created, containing compiled RPG Maker files with your translation.']]
-        end
-
-    OptionParser.new(banner) do |cmd|
-        cmd.on('-i', '--input-dir PATH', String,
-               *input_dir_description) do |dir|
-            options[:input_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
-            options[:output_path] = options[:input_path]
-        end
-
-        cmd.on('-o', '--output-dir PATH', String,
-               *output_dir_description) do |dir|
-            options[:output_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+        when 'read'
+            [
+                "#{read_command_description}\n\nOPTIONS:\n",
+                ['Input directory, containing folders "original" or "data" with original game files.'],
+                [
+                    'Output directory, where a "translation" folder will be created, containing parsed .txt files ' \
+                        'with the text from the game.',
+                ],
+            ]
+        when 'write'
+            [
+                "#{write_command_description}\n\nOPTIONS:\n",
+                [
+                    'Input directory, containing folders "original" or "data" and "translation" with original game ' \
+                        'files and .txt files with translation respectively.',
+                ],
+                [
+                    'Output directory, where an "output" folder will be created, containing compiled RPG Maker files ' \
+                        'with your translation.',
+                ],
+            ]
+        else
+            [
+                banner_text,
+                [
+                    '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.',
+                ],
+                [
+                    'When reading: Output directory, where a "translation" folder will be created, containing parsed ' \
+                        '.txt files with the text from the game.',
+                    'When writing: Output directory, where an "output" folder will be created, containing compiled ' \
+                        'RPG Maker files with your translation.',
+                ],
+            ]
         end
 
-        cmd.on('--disable-processing FILES', Array,
-               'Skips processing 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)
-                options[:disable_processing][files[index]] = true if index
+    OptionParser
+        .new(banner) do |cmd|
+            cmd.on('-i', '--input-dir PATH', String, *input_dir_description) do |dir|
+                options[:input_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
+                options[:output_path] = options[:input_path]
             end
-        end
 
-        cmd.on('--disable-custom-processing',
-               'Disables built-in custom text processing for some games.',
-               'This flag will automatically be used when writing if you parsed game text with it.') do
-            options[:disable_custom_processing] = true
-        end
-
-        cmd.on('-r', '--romanize',
-               'If you parsing text from a Japanese game, that contains symbols like 「」, which are just the Japanese quotation marks,',
-               'it automatically replaces these symbols by their roman equivalents (in this case, "").',
-               'This flag will automatically be used when writing if you parsed game text with it.') do
-            options[:romanize] = true
-        end
-
-        if options[:action] == 'read'
-            cmd.on('-f', '--force',
-                   'Force rewrite all files. Cannot be used with --append.',
-                   'USE WITH CAUTION!') do
-                options[:force] = true
+            cmd.on('-o', '--output-dir PATH', String, *output_dir_description) do |dir|
+                options[:output_path] = File.exist?(dir) ? File.realpath(dir) : (raise "#{dir} not found")
             end
 
-            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
-                raise '--append cannot be used with --force.' if options[:force]
-                options[:append] = true
+            cmd.on(
+                '--disable-processing FILES',
+                Array,
+                'Skips processing 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)
+                    options[:disable_processing][files[index]] = true if index
+                end
             end
-        elsif options[:action] == 'write'
-            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]') do |num|
-                raise 'Allowed values: 0, 1, 2.' if num > 2
-                options[:shuffle_level] = num
+
+            cmd.on(
+                '--disable-custom-processing',
+                'Disables built-in custom text processing for some games.',
+                'This flag will automatically be used when writing if you parsed game text with it.',
+            ) { options[:disable_custom_processing] = true }
+
+            cmd.on(
+                '-r',
+                '--romanize',
+                'If you parsing text from a Japanese game, that contains symbols like 「」, which are just the ' \
+                    'Japanese quotation marks,',
+                'it automatically replaces these symbols by their roman equivalents (in this case, "").',
+                'This flag will automatically be used when writing if you parsed game text with it.',
+            ) { options[:romanize] = true }
+
+            if options[:action] == 'read'
+                cmd.on('-f', '--force', 'Force rewrite all files. Cannot be used with --append.', 'USE WITH CAUTION!') do
+                    options[:force] = true
+                end
+
+                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
+                    raise '--append cannot be used with --force.' if options[:force]
+                    options[:append] = true
+                end
+            elsif options[:action] == 'write'
+                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]',
+                ) do |num|
+                    raise 'Allowed values: 0, 1, 2.' if num > 2
+                    options[:shuffle_level] = num
+                end
             end
-        end
 
-        cmd.on('-l', '--log',
-               'Enables logging.') do
-            options[:logging] = true
-        end
+            cmd.on('-l', '--log', 'Enables logging.') { options[:logging] = true }
 
-        cmd.on('-h', '--help',
-               "Prints the program's help message or for the entered subcommand.") do
-            puts cmd
-            exit
+            cmd.on('-h', '--help', "Prints the program's help message or for the entered subcommand.") do
+                puts cmd
+                exit
+            end
         end
-    end.parse!
+        .parse!
 
     options
 end
@@ -181,8 +217,9 @@ metadata_file_path = File.join(input_path, 'translation', '.rvpacker-txt-metadat
 FileUtils.mkdir_p(maps_path)
 FileUtils.mkdir_p(other_path)
 
-engine = extensions.each_pair { |sym, ext| break sym if File.exist?(File.join(original_directory, "System.#{ext}")) } ||
-    (raise "Couldn't determine project engine.")
+engine =
+    extensions.each_pair { |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]}")
 
@@ -195,9 +232,9 @@ files.each do |file|
     basename = File.basename(file)
     next unless basename.end_with?(extensions[engine])
 
-    if basename.start_with?(/Map[0-9]/)
+    if basename.match?(/^Map[0-9]/)
         maps_files_paths.push(file)
-    elsif !basename.start_with?(/Map|Tilesets|Animations|System|Scripts|Areas/)
+    elsif !basename.match?(/^(Map|Tilesets|Animations|System|Scripts|Areas)/)
         other_files_paths.push(file)
     elsif basename.start_with?('System')
         system_file_path = file
@@ -217,29 +254,41 @@ $wait_time = 0
 if options[:action] == 'read'
     require 'read'
 
-    processing_mode = if force
-                          unless silent
-                              wait_time_start = Time.now
+    processing_mode =
+        if force
+            unless silent
+                wait_time_start = Time.now
 
-                              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 $stdin.gets.chomp == 'Y'
+                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 $stdin.gets.chomp == 'Y'
 
-                              $wait_time += Time.now - wait_time_start
-                          end
-                          :force
-                      elsif append
-                          :append
-                      else
-                          :default
-                      end
+                $wait_time += Time.now - wait_time_start
+            end
+            :force
+        elsif append
+            :append
+        else
+            :default
+        end
 
-    File.binwrite(metadata_file_path, Marshal.dump({ romanize: romanize, disable_custom_processing: disable_custom_processing }))
+    File.binwrite(
+        metadata_file_path,
+        Marshal.dump({ romanize: romanize, disable_custom_processing: disable_custom_processing }),
+    )
 
     read_map(maps_files_paths, maps_path, romanize, logging, game_type, processing_mode) unless disable_processing[:maps]
-    read_other(other_files_paths, other_path, romanize, logging, game_type, processing_mode) unless disable_processing[:other]
-    read_system(system_file_path, ini_file_path, other_path, romanize, logging, processing_mode) unless disable_processing[:system]
+
+    unless disable_processing[:other]
+        read_other(other_files_paths, other_path, romanize, logging, game_type, processing_mode)
+    end
+
+    unless disable_processing[:system]
+        read_system(system_file_path, ini_file_path, other_path, romanize, logging, processing_mode)
+    end
+
     read_scripts(scripts_file_path, other_path, romanize, logging, processing_mode) unless disable_processing[:scripts]
 else
     require 'write'
@@ -261,9 +310,18 @@ else
         end
     end
 
-    write_map(maps_files_paths, maps_path, output_path, shuffle_level, romanize, logging, game_type) unless disable_processing[:maps]
-    write_other(other_files_paths, other_path, output_path, shuffle_level, romanize, logging, game_type) unless disable_processing[:other]
-    write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, romanize, logging) unless disable_processing[:system]
+    unless disable_processing[:maps]
+        write_map(maps_files_paths, maps_path, output_path, shuffle_level, romanize, logging, game_type)
+    end
+
+    unless disable_processing[:other]
+        write_other(other_files_paths, other_path, output_path, shuffle_level, romanize, logging, game_type)
+    end
+
+    unless disable_processing[:system]
+        write_system(system_file_path, ini_file_path, other_path, output_path, shuffle_level, romanize, logging)
+    end
+
     write_scripts(scripts_file_path, other_path, output_path, romanize, logging) unless disable_processing[:scripts]
 end
 

data/lib/classes.rb

@@ -1,22 +1,22 @@
-=begin
-Copyright (c) 2013 Howard Jeng
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
-to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or
-substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
-FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-=end
+# frozen_string_literal: true
+
+# Copyright (c) 2013 Howard Jeng
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+# to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+# FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
 
 class Table
     def initialize(bytes)
@@ -75,43 +75,6 @@ class Rect
     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
-
 class Hash
     def insert_at_index(index, key, value)
         return self[key] = value if index >= size
@@ -160,11 +123,11 @@ module RPG
     end
 
     class Skill
-        attr_accessor :name, :description, :note
+        attr_accessor :name, :description, :note, :message1, :message2
     end
 
     class State
-        attr_accessor :name, :description, :note
+        attr_accessor :name, :description, :note, :message1, :message2, :message3, :message4
     end
 
     class Weapon
@@ -248,10 +211,8 @@ module RGSS
         %i[RPG UsableItem],
         %i[RPG UsableItem Damage],
         %i[RPG UsableItem Effect],
-        %i[RPG Weapon]
+        %i[RPG Weapon],
     ].freeze
 
-    CLASSES_NESTED_ARRAY.each do |symbol_array|
-        process(Object, *symbol_array)
-    end
+    CLASSES_NESTED_ARRAY.each { |symbol_array| process(Object, *symbol_array) }
 end