rvpacker-txt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23d385ac1a1e31fb6b845b028746ca52e58c882aed04ffd23721dfe513934451
+  data.tar.gz: 138b367cdd190e4edfbc8f1449b7b5129f03d2d614e8f17f7dbb9599c7c3aeb9
+SHA512:
+  metadata.gz: c1273a05232251e539300f9c5cef0c1b082c041e5ecd3e7f4284f933ea5df29641808395d08e344dcd825f8cca727701e3f8e61fb9280016e47d60eecc8f2dfb
+  data.tar.gz: bd29920e41d1fd3871879d4a541863b078329f57338adfcc12fe08aeee6970b4e36b568747a06d0105388ae280482365039c98f8ee6bdf43e05550359fda0d17

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rvpacker-txt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,17 @@
+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.

data/README.md

@@ -0,0 +1,78 @@
+# rvpacker-txt
+
+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:
+
+* RPG library (stub classes for serialization of RPGMaker game data)
+* RGSS library (some more classes for RPGMaker serialization)
+* rvpacker-txt (the script you call on the frontend)
+
+# Installation
+
+```
+$ gem install rvpacker-txt
+```
+
+Usage
+=====
+
+```
+$ rvpacker-txt -h
+Usage: rvpacker-txt COMMAND [options]
+
+COMMANDS:
+    read - Parses RPG Maker game files to .txt
+    write - Writes parsed files back to their initial form
+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.
+    -s, --shuffle NUMBER             At value 1: Shuffles all lines in strings, at value 2: shuffles all lines and words in strings.
+    -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
+```
+
+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.
+Lines from Scripts file will be parsed into translation/other/scripts.txt file as plain text.
+
+To write previously parsed project back to its initial form:
+
+```
+$ rvpacker 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
+to their initial form in output directory.
+
+## 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
+
+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/
+
+akesterson, ymaxkrapzv and BigBlueHat created an original rvpacker repository with the initial frontend for SiCrane's
+YAML importer/exporter.
+
+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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/rvpacker-txt

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require('RGSS')
+require('optparse')
+
+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"
+
+    options.on('-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.') do |dir|
+        opts[:input_dir] = dir
+    end
+
+    options.on('-l', '--log', 'Log information while processing.') do
+        opts[:log] = true
+    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_tail('-h', '--help', 'Show help message.') do
+        puts options
+        exit
+    end
+end.parse!(ARGV)
+
+if ARGV.empty?
+    puts 'COMMAND argument is required.'
+    exit
+end
+
+opts[:action] = ARGV.shift
+
+unless %w[read write].include?(opts[:action])
+    puts 'Invalid command. Allowed commands are: read, write.'
+    exit
+end
+
+project_types = { 'vx' => :vx, 'ace' => :ace, 'xp' => :xp }
+$logging = opts[:log]
+
+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" directory not found within input directory.' if data_folder.nil?
+
+types = %i[vx ace xp]
+
+type = types.find do |_type|
+    case _type
+        when 'vx'
+            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rxdata'))
+        when 'xp'
+            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata'))
+        when 'ace'
+            break project_types[_type] if File.exist?(File.join(directory, data_folder, 'System.rvdata2'))
+        else
+            break nil
+    end
+end
+
+raise 'Couldn\'t determine project engine.' if type.nil?
+
+RGSS.serialize(
+    type,
+    opts[:action],
+    directory,
+    {
+        line_width: -1,
+        table_width: -1,
+    }
+)

data/lib/RGSS/BasicCoder.rb

@@ -0,0 +1,54 @@
+module RGSS
+    module BasicCoder
+        def encode_with(coder)
+            ivars.each do |var|
+                name = var.to_s.sub(/^@/, '')
+                value = instance_variable_get(var)
+                coder[name] = encode(name, value)
+            end
+        end
+
+        def encode(name, value)
+            return value
+        end
+
+        def init_with(coder)
+            coder.map.each do |key, value|
+                sym = "@#{key}".to_sym
+                instance_variable_set(sym, decode(key, value))
+            end
+        end
+
+        def decode(name, value)
+            return value
+        end
+
+        def ivars
+            return instance_variables
+        end
+
+        INCLUDED_CLASSES = []
+
+        def self.included(mod)
+            INCLUDED_CLASSES.push(mod)
+        end
+
+        def self.set_ivars_methods(version)
+            INCLUDED_CLASSES.each do |c|
+                if version == :ace
+                    RGSS.reset_method(
+                        c,
+                        :ivars,
+                        -> { return instance_variables }
+                    )
+                else
+                    RGSS.reset_method(
+                        c,
+                        :ivars,
+                        -> { return instance_variables.sort }
+                    )
+                end
+            end
+        end
+    end
+end