chingu 0.5.8 → 0.5.8.1

data/Manifest.txt

@@ -71,6 +71,7 @@ lib/chingu/helpers/gfx.rb
 lib/chingu/helpers/input_client.rb
 lib/chingu/helpers/input_dispatcher.rb
 lib/chingu/helpers/rotation_center.rb
+lib/chingu/high_score.rb
 lib/chingu/inflector.rb
 lib/chingu/input.rb
 lib/chingu/named_resource.rb

data/README.rdoc

@@ -12,7 +12,8 @@ Chingu has started to settle down, thouch core classes and naming can still chan
 
 
 == DESCRIPTION
-Game framework built on top of the OpenGL accelerated game lib Gosu. 
+OpenGL accelerated 2D game framework for Ruby.
+Builds on the awesome Gosu (Ruby/C++) which provides all the core functionality.
 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.
 
 
@@ -200,7 +201,8 @@ The basic ideas behind it are:
 * Keep naming close to Gosu, but add smart convenient methods / shortcuts and a more rubyish feeling
 * No game logic allowed in GameObject, since that's not likely to be useful for others.
 
-I've chose to base it around Image#draw_rot. So basically all the arguments that you pass to draw_rot can be passed to GameObject#new when creating a new object, an example using almost all arguments would be:
+It's based around Image#draw_rot. So basically all the arguments that you pass to draw_rot can be passed to GameObject#new when creating a new object.
+An example using almost all arguments would be:
   
   #
   # You probably recognize the arguments from http://www.libgosu.org/rdoc/classes/Gosu/Image.html#M000023
@@ -302,6 +304,10 @@ Game states aren't complicated. In Chingu a GameState is a class that behaves mo
   # A simple GameState-example
   class Intro < Chingu::GameState
   
+    def initialize(options)
+      # called as usual when class is created, load resources and simular here
+    end
+  
     def update
       # game logic here
     end
@@ -310,7 +316,7 @@ Game states aren't complicated. In Chingu a GameState is a class that behaves mo
       # screen manipulation here
     end
         
-    # Called when we enter the game state
+    # Called Each time when we enter the game state, use this to reset the gamestate to a "virgin state"
     def setup
       @player.angle = 0   # point player upwards
     end
@@ -379,10 +385,10 @@ 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 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
+* initialize()    - as you might expect, called when GameState is created.
+* 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.
 * update()        - just as in your normal game loop, put your game logic here.
 * draw()          - just as in your normal game loop, put your screen manipulation here.
 * finalize()      - called when a game state de-activated (for example by pushing a new one on top with push_game_state)
@@ -415,7 +421,7 @@ Or Chingus shortcut:
     end
   end
   
-Chingus inputhandler will detect that Menu is a gamestate-class, create a new instance, cache it and activate it with push_game_state().
+Chingus inputhandler will detect that Menu is a GameState-class, create a new instance and activate it with push_game_state().
 
 === Traits
 Traits (often called behaivors) is a way of adding logic to any class inheriting from BasicGameObject / GameObject.
@@ -561,6 +567,8 @@ There's 1 zillion ways of naming stuff. As a general guideline I've tried to fol
 If Gosu didn't have a good name for a certain thing/method I've checked Ruby itself and then Rails since alot of Ruby-devs are familiar with Rails.
 GameObject.all is naming straight from rails for example. Most stuff in GameObject follow the naming from Gosus Image#draw_rot.
 
+As far as possible, use correct rubyfied english game_objects, not gameobjects. class HighScore, not Highscore.
+
 == TODO:
 * add :padding and :align => :topleft etc to class Text
 * (skip) rename Chingu::Window so 'include Chingu' and 'include Gosu' wont make Window collide

data/chingu.gemspec

@@ -2,22 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.5.8"
+  s.version = "0.5.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2009-10-18}
-  s.description = %q{Game framework built on top of the OpenGL accelerated game lib Gosu. 
+  s.date = %q{2009-10-19}
+  s.description = %q{OpenGL accelerated 2D game framework for Ruby.
+Builds on the awesome Gosu (Ruby/C++) which provides all the core functionality.
 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", "benchmarks/README.txt"]
-  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "benchmarks/README.txt", "benchmarks/benchmark.rb", "benchmarks/benchmark3.rb", "benchmarks/benchmark4.rb", "benchmarks/benchmark5.rb", "benchmarks/benchmark6.rb", "benchmarks/meta_benchmark.rb", "benchmarks/meta_benchmark2.rb", "chingu.gemspec", "examples/example1.rb", "examples/example10.rb", "examples/example11.rb", "examples/example12.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/game1.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/bullet.png", "examples/media/bullet_hit.wav", "examples/media/city1.csv", "examples/media/city1.png", "examples/media/city2.png", "examples/media/droid.bmp", "examples/media/enemy_bullet.png", "examples/media/explosion.wav", "examples/media/fire_bullet.png", "examples/media/fireball.png", "examples/media/laser.wav", "examples/media/particle.png", "examples/media/plane.csv", "examples/media/plane.png", "examples/media/ruby.png", "examples/media/saucer.csv", "examples/media/saucer.gal", "examples/media/saucer.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/basic_game_object.rb", "lib/chingu/core_extensions.rb", "lib/chingu/fpscounter.rb", "lib/chingu/game_object.rb", "lib/chingu/game_object_list.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/helpers/game_object.rb", "lib/chingu/helpers/game_state.rb", "lib/chingu/helpers/gfx.rb", "lib/chingu/helpers/input_client.rb", "lib/chingu/helpers/input_dispatcher.rb", "lib/chingu/helpers/rotation_center.rb", "lib/chingu/inflector.rb", "lib/chingu/input.rb", "lib/chingu/named_resource.rb", "lib/chingu/parallax.rb", "lib/chingu/particle.rb", "lib/chingu/rect.rb", "lib/chingu/require_all.rb", "lib/chingu/text.rb", "lib/chingu/traits/collision_detection.rb", "lib/chingu/traits/effect.rb", "lib/chingu/traits/retrofy.rb", "lib/chingu/traits/timer.rb", "lib/chingu/traits/velocity.rb", "lib/chingu/window.rb"]
+  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "benchmarks/README.txt", "benchmarks/benchmark.rb", "benchmarks/benchmark3.rb", "benchmarks/benchmark4.rb", "benchmarks/benchmark5.rb", "benchmarks/benchmark6.rb", "benchmarks/meta_benchmark.rb", "benchmarks/meta_benchmark2.rb", "chingu.gemspec", "examples/example1.rb", "examples/example10.rb", "examples/example11.rb", "examples/example12.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/game1.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/bullet.png", "examples/media/bullet_hit.wav", "examples/media/city1.csv", "examples/media/city1.png", "examples/media/city2.png", "examples/media/droid.bmp", "examples/media/enemy_bullet.png", "examples/media/explosion.wav", "examples/media/fire_bullet.png", "examples/media/fireball.png", "examples/media/laser.wav", "examples/media/particle.png", "examples/media/plane.csv", "examples/media/plane.png", "examples/media/ruby.png", "examples/media/saucer.csv", "examples/media/saucer.gal", "examples/media/saucer.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/basic_game_object.rb", "lib/chingu/core_extensions.rb", "lib/chingu/fpscounter.rb", "lib/chingu/game_object.rb", "lib/chingu/game_object_list.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/helpers/game_object.rb", "lib/chingu/helpers/game_state.rb", "lib/chingu/helpers/gfx.rb", "lib/chingu/helpers/input_client.rb", "lib/chingu/helpers/input_dispatcher.rb", "lib/chingu/helpers/rotation_center.rb", "lib/chingu/high_score.rb", "lib/chingu/inflector.rb", "lib/chingu/input.rb", "lib/chingu/named_resource.rb", "lib/chingu/parallax.rb", "lib/chingu/particle.rb", "lib/chingu/rect.rb", "lib/chingu/require_all.rb", "lib/chingu/text.rb", "lib/chingu/traits/collision_detection.rb", "lib/chingu/traits/effect.rb", "lib/chingu/traits/retrofy.rb", "lib/chingu/traits/timer.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"]
   s.rubyforge_project = %q{chingu}
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Game framework built on top of the OpenGL accelerated game lib Gosu}
+  s.summary = %q{OpenGL accelerated 2D game framework for Ruby}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/chingu.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -26,7 +26,8 @@ require 'rubygems' unless RUBY_VERSION =~ /1\.9/
 require 'gosu'
 require File.join(CHINGU_ROOT,"chingu","require_all") # Thanks to http://github.com/tarcieri/require_all !
 require_all "#{CHINGU_ROOT}/chingu"
+#autoload :OpenStruct, "ostruct"
 
 module Chingu
-  VERSION = "0.5.8"
+  VERSION = "0.5.8.1"
 end

data/lib/chingu/animation.rb

@@ -3,7 +3,11 @@ module Chingu
   # The Animation-class helps you load and manage a tileanimation.
   # A Tileanimation is a file where all the frames are put after eachother.
   #
-  # An easy to use program to create tileanimations is http://tilestudio.sourceforge.net/
+  # An easy to use program to create tileanimations is http://tilestudio.sourceforge.net/ or http://www.humanbalance.net/gale/us/
+  #
+  # TODO: 
+  # Support frames in invidual image-files?
+  # Is autodetection of width / height possible? 
   #
   class Animation
     attr_accessor :frames, :delay
@@ -13,7 +17,7 @@ module Chingu
     #
     #   - loop: [true|false]. After the last frame is used, start from the beginning.
     #   - bounce: [true|false]. After the last frame is used, play it backwards untill the first frame is used again, then start playing forwards again.
-    #   - file:   Tile-file to cut up animation frames from.
+    #   - file:   Tile-file to cut up animation frames from. Could be a full path or just a name -- then it will look for media_path(file)
     #   - width:  width of each frame in the tileanimation
     #   - height:  width of each frame in the tileanimation
     #   - size: [x,y] specify width/height with 1 argument (an array)

data/lib/chingu/core_extensions.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/fpscounter.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/game_object.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/game_object_list.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/game_state.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/game_state_manager.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -108,11 +108,13 @@ module Chingu
         # Make sure the game state knows about the manager
         new_state.game_state_manager = self
         
-        
         # Give the soon-to-be-disabled state a chance to clean up by calling finalize() on it.
         @previous_game_state = current_game_state
         current_game_state.finalize   if current_game_state.respond_to?(:finalize) && options[:finalize]
         
+        # So BasicGameObject#create connects object to new state in its setup()
+        self.inside_state = new_state
+        
         # Call setup
         new_state.setup               if new_state.respond_to?(:setup) && options[:setup]
         
@@ -128,7 +130,7 @@ module Chingu
             @game_states[-1] = new_state
           end
         end
-        self.inside_state = current_game_state
+        ## MOVEDE: self.inside_state = current_game_state
       end
     end
     alias :switch :switch_game_state
@@ -144,6 +146,10 @@ module Chingu
       new_state = game_state_instance(state)
             
       if new_state
+        
+        # So BasicGameObject#create connects object to new state in its setup()
+        self.inside_state = new_state
+        
         # Call setup
         new_state.setup               if new_state.respond_to?(:setup) && options[:setup]
         
@@ -162,7 +168,7 @@ module Chingu
           # Push new state on top of stack and therefore making it active
           @game_states.push(new_state)
         end
-        self.inside_state = current_game_state
+        ## MOVED: self.inside_state = current_game_state
       end
     end
     alias :push :push_game_state
@@ -185,7 +191,10 @@ module Chingu
       # Activate the game state "bellow" current one with a simple Array.pop
       #
       @game_states.pop
-        
+      
+      # So BasicGameObject#create connects object to new state in its setup()
+      self.inside_state = current_game_state
+      
       # Call setup on the new current state
       current_game_state.setup       if current_game_state.respond_to?(:setup) && options[:setup]
       
@@ -194,7 +203,7 @@ module Chingu
         transitional_game_state = @transitional_game_state.new(current_game_state, @transitional_game_state_options)
         self.switch_game_state(transitional_game_state, :transitional => false)
       end
-      self.inside_state = current_game_state
+      ## MOVED: self.inside_state = current_game_state
     end
     alias :pop :pop_game_state
 

data/lib/chingu/game_states/debug.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,12 +19,12 @@
 #
 #++
 
-
-#
-# Debug game state (F1 is default key to start/exit debug win, 'p' to pause game)
-#
-module Chingu
+module Chingu  
   module GameStates
+  
+    #
+    # Debug game state (F1 is default key to start/exit debug win, 'p' to pause game)
+    #  
     class Debug < Chingu::GameState
       def initialize(options)
         super

data/lib/chingu/game_states/fade_to.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -20,18 +20,19 @@
 #++
 
 
-#
-# Premade game state for chingu - Fade between two game states
-# Fade from the current game state to a new one whenever with: 
-#
-#   push_game_state(Chingu::GameStates::FadeTo.new(new_game_state, :speed => 3))
-#
-# .. Or make your whole game look better with 1 line:
-#
-#   transitional_game_state(Chingu::GameStates::FadeTo, :speed => 10)
-#
 module Chingu
   module GameStates
+  
+    #
+    # Premade game state for chingu - Fade between two game states
+    # Fade from the current game state to a new one whenever with: 
+    #
+    #   push_game_state(Chingu::GameStates::FadeTo.new(new_game_state, :speed => 3))
+    #
+    # .. Or make your whole game look better with 1 line:
+    #
+    #   transitional_game_state(Chingu::GameStates::FadeTo, :speed => 10)
+    #
     class FadeTo < Chingu::GameState
       
       def initialize(new_game_state, options = {})
@@ -65,7 +66,7 @@ module Chingu
       end
       
       def draw
-        # Stop endless loops
+        # Stop possible endless loops
         if @drawn == false
           @drawn = true
           

data/lib/chingu/game_states/pause.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,17 +19,16 @@
 #
 #++
 
-
-
-#
-# Premade game state for chingu - A simple pause state.
-# Pause whenever with: 
-#   push_game_state(Chingu::GameStates::Pause)
-#
-# requires global $window
-#
 module Chingu
   module GameStates
+  
+    #
+    # Premade game state for chingu - A simple pause state.
+    # Pause whenever with: 
+    #   push_game_state(Chingu::GameStates::Pause)
+    #
+    # requires the global $window set to the instance of Gosu::Window (automaticly handled if you use Chingu::Window)
+    #
     class Pause < Chingu::GameState
       def initialize(options = {})
         super

data/lib/chingu/helpers/game_object.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Helpers
   

data/lib/chingu/helpers/gfx.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Helpers
     

data/lib/chingu/helpers/input_client.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Helpers
   

data/lib/chingu/helpers/input_dispatcher.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Helpers
   

data/lib/chingu/helpers/rotation_center.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Helpers
     module RotationCenter

data/lib/chingu/high_score.rb

@@ -0,0 +1,60 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+
+module Chingu
+
+  #
+  # Highscore-class
+  #
+  # - Keeps a local YAML file with highscores, default highscores.yml in root game dir.
+  # - Add, delete, clear highscores
+  # - Iterate through highscores with simple Highscore#each
+  #
+  class HighScore
+    def initialize(options = {})
+      @file = options[:file] || "high_scores.yml"
+      @high_scores = Array.new
+      
+      #OpenStruct.new()
+    end
+    
+    #
+    # 
+    #
+    def add(name, score)
+      
+    end
+    alias << add
+    
+    def each
+      @highscores.each { |highscore| yield highscore }
+    end
+
+    def save
+    end
+  
+    def self.all
+    
+    end
+  end
+
+end

data/lib/chingu/inflector.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or

data/lib/chingu/input.rb

@@ -1,3 +1,24 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
 module Chingu
 	module Input
 		include Gosu::Button

data/lib/chingu/parallax.rb

@@ -1,9 +1,35 @@
+#--
 #
-# Class for simple parallaxscrolling
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
-# See: http://en.wikipedia.org/wiki/Parallax_scrolling
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
 #
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
 module Chingu
+  #
+  # Class for simple parallaxscrolling
+  #
+  # See http://en.wikipedia.org/wiki/Parallax_scrolling for information about parallaxscrolling.
+  #
+  # Basic usage:
+  #   @parallax = Chingu::Parallax.create(:x => 0, :y => 0)
+  #   @parallax << Chingu::ParallaxLayer.new(:image => "far_away_mountins.png", :damping => 20, :center => 0)
+  #   @parallax << Chingu::ParallaxLayer.new(:image => "trees.png", :damping => 5, :center => 0)
+  #
   class Parallax < Chingu::GameObject
     attr_reader :layers
 

data/lib/chingu/text.rb

@@ -1,3 +1,24 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
 module Chingu
   #
   # Text is a class to give the use of Gosu::Font more rubyish feel and fit it better into Chingu.

data/lib/chingu/traits/collision_detection.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Traits
     #

data/lib/chingu/traits/effect.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Traits
   
@@ -30,9 +29,9 @@ module Chingu
     #   fade(amount)    # modifies @color.alpha
     # 
     # Also adds attributes
-    #   rotation_rate=amount   # adds amount to @angle each game loop
-    #   scale_rate=amount      # adds amount to @factor_x and @factor_y each game loop
-    #   fade_rate=amount       # adds amount to @color.alpha each game loop
+    #   rotation_rate = amount   # adds amount to @angle each game loop
+    #   scale_rate = amount      # adds amount to @factor_x and @factor_y each game loop
+    #   fade_rate = amount       # adds amount to @color.alpha each game loop
     #
     #
     # WARNING, I'm very close to deprecating this trait, it doesn't do much and still introduces new names to learn.

data/lib/chingu/traits/retrofy.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Traits
     #

data/lib/chingu/traits/timer.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,9 +19,9 @@
 #
 #++
 
-
 module Chingu
   module Traits
+  
     #
     # A chingu trait providing timer-methods to its includer, examples:
     #   during(300) { @color = Color.new(0xFFFFFFFF) }   # forces @color to white ever update for 300 ms

data/lib/chingu/traits/velocity.rb

@@ -1,6 +1,6 @@
 #--
 #
-# Chingu -- Game framework built on top of the opengl accelerated gamelib Gosu
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
 # Copyright (C) 2009 ippa / ippa@rubylicio.us
 #
 # This library is free software; you can redistribute it and/or
@@ -19,7 +19,6 @@
 #
 #++
 
-
 module Chingu
   module Traits
     #

data/lib/chingu/window.rb

@@ -1,5 +1,37 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
 module Chingu
 
+  #
+  # See http://www.libgosu.org/rdoc/classes/Gosu/Window.html
+  #
+  # On top of that we add:
+  # - Default widht / height, --fullscreen option from console
+  # - Sets a global variable $window = self, which is then used throughout Chingu
+  # - Defaultd #update which updates all game_objects which are not pasued
+  # - Default #draw which draws all game_objects which are visible
+  # - Default Asset-directories media/, sfx/, gfx/ etc.
+  # - Tracking of button_up/button_down etc to enable Chingus pretty inputhandling
+  #
   class Window < Gosu::Window
     include Chingu::Helpers::GFX                # Adds fill(), fade() etc to each game state
     include Chingu::Helpers::GameState          # Easy access to the global game state-queue
@@ -9,16 +41,6 @@ module Chingu
     
     attr_reader :root, :game_state_manager, :game_objects, :milliseconds_since_last_tick
     
-    #
-    # See http://www.libgosu.org/rdoc/classes/Gosu/Window.html
-    #
-    # On top of that we add:
-    # - Default widht / height, --fullscreen option from console
-    # - Global variable $window
-    # - Standard #update which updates all Chingu::GameObject's 
-    # - Standard #draw which goes through 
-    # - Assethandling with Image["picture.png"] and Sample["shot.wav"]
-    #
     def initialize(width = 800, height = 600, fullscreen = false, update_interval = 16.666666)
       fullscreen ||= ARGV.include?("--fullscreen")
       $window = super(width, height, fullscreen, update_interval)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chingu
 version: !ruby/object:Gem::Version 
-  version: 0.5.8
+  version: 0.5.8.1
 platform: ruby
 authors: 
 - ippa
@@ -30,7 +30,7 @@ cert_chain:
   hxtMlw==
   -----END CERTIFICATE-----
 
-date: 2009-10-18 00:00:00 +02:00
+date: 2009-10-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,8 @@ dependencies:
         version: 2.3.3
     version: 
 description: |-
-  Game framework built on top of the OpenGL accelerated game lib Gosu. 
+  OpenGL accelerated 2D game framework for Ruby.
+  Builds on the awesome Gosu (Ruby/C++) which provides all the core functionality.
   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.
 email: 
 - ippa@rubylicio.us
@@ -130,6 +131,7 @@ files:
 - lib/chingu/helpers/input_client.rb
 - lib/chingu/helpers/input_dispatcher.rb
 - lib/chingu/helpers/rotation_center.rb
+- lib/chingu/high_score.rb
 - lib/chingu/inflector.rb
 - lib/chingu/input.rb
 - lib/chingu/named_resource.rb
@@ -172,6 +174,6 @@ rubyforge_project: chingu
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Game framework built on top of the OpenGL accelerated game lib Gosu
+summary: OpenGL accelerated 2D game framework for Ruby
 test_files: []