moonpxi-nimo 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Paulo Schneider
+
+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.rdoc

@@ -0,0 +1,15 @@
+= nimo
+
+Description goes here.
+
+== TODO
+
+- Sort out resource loading, specially for sounds.
+- Create eventy.rb example to demonstrate how to do events (i.e. timers, screen transition hooks, etc).
+- Finish soundy.rb.
+- Create texty.rb to demonstrate 'system' and bitmap fonts.
+- Add stuff to this README.
+
+== Copyright
+
+Copyright (c) 2009 moonpxi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "nimo"
+    gem.summary = "Ruby game development library using Gosu."
+    gem.email = "paulo.schneider@gmail.com"
+    gem.homepage = "http://github.com/moonpxi/nimo"
+    gem.authors = ["moonpxi"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nimo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

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

data/examples/bouncy.rb

@@ -0,0 +1,101 @@
+# bouncy.rb
+# 
+# Example using deflectors, projectiles and moveable behaviors. It demonstrates how to create interacting
+# objects and representations
+# 
+# TODO: collision behavior is still a bit wonky. Balls disappear at the edge of the screen sometimes.
+#
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+include Gosu::Button
+
+WINDOW_WIDTH = 512
+WINDOW_HEIGHT = 480
+
+class Pad < Nimo::GameObject
+  include Nimo::Behavior::Deflector
+  include Nimo::Behavior::Moveable
+  
+  def initialize
+    super(:x => 200, :y => 400, :width => 80, :height => 40, :speed => 5,
+          :boundary => Object.from_hash(:x => 0, :y => 0, :width => WINDOW_WIDTH, :height => WINDOW_HEIGHT))
+    when_deflect { |projectile| projectile.change_color }
+  end
+  
+  def deflection_modifier(ball)
+    (ball.center.x - self.center.x)/(1.5*@width)
+  end
+  
+end
+
+
+class Wall < Nimo::GameObject
+  include Nimo::Behavior::Deflector
+  
+  def self.sections
+    [ Wall.new(:x => -10, :y => -10, :width => 10, :height => WINDOW_HEIGHT + 10),
+      Wall.new(:x => -10, :y => -10, :width => WINDOW_WIDTH + 10, :height => 10),
+      Wall.new(:x => WINDOW_WIDTH, :y => -10, :width => 10, :height => WINDOW_HEIGHT + 10),
+      Wall.new(:x => -10, :y => WINDOW_HEIGHT, :width => WINDOW_WIDTH, :height => 10) ]
+  end
+end
+
+
+class Ball < Nimo::GameObject
+  include Nimo::Behavior::Deflector
+  include Nimo::Behavior::Projectile
+ 
+  attr_accessor :speed, :old_speed
+
+  def initialize(*deflectors)
+    random_velocity = Nimo::Behavior::Velocity.new(0, 1)
+    random_velocity.adjust(rand)
+    
+    super(:x => 200, :y => 200, :width => 10, :height => 10, :velocity => random_velocity, :speed => 10, :old_speed => 0)
+    with_deflectors(deflectors)
+    
+    @colors = [Gosu::red, Gosu::green, Gosu::yellow, Gosu::blue, Gosu::white]
+    @color_index = 0
+  end
+  
+  def color
+    @colors[@color_index]
+  end
+  
+  def change_color
+    @color_index = @color_index == @colors.size - 1 ? 0 : @color_index + 1
+    notify(:color_change)
+  end
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pad = Pad.new
+  balls = (0..19).collect { Ball.new(pad, Wall.sections) }
+  
+  Nimo::Game("Bouncy", WINDOW_WIDTH, WINDOW_HEIGHT) do
+    
+    screen :game do
+      balls.each do |ball|
+        quad :for => ball, :with => {:color => ball.color} do
+          always { move }
+          listen_to(:color_change) { self.color = game_object.color }
+        end
+      end
+
+      quad :for => pad, :with => {:color => Gosu::white} do
+        when_key(KbLeft) { move_left }
+        when_key(KbRight) { move_right }
+        when_key(KbUp) { move_up }
+        when_key(KbDown) { move_down }
+
+        when_key(KbSpace) { balls.each { |ball| ball.speed, ball.old_speed = ball.old_speed, ball.speed }  }
+      end
+
+      when_key(KbEscape) { exit }
+    end
+    
+  end
+  
+end

data/examples/eventy.rb

@@ -0,0 +1,19 @@
+# 
+# eventy.rb
+# 
+# Demonstrate how to use on enter and timer events. Not very detailed.
+#
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+
+THREE_SECONDS = 3
+
+Nimo::Game("Eventy", 512, 480) do
+  fonts :main => { :type => "Helvetica", :size => 20 }
+
+  screen :main do
+    text :with => { :text => "Will exit in a three seconds", :font => :main, :x => 10, :y => 200, :color => Gosu::white }
+    listen_to(:on_enter) { timer_for(THREE_SECONDS) { exit } } 
+  end
+end

data/examples/imagey.rb

@@ -0,0 +1,82 @@
+# 
+# imagey.rb
+# 
+# Demonstrate how to load and use whole images and sub-images as representations.
+# The character and dungeon images were retrieved from: http://www.molotov.nu/?page=graphics
+# 
+# TODO Add better boundary check for trees
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+include Gosu::Button
+
+WINDOW_WIDTH = 512
+WINDOW_HEIGHT = 480
+WINDOW = {:x => 0, :y => 0, :width => WINDOW_WIDTH, :height => WINDOW_HEIGHT}
+
+class Player < Nimo::GameObject
+  include Nimo::Behavior::Moveable
+  
+  def initialize
+    super(:x => 32, :y => 32, :width => 32, :height => 32, :speed => 32, 
+          :boundary => Object.from_hash(:x => 32, :y => 32, :width => WINDOW_WIDTH - 32, :height => WINDOW_HEIGHT - 32))
+  end
+end
+
+class Dungeon
+  # A bit hacktastic!
+  def self.representation
+    map_config = {:image => :map_tiles}
+    representations = []
+    
+    16.times do |x|
+      15.times do |y|
+        if x == 0 || x == 15 || y == 0 || y == 14
+          representations << map_config.merge(:x => x*32, :y => y*32, :index => 2)
+        else
+          representations << map_config.merge(:x => x*32, :y => y*32, :index => 79)
+        end
+      end
+    end
+    representations << map_config.merge(:x => 7*32, :y => 0, :index => 1)
+    representations << map_config.merge(:x => 8*32, :y => 0, :index => 20)
+    representations << map_config.merge(:x => 9*32, :y => 0, :index => 1)
+    
+    representations << map_config.merge(:x => 7*32, :y => 4*32, :index => 85)
+    representations << map_config.merge(:x => 3*32, :y => 13*32, :index => 85)
+    representations << map_config.merge(:x => 14*32, :y => 3*32, :index => 85)
+    
+    return representations
+  end
+end
+
+
+if __FILE__ == $PROGRAM_NAME
+  Nimo::Game("Imagey", WINDOW_WIDTH, WINDOW_HEIGHT) do
+    images :jeeklabs => { :filename => "examples/images/jeeklabs.png" },
+           :char_tiles => { :filename => "examples/images/dg_classm32.png", :tile_dimension => [32, 32] },
+           :map_tiles => { :filename => "examples/images/dg_dungeon32.png", :tile_dimension => [32, 32] }
+    
+    screen :title do
+      quad :with => WINDOW.merge(:color => Gosu::white)
+      image :with => {:x => 116, :y => 190, :image => :jeeklabs}
+      
+      any_key { go_to :game }
+    end
+    
+    screen :game do
+      Dungeon.representation.each { |params| image :with => params }
+
+      image :for => Player.new, :with => {:image => :char_tiles, :index => 85} do
+        when_key(KbLeft, :repeatable => false) { self.move_left }
+        when_key(KbRight, :repeatable => false) { self.move_right }
+        when_key(KbUp, :repeatable => false) { move_up }
+        when_key(KbDown, :repeatable => false) { move_down }
+      end
+        
+      when_key(KbEscape) { exit }
+    end
+    
+  end
+  
+end

data/examples/screeny.rb

@@ -0,0 +1,80 @@
+# 
+# screeny.rb
+# 
+# Example demonstrates how to navigate between screens and menus, and also some text output.
+#
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+include Gosu::Button
+
+WINDOW_WIDTH = 512
+WINDOW_HEIGHT = 480
+
+class Wall < Nimo::GameObject
+  include Nimo::Behavior::Deflector
+  
+  def self.sections
+    [ Wall.new(:x => -10, :y => -10, :width => 10, :height => WINDOW_HEIGHT + 10),
+      Wall.new(:x => -10, :y => -10, :width => WINDOW_WIDTH + 10, :height => 10),
+      Wall.new(:x => WINDOW_WIDTH, :y => -10, :width => 10, :height => WINDOW_HEIGHT + 10),
+      Wall.new(:x => -10, :y => WINDOW_HEIGHT, :width => WINDOW_WIDTH, :height => 10) ]
+  end
+end
+
+
+class Ball < Nimo::GameObject
+  include Nimo::Behavior::Deflector
+  include Nimo::Behavior::Projectile
+  
+  def initialize(*deflectors)
+    random_velocity = Nimo::Behavior::Velocity.new(0, 1)
+    random_velocity.adjust(rand + -rand)
+    
+    super(:x => 200, :y => 200, :width => 10, :height => 10, :velocity => random_velocity, :speed => 10)
+    with_deflectors(deflectors)
+  end
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Nimo::Game("Screeny", WINDOW_WIDTH, WINDOW_HEIGHT) do
+    fonts :main => { :type => "Helvetica", :size => 20 }
+    
+    screen :start do
+      text :with => {:text => "StartScreen: press any key to go to the GameScreen", 
+                     :x => 10, :y => 200, :font => :main, :color => Gosu::white}
+      any_key { go_to :game }
+    end
+    
+    screen :game do
+      text :with => {:text => "GameScreen: press any key to open the MenuScreen",
+                     :x => 10, :y => 10, :font => :main, :color => Gosu::white}
+
+      balls = (0..19).collect { Ball.new(Wall.sections) }
+      balls.each do |ball|
+        ball.with_deflectors(balls.find_all { |other_ball| other_ball != ball })
+        quad :for => ball, :with => {:color => Gosu::red} do
+          always { move }
+        end
+      end
+      
+      any_key { open_menu :menu }
+    end
+    
+    screen :menu do
+      text :with => {:text => "MenuScreen:", :x => 100, :y => 200, :font => :main, :color => Gosu::white, :size => 15}
+      text :with => {:text => "- <ESC> to go to the EndScreen", :x => 100, :y => 215, :font => :main, :color => Gosu::white, :size => 15}
+      text :with => {:text => "- <ENTER> to go to the GameScreen", :x => 100, :y => 230, :font => :main, :color => Gosu::white, :size => 15}
+      
+      when_key(KbReturn) { close_menu }
+      when_key(KbEscape) { close_menu and go_to :end }
+    end
+    
+    screen :end do
+      text :with => {:text => "EndScreen: you've reached the end of this example!",
+                     :x => 10, :y => 200, :font => :main, :color => Gosu::white}
+      any_key { exit }
+    end
+  end
+end

data/examples/simplest.rb

@@ -0,0 +1,23 @@
+# simplest.rb
+# 
+# Simplest example ever! A white box controlled by the arrow keys.
+# 
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+include Gosu::Button
+
+Nimo::Game("Simplest", 640, 480) do
+  
+  screen :game do
+    quad :with => { :width => 20, :height => 20, :color => Gosu::white } do
+      when_key(KbLeft)  { self.x -= 5 }
+      when_key(KbRight) { self.x += 5 }
+      when_key(KbUp)    { self.y -= 5 }
+      when_key(KbDown)  { self.y += 5 }
+    end
+    
+    when_key(KbEscape) { exit }
+  end
+  
+end

data/examples/soundy.rb

@@ -0,0 +1,40 @@
+# 
+# soundy.rb
+# 
+# Demonstrate how to play sounds and background music. 
+# Copyright (sort of): the sounds used here came from my Ubuntu installation (probably from the KDE distribution).
+#
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'nimo'
+
+WINDOW_WIDTH = 512
+WINDOW_HEIGHT = 480
+
+Nimo::Game("Soundy", WINDOW_WIDTH, WINDOW_HEIGHT) do
+  sounds :startup => { :filename => "examples/sounds/KDE-Sys-Log-Out.ogg" },
+         :effect => { :filename => "examples/sounds/k3b_error1.wav" }
+  fonts :main => { :type => "Helvetica", :size => 15}
+  
+  screen :main do
+    listen_to(:on_enter) { sounds[:startup].play(true) }
+
+    text :with => {:x => 10, :y => 10, :font => :main, :color => Gosu::white,
+                   :text => "This screen will play a background sound."}
+    text :with => {:x => 10, :y => 28, :font => :main, :color => Gosu::white,
+                   :text => "Press <esc> to quit or <enter> to go to the next screen."}
+    
+    when_key(Gosu::Button::KbEscape) { exit }
+    when_key(Gosu::Button::KbReturn) { sounds[:startup].stop; go_to :another }
+  end
+  
+  screen :another do
+    text :with => {:x => 10, :y => 10, :font => :main, :color => Gosu::white,
+                   :text => "This screen will play a sound effect."}
+    text :with => {:x => 10, :y => 28, :font => :main, :color => Gosu::white,
+                   :text => "Press <esc> to go back or <enter> to play the sound."}
+
+    when_key(Gosu::Button::KbEscape) { go_to :main }
+    when_key(Gosu::Button::KbReturn) { sounds[:effect].play }
+  end
+end