eidolon 0.1.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDE4MzAyZjFlOWE3ZTJlZmNjNzIxNWFlN2RjOWQ2ZWYxOTA4YTUxOA==
+  data.tar.gz: !binary |-
+    MTJjZGE1YmQ0YjNhNGJmNTY1MzdiZDM5YjNiNDI4MDQyMmI1MmE3Nw==
+SHA512:
+  metadata.gz: !binary |-
+    MDI0YTY3MmMwYmJiOWQ2OThmZjY2MDZlN2U0NWY2N2E2NTc3NmI3NDM5NDMz
+    MzVlNGMxMmYyZjkzNmUwOTg5NzJiMTEyZTJkMDY1MjI1ZGY5ZmY1Yjc0ZTQw
+    MmQ1MGI1YzNhOWY4NjA5ZDBhNjY5ZmZlOTY5YmYxNjRjNjk2NWM=
+  data.tar.gz: !binary |-
+    ODJhNGI3NGVmMWViOWQzNzljMzcyZTMxOTYyYjYzYzExMzg1YTU3ZDIzM2I0
+    YWMwNDk5MmNjMmFlYTFlZTRiMTRkOTBkYTA5MDA3N2IxZjRjNWYwZmM3MWE5
+    NmRjZjg1NzA1MWM3YjhjNjZlYjc2NDFkYjhiYzA4MTFmZmVlODM=

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Solistra <solistra@gmx.com> and Enelvon <enelvon@gmail.com>
+
+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,76 @@
+# Eidolon
+[![Build Status](https://travis-ci.org/sesvxace/eidolon.svg?branch=master)][travis]
+[![Coverage Status](https://coveralls.io/repos/sesvxace/eidolon/badge.png?branch=master)][coverage]
+[![Gem Version](https://badge.fury.io/rb/eidolon.svg)][gem]
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)][yard]
+
+1. _noun: an idealized person or thing._
+2. _noun: a phantom._
+
+## Summary
+In short, Eidolon provides the minimal scaffolding required to load data from the RPG Maker series into a pure, external Ruby installation independent of the chosen Ruby implementation (MRI, JRuby, or Rubinius) or the user's operating system.
+
+**Note:** Eidolon is only concerned with the _loading_ of RGSSx data -- it is _not_ built for the purposes of external manipulation and serialization of it.
+
+## Usage
+The simplest use case for Eidolon is when you already know which version of the RGSS data structures your application will require. If you are only operating with one (whether it be RGSS, RGSS2, or RGSS3), you simply need to require the necessary version:
+
+```ruby
+require 'eidolon/rgss'
+# -- OR --
+require 'eidolon/rgss2'
+# -- OR --
+require 'eidolon/rgss3'
+```
+
+Note that only one version may be required this way: attempting to require more than one version of the RGSS data structures will result in superclass mismatches. For this reason, if you potentially need to operate with more than one of the RGSS versions, you should use the core Eidolon module; essentially, the usage of this module allows you to dynamically create and destroy the needed RPG data structures whenever they are required. See the included documentation for more detailed information about the usage of the Eidolon module.
+
+```ruby
+require 'eidolon'
+
+def load_data(filename)
+  File.open(filename, 'rb') do |file|
+    return Marshal.load(file)
+  end
+end
+
+@rgss_data  = []
+@rgss3_data = []
+
+Eidolon.build('RGSS')
+Dir.glob('**/*.rxdata') do |rxdata|
+  @rgss_data.push(load_data(rxdata))
+end
+
+Eidolon.destroy!
+
+Eidolon.build('RGSS3')
+Dir.glob('**/*.rvdata2') do |rvdata2|
+  @rgss3_data.push(load_data(rvdata2))
+end
+```
+
+## Installation
+```sh
+$ gem install eidolon
+```
+
+## Contributing
+If you are interested in development, simply fork [the GitHub repository][eidolon], create a new branch, commit the changes, and create a new pull request.
+
+```sh
+$ git checkout -b new-branch
+$ git commit -am 'Added some feature.'
+$ git push origin new-branch
+```
+
+Please be sure to _create a new branch_ and _provide tests_ for your work. Contributions that do not meet these requirements will **not** be accepted.
+
+## License
+Eidolon is made available under the terms of the MIT Expat license. See the included LICENSE file for more information.
+
+[coverage]: https://coveralls.io/r/sesvxace/eidolon?branch=master
+[eidolon]:  https://github.com/sesvxace/eidolon
+[gem]:      http://badge.fury.io/rb/eidolon
+[travis]:   https://travis-ci.org/sesvxace/eidolon
+[yard]:     http://rubydoc.info/gems/eidolon/frames

data/lib/eidolon.rb

@@ -0,0 +1,129 @@
+require 'eidolon/version'
+
+# == Eidolon
+# This module provides methods for building the data structures used by the RPG
+# Maker series of game development programs so that the serialized data may be
+# loaded into an external Ruby implementation. The methods used are platform
+# and dependency agnostic.
+# 
+# == Usage
+# It is recommended that you explicitly declare which RGSS version Eidolon
+# should use before building the RGSSx data structures required; this is done
+# through the +Eidolon.rgss_version=+ method. This method accepts both integer
+# and representative string values -- for example, passing it an argument of
+# 1 or "RGSS" will both set the Eidolon RGSS version to the appropriate value.
+# Recognized RGSS versions are "RGSS" (XP), "RGSS2" (VX), and "RGSS3" (VX Ace).
+# 
+# After explicitly requesting the desired RGSS version, you will want to build
+# the desired data structures with the +Eidolon.build+ method. This will create
+# the data structures for the specified RGSS version for use by the currently
+# running Ruby implementation. Note that the +Eidolon.build+ method will only
+# build data structures *once*.
+# 
+# You will need to use the +Eidolon.destroy!+ method if you intend to use more
+# than one RGSS version in a single Ruby session. On their own, the RGSSx data
+# structures are inherently incompatible with one another -- as such, the
+# previous data structures must be destroyed, which is what +Eidolon.destroy!+
+# does for you.
+# 
+# == Example
+#     require 'eidolon'
+#     
+#     # Building the RGSS3 (VX Ace) data structures.
+#     Eidolon.rgss_version = 'RGSS3'
+#     Eidolon.rgss_version # => "rgss3"
+#     Eidolon.build        # => true
+#     Eidolon.built?       # => true
+#     
+#     # Destroy the previously built RGSS3 data structures.
+#     Eidolon.destroy!
+#     Eidolon.built? # => false
+#     
+#     # Now we can build the RGSS (XP) data structures as well.
+#     Eidolon.build(1) # => true
+#     
+#     # Obtaining an array of the built RGSSx structures.
+#     Eidolon.built # => ["rgss", "rgss3"]
+module Eidolon
+  class << self
+    # The RGSSx version used by Eidolon. This determines which data structures
+    # to require in order to facilitate working with serialized RGSSx data.
+    attr_reader :rgss_version
+    
+    # An array of the RGSS versions which have had their data structures built
+    # by Eidolon.
+    attr_reader :built
+  end
+  
+  # Initialize the array of built RGSS versions.
+  @built = []
+  
+  # Set the RGSS version used by Eidolon to the passed value. May be set to an
+  # integer or representative string value for the desired RGSS version.
+  # 
+  # Examples:
+  #    Eidolon.rgss_version = "RGSS3" # Sets the version to "rgss3".
+  #    Eidolon.rgss_version = 1       # Sets the version to "rgss".
+  def self.rgss_version=(value)
+    return unless valid?(value)
+    @rgss_version = transform(value)
+  end
+  
+  # Builds the data structures for the desired RGSS version. Returns +true+ if
+  # the data structures were built, +false+ otherwise. This is a safe method,
+  # ensuring that only the data structures from a single RGSS version will be
+  # built.
+  def self.build(version = @rgss_version)
+    return false if version.nil?
+    built? ? false : build!(version)
+  end
+  
+  # Forces building of the data structures for the desired RGSS version.
+  # Returns +true+ if the data structures were built, +false+ otherwise.
+  def self.build!(version = @rgss_version)
+    return false if version.nil?
+    self.rgss_version = version
+    @built.push(@rgss_version).compact.sort!.uniq!
+    load 'eidolon/rgssx/loader.rb'
+    load "eidolon/#{@rgss_version}/loader.rb"
+  rescue LoadError
+    destroy!
+    false
+  end
+  
+  # Destroys the currently built RGSS data structures. Returns +true+ if the
+  # data structures were destroyed, +false+ otherwise (normally, this method
+  # will only return +false+ if there were no data structures to destroy).
+  def self.destroy!
+    true if Object.send(:remove_const, :RPG)
+  rescue NameError
+    false
+  end
+  
+  # Returns +true+ if data structures have been built, +false+ otherwise.
+  def self.built?
+    Object.const_defined?(:RPG)
+  end
+  
+  class << self
+    private
+    # Transforms the given value into an applicable string used to find the
+    # appropriate RGSS version.
+    def transform(version)
+      if version =~ /^rgss(\d?)/i
+        return 'rgss' if $1.empty?
+        'rgss' << $1
+      else
+        return 'rgss' if version == 1
+        'rgss' << version.to_s
+      end
+    end
+  
+    # Returns +true+ if a "loader.rb" file exists for the given RGSS version,
+    # +false+ otherwise.
+    def valid?(version)
+      fn = File.dirname(__FILE__) << "/eidolon/#{transform(version)}/loader.rb"
+      File.file?(fn)
+    end
+  end
+end

data/lib/eidolon/rgss.rb

@@ -0,0 +1,2 @@
+require 'eidolon/rgssx'
+require 'eidolon/rgss/rpg'

data/lib/eidolon/rgss/loader.rb

@@ -0,0 +1,24 @@
+# This file loads all of the internal data structures used by RPG Maker XP.
+# Essentially, requiring this file will build a generic copy of the XP data
+# structures for use in a Ruby installation outside of XP itself.
+# 
+# The XP data structures are extraordinarily simple and only require that they
+# be loaded -- the actual order of loading them is unimportant (unlike the data
+# structures used by VX and VX Ace, which require some specific ordering).
+
+require 'eidolon/rgssx'
+
+load 'eidolon/rgss/rpg/actor.rb'
+load 'eidolon/rgss/rpg/armor.rb'
+load 'eidolon/rgss/rpg/class.rb'
+load 'eidolon/rgss/rpg/class/learning.rb'
+load 'eidolon/rgss/rpg/enemy.rb'
+load 'eidolon/rgss/rpg/enemy/action.rb'
+load 'eidolon/rgss/rpg/item.rb'
+load 'eidolon/rgss/rpg/skill.rb'
+load 'eidolon/rgss/rpg/state.rb'
+load 'eidolon/rgss/rpg/system.rb'
+load 'eidolon/rgss/rpg/system/test_battler.rb'
+load 'eidolon/rgss/rpg/system/words.rb'
+load 'eidolon/rgss/rpg/tileset.rb'
+load 'eidolon/rgss/rpg/weapon.rb'

data/lib/eidolon/rgss/rpg.rb

@@ -0,0 +1,18 @@
+# Require all of the generic RGSSx data structures.
+require 'eidolon/rgssx/rpg'
+
+# Require the XP-specific RGSS data structures.
+require 'eidolon/rgss/rpg/actor'
+require 'eidolon/rgss/rpg/armor'
+require 'eidolon/rgss/rpg/class'
+require 'eidolon/rgss/rpg/class/learning'
+require 'eidolon/rgss/rpg/enemy'
+require 'eidolon/rgss/rpg/enemy/action'
+require 'eidolon/rgss/rpg/item'
+require 'eidolon/rgss/rpg/skill'
+require 'eidolon/rgss/rpg/state'
+require 'eidolon/rgss/rpg/system'
+require 'eidolon/rgss/rpg/system/test_battler'
+require 'eidolon/rgss/rpg/system/words'
+require 'eidolon/rgss/rpg/tileset'
+require 'eidolon/rgss/rpg/weapon'

data/lib/eidolon/rgss/rpg/actor.rb

@@ -0,0 +1,31 @@
+module RPG
+  # == RGSS
+  # This data structure is specific to RGSS (XP).
+  # 
+  # == Actor
+  # Data class for actors.
+  class Actor
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :class_id
+    attr_accessor :initial_level
+    attr_accessor :final_level
+    attr_accessor :exp_basis
+    attr_accessor :exp_inflation
+    attr_accessor :character_name
+    attr_accessor :character_hue
+    attr_accessor :battler_name
+    attr_accessor :battler_hue
+    attr_accessor :parameters
+    attr_accessor :weapon_id
+    attr_accessor :armor1_id
+    attr_accessor :armor2_id
+    attr_accessor :armor3_id
+    attr_accessor :armor4_id
+    attr_accessor :weapon_fix
+    attr_accessor :armor1_fix
+    attr_accessor :armor2_fix
+    attr_accessor :armor3_fix
+    attr_accessor :armor4_fix
+  end
+end

data/lib/eidolon/rgss/rpg/armor.rb

@@ -0,0 +1,25 @@
+module RPG
+  # == RGSS
+  # This data structure is specific to RGSS (XP).
+  # 
+  # == Armor
+  # Data class for armor.
+  class Armor
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :icon_name
+    attr_accessor :description
+    attr_accessor :kind
+    attr_accessor :auto_state_id
+    attr_accessor :price
+    attr_accessor :pdef
+    attr_accessor :mdef
+    attr_accessor :eva
+    attr_accessor :str_plus
+    attr_accessor :dex_plus
+    attr_accessor :agi_plus
+    attr_accessor :int_plus
+    attr_accessor :guard_element_set
+    attr_accessor :guard_state_set
+  end
+end

data/lib/eidolon/rgss/rpg/class.rb

@@ -0,0 +1,17 @@
+module RPG
+  # == RGSS
+  # This data structure is specific to RGSS (XP).
+  # 
+  # == Class
+  # Data class for classes (as used by actors).
+  class Class
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :position
+    attr_accessor :weapon_set
+    attr_accessor :armor_set
+    attr_accessor :element_ranks
+    attr_accessor :state_ranks
+    attr_accessor :learnings
+  end
+end

data/lib/eidolon/rgss/rpg/class/learning.rb

@@ -0,0 +1,15 @@
+require 'eidolon/rgss/rpg/class'
+
+module RPG
+  class Class
+    # == RGSS
+    # This data structure is specific to RGSS (XP).
+    # 
+    # == Learning
+    # Data class for the learned skills of a class (as used by actors).
+    class Learning
+      attr_accessor :level
+      attr_accessor :skill_id
+    end
+  end
+end

data/lib/eidolon/rgss/rpg/enemy.rb

@@ -0,0 +1,34 @@
+module RPG
+  # == RGSS
+  # This data structure is specific to RGSS (XP).
+  # 
+  # == Enemy
+  # Data class for enemies.
+  class Enemy
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :battler_name
+    attr_accessor :battler_hue
+    attr_accessor :maxhp
+    attr_accessor :maxsp
+    attr_accessor :str
+    attr_accessor :dex
+    attr_accessor :agi
+    attr_accessor :int
+    attr_accessor :atk
+    attr_accessor :pdef
+    attr_accessor :mdef
+    attr_accessor :eva
+    attr_accessor :animation1_id
+    attr_accessor :animation2_id
+    attr_accessor :element_ranks
+    attr_accessor :state_ranks
+    attr_accessor :actions
+    attr_accessor :exp
+    attr_accessor :gold
+    attr_accessor :item_id
+    attr_accessor :weapon_id
+    attr_accessor :armor_id
+    attr_accessor :treasure_prob
+  end
+end

data/lib/eidolon/rgss/rpg/enemy/action.rb

@@ -0,0 +1,22 @@
+require 'eidolon/rgss/rpg/enemy'
+
+module RPG
+  class Enemy
+    # == RGSS
+    # This data structure is specific to RGSS (XP).
+    # 
+    # == Action
+    # Data class for an enemy action in battle.
+    class Action
+      attr_accessor :kind
+      attr_accessor :basic
+      attr_accessor :skill_id
+      attr_accessor :condition_turn_a
+      attr_accessor :condition_turn_b
+      attr_accessor :condition_hp
+      attr_accessor :condition_level
+      attr_accessor :condition_switch_id
+      attr_accessor :rating
+    end
+  end
+end

data/lib/eidolon/rgss/rpg/item.rb

@@ -0,0 +1,34 @@
+module RPG
+  # == RGSS
+  # This data structure is specific to RGSS (XP).
+  # 
+  # == Item
+  # Data class for items.
+  class Item
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :icon_name
+    attr_accessor :description
+    attr_accessor :scope
+    attr_accessor :occasion
+    attr_accessor :animation1_id
+    attr_accessor :animation2_id
+    attr_accessor :menu_se
+    attr_accessor :common_event_id
+    attr_accessor :price
+    attr_accessor :consumable
+    attr_accessor :parameter_type
+    attr_accessor :parameter_points
+    attr_accessor :recover_hp_rate
+    attr_accessor :recover_hp
+    attr_accessor :recover_sp_rate
+    attr_accessor :recover_sp
+    attr_accessor :hit
+    attr_accessor :pdef_f
+    attr_accessor :mdef_f
+    attr_accessor :variance
+    attr_accessor :element_set
+    attr_accessor :plus_state_set
+    attr_accessor :minus_state_set
+  end
+end