gosu_extensions 0.1.0

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gosu_extensions"
+    gemspec.summary = ""
+    gemspec.email = "florian.hanke@gmail.com"
+    gemspec.homepage = "http://www.github.com/floere/gosu_extensions"
+    gemspec.description = ""
+    gemspec.authors = ["Florian Hanke"]
+    gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+    gemspec.files = FileList["[A-Z]*", "{generators,lib,rails,spec}/**/*"]
+    gemspec.add_dependency 'gosu'
+    gemspec.add_dependency 'chipmunk'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "Jeweler not available (#{e}). Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/controls.rb

@@ -0,0 +1,35 @@
+# Controls for a controllable.
+# Example:
+#   # Note: left, right, full_speed_ahead, reverse, revive are
+#   #       methods on the @player.
+#   #
+#   @controls << Controls.new(self, @player,
+#     Gosu::Button::KbA => :left,
+#     Gosu::Button::KbD => :right,
+#     Gosu::Button::KbW => :full_speed_ahead,
+#     Gosu::Button::KbS => :reverse,
+#     Gosu::Button::Kb1 => :revive
+#   )
+#
+#
+#
+class Controls
+  
+  #
+  #
+  def initialize window, controllable
+    @window = window
+    @controllable = controllable
+    @mapping = controllable.controls_mapping
+  end
+  
+  # 
+  #
+  def handle
+    return if @controllable.destroyed?
+    @mapping.each do |key, command|
+      @controllable.send(command) if @window.button_down? key
+    end
+  end
+  
+end

data/lib/extensions/module.rb

@@ -0,0 +1,15 @@
+class Module
+  
+  def manual text
+    metaclass.send :define_method, :manual! do
+      puts <<-MANUAL
+    MANUAL FOR #{self}
+#{text}
+    Change #{self}.manual! -> #{self}, to not show the manual anymore.
+    
+      MANUAL
+      self
+    end
+  end
+  
+end

data/lib/extensions/numeric.rb

@@ -0,0 +1,9 @@
+class Numeric
+  
+  # Convenience method for converting from radians to a Vec2 vector.
+  #
+  def radians_to_vec2
+    CP::Vec2.new Math::cos(self), Math::sin(self)
+  end
+  
+end

data/lib/game_window.rb

@@ -0,0 +1,381 @@
+# Extend this class for your game.
+#
+# Example:
+#   class MyGreatGame < GameWindow
+#
+class GameWindow < Gosu::Window
+  
+  include InitializerHooks
+  
+  attr_writer :full_screen,
+              :font_name,
+              :font_size,
+              :damping,
+              :caption,
+              :screen_width,
+              :screen_height,
+              :gravity
+  attr_reader :environment,
+              :moveables,
+              :font
+  attr_accessor :background_path,
+                :background_hard_borders
+  
+  def initialize
+    after_initialize
+    
+    super self.screen_width, self.screen_height, self.full_screen, 16
+    
+    setup_window
+    setup_background
+    setup_containers
+    setup_steps
+    setup_waves
+    setup_scheduling
+    setup_font
+    
+    setup_environment
+    setup_enemies
+    setup_players
+    setup_collisions
+  end
+  
+  def media_path
+    @media_path || 'media'
+  end
+  def full_screen
+    @full_screen || false
+  end
+  def font_name
+    @font_name || Gosu::default_font_name
+  end
+  def font_size
+    @font_size || 20
+  end
+  def damping
+    @damping || 0.001
+  end
+  def caption
+    @caption || ""
+  end
+  def screen_width
+    @screen_width || DEFAULT_SCREEN_WIDTH
+  end
+  def screen_height
+    @screen_height || DEFAULT_SCREEN_HEIGHT
+  end
+  def gravity_vector
+    @gravity || @gravity = CP::Vec2.new(0, 0.98/SUBSTEPS)
+  end
+  
+  class << self
+    def gravity amount = 0.98
+      InitializerHooks.register self do
+        self.gravity = CP::Vec2.new 0, amount.to_f/SUBSTEPS
+      end
+    end
+    def width value = DEFAULT_SCREEN_WIDTH
+      InitializerHooks.register self do
+        self.screen_width = value
+      end
+    end
+    def height value = DEFAULT_SCREEN_HEIGHT
+      InitializerHooks.register self do
+        self.screen_height = value
+      end
+    end
+    def caption text = ""
+      InitializerHooks.register self do
+        self.caption = text
+      end
+    end
+    def damping amount = 0.0
+      InitializerHooks.register self do
+        self.damping = amount
+      end
+    end
+    def font name = Gosu::default_font_name, size = 20
+      InitializerHooks.register self do
+        self.font_name = name
+        self.font_size = size
+      end
+    end
+    def background path, options = {}
+      InitializerHooks.register self do
+        self.background_path = path
+        self.background_hard_borders = options[:hard_borders] || false
+      end
+    end
+    def full_screen
+      InitializerHooks.register self do
+        self.full_screen = true
+      end
+    end
+    def collisions &block
+      raise "collisions are defined in a block" unless block_given?
+      InitializerHooks.register self do
+        @collision_definitions = block
+      end
+    end
+  end
+  
+  def setup_window
+    self.caption = self.class.caption || ""
+  end
+  def setup_background
+    @background_image = Gosu::Image.new self, File.join(Resources.root, self.background_path), self.background_hard_borders
+  end
+  def setup_containers
+    @moveables = []
+    @controls = []
+    @remove_shapes = []
+    @players = []
+  end
+  def setup_steps
+    @step = 0
+    @dt = 1.0 / 60.0
+  end
+  def setup_waves
+    @waves = Waves.new self
+  end
+  def setup_scheduling
+    @scheduling = Scheduling.new
+  end
+  def setup_font
+    @font = Gosu::Font.new self, self.font_name, self.font_size
+  end
+  def setup_environment
+    @environment = CP::Space.new
+    class << @environment
+      attr_accessor :window
+    end
+    @environment.window = self
+    @environment.damping = -self.damping + 1 # recalculate the damping such that 0.0 has no damping.
+  end
+  
+  # Override.
+  #
+  def setup_players; end
+  def setup_enemies; end
+  
+  #
+  #
+  # Example:
+  #   collisions do
+  #     add_collision_func ...
+  #
+  def setup_collisions
+    @environment.instance_eval &@collision_definitions
+  end
+  
+  # Add controls for a player.
+  #
+  # Example:
+  #   add_controls_for @player1, Gosu::Button::KbA => :left,
+  #                              Gosu::Button::KbD => :right,
+  #                              Gosu::Button::KbW => :full_speed_ahead,
+  #                              Gosu::Button::KbS => :reverse,
+  #                              Gosu::Button::Kb1 => :revive
+  #
+  def add_controls_for object
+    @controls << Controls.new(self, object)
+  end
+  
+  
+  # Core methods used by the extensions "framework"
+  #
+  
+  # The main loop.
+  #
+  # TODO implement hooks.
+  #
+  def update
+    @step += 1
+    # Step the physics environment SUBSTEPS times each update.
+    #
+    SUBSTEPS.times do
+      remove_shapes!
+      reset_forces
+      move_all
+      targeting
+      handle_input
+      step_once
+    end
+    @waves.check @step
+    @scheduling.step
+  end
+  # Each step, this is called to handle any input.
+  #
+  def handle_input
+    @controls.each &:handle
+  end
+  # Does a single step.
+  #
+  def step_once
+    # Perform the step over @dt period of time
+    # For best performance @dt should remain consistent for the game
+    @environment.step @dt
+  end
+  
+  # Things unregister themselves here.
+  #
+  # Note: Use as follows in a Thing.
+  #       
+  #       def destroy
+  #         threaded do
+  #           5.times { sleep 0.1; animate_explosion }
+  #           @window.unregister self
+  #         end
+  #       end
+  #
+  def unregister thing
+    remove thing.shape
+  end
+  
+  # Remove this shape the next turn.
+  #
+  # Note: Internal use. Use unregister to properly remove a moveable.
+  #
+  def remove shape
+    @remove_shapes << shape
+  end
+  
+  # Run some code at relative time <time>.
+  #
+  # Example:
+  #   # Will destroy the object that calls this method
+  #   # in 20 steps.
+  #   #
+  #   window.threaded 20 do
+  #     destroy!
+  #   end
+  #
+  def threaded time = 1, &code
+    @scheduling.add time, &code
+  end
+  
+  # Moves each moveable.
+  #
+  def move_all
+    @moveables.each &:move
+  end
+  
+  # Handles the targeting process.
+  #
+  def targeting
+    @moveables.select { |m| m.respond_to? :target }.each do |gun|
+      gun.target *@moveables.select { |m| m.kind_of? Enemy }
+    end
+  end
+  
+  
+  
+  
+  # Utility Methods
+  #
+  
+  # 
+  #
+  # Example:
+  # * x, y = uniform_random_position
+  #
+  def uniform_random_position
+    [rand(self.width), rand(self.height)]
+  end
+  
+  #
+  #
+  # Example:
+  #   imprint do
+  #     circle x, y, radius, :fill => true, :color => :black
+  #   end
+  #
+  def imprint &block
+    @background_image.paint &block
+  end
+  
+  # Randomly adds a Thing to a uniform random position.
+  #
+  def randomly_add type
+    thing = type.new self
+    thing.warp_to *uniform_random_position
+    register thing
+  end
+  
+  # Moveables register themselves here.
+  #
+  def register moveable
+    @moveables << moveable
+    moveable.add_to @environment
+  end
+  
+  def remove_shapes!
+    # This iterator makes an assumption of one Shape per Star making it safe to remove
+    # each Shape's Body as it comes up
+    # If our Stars had multiple Shapes, as would be required if we were to meticulously
+    # define their true boundaries, we couldn't do this as we would remove the Body
+    # multiple times
+    # We would probably solve this by creating a separate @remove_bodies array to remove the Bodies
+    # of the Stars that were gathered by the Player
+    #
+    # p @remove_shapes unless @remove_shapes.empty?
+    @remove_shapes.each do |shape|
+      @environment.remove_body shape.body
+      @environment.remove_shape shape
+      @moveables.delete_if { |moveable| moveable.shape == shape }
+    end
+    @remove_shapes.clear
+  end
+  
+  def reset_forces
+    # When a force or torque is set on a Body, it is cumulative
+    # This means that the force you applied last SUBSTEP will compound with the
+    # force applied this SUBSTEP; which is probably not the behavior you want
+    # We reset the forces on the Player each SUBSTEP for this reason
+    #
+    # @player1.shape.body.reset_forces
+    # @player2.shape.body.reset_forces
+    # @player3.shape.body.reset_forces
+    # @players.each { |player| player.shape.body.reset_forces }
+  end
+  
+  # def revive player
+  #   return if @moveables.find { |moveable| moveable == player }
+  #   register player
+  # end
+  
+  # Drawing methods
+  #
+  
+  def draw
+    draw_background
+    draw_ambient
+    draw_moveables
+    draw_ui
+  end
+  def draw_background
+    @background_image.draw 0, 0, Layer::Background, 1.0, 1.0 if @background_image
+  end
+  def draw_ambient
+    
+  end
+  def draw_moveables
+    @moveables.each &:draw
+  end
+  def draw_ui
+    # @font.draw "P1 Score: ", 10, 10, ZOrder::UI, 1.0, 1.0, 0xffff0000
+  end
+  
+  # Escape exits by default.
+  #
+  def button_down id
+    close if exit?(id)
+  end
+  
+  # Override exit? if you want to define another exit rule.
+  #
+  def exit? id = nil
+    id == Gosu::Button::KbEscape
+  end
+  
+end

data/lib/gosu_extensions.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'active_support'
+# require 'texplay'
+begin
+  require 'gosu'
+rescue LoadError => e
+  puts "Couldn't find gem gosu. Install using:\n\nsudo gem install gosu.\n\n"
+  raise e
+end
+begin
+  require 'chipmunk' # A physics framework.
+rescue LoadError => e
+  puts "Couldn't find gem chipmunk. Install using:\n\nsudo gem install chipmunk.\n\n"
+  raise e
+end
+
+require 'resources'
+require 'vector_utilities'
+
+$:.unshift File.join(File.dirname(__FILE__), '/extensions')
+require 'module'
+require 'numeric'
+
+$:.unshift File.join(File.dirname(__FILE__), '/traits')
+require 'it_is_a'
+require 'pod'
+require 'attachable'
+require 'damaging'
+require 'generator'
+require 'initializer_hooks'
+require 'lives'
+require 'targeting'
+require 'targeting/closest'
+require 'shooter'
+require 'shot'
+require 'targetable'
+require 'turnable'
+require 'controllable'
+
+$:.unshift File.join(File.dirname(__FILE__), '/units')
+require 'thing'
+require 'moveable'
+require 'short_lived'
+
+require 'controls'
+require 'game_window'
+require 'scheduling'
+require 'waves'
+require 'layer'
+
+DEFAULT_SCREEN_WIDTH  = 1200
+DEFAULT_SCREEN_HEIGHT =  700
+SUBSTEPS              =   10

data/lib/layer.rb

@@ -0,0 +1,11 @@
+# Layering of sprites.
+#
+# 4 Layers:
+# * UI
+# * Players (Controlled and AI Elements)
+# * Ambient (Moveable Background)
+# * Background (Fixed, true Background)
+#
+module Layer
+  Background, Ambient, Players, UI = 0, 1, 2, 3
+end