ippa-chingu 0.5.2.1 → 0.5.3

data/Manifest.txt

@@ -47,6 +47,7 @@ lib/chingu/game_states/fade_to.rb
 lib/chingu/game_states/pause.rb
 lib/chingu/gfx_helpers.rb
 lib/chingu/helpers.rb
+lib/chingu/inflector.rb
 lib/chingu/input.rb
 lib/chingu/named_resource.rb
 lib/chingu/parallax.rb
@@ -58,5 +59,6 @@ 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/rotation_center.rb
 lib/chingu/traits/velocity.rb
 lib/chingu/window.rb

data/README.rdoc

@@ -5,8 +5,7 @@ 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.
+This is still a rather young project, core classes and naming can still change.
 
 == INSTALL
   gem sources -a http://gems.github.com
@@ -29,11 +28,13 @@ There was always a huge big chunk of checking keyboard-events in the main loop.
 Borrowing ideas from Rubygame this has now become @player.keyboard(:left => :move_left, :space => :fire ... etc.
 
 
-== OVERVIEW
-Chingu consists of the following core classes:
+== CORE OVERVIEW
+Chingu consists of the following core classes / concepts:
 
 === Chingu::Window
-The main window, use it at you use Gosu::Window.
+The main window, use it at you use Gosu::Window now. Calcs the framerate, takes care of states, 
+handles chingu-formated input, updates and draws BasicGameObject / GameObjects automaticly.
+Available thoughout your source as $window (Yes, that's the only global Chingu has).
 
 === Chingu::GameObject
 Use this for all your in game objects. The player, the enemies, the bullets, the powerups, the loot laying around.
@@ -44,11 +45,8 @@ 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.
+It _can_ be extended with Chingus trait-system though.
+BasicGameObject#parent points to either $window or a game state and is automaticly set on creation time.
 
 === Chingu::GameStateManager
 Keeps track of the game states. Implements a stack-based system with push_game_state and pop_game_state.
@@ -62,14 +60,40 @@ 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.
 
+=== Traits
+Traits are extensions (or plugins if you so will) to BasicGameObjects. 
+The aim is so encapsulate common behaivor into stand alone classes and modules for easy inclusion in your game classes.
+In it's most basic form it's just a class which answers to setup() (called on your game objects creation), update() and draw().
+Traits are a fairly new addition to Chingu and will probably morph some more before stabilizing. 
+
+
+== OTHER CLASSES / HELPERS
+
+=== Chingu::Text
+Makes use of Gosu::Font more rubyish and powerful.
+In it's core, another Chingu::GameObject + Gosu::Font.
+
 === 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
+=== Chingu::Parallax
 A class for easy paralaxxscrolling. See example3.rb for more.
 
-== THE BASICS
+=== Various Helpers
+Both $window and game states gets some new graphical helpers, currently only 3, but quite useful:
+
+fill()          # Fills whole window with color 'color'.
+fill_rect()     # Fills a given Rect 'rect' with Color 'color'
+fill_gradient() # Fills window or a given rect with a gradient between two colors.
+
+If you base your models on GameObject (or BasicGameObject) you get:
+Enemy.all                 # Returns all object based on this class
+Enemy.each                # Iterates through all objects of class Enemt.
+Enemy.destroy_if(&block)  # destroy all objects for which &block returns true
+
+
+== BASICS / EXAMPLES
 
 === Chingu::Window
 With Gosu the main window inherits from Gosu::Window. In Chingu we use Chingu::Window. It's a basic Gosu::Window with extra cheese on top of it. keyboard handling, automatic update/draw calls to all gameobjects, fps counting etc.
@@ -444,7 +468,7 @@ See http://www.libgosu.org/rdoc/classes/Gosu/Window.html for a full set of metho
 
 == TODO:
 * add :padding and :align => :topleft etc to class Text
-* rename Chingu::Window so 'include Chingu' and 'include Gosu' wont make Window collide
+* (skip) 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"
@@ -460,19 +484,19 @@ See http://www.libgosu.org/rdoc/classes/Gosu/Window.html for a full set of metho
 * (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
+* (done) More examples when effects are more complete
 * class ChipmunkObject
-* class Actor/MovingActor with maybe a bit more logic then the basic GameObject. Would ppl find is useful?
+* (has_trait :velocity :p..) 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"
 * (10% done) Make it possible for ppl to use the parts of Chingu they like
 * (done) At least make GameStateManager really easy to use with pure Gosu / Document it!
-* 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"
 * (skipping) intergrate MovieMaker - solve this with traits instead.
+* A more robust game state <-> game_object system to connect them together.
 * FIX example4: :p => Pause.new  would Change the "inside_game_state" to Pause and make @player belong to Pause.
 
 == WHY?

data/chingu.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.5.2.1"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
 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", "Manifest.txt", "README.rdoc", "Rakefile", "benchmarks/README.txt", "benchmarks/benchmark.rb", "benchmarks/benchmark3.rb", "benchmarks/benchmark4.rb", "benchmarks/meta_benchmark.rb", "benchmarks/meta_benchmark2.rb", "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.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "benchmarks/README.txt", "benchmarks/benchmark.rb", "benchmarks/benchmark3.rb", "benchmarks/benchmark4.rb", "benchmarks/meta_benchmark.rb", "benchmarks/meta_benchmark2.rb", "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/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/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/rotation_center.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

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

data/examples/example2.rb

@@ -24,8 +24,6 @@ end
 # Our Player
 #
 class Player < Chingu::GameObject
-  has_trait :input
-
   def initialize(options = {})
     super
     @image = Image["spaceship.png"]

data/examples/example4.rb

@@ -40,8 +40,6 @@ end
 
 # Our Player 
 class Player < Chingu::GameObject
-  has_trait :input
-  
   def initialize(options = {})
     super
     @image = Image["spaceship.png"]

data/lib/chingu.rb

@@ -11,12 +11,14 @@ require 'set'
     effect
     velocity
     input
+    rotation_center
 		}.each do |lib|
       root ||= File.dirname(File.expand_path(__FILE__))
       require File.join(root,"chingu","traits",lib)
     end
 
 %w{	helpers
+    inflector
     gfx_helpers
     core_extensions
     basic_game_object
@@ -49,5 +51,5 @@ require 'set'
     end
 
 module Chingu
-  VERSION = "0.5.2.1"
+  VERSION = "0.5.3"
 end

data/lib/chingu/animation.rb

@@ -6,7 +6,7 @@ module Chingu
   # An easy to use program to create tileanimations is http://tilestudio.sourceforge.net/
   #
   class Animation
-    attr_accessor :frames
+    attr_accessor :frames, :delay
     
     #
     # Create a new Animation. 

data/lib/chingu/basic_game_object.rb

@@ -36,7 +36,7 @@ module Chingu
       Array(traits).each do |trait|
         
         if trait.is_a?(::Symbol) || trait.is_a?(::String)
-          string = "Chingu::Traits::#{trait.to_s.downcase.capitalize}"
+          string = "Chingu::Traits::#{Chingu::Inflector.camelize(trait)}"
           klass_or_module = eval(string)
           
           if klass_or_module.is_a?(Class)
@@ -48,8 +48,7 @@ module Chingu
         end
       end
     end
-
-    
+        
     #
     # BasicGameUnit initialize
     #

data/lib/chingu/game_object.rb

@@ -7,51 +7,8 @@ module Chingu
 
   class GameObject < Chingu::BasicGameObject
     attr_accessor :image, :x, :y, :angle, :center_x, :center_y, :factor_x, :factor_y, :color, :mode, :zorder
-    
-    #
-    # returns [center_x, center_y]
-    #
-    @@rotation_centers = {
-      :top_left => [0,0],
-      :left_top => [0,0],
-      
-      :center_left => [0,0.5],
-      :left_center => [0,0.5],
-      
-      :bottom_left => [0,1],
-      :left_bottom => [0,1],
-      
-      :top_center => [0.5,0],
-      :center_top => [0.5,0],
-      
-      :center_center => [0.5,0.5],
-      :center => [0.5,0.5],
-      
-      :bottom_center => [0.5,1],
-      :center_bottom => [0.5,1],
-      
-      :top_right => [1,0],
-      :right_top => [1,0],
-      
-      :center_right => [1,0.5],
-      :right_center => [1,0.5],
-      
-      :bottom_right => [1,1],
-      :right_bottom => [1,1]
-    }
-    
-    #
-    # Sets @center_x and @center_y according to given alignment. Available alignments are:
-    #
-    #   :top_left, :center_left, :bottom_left, :top_center, 
-    #   :center_center, :bottom_center, :top_right, :center_right and :bottom_right
-    #
-    # They're also available in the opposite order with the same meaning.
-    #
-    def rotation_center(alignment)
-      @center_x, @center_y = @@rotation_centers[alignment.to_sym]
-    end
-    
+    has_trait :input, :rotation_center
+        
     def initialize(options = {})
       super
 
@@ -115,6 +72,7 @@ module Chingu
       not inside_window?(x,y)
     end
     
+    # Calculates the distance from self to a given objevt
     def distance_to(object)
       distance(self.x, self.y, object.x, object.y)
     end

data/lib/chingu/inflector.rb

@@ -0,0 +1,12 @@
+module Chingu
+  module Inflector    
+    def Inflector.camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+      else
+        lower_case_and_underscored_word.first.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+
+  end
+end

data/lib/chingu/traits/rotation_center.rb

@@ -0,0 +1,62 @@
+module Chingu
+  module Traits
+    module RotationCenter
+      #
+      # returns [center_x, center_y] (see Gosu::Image#draw_rot)
+      # 
+      @@rotation_centers = {
+        :top_left => [0,0],
+        :left_top => [0,0],
+        
+        :center_left => [0,0.5],
+        :middle_left => [0,0.5],
+        :left_center => [0,0.5],
+        :left_middle => [0,0.5],
+        
+        :bottom_left => [0,1],
+        :left_bottom => [0,1],
+        
+        :top_center => [0.5,0],
+        :top_middle => [0.5,0],
+        :center_top => [0.5,0],
+        :middle_top => [0.5,0],
+        
+        :center_center => [0.5,0.5],
+        :middle_middle => [0.5,0.5],
+        :center => [0.5,0.5],
+        :middle => [0.5,0.5],
+        
+        :bottom_center => [0.5,1],
+        :bottom_middle => [0.5,1],
+        :center_bottom => [0.5,1],
+        :middle_bottom => [0.5,1],
+        
+        :top_right => [1,0],
+        :right_top => [1,0],
+        
+        :center_right => [1,0.5],
+        :middle_right => [1,0.5],
+        :right_center => [1,0.5],
+        :right_middle => [1,0.5],
+        
+        :bottom_right => [1,1],
+        :right_bottom => [1,1]
+      }
+    
+      #
+      # Sets @center_x and @center_y according to given alignment. Available alignments are:
+      #
+      #   :top_left, :center_left, :bottom_left, :top_center, 
+      #   :center_center, :bottom_center, :top_right, :center_right and :bottom_right
+      #
+      # They're also available in the opposite order with the same meaning.
+      # They're also available (hey, hashlookups are speedy) with "middle" instead of "center" since
+      # those 2 words basicly have the same meaning and are both understandable.
+      #
+      def rotation_center(alignment)
+        @center_x, @center_y = @@rotation_centers[alignment.to_sym]
+      end
+      
+    end
+  end
+end

data/lib/chingu/window.rb

@@ -107,12 +107,12 @@ module Chingu
       
       
       #
-      # Call update(milliseconds_since_last_tick) on all game objects belonging to the main window.
+      # Call update() on all game objects belonging to the main window.
       #
       update_game_objects
       
       #
-      # Call update(milliseconds_since_last_tick) on all game objects belonging to the current game state.
+      # Call update() on all game objects belonging to the current game state.
       #
       update_game_state_manager
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ippa-chingu
 version: !ruby/object:Gem::Version 
-  version: 0.5.2.1
+  version: 0.5.3
 platform: ruby
 authors: 
 - ippa
@@ -83,6 +83,7 @@ files:
 - lib/chingu/game_states/pause.rb
 - lib/chingu/gfx_helpers.rb
 - lib/chingu/helpers.rb
+- lib/chingu/inflector.rb
 - lib/chingu/input.rb
 - lib/chingu/named_resource.rb
 - lib/chingu/parallax.rb
@@ -94,10 +95,12 @@ files:
 - lib/chingu/traits/deprecated_visual.rb
 - lib/chingu/traits/effect.rb
 - lib/chingu/traits/input.rb
+- lib/chingu/traits/rotation_center.rb
 - lib/chingu/traits/velocity.rb
 - lib/chingu/window.rb
 has_rdoc: false
 homepage: http://github.com/ippa/chingu/tree/master
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -119,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: chingu
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Game framework built on top of the OpenGL accelerated game lib Gosu