gamebox 0.0.7 → 0.0.8

data/.gitignore

@@ -0,0 +1,6 @@
+pkg
+*.swp
+*.log
+doc
+coverage
+.DS_Store

data/History.txt

@@ -61,3 +61,9 @@
 * new major ruby platformer example
 * merged Mode/Level into Stage
 * added curtain transitions
+
+=== 0.0.8 / 2010-02-05
+
+* Cleaning up APIs
+* Adding basic collision detection system
+* added timers to stage for calling blocks on an interval

data/Rakefile

@@ -1,25 +1,27 @@
-require 'rubygems'
-gem 'hoe', '>= 2.3.0'
-require 'hoe'
-
-require File.dirname(__FILE__)+'/lib/gamebox/version'
-Hoe.spec 'gamebox' do
-  developer('Shawn Anderson', 'shawn42@gmail.com')
-  developer('Jason Roelofs', 'jameskilton@gmail.com')
-  developer('Karlin Fox', 'karlin.fox@gmail.com')
-  description = "Framework for building and distributing games using Rubygame"
-  email = 'shawn42@gmail.com'
-  summary = "Framework for building and distributing games using Rubygame"
-  url = "http://shawn42.github.com/gamebox"
-  self.version = Gamebox::VERSION::STRING
-  changes = paragraphs_of('History.txt', 12..13).join("\n\n")
-  extra_deps << ['constructor']
-  extra_deps << ['publisher']
-  extra_deps << ['rspec']
-  if extra_rdoc_files
-    extra_rdoc_files << 'docs/getting_started.rdoc' 
+begin
+  require 'jeweler'
+  require File.dirname(__FILE__)+'/lib/gamebox/version'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gamebox"
+    gem.executables = "gamebox"
+    gem.rubyforge_project = "gamebox"
+    gem.summary = %Q{Framework for building and distributing games using Rubygame}
+    gem.description = %Q{Framework for building and distributing games using Rubygame}
+    gem.email = "shawn42@gmail.com"
+    gem.homepage = "http://shawn42.github.com/gamebox"
+    gem.authors = ["Shawn Anderson","Jason Roelofs","Karlin Fox"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "jeweler"
+    gem.add_dependency 'rubygame'
+    gem.add_dependency 'constructor'
+    gem.add_dependency 'publisher'
+    gem.files.exclude 'examples'
+    gem.test_files = FileList['{spec,test}/**/*.rb']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
-  remote_rdoc_dir = ' ' # Release to root
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 STATS_DIRECTORIES = [
@@ -34,9 +36,10 @@ end
 
 require 'spec/rake/spectask'
 desc "Run all rspecs"
-Spec::Rake::SpecTask.new('rspec') do |t|
+Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/*_spec.rb']
 end
+task :default => :spec
 
 desc "Run rcov rspecs"
 Spec::Rake::SpecTask.new('rcov_rspec') do |t|
@@ -44,6 +47,5 @@ Spec::Rake::SpecTask.new('rcov_rspec') do |t|
   t.rcov = true
   t.rcov_opts = ['--exclude', 'examples']
 end
-task :default => :rspec
 
 # vim: syntax=Ruby

data/TODO.txt

@@ -1,9 +1,11 @@
 planned features:
 add network manager stub
 highscore upload system (use from chingu)
-FIX:add some kind of fade in/out for actors w/ smooth interpolation
-add basic generator for things like actors/levels/etc with tests
-add while key down K_UP callback?
+
+change update system to 
+on_update do |time|
+  # do stuff?
+end
 
 allow easy pausing of game and physics
   - fire :pause event w/ a new Director of actors? 

data/VERSION

@@ -0,0 +1 @@
+0.0.8

data/bin/gamebox

@@ -51,13 +51,13 @@ Dir.mkdir(TARGET_DIR) unless File.exist?(TARGET_DIR) && File.directory?(TARGET_D
 Dir.mkdir(TARGET_DIR + "/config")
 Dir.mkdir(TARGET_DIR + "/data")
 Dir.mkdir(TARGET_DIR + "/data/graphics")
-Dir.mkdir(TARGET_DIR + "/data/sound")
+Dir.mkdir(TARGET_DIR + "/data/sounds")
 Dir.mkdir(TARGET_DIR + "/data/music")
 Dir.mkdir(TARGET_DIR + "/doc")
 Dir.mkdir(TARGET_DIR + "/lib")
 Dir.mkdir(TARGET_DIR + "/script")
 Dir.mkdir(TARGET_DIR + "/src")
-Dir.mkdir(TARGET_DIR + "/test")
+Dir.mkdir(TARGET_DIR + "/spec")
 
 Dir.chdir(SOURCE_DIR + "/template_app")
 Dir.glob("**/*").each do |file|

data/docs/CODE_REVIEW

@@ -0,0 +1,48 @@
+1) Lots more documentation. All public methods and All classes need rdoc, including example usage where applicable
+
+2) Other non-code documentation:
+  - Gamebox convensions (data dir is the big one)
+  - High level: what is a Stage, Actor, Director, etc, the description of the concepts Gamebox uses
+  - update / render loop
+  - Parallax and view layers
+  - Publisher usage. how why and where
+
+actor.rb
+ * visibility should be a part of graphical
+
+behavior.rb
+ * To reiterate the documentation point, given that Behaviors are the core of Gamebox, this class will need a
+    lot of documentation on what they are, why it's done this way, how to make your own, etc.
+
+physics.rb
+ * Potential confusion with #add_collision_func. The comment implies that :foo and :bar won't be registerd to collide, nor will :baz or :yar. Would it make more sense to change the signature to:
+
+     add_collision_func(*these_things, *can_collide_with) 
+  
+   or make it just a straight *args and Gamebox will register all permutations of the given arguments?
+
+resource_manager.rb
+ * Potentially doing too much? Split out font, sound, image loading into seperate manager subclasses?
+
+stage.rb
+ * create_actors_from_svg sounds more like a resource manager job than the stage
+
+views/graphical_actor_view.rb
+ * seems to handle too much. This class shouldn't care about physics, possibly have a PhysicalActorView instead for rendering according to Chipmunk?
+
+
+notes:
+
+ - Auto dependency detection and resolution for behaviors
+
+ - Possible implementation for dynamic behavior parameters (see mjr_ruby background.rb)
+   * In line w/ procs that get evaluated later:
+      has_behaviors :graphical => {:tiled => true, :num_x_tiles => proc{|alksjdfla| alkdjfasd }
+   * Can set later
+      has_behaviors :graphical => {:tiled => true}
+
+      def setup
+         self.graphical.num_x_tiles = ...
+          ...
+      end
+

data/docs/getting_started.rdoc

@@ -18,7 +18,7 @@ The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing com
   - rubygame (all of its dependencies)
   - constructor
   - publisher
-  - bacon for unit tests
+  - rspec for unit tests
 
 == Game Creation
 
@@ -31,6 +31,7 @@ The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing com
 	|   |-- boot.rb
 	|   |-- environment.rb
 	|   |-- game.yml
+	|   |-- gamebox_generator_version.yml
 	|   `-- stage_config.yml
 	|-- data
 	|   |-- fonts
@@ -46,13 +47,16 @@ The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing com
 	|-- lib
 	|   |-- code_statistics.rb
 	|   `-- platform.rb
-	|-- script
-	|-- src
-	|   |-- app.rb
-	|   |-- demo_level.rb
-	|   |-- game.rb
-	|   `-- my_actor.rb
-	`-- test
+  |-- script
+  |   `-- generate
+  |-- spec
+  |   `-- helper.rb
+	`-- src
+	    |-- app.rb
+	    |-- demo_stage.rb
+	    |-- game.rb
+	    `-- my_actor.rb
+
 - you now have a runnable gamebox game
 
 	cd zapper
@@ -64,7 +68,7 @@ An Actor is the base class for any game object. A building, the player, the scor
 
 So Actors sound fun, how do I get one? That's where the ActorFactory comes in. In your Level class (demo_level.rb by default) you can use the create_actor helper method as shown below.
 
-	@score = create_actor :score, :x => 10, :y => 10
+	@score = spawn :score, :x => 10, :y => 10
 	
 This call will return an instance of the Score class (the first arg is the symbolized version of the classname). The ActorFactory will try to require the symbolized class name for you.  It will also create the view for the actor and register it to be drawn.  Which view is instantiated depends on the actor requested.  The factory will always look for a class named the same as the actor with View on the end. So the actor Score will look for ScoreView.  If ScoreView does not exist, a generic view class will be used based on the behaviors of the actor. Each ActorView class is constructed with a reference to the actor it is displaying. See ActorFactor#build for more details.
 
@@ -76,7 +80,7 @@ That's great, but how do I tell my actors what to do?  They can register for eve
 
 == Sound
 
-There are two ways to play sounds in Gamebox. From your level you can simple access the SoundManager via the @sound_manager instance variable. From your actors, you can play sounds via the play_sound helper method.
+There are two ways to play sounds in Gamebox. From your stage you can simple access the SoundManager via the sound_manager method. From your actors, you can play sounds via the play_sound helper method in the audible behavior.
 
 	# music
 	sound_manager.play_music :overworld
@@ -87,6 +91,7 @@ There are two ways to play sounds in Gamebox. From your level you can simple acc
 or
 
 	# from an actor
+  has_behavior :audible
 	play_sound :jump
 
 == Resources
@@ -113,8 +118,7 @@ This snippet show us that our Actor wants to be updated on every gameloop and th
 	            |   |-- 2.png
 	            |   |-- ...
 	            |   `-- 8.png
-	            |-- idle
-	            |   `-- 1.png
+	            |-- idle.png
 	            `-- walking
 	                |-- 1.png
 	                `-- 2.png
@@ -129,9 +133,21 @@ The animation will cycle through all the numbered png files for the current acti
   batman.stop_animating
 
 
-Animated and Updatable are just two behaviors available in Gamebox. Other include	graphical, layered, and physical. You can easily add your own game specific behaviors by extending Behavior. (see Wanderer in rague example).
+Animated and Updatable are just two behaviors available in Gamebox. Other include	graphical, audible, layered, and physical. You can easily add your own game specific behaviors by extending Behavior. (see Wanderer in rague example for a simple behavior).
 
-== Levels
 == Stages
+
+A Stage is where all the magic happens. A Stage can be any gameplay mode in your game. The main menu has a different interactions than the _real_ game.  In Gamebox, each should have their own Stage. Stages are configured via the stage_config.yml file in config. Listing :demo there will create DemoStage for you.  Game.rb decides which stage to start on. 
+
+== StageManager
+
+So how do these actors end up on the screen? The StageManager. The stage manager handles contruction of new stages and drawing their actors too. Gamebox has built-in support for parallaxing. Parallax layers denote this distance from the audience an Actor should be.  The clouds in the sky that are really far away can be set to INFINITY to have them not move at all as the viewport moves.  Each parallax layer has layers to allow Actors to be on top of one another, but have the same distance from the audience.  The StageManager respects Actor's layered behaviors, if specified. If no layer is specified, the StageManager puts the Actor on parallax layer one of layer one. Example layered behavior:
+
+  has_behavior :layered => {:parallax => 30, :layer => 2}
+
+This Actor will be 30 layers away from the audience, and will sit on top of anything in parallax layer 30 that has layer less than 2.
+
+
+== Publisher
 == Physics
 == SVG Levels

data/gamebox.gemspec

@@ -0,0 +1,184 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gamebox}
+  s.version = "0.0.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shawn Anderson", "Jason Roelofs", "Karlin Fox"]
+  s.date = %q{2010-02-18}
+  s.default_executable = %q{gamebox}
+  s.description = %q{Framework for building and distributing games using Rubygame}
+  s.email = %q{shawn42@gmail.com}
+  s.executables = ["gamebox"]
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "README.txt",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION",
+     "bin/gamebox",
+     "docs/CODE_REVIEW",
+     "docs/getting_started.rdoc",
+     "docs/logo.png",
+     "gamebox.gemspec",
+     "lib/gamebox.rb",
+     "lib/gamebox/actor.rb",
+     "lib/gamebox/actor_factory.rb",
+     "lib/gamebox/actor_view.rb",
+     "lib/gamebox/actors/curtain.rb",
+     "lib/gamebox/actors/label.rb",
+     "lib/gamebox/actors/logo.rb",
+     "lib/gamebox/actors/score.rb",
+     "lib/gamebox/actors/svg_actor.rb",
+     "lib/gamebox/ai/line_of_site.rb",
+     "lib/gamebox/ai/polaris.rb",
+     "lib/gamebox/ai/two_d_grid_location.rb",
+     "lib/gamebox/ai/two_d_grid_map.rb",
+     "lib/gamebox/arbiter.rb",
+     "lib/gamebox/backstage.rb",
+     "lib/gamebox/behavior.rb",
+     "lib/gamebox/behaviors/animated.rb",
+     "lib/gamebox/behaviors/audible.rb",
+     "lib/gamebox/behaviors/collidable.rb",
+     "lib/gamebox/behaviors/graphical.rb",
+     "lib/gamebox/behaviors/layered.rb",
+     "lib/gamebox/behaviors/physical.rb",
+     "lib/gamebox/behaviors/updatable.rb",
+     "lib/gamebox/class_finder.rb",
+     "lib/gamebox/config_manager.rb",
+     "lib/gamebox/console_app.rb",
+     "lib/gamebox/data/config/objects.yml",
+     "lib/gamebox/data/fonts/Asimov.ttf",
+     "lib/gamebox/data/fonts/GAMEBOX_FONTS_GO_HERE",
+     "lib/gamebox/data/graphics/GAMEBOX_GRAPHICS_GO_HERE",
+     "lib/gamebox/data/graphics/logo.png",
+     "lib/gamebox/data/music/GAMEBOX_MUSIC_GOES_HERE",
+     "lib/gamebox/data/sounds/GAMEBOX_SOUND_FX_GO_HERE",
+     "lib/gamebox/director.rb",
+     "lib/gamebox/event_compat.rb",
+     "lib/gamebox/gamebox_application.rb",
+     "lib/gamebox/gamebox_generator.rb",
+     "lib/gamebox/generators/actor_generator.rb",
+     "lib/gamebox/generators/view_generator.rb",
+     "lib/gamebox/input_manager.rb",
+     "lib/gamebox/lib/aliasing.rb",
+     "lib/gamebox/lib/code_statistics.rb",
+     "lib/gamebox/lib/diy.rb",
+     "lib/gamebox/lib/inflections.rb",
+     "lib/gamebox/lib/inflector.rb",
+     "lib/gamebox/lib/linked_list.rb",
+     "lib/gamebox/lib/metaclass.rb",
+     "lib/gamebox/lib/numbers_ext.rb",
+     "lib/gamebox/lib/platform.rb",
+     "lib/gamebox/lib/publisher_ext.rb",
+     "lib/gamebox/lib/sorted_list.rb",
+     "lib/gamebox/lib/surface_ext.rb",
+     "lib/gamebox/physical_director.rb",
+     "lib/gamebox/physical_stage.rb",
+     "lib/gamebox/physics.rb",
+     "lib/gamebox/resource_manager.rb",
+     "lib/gamebox/sound_manager.rb",
+     "lib/gamebox/spec/helper.rb",
+     "lib/gamebox/stage.rb",
+     "lib/gamebox/stage_manager.rb",
+     "lib/gamebox/svg_document.rb",
+     "lib/gamebox/tasks/gamebox_tasks.rb",
+     "lib/gamebox/templates/actor.erb",
+     "lib/gamebox/templates/actor_spec.erb",
+     "lib/gamebox/templates/actor_view.erb",
+     "lib/gamebox/templates/actor_view_spec.erb",
+     "lib/gamebox/templates/template_app/.gitignore",
+     "lib/gamebox/templates/template_app/README",
+     "lib/gamebox/templates/template_app/Rakefile",
+     "lib/gamebox/templates/template_app/config/boot.rb",
+     "lib/gamebox/templates/template_app/config/environment.rb",
+     "lib/gamebox/templates/template_app/config/game.yml",
+     "lib/gamebox/templates/template_app/config/stage_config.yml",
+     "lib/gamebox/templates/template_app/data/fonts/FONTS_GO_HERE",
+     "lib/gamebox/templates/template_app/data/graphics/GRAPHICS_GO_HERE",
+     "lib/gamebox/templates/template_app/data/music/MUSIC_GOES_HERE",
+     "lib/gamebox/templates/template_app/data/sounds/SOUND_FX_GO_HERE",
+     "lib/gamebox/templates/template_app/doc/README_FOR_APP",
+     "lib/gamebox/templates/template_app/script/generate",
+     "lib/gamebox/templates/template_app/spec/helper.rb",
+     "lib/gamebox/templates/template_app/src/app.rb",
+     "lib/gamebox/templates/template_app/src/demo_stage.rb",
+     "lib/gamebox/templates/template_app/src/game.rb",
+     "lib/gamebox/templates/template_app/src/my_actor.rb",
+     "lib/gamebox/version.rb",
+     "lib/gamebox/viewport.rb",
+     "lib/gamebox/views/graphical_actor_view.rb",
+     "lib/gamebox/wrapped_screen.rb",
+     "script/perf_polaris.rb",
+     "spec/actor_spec.rb",
+     "spec/actor_view_spec.rb",
+     "spec/animated_spec.rb",
+     "spec/backstage_spec.rb",
+     "spec/behavior_spec.rb",
+     "spec/collidable_spec.rb",
+     "spec/helper.rb",
+     "spec/label_spec.rb",
+     "spec/line_of_site_spec.rb",
+     "spec/physical_spec.rb",
+     "spec/polaris_spec.rb",
+     "spec/resource_manager_spec.rb",
+     "spec/stage_spec.rb",
+     "spec/viewport_spec.rb"
+  ]
+  s.homepage = %q{http://shawn42.github.com/gamebox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{gamebox}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Framework for building and distributing games using Rubygame}
+  s.test_files = [
+    "spec/actor_spec.rb",
+     "spec/actor_view_spec.rb",
+     "spec/animated_spec.rb",
+     "spec/backstage_spec.rb",
+     "spec/behavior_spec.rb",
+     "spec/collidable_spec.rb",
+     "spec/helper.rb",
+     "spec/label_spec.rb",
+     "spec/line_of_site_spec.rb",
+     "spec/physical_spec.rb",
+     "spec/polaris_spec.rb",
+     "spec/resource_manager_spec.rb",
+     "spec/stage_spec.rb",
+     "spec/viewport_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rubygame>, [">= 0"])
+      s.add_runtime_dependency(%q<constructor>, [">= 0"])
+      s.add_runtime_dependency(%q<publisher>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rubygame>, [">= 0"])
+      s.add_dependency(%q<constructor>, [">= 0"])
+      s.add_dependency(%q<publisher>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rubygame>, [">= 0"])
+    s.add_dependency(%q<constructor>, [">= 0"])
+    s.add_dependency(%q<publisher>, [">= 0"])
+  end
+end
+