rgss_db 1.0.0

data/lib/rgss_db/model/debug.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module RgssDb
+  #
+  # Debug module
+  #
+  module Debug
+    # Debug log file name
+    # @return [String]
+    DEBUG_FILE_NAME = "rgss-db.log"
+
+    # Debug mode disabled
+    # @return [Integer]
+    DEBUG_MODE_DISABLE = 0
+
+    # Debug mode errors and below
+    # @return [Integer]
+    DEBUG_MODE_ERROR = 1
+
+    # Debug mode warnings and below
+    # @return [Integer]
+    DEBUG_MODE_WARNING = 2
+
+    # Debug mode info and below
+    # @return [Integer]
+    DEBUG_MODE_INFO = 3
+
+    # Debug absolute file path
+    # @return [String]
+    @debug_file_path = ""
+
+    # Debug mode
+    # @return [Integer]
+    @debug_mode = 0
+
+    # Debug extra information
+    # @return [String]
+    @debug_extra_info = ""
+
+    #
+    # Starts the debug module with the given information
+    #
+    # Optionally sets the debug mode
+    #
+    # @param debug_file_path [String] Path to the debug file
+    # @param debug_mode [Integer] Debug mode
+    #
+    def self.start(debug_file_path, debug_mode = nil)
+      @debug_file_path = File.join(debug_file_path, DEBUG_FILE_NAME)
+      @debug_mode = debug_mode unless debug_mode.nil?
+
+      # Creates the directory (recursively)
+      FileUtils.mkdir_p(debug_file_path)
+
+      # Overwrites file if it exists already
+      File.truncate(@debug_file_path, 0) if File.exist?(@debug_file_path)
+    end
+
+    #
+    # Gets the debug mode
+    #
+    # @return [Integer]
+    #
+    def self.debug_mode
+      @debug_mode
+    end
+
+    #
+    # Sets the debug mode
+    #
+    # Set to 0 to disable
+    #
+    # @param debug_mode [Integer] Debug mode
+    #
+    def self.update_debug_mode(debug_mode)
+      @debug_mode = debug_mode
+    end
+
+    #
+    # Sets the debug extra information
+    #
+    # @param extra_info [Array<String>]
+    #
+    def self.update_extra_info(*extra_info)
+      @debug_extra_info = extra_info
+    end
+
+    #
+    # Writes the debug header to the log file
+    #
+    def self.write_debug_header
+      log("<--- debug module started --->")
+      log("debug mode: #{Debug.debug_mode}")
+      log("debug extra:")
+      @debug_extra_info.each { |str| log("\t- #{str}") }
+      log("<---------------------------->")
+    end
+
+    #
+    # Logs the string
+    #
+    # @param string [String]
+    #
+    def self.log(string)
+      File.write(@debug_file_path, "#{string}\n", mode: "a") unless disabled?
+    end
+
+    #
+    # Logs the string as information
+    #
+    # @param string [String]
+    #
+    def self.log_info(string)
+      log("info: #{string}") if info?
+    end
+
+    #
+    # Logs the string as an error
+    #
+    # @param string [String]
+    #
+    def self.log_error(string)
+      log("error: #{string}") if error?
+    end
+
+    #
+    # Logs the string as a warning
+    #
+    # @param string [String]
+    #
+    def self.log_warning(string)
+      log("warning: #{string}") if warning?
+    end
+
+    #
+    # Logs the given exception as an error
+    #
+    # Optionally logs the application options if given
+    #
+    # @param app_options [Hash]
+    #
+    # @param [StandardError] exception
+    #
+    def self.log_exception(exception, app_options = nil)
+      # Logs the exception
+      log_error("Application Exception:")
+      log_error("\t#{exception.message} (#{exception.class})")
+      exception.backtrace.each do |str|
+        log_error("\t\tfrom #{str}")
+      end
+
+      return unless app_options.is_a?(Hash)
+
+      # Logs the application options
+      log_error("Application options:")
+      app_options.each_pair do |opt_id, opt_value|
+        log_error("\t- #{opt_id} => #{opt_value}")
+      end
+    end
+
+    #
+    # Checks whether the debug module is disabled or not
+    #
+    # @return [Boolean]
+    #
+    def self.disabled?
+      @debug_mode == DEBUG_MODE_DISABLE
+    end
+
+    #
+    # Checks whether the debug mode is info or not
+    #
+    # @return [Boolean]
+    #
+    def self.info?
+      @debug_mode >= DEBUG_MODE_INFO
+    end
+
+    #
+    # Checks whether the debug mode is error or not
+    #
+    # @return [Boolean]
+    #
+    def self.error?
+      @debug_mode >= DEBUG_MODE_ERROR
+    end
+
+    #
+    # Checks whether the debug mode is warning or not
+    #
+    # @return [Boolean]
+    #
+    def self.warning?
+      @debug_mode >= DEBUG_MODE_WARNING
+    end
+  end
+end

data/lib/rgss_db/model/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RgssDb
+  #
+  # Base Error class
+  #
+  class Error < StandardError
+    #
+    # Creates a new error object
+    #
+    # @param message [String] Error message
+    #
+    def initialize(message)
+      super("[rgss-db] #{message}")
+    end
+  end
+end

data/lib/rgss_db/model/mixins/jsonable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RgssDb
+  #
+  # Jsonable mixin
+  #
+  module Jsonable
+    #
+    # Returns this instance as a json-ready hash
+    #
+    # @return [Hash]
+    #
+    def as_json
+      hash = {}
+      hash.store(JSON.create_id, self.class.name)
+      instance_variables.each do |ivar|
+        ivar_id = ivar.to_s.delete("@")
+        ivar_value = instance_variable_get(ivar)
+        hash.store(ivar_id, ivar_value)
+      end
+      hash
+    end
+
+    #
+    # Converts this instance to a JSON string
+    #
+    # @param args [Array] Arguments
+    #
+    # @return [String]
+    #
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+  end
+end

data/lib/rgss_db/model/mixins/jsonable_constructor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RgssDb
+  #
+  # Jsonable constructor module
+  #
+  module JsonableConstructor
+    #
+    # JSON constructor
+    #
+    # This constructor is used to create a default instance
+    #
+    # Note: Needs to be overriden in case class constructor needs arguments
+    #
+    # @param args [Array]
+    #
+    # @return Class instance
+    #
+    def json_new(*args)
+      new(*args)
+    end
+
+    #
+    # JSON deserializer
+    #
+    # @param hash [Hash]
+    # @param args [Array]
+    #
+    # @return Class instance
+    #
+    def json_create(hash, *args)
+      instance = json_new(*args)
+      hash.each_pair do |key, value|
+        ivar = "@#{key}".to_sym
+        instance.instance_variable_set(ivar, value) if instance.instance_variables.include?(ivar)
+      end
+      instance
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rgss/color.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+#
+# The RGBA color class.
+#
+# Each component is handled with a floating-point value (Float).
+#
+class Color
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Color object. If alpha is omitted, it is assumed to be 255.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param red [Integer]
+  # @param green [Integer]
+  # @param blue [Integer]
+  # @param alpha [Integer]
+  #
+  def initialize(red = 0, green = 0, blue = 0, alpha = 0)
+    @red = red
+    @green = green
+    @blue = blue
+    @alpha = [red, green, blue].sum.positive? && alpha.zero? ? 255 : alpha
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # double, double, double, double (double-precision)
+    [@red, @green, @blue, @alpha].pack("dddd")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Color]
+  #
+  def self._load(serialized_string)
+    Color.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Color]
+  #
+  def self.new_serialized(serialized_string)
+    # double, double, double, double (double-precision)
+    red, green, blue, alpha = serialized_string.unpack("dddd")
+
+    # Creates the instance
+    Color.new(red, green, blue, alpha)
+  end
+
+  attr_accessor :red, :green, :blue, :alpha
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rgss/rect.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+#
+# The rectangle class.
+#
+class Rect
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a new Rect object.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param x [Integer]
+  # @param y [Integer]
+  # @param width [Integer]
+  # @param height [Integer]
+  #
+  def initialize(x = 0, y = 0, width = 0, height = 0)
+    @x = x
+    @y = y
+    @width = width
+    @height = height
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # int32_t, int32_t, int32_t, int32_t
+    [@x, @y, @width, @height].pack("llll")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Rect]
+  #
+  def self._load(serialized_string)
+    Rect.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Rect]
+  #
+  def self.new_serialized(serialized_string)
+    # int32_t, int32_t, int32_t, int32_t
+    x, y, width, height = serialized_string.unpack("llll")
+
+    # Creates the instance
+    Rect.new(x, y, width, height)
+  end
+
+  attr_accessor :x, :y, :width, :height
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rgss/table.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+#
+# The multidimensional array class.
+#
+# Each element is an integer of 2 signed bytes ranging from -32,768 to 32,767.
+#
+class Table
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Table object.
+  #
+  # Specifies the size of each dimension in the multidimensional array. 1-, 2-, and 3-dimensional arrays are possible.
+  #
+  # Arrays with no parameters are also permitted.
+  #
+  # @param xsize [Integer]
+  # @param ysize [Integer]
+  # @param zsize [Integer]
+  #
+  def initialize(xsize, ysize = 0, zsize = 0)
+    # RMXP needs dimensions
+    @dim = 1
+    @dim = 2 if ysize.positive?
+    @dim = 3 if zsize.positive?
+    @x = xsize
+    @y = ysize
+    @z = zsize
+    @data = []
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # int32_t, int32_t, int32_t, int32_t, int32_t, int16_t *
+    [@dim, @x, @y, @z, @x * @y * @z, *@data].pack("llllls*")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Table]
+  #
+  def self._load(serialized_string)
+    Table.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Table]
+  #
+  def self.new_serialized(serialized_string)
+    # int32_t, int32_t, int32_t, int32_t, int32_t, int16_t *
+    dim, x, y, z, size, *data = serialized_string.unpack("llllls*")
+
+    # Checks if written size value matches the actual size of the table
+    raise "Table: bad file format (size mismatch)" unless size == (x * y * z)
+    # Double check no data was lost
+    raise "Table: bad file format (data length mismatch)" unless size == data.length
+
+    # Creates the instance
+    table = Table.new(0, 0, 0)
+    table.dim = dim
+    table.x = x
+    table.y = y
+    table.z = z
+    table.data = data
+    table
+  end
+
+  #
+  # Returns a table instance for JSON deserialization
+  #
+  # @param args [Array]
+  #
+  # @return [Table]
+  #
+  def self.json_new(*args)
+    Table.new(0, 0, 0)
+  end
+
+  attr_accessor :dim, :x, :y, :z, :data
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rgss/tone.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+#
+# The color tone class.
+#
+# Each component is handled with a floating-point value (Float).
+#
+class Tone
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Tone object. If gray is omitted, it is assumed to be 0.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param red [Integer]
+  # @param green [Integer]
+  # @param blue [Integer]
+  # @param gray [Integer]
+  #
+  def initialize(red = 0, green = 0, blue = 0, gray = 0)
+    @red = red
+    @green = green
+    @blue = blue
+    @gray = gray
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # double, double, double, double (double-precision)
+    [@red, @green, @blue, @gray].pack("dddd")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Tone]
+  #
+  def self._load(serialized_string)
+    Tone.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Tone]
+  #
+  def self.new_serialized(serialized_string)
+    # double, double, double, double (double-precision)
+    red, green, blue, gray = serialized_string.unpack("dddd")
+
+    # Creates the instance
+    Tone.new(red, green, blue, gray)
+  end
+
+  attr_accessor :red, :green, :blue, :gray
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rgss.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Application mixins
+require_relative "../../mixins/jsonable"
+require_relative "../../mixins/jsonable_constructor"
+
+# RGSS Impl.
+require_relative "./rgss/color"
+require_relative "./rgss/rect"
+require_relative "./rgss/table"
+require_relative "./rgss/tone"

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/actor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for actors.
+  #
+  class Actor
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @class_id = 1
+      @initial_level = 1
+      @exp_basis = 25
+      @exp_inflation = 35
+      @character_name = ""
+      @character_index = 0
+      @face_name = ""
+      @face_index = 0
+      @parameters = Table.new(6, 100)
+      @weapon_id = 0
+      @armor1_id = 0
+      @armor2_id = 0
+      @armor3_id = 0
+      @armor4_id = 0
+      @two_swords_style = false
+      @fix_equipment = false
+      @auto_battle = false
+      @super_guard = false
+      @pharmacology = false
+      @critical_bonus = false
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :class_id, :initial_level, :exp_basis, :exp_inflation, :character_name, :character_index,
+                  :face_name, :face_index, :parameters, :weapon_id, :armor1_id, :armor2_id, :armor3_id, :armor4_id,
+                  :two_swords_style, :fix_equipment, :auto_battle, :super_guard, :pharmacology, :critical_bonus
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/animation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for animation.
+  #
+  class Animation
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @animation1_name = ""
+      @animation1_hue = 0
+      @animation2_name = ""
+      @animation2_hue = 0
+      @position = 1
+      @frame_max = 1
+      @frames = [RPG::Animation::Frame.new]
+      @timings = []
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :animation1_name, :animation1_hue, :animation2_name, :animation2_hue, :position,
+                  :frame_max, :frames, :timings
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/animation_frame.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RPG
+  class Animation
+    #
+    # Data class for animation frames.
+    #
+    class Frame
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @cell_max = 0
+        @cell_data = Table.new(0, 0)
+      end
+
+      attr_accessor :cell_max, :cell_data
+    end
+  end
+end