ippa-chingu 0.4.8 → 0.5

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.5 / 2009-10-7
+Big refactor of GameObject. Now has BasicGameObject as base.
+A first basic "trait"-system where GameObject "has_traits :visual, :velocity" etc.
+Tons of enhancements and fixes. Speed optimization. More examples.
+
 === 0.4.5 / 2009-08-27
 Tons of small fixes across the board. 
 Started on GFX Helpers (fill, fill_rect, fill_gradient so far).

data/README.rdoc

@@ -3,6 +3,8 @@ http://github.com/ippa/chingu/tree/master
 
 DOCUMENTATION: http://rdoc.info/projects/ippa/chingu
 
+Ruby 1.9.1 is recommended. Also works with 1.8.7+.
+
 This is an early preview, a lot of functionality is still missing!
 It's also in a state of flux while I decide on core-naming etc.
 
@@ -13,7 +15,7 @@ It's also in a state of flux while I decide on core-naming etc.
 
 == DESCRIPTION
 Game framework built on top of the OpenGL accelerated game lib Gosu. 
-It adds simple yet powerfull game states, prettier inputhandling, deploymentsafe asset-handling, a basic re-usable game object and automation of common task.
+It adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and automation of common task.
 
 
 == THE STORY
@@ -34,11 +36,16 @@ Chingu consists of the following core classes:
 The main window, use it at you use Gosu::Window.
 
 === Chingu::GameObject
-Use for all your in game objects. The player, the enemies, the bullets, the powerups, the loot laying around.
+Use this for all your in game objects. The player, the enemies, the bullets, the powerups, the loot laying around.
 It's very reusable and doesn't contain any game-logic (that's up to you!). Only stuff to put it on screen a certain way.
 It also gives you a couple of bonuses with chingu, as automatic updates/draws and easier input-mapping.
 Has either Chingu::Window or a Chingu::GameState as "owner".
 
+=== Chingu::BasicGameObject
+For those who think GameObject is a too little fat, there's BasicGameObject (GameObject inherits from BasicGameObject).
+BasicGameObject is just an empty frame (no x,y,image accessors or draw-logic) for you to build on.
+It _can_ be extended with Chingus trait-system though. and it belong to either $window or a game state as BasicObject.
+
 === Chingu::Text
 Makes use of Gosu::Font more rubyish and powerful.
 In it's core, another Chingu::GameObject + Gosu::Font.
@@ -55,6 +62,12 @@ If using game states, the flow of draw/update/button_up/button_down is:
 Chingu::Window --> Chingu::GameStateManager --> Chingu::GameState.
 For example, inside game state Menu you call push_game_state(Level). When Level exists, it will go back to Menu.
 
+=== Chingu::Animation
+Load and interact with tile-based animations. loop, bounce and access invidual frame(s) easily.
+An "@image = @animation.next!" in your Player#update is usually enough to get you started!
+
+== Chingu::Parallax
+A class for easy paralaxxscrolling. See example3.rb for more.
 
 == THE BASICS
 
@@ -113,7 +126,7 @@ Chingu doesn't change any fundamental concept of Gosu, but it will make the abov
   #
   # We use Chingu::Window instead of Gosu::Window
   #
-  class Game < Chingu:Window
+  class Game < Chingu::Window
     def initialize
       super       # This is always needed if you want to take advantage of what chingu offers
       #
@@ -222,7 +235,7 @@ Another more complex example:
   # Pressing ESC would call Play#close
   # Holding down LEFT would call Play#move_left on every game iteration
   # Holding down RIGHT would call Play#move_right on every game iteration
-  # Relasing SPACE would call Play#fire
+  # Releasing SPACE would call Play#fire
   #
   
   class Play < Chingu::GameState
@@ -242,14 +255,14 @@ In Gosu the above code would include code in button_up(), button_down() and a ch
 
 Every symbol can be prefixed by either "released_" or "holding_" while no prefix at all defaults to pressed once.
 
-So, why not :up_space or :relase_space instead of :released_space?
+So, why not :up_space or :release_space instead of :released_space?
 +:up_space+ doesn't sound like english, :release_space sounds more like a command then an event.
 
 
 Or +:hold_left+ or :down_left instead of :holding_left?
 :holding_left sounds like something that's happening over a period of time, not a single trigger, which corresponds well to how it works.
 
-And with the default :space => :something youd imagine that :something is called once. You press :space once, :something get's executed once.
+And with the default :space => :something you would imagine that :something is called once. You press :space once, :something is executed once.
 
 
 === GameState / GameStateManager
@@ -283,7 +296,7 @@ Game states aren't complicated. In Chingu a GameState is a class that behaves mo
 
   end
 
-Looks familiar ye?
+Looks familiar yet?
 You can activate the above game state in 2 ways
 
   class Game < Chingu::Window
@@ -309,15 +322,15 @@ Another example:
     def initialize
       #
       # We start by pushing Menu to the game state stack, making it active as the only state on stack.
-      # :setup => :false which will skip setup() from beeing called (standard when switching to a new state)
+      # :setup => :false which will skip setup() from being called (standard when switching to a new state)
       #
       push_game_state(Menu, :setup => false)
       
       #
-      # We push another game state to the stack, Play. We now have 2 states, which active beeing first / active.
+      # We push another game state to the stack, Play. We now have 2 states, which active being first / active.
       #
-      # :finalize => false will skip setup() from beeing called on game state 
-      # that's beeing pushed down the stack, in this case Intro.setup().
+      # :finalize => false will skip setup() from being called on game state 
+      # that's being pushed down the stack, in this case Intro.setup().
       #
       push_game_state(Play, :finalize => false)
     
@@ -340,7 +353,7 @@ Another example:
   
 A GameState in Chingu is just a class with the following instance methods: 
 
-* initialize()    - called only once with push_game_state(Intro) but everytime with push_game_state(Intro.new)
+* initialize()    - called only once with push_game_state(Intro) but every time with push_game_state(Intro.new)
 * setup()         - called each time the game state becomes active. 
 * button_down(id) - Called when a button is down
 * button_up(id)   - Called when a button is released
@@ -380,13 +393,13 @@ Chingus inputhandler will detect that Menu is a gamestate-class, create a new in
 
 === Assets / Paths
 
-You might wonder why this is nessesary in the straight Gosu example:
+You might wonder why this is necessary in the straight Gosu example:
   ROOT_PATH = File.dirname(File.expand_path(__FILE__))
   @image = Image.new(File.join(ROOT_PATH, "media", "player.png"))
 
 It enables you to start your game from any directory and it will still find your assets (pictures, samples, fonts etc..) correctly.
 For a local development version this might not be important, you're likely to start the game from the games root-dir.
-But as soon as you try to deploy (for example to windows with OCRA - http://github.com/larsch/ocra/tree/master) you'll run into trouble of you dont do it like that.
+But as soon as you try to deploy (for example to windows with OCRA - http://github.com/larsch/ocra/tree/master) you'll run into trouble of you don't do it like that.
  
 Chingu solves this problem behind the scenes for the most common assets. The 2 lines above can be replaced with:
   Image["player.png"]
@@ -430,20 +443,27 @@ Since Chingu::Window is just Gosu::Window + some cheese you can do your $window.
 See http://www.libgosu.org/rdoc/classes/Gosu/Window.html for a full set of methods.
 
 == TODO:
+* add :padding and :align => :topleft etc to class Text
+* rename Chingu::Window so 'include Chingu' and 'include Gosu' wont make Window collide
+* (done) BasicObject vs GameObject vs ScreenObject => Became BasicGameObject and GameObject
+* (50%) some kind of componentsystem for GameObject (which should be cleaned up)
+* (done) scale <--> growth parameter. See trait "effect"
+* (done) Enemy.all ... instead of game_objects_of_type(Enemy) ? could this be cool / understandable?
+* (done) Don't call .update(time) with timeparameter, make time available thru other means when needed.
+* (10% done) debug screen / game state.. check out shawn24's elite irb sollution :)
 * (done) Complete the input-definitions with all possible inputs (keyboard, gamepad, mouse)!
 * (done) Complete input-stuff with released-states etc
 * (done) More gfx effects, for example: fade in/out to a specific color (black makes sense between levels).
 * (posted request on forums) Summon good proven community gosu snippets into Chingu
 * (done) Generate docs @ ippa.github.com-  http://rdoc.info/projects/ippa/chingu !
 * (done) A good scene-manager to manage welcome screens, levels and game flow- GameStateManager / GameState !
-* More docs
 * (20% done) make a playable simple game in examples\ that really depends on game states
 * (done) Make a gem- first gem made on github
 * (done) Automate gemgenning rake-task even more
 * More examples when effects are more complete
 * class ChipmunkObject
-* class Actor/MovingActor with maybe abit more logic then the basic GameObject. Would ppl find is useful?
-* (40% done) Spell check all docs, sloppy spelling turns ppl off.
+* class Actor/MovingActor with maybe a bit more logic then the basic GameObject. Would ppl find is useful?
+* (60% done) Spell check all docs, sloppy spelling turns ppl off. tnx jduff ;).
 * Tests
 * (done) Streamline fps / tick code
 * (done) Encapsulate Font.new / draw_rot with a "class Text < GameObject"
@@ -452,7 +472,7 @@ See http://www.libgosu.org/rdoc/classes/Gosu/Window.html for a full set of metho
 * A more robust game state <-> game_object system to connect them together.
 * (50% done) Get better at styling rdocs
 * (done) all �gamestate� ? �game state� ?   it's "game state"
-* intergrate MovieMaker
+* (skipping) intergrate MovieMaker - solve this with traits instead.
 * FIX example4: :p => Pause.new  would Change the "inside_game_state" to Pause and make @player belong to Pause.
 
 == WHY?
@@ -467,11 +487,11 @@ See http://www.libgosu.org/rdoc/classes/Gosu/Window.html for a full set of metho
 * Don't separate too much from Gosus core-naming
 
 == CREDITS:
-Jacius of Rubygame (For doing cool stuff that's well documented as re-usable). So far rect.rb and named_resource.rb is taken from Rubygame.
-
-jlnr,philymore,shawn24 for constructive feedback
-
+* Jacius of Rubygame (For doing cool stuff that's well documented as re-usable). So far rect.rb and named_resource.rb is taken from Rubygame.
+* Jduff for input / commits.
+* Jlnr,Philymore,Shawn24,JamesKilton for constructive feedback/discussions.
 
 == REQUIREMENTS:
 * Gosu latest version
-* Ruby 1.8 (Has not been verified with 1.9 yet)
+* Ruby 1.8.7+ (Works with 1.9+ as well!)
+

data/chingu.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.4.8"
+  s.version = "0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2009-08-30}
+  s.date = %q{2009-09-07}
   s.description = %q{Game framework built on top of the OpenGL accelerated game lib Gosu. 
-It adds simple yet powerfull game states, prettier inputhandling, deploymentsafe asset-handling, a basic re-usable game object and automation of common task.}
+It adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and automation of common task.}
   s.email = ["ippa@rubylicio.us"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "chingu.gemspec", "examples/example1.rb", "examples/example2.rb", "examples/example3.rb", "examples/example4.rb", "examples/example5.rb", "examples/example6.rb", "examples/example7.rb", "examples/media/Parallax-scroll-example-layer-0.png", "examples/media/Parallax-scroll-example-layer-1.png", "examples/media/Parallax-scroll-example-layer-2.png", "examples/media/Parallax-scroll-example-layer-3.png", "examples/media/background1.png", "examples/media/fire_bullet.png", "examples/media/fireball.png", "examples/media/particle.png", "examples/media/ruby.png", "examples/media/spaceship.png", "examples/media/stickfigure.bmp", "examples/media/stickfigure.png", "examples/media/video_games.png", "lib/chingu.rb", "lib/chingu/animation.rb", "lib/chingu/assets.rb", "lib/chingu/core_extensions.rb", "lib/chingu/effects.rb", "lib/chingu/fpscounter.rb", "lib/chingu/game_object.rb", "lib/chingu/game_state.rb", "lib/chingu/game_state_manager.rb", "lib/chingu/game_states/fade_to.rb", "lib/chingu/game_states/pause.rb", "lib/chingu/gfx_helpers.rb", "lib/chingu/helpers.rb", "lib/chingu/input.rb", "lib/chingu/named_resource.rb", "lib/chingu/parallax.rb", "lib/chingu/particle.rb", "lib/chingu/rect.rb", "lib/chingu/text.rb", "lib/chingu/window.rb"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "chingu.gemspec", "examples/example1.rb", "examples/example2.rb", "examples/example3.rb", "examples/example4.rb", "examples/example5.rb", "examples/example6.rb", "examples/example7.rb", "examples/example8.rb", "examples/example9.rb", "examples/media/Parallax-scroll-example-layer-0.png", "examples/media/Parallax-scroll-example-layer-1.png", "examples/media/Parallax-scroll-example-layer-2.png", "examples/media/Parallax-scroll-example-layer-3.png", "examples/media/background1.png", "examples/media/fire_bullet.png", "examples/media/fireball.png", "examples/media/particle.png", "examples/media/ruby.png", "examples/media/spaceship.png", "examples/media/stickfigure.bmp", "examples/media/stickfigure.png", "examples/media/video_games.png", "lib/chingu.rb", "lib/chingu/actor.rb", "lib/chingu/animation.rb", "lib/chingu/assets.rb", "lib/chingu/basic_game_object.rb", "lib/chingu/core_extensions.rb", "lib/chingu/effects.rb", "lib/chingu/fpscounter.rb", "lib/chingu/game_object.rb", "lib/chingu/game_state.rb", "lib/chingu/game_state_manager.rb", "lib/chingu/game_states/debug.rb", "lib/chingu/game_states/fade_to.rb", "lib/chingu/game_states/pause.rb", "lib/chingu/gfx_helpers.rb", "lib/chingu/helpers.rb", "lib/chingu/input.rb", "lib/chingu/named_resource.rb", "lib/chingu/parallax.rb", "lib/chingu/particle.rb", "lib/chingu/rect.rb", "lib/chingu/text.rb", "lib/chingu/traits/collision_detection.rb", "lib/chingu/traits/deprecated_module_visual.rb", "lib/chingu/traits/deprecated_visual.rb", "lib/chingu/traits/effect.rb", "lib/chingu/traits/input.rb", "lib/chingu/traits/velocity.rb", "lib/chingu/window.rb"]
   s.homepage = %q{http://github.com/ippa/chingu/tree/master}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/examples/example1.rb

@@ -27,6 +27,8 @@ class Game < Chingu::Window
 end
 
 class Player < Chingu::GameObject
+  has_trait :input
+  
   def move_left;  @x -= 1; end
   def move_right; @x += 1; end
   def move_up;    @y -= 1; end

data/examples/example2.rb

@@ -6,6 +6,8 @@ include Gosu
 # A little more complicated example where we do our own #update and #draw code.
 # We also add another Actor - a bullet fired with space.
 #
+# Also tests out the Debug game state.
+#
 class Game < Chingu::Window
   def initialize
     #
@@ -14,45 +16,16 @@ class Game < Chingu::Window
     #
     super
     
-    @player = Player.new(:x => 200, :y => 200, :image => Image["spaceship.png"])
-    @player.input = { :holding_left => :move_left, 
-                      :holding_right => :move_right, 
-                      :holding_up => :move_up, 
-                      :holding_down => :move_down, 
-                      :space => :fire,
-                      :escape => :exit
-                      }
-  end
-
-  #
-  # If we want to add extra graphics drawn just define your own draw.
-  # Be sure to call #super for enabling Chingus autodrawing of Actors.
-  # Putting #super before or after the background-draw-call really doesn't matter since Gosu work with "zorder".
-  #
-  def draw
-    # Raw Gosu Image.draw(x,y,zorder)-call
-    Image["background1.png"].draw(0, 0, 0)    
-    super
+    push_game_state(Play.new)
   end
-
-  #
-  # Gosus place for gamelogic is #update in the mainwindow
-  #
-  # A #super call here would call #update on all Chingu::Actors and check their inputs, and call the specified method.
-  # 
-  def update
-    
-    ### Your own gamelogic here
-    super
-    self.caption = "FPS: #{self.fps} milliseconds_since_last_tick: #{self.milliseconds_since_last_tick}"
-  end
-  
 end
 
 #
 # Our Player
 #
 class Player < Chingu::GameObject
+  has_trait :input
+
   def initialize(options = {})
     super
     @image = Image["spaceship.png"]
@@ -78,10 +51,67 @@ class Bullet < Chingu::GameObject
   end
 
   # Move the bullet forward
-  def update(time)
+  def update
     @y -= 2
   end
   
 end
 
+class Play < Chingu::GameState
+  
+  def initialize
+    super
+    @player = Player.new(:x => 200, :y => 200)
+    @player.input = { :holding_left => :move_left, 
+                      :holding_right => :move_right, 
+                      :holding_up => :move_up, 
+                      :holding_down => :move_down, 
+                      :space => :fire,
+                      :escape => :exit,
+                      }
+    self.input = { :f1 => :debug }
+  end
+  
+  def debug
+    #puts "--------"
+    #GameObject.all.each do |game_object|
+    #  puts game_object.class
+    #end
+    #return 
+    
+    push_game_state(Chingu::GameStates::Debug)
+  end
+    
+  #
+  # If we want to add extra graphics drawn just define your own draw.
+  # Be sure to call #super for enabling Chingus autodrawing of Actors.
+  # Putting #super before or after the background-draw-call really doesn't matter since Gosu work with "zorder".
+  #
+  def draw
+    # Raw Gosu Image.draw(x,y,zorder)-call
+    Image["background1.png"].draw(0, 0, 0)    
+    super
+  end
+
+  #
+  # Gosus place for gamelogic is #update in the mainwindow
+  #
+  # A #super call here would call #update on all Chingu::Actors and check their inputs, and call the specified method.
+  # 
+  def update
+    Bullet.destroy_if { |bullet| bullet.outside_window? }
+    #Bullet.destroy_if(&:outside_window?)
+    
+    #
+    # Bullet.each_collision(Enemy) do |bullet, enemy|
+    #   enemy.collision_with(bullet)
+    #   bullet.destroy!
+    # end
+    #
+      
+    super
+    $window.caption = "FPS: #{$window.fps} - milliseconds_since_last_tick: #{$window.milliseconds_since_last_tick} - game objects# #{current_game_state.game_objects.size}"
+  end  
+end
+
 Game.new.show

data/examples/example4.rb

@@ -40,6 +40,8 @@ end
 
 # Our Player 
 class Player < Chingu::GameObject
+  has_trait :input
+  
   def initialize(options = {})
     super
     @image = Image["spaceship.png"]
@@ -51,7 +53,9 @@ class Player < Chingu::GameObject
   def move_down;  @y += 1; end 
 
   def fire
-    Bullet.new(:x => @x, :y => @y)
+    Bullet.new(:x => @x - 20, :y => @y)
+    Bullet.new(:x => @x, :y => @y) 
+    Bullet.new(:x => @x + 20, :y => @y)
   end  
 end
 
@@ -62,7 +66,7 @@ class Bullet < Chingu::GameObject
     @image = Image["fire_bullet.png"]
   end
   
-  def update(time)
+  def update
     @y -= 2
   end
 end
@@ -113,7 +117,7 @@ class Level < Chingu::GameState
                       :holding_right => :move_right, 
                       :holding_up => :move_up, 
                       :holding_down => :move_down, 
-                      :left_ctrl => :fire}
+                      :space => :fire}
     
     #
     # The input-handler understands gamestates. P is pressed --> push_gamegate(Pause)
@@ -122,6 +126,12 @@ class Level < Chingu::GameState
     self.input = {:p => Pause, :r => lambda{ current_game_state.setup } }
   end
   
+  def update
+    super
+    Bullet.destroy_if {|bullet| bullet.outside_window? }
+    $window.caption = "FPS: #{$window.fps} - GameObjects: #{game_objects.size}"
+  end
+  
   #
   # setup() is called each time you switch to the game state (and on creation time).
   # You can skip setup by switching with push_game_state(:setup => false) or pop_game_state(:setup => false)
@@ -130,6 +140,7 @@ class Level < Chingu::GameState
   #
   def setup
     # Place player in a good starting position
+    Bullet.clear
     @player.x = $window.width/2
     @player.y = $window.height - @player.image.height
   end
@@ -138,6 +149,8 @@ end
 #
 # SPECIAL GAMESTATE - Pause
 #
+# NOTICE: Chingu now comes with a predefined Chingu::GameStates::Pause that works simular to this!
+#
 class Pause < Chingu::GameState
   def initialize(options)
     super

data/examples/example5.rb

@@ -55,7 +55,7 @@ class State1 < Chingu::GameState
     @spinner_index = 0.0
   end
   
-  def update(dt)
+  def update
     @spinner_index += 0.1
     @spinner_index = 0    if @spinner_index >= @spinner.size
   end
@@ -71,7 +71,7 @@ class State2 < Chingu::GameState
     @ticks = 0.0
   end
   
-  def update(dt)
+  def update
     @ticks += 0.01
     @factor = 1.5 + Math.sin(@ticks).to_f
   end
@@ -88,7 +88,7 @@ class State3 < Chingu::GameState
     @ticks = 0.0
   end
   
-  def update(dt)
+  def update
     @ticks += 0.01
     @factor = 1.5 + Math.sin(@ticks).to_f
   end