adventure_rl 0.0.1.pre.ld42

data/lib/AdventureRL/Window.rb

@@ -0,0 +1,152 @@
+module AdventureRL
+  class Window < Gosu::Window
+    include Helpers::MethodHelper
+
+    @@WINDOW = nil
+
+    class << self
+      # This returns the current Window.
+      # As there should always only be one instance of Window,
+      # this should be fine.
+      def get_window
+        return @@WINDOW
+      end
+    end
+
+    def initialize settings_arg = {}
+      @@WINDOW = self
+      settings_arg = {}  unless (settings_arg)
+      settings = Settings.new(
+        DEFAULT_SETTINGS.get(:window)
+      ).merge(settings_arg)
+      @_layer = Layer.new(
+        position:           settings.get(:position),
+        size:               settings.get(:size),
+        origin:             settings.get(:origin),
+        has_solids_manager: settings.get(:has_solids_manager)
+      )
+      Helpers::PipeMethods.pipe_methods_from self, to: @_layer
+      @_target_fps        = settings.get(:fps)
+      @background_color   = settings.get(:background_color)    if (settings.get(:background_color))
+      @background_z_index = settings.get(:background_z_index)
+      #@_solids_manager = SolidsManager.new
+      super(
+        get_size(:width), get_size(:height),
+        fullscreen:      settings.get(:fullscreen),
+        update_interval: _get_update_inteval_from_fps(@_target_fps)
+      )
+      self.caption = settings.get(:caption)
+      _call_setup_method settings_arg
+    end
+
+    # This method can be overwritten by user,
+    # and will be called after <tt>#initialize</tt>.
+    def setup args
+    end
+
+    # Returns the current FPS.
+    # This is just a wrapper method around <tt>Gosu.fps</tt>
+    # to maintain the design pattern with <tt>get_*</tt> methods.
+    def get_fps
+      return Gosu.fps
+    end
+
+    # Returns the expected FPS.
+    # These were passed to <tt>#initialize</tt> in the settings.
+    def get_target_fps
+      return @_target_fps
+    end
+
+    # Returns SolidsManager.
+    #def get_solids_manager
+    #  return @_solids_manager
+    #end
+
+    # Wrapper method around Gosu::Window#fullscreen?,
+    # just to follow the design pattern.
+    def is_fullscreen?
+      return fullscreen?
+    end
+
+    # Wrapper method around Gosu::Window#fullscreen=,
+    # just to follow the design pattern.
+    def set_fullscreen state
+      self.fullscreen = !!state
+    end
+
+    # Toggle beteween fullscreen and windowed states.
+    def toggle_fullscreen
+      set_fullscreen !is_fullscreen?
+    end
+
+    # If you use #button_down in your game,
+    # be sure to call <tt>super</tt> at the beginning of the method,
+    # to take advantage of the framework's button events.
+    def button_down btnid
+      EventHandlers::Buttons.button_down btnid
+      Menu.button_down btnid
+    end
+
+    # If you use #button_up in your game,
+    # be sure to call <tt>super</tt> at the beginning of the method,
+    # to take advantage of the framework's button events.
+    def button_up btnid
+      EventHandlers::Buttons.button_up btnid
+      Menu.button_up btnid
+    end
+
+    # Show cursor.
+    def needs_cursor?
+      return true
+    end
+
+    # Default #update method.
+    # If you overwrite this, be sure to call <tt>super</tt>
+    # in your method.
+    def update
+      @_layer.update
+      #@_solids_manager.update
+      EventHandlers::Buttons.update
+      Menu.update
+    end
+
+    # Default #draw method.
+    # You might want to call <tt>super</tt>
+    # if you overwrite this method.
+    def draw
+      @_layer.draw
+      draw_background_color  if (@background_color)
+    end
+
+    def draw_background_color
+      Gosu.draw_rect(
+        *get_corner(:left, :top).values,
+        *get_size.values,
+        @background_color,
+        @background_z_index
+      )
+    end
+
+    # Overwrite the Gosu#show method, so we can
+    # call Deltatime#reset on all previously created Deltatimes.
+    def show
+      Deltatime::DELTATIMES.each &:reset
+      super
+    end
+
+    private
+
+      def _get_update_inteval_from_fps fps
+        return (1.0 / fps.to_f) * 1000
+      end
+
+      def _call_setup_method args
+        return  unless (method_exists?(:setup))
+        if (method_takes_arguments?(:setup))
+          setup args
+        else
+          setup
+        end
+      end
+  end
+end

data/lib/AdventureRL/misc/extensions.rb

@@ -0,0 +1,80 @@
+module AdventureRL::Extensions  end
+
+# HASH
+module AdventureRL::Extensions::HashExtension
+  def keys_to_sym
+    return self.map do |key, val|
+      new_val = val
+      new_val = val.keys_to_sym  if (val.is_a? Hash)
+      new_key = key
+      new_key = key.to_sym       if (key.is_a? String)
+      next [new_key, new_val]
+    end .to_h
+  end
+  def sort_by_keys *keys
+    keys.flatten!
+    return self.sort_by do |key, val|
+      next keys.index key
+    end .to_h
+  end
+end
+Hash.include AdventureRL::Extensions::HashExtension
+
+# ARRAY
+module AdventureRL::Extensions::ArrayExtension
+  def include_all? *vals
+    return vals.all? do |val|
+      next self.include? val
+    end
+  end
+  def include_any? *vals
+    return vals.any? do |val|
+      next self.include? val
+    end
+  end
+  def sort_by_array *array
+    array.flatten!
+    return self.sort do |one, two|
+      indexes = [
+        array.index(one),
+        array.index(two)
+      ]
+      next (indexes[0] || Float::INFINITY) <=> (indexes[1] || Float::INFINITY)  if (indexes.any?)
+      next one <=> two
+    end
+  end
+  def mean
+    return (self.sum.to_f / self.size.to_f)
+  end
+end
+Array.include AdventureRL::Extensions::ArrayExtension
+
+# RANGE
+module AdventureRL::Extensions::RangeExtension
+  def sample
+    return self.to_a.sample
+  end
+end
+Range.include AdventureRL::Extensions::RangeExtension
+
+# STRING and SYMBOL
+module AdventureRL::Extensions::StringAndSymbolExtension
+  def upper?
+    return self == self.upcase
+  end
+  def lower?
+    return self == self.downcase
+  end
+end
+String.include AdventureRL::Extensions::StringAndSymbolExtension
+Symbol.include AdventureRL::Extensions::StringAndSymbolExtension
+
+# INTEGER and FLOAT
+module AdventureRL::Extensions::IntegerAndFloatExtension
+  def sign
+    return 0  if (self == 0)
+    return self / self.abs
+  end
+end
+Integer.include AdventureRL::Extensions::IntegerAndFloatExtension
+Float.include   AdventureRL::Extensions::IntegerAndFloatExtension

data/lib/AdventureRL/misc/require_files.rb

@@ -0,0 +1,45 @@
+# This file purely <tt>require</tt>s code files.
+module AdventureRL
+  def self.require_dir dir, options = {}
+    directory = Pathname.new dir.to_s
+    Helpers::Error.error_no_directory directory  unless (Helpers::Error.directory_exists? directory)
+    options[:priority] = [options[:priority]].flatten.compact
+    options[:priority].map! do |filename|
+      next directory.join("#{filename.sub(/\.rb\z/,'')}.rb")
+    end
+    directory.children.sort_by_array(options[:priority]).each do |file|
+      filepath = file.to_path
+      require filepath  if (filepath.match?(/\.rb\z/))
+    end
+  end
+
+  require DIR[:src].join     'version'
+  require DIR[:misc].join    'extensions'
+  require DIR[:helpers].join 'Error'
+  require DIR[:helpers].join 'MethodHelper'
+  require DIR[:helpers].join 'PipeMethods'
+  require DIR[:src].join     'Settings'
+  require DIR[:src].join     'Window'
+  require DIR[:src].join     'Deltatime'
+  require DIR[:src].join     'TimingHandler'
+  require DIR[:src].join     'Point'
+  require DIR[:src].join     'Mask'
+  require DIR[:src].join     'SolidsManager'  # NOTE: require before Modifiers!
+  require_dir DIR[:src].join('Modifiers'),     priority: 'Velocity'
+  require DIR[:src].join     'Rectangle'
+  require DIR[:src].join     'Image'
+  require DIR[:src].join     'Animation'
+  require DIR[:src].join     'Layer'
+  require DIR[:src].join     'FileGroup'
+  require DIR[:src].join     'FileGroupPlayer'
+  require DIR[:src].join     'Clip'
+  require DIR[:src].join     'ClipPlayer'
+  require DIR[:src].join     'Audio'
+  require DIR[:src].join     'AudioPlayer'
+  require_dir DIR[:src].join('Events'),        priority: 'Event'
+  require_dir DIR[:src].join('EventHandlers'), priority: ['EventHandler', 'Buttons']
+  require DIR[:src].join     'Quadtree'
+  require DIR[:src].join     'Textbox'
+  require DIR[:src].join     'Button'
+  require DIR[:src].join     'Menu'
+end

data/lib/AdventureRL/version.rb

@@ -0,0 +1,3 @@
+module AdventureRL
+  VERSION = '0.0.1-ld42'
+end

data/lib/adventure_rl.rb

@@ -0,0 +1,22 @@
+require 'gosu'
+require 'pathname'
+require 'yaml'
+
+module AdventureRL
+  entry = Pathname.new(__FILE__).realpath
+  # The root directory of the gem. Used for requiring ruby files.
+  ROOT  = entry.dirname
+  # A constant containing a bunch of directories or files.
+  DIR   = {
+    entry:    entry,
+    src:      ROOT.join('AdventureRL'),
+    helpers:  ROOT.join('AdventureRL/Helpers'),
+    misc:     ROOT.join('AdventureRL/misc'),
+    settings: ROOT.join('default_settings.yml')
+  }
+
+  require DIR[:misc].join 'require_files'
+
+  # Default gem settings defined in <tt>default_settings.yml</tt>.
+  DEFAULT_SETTINGS = Settings.new DIR[:settings]
+end

data/lib/default_settings.yml

@@ -0,0 +1,20 @@
+# Default AdventureRL settings.
+# TODO: The developer should be able to overwrite settings here in a custom settings.yml file.
+---
+# Window settings
+window:
+  caption:            'AdventureRL Window Caption!'
+  fps:                30
+  fullscreen:         false
+  has_solids_manager: true
+  size:
+    width:  960
+    height: 540
+  position:
+    x: 0
+    y: 0
+  origin:
+    x: :left
+    y: :top
+  background_z_index: -1
+...

data/vimrc

@@ -0,0 +1,4 @@
+nmap <leader>rr :!%<CR>
+nmap <leader>rd :!bin/rdoc<CR>
+nmap <leader>rt :!rake test<CR>
+nmap <leader>rc :!runrb run bin/console<CR><CR>

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: adventure_rl
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.ld42
+platform: ruby
+authors:
+- Noah Rosenzweig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+description: |2
+    This video game framework is written using the Gosu game development library.
+    It was originally intended to be used for writing Point-N-Click adventure games,
+    but has become a more general 2D video game framework.
+    It's interesting features include video and audio playback capabilities.
+    The project is definitely lacking some documentation.
+    Although I have been trying to write documentation using rdoc and write tests
+    with Minitest, I do not think that I have been doing either of those very successfully.
+    I don't think many people aside from myself will be able to use it properly,
+    as I have built it specifically for my needs.
+    Thank you for reading, have a nice day :)
+email:
+- rosenzweig.noah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- adventure_rl.gemspec
+- bin/console
+- bin/mkaudio
+- bin/mkclip
+- bin/rdoc
+- bin/setup
+- bin/vimall
+- doc/Mask.md
+- doc/Point.md
+- doc/Window.md
+- lib/AdventureRL/Animation.rb
+- lib/AdventureRL/Audio.rb
+- lib/AdventureRL/AudioPlayer.rb
+- lib/AdventureRL/Button.rb
+- lib/AdventureRL/Clip.rb
+- lib/AdventureRL/ClipPlayer.rb
+- lib/AdventureRL/Deltatime.rb
+- lib/AdventureRL/EventHandlers/Buttons.rb
+- lib/AdventureRL/EventHandlers/EventHandler.rb
+- lib/AdventureRL/EventHandlers/MouseButtons.rb
+- lib/AdventureRL/Events/Event.rb
+- lib/AdventureRL/Events/Mouse.rb
+- lib/AdventureRL/FileGroup.rb
+- lib/AdventureRL/FileGroupPlayer.rb
+- lib/AdventureRL/Helpers/Error.rb
+- lib/AdventureRL/Helpers/MethodHelper.rb
+- lib/AdventureRL/Helpers/PipeMethods.rb
+- lib/AdventureRL/Image.rb
+- lib/AdventureRL/Layer.rb
+- lib/AdventureRL/Mask.rb
+- lib/AdventureRL/Menu.rb
+- lib/AdventureRL/Modifiers/Gravity.rb
+- lib/AdventureRL/Modifiers/Inventory.rb
+- lib/AdventureRL/Modifiers/Pusher.rb
+- lib/AdventureRL/Modifiers/Solid.rb
+- lib/AdventureRL/Modifiers/Velocity.rb
+- lib/AdventureRL/Point.rb
+- lib/AdventureRL/Quadtree.rb
+- lib/AdventureRL/Rectangle.rb
+- lib/AdventureRL/Settings.rb
+- lib/AdventureRL/SolidsManager.rb
+- lib/AdventureRL/Textbox.rb
+- lib/AdventureRL/TimingHandler.rb
+- lib/AdventureRL/Window.rb
+- lib/AdventureRL/misc/extensions.rb
+- lib/AdventureRL/misc/require_files.rb
+- lib/AdventureRL/version.rb
+- lib/adventure_rl.rb
+- lib/default_settings.yml
+- vimrc
+homepage: https://github.com/Noah2610/AdventureRL
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Game framework built on top of Gosu.
+test_files: []