gamebox 0.0.1

data/History.txt

@@ -0,0 +1,18 @@
+=== 0.0.1 / 2009-06-19
+
+* Gamebox lives!
+  * got game generation working in ruby 1.8
+  * initial objects built
+    * Actor/ActorViews (game objects)
+    * Director manages actors
+    * Level manages directors, backgrounds, level goals
+    * Mode manages level loading and order
+    * Behavior system for adding behaviors to actors (ie physical to put an actor into a physical space)
+    * Loading of Levels from an SVG file
+		* Polaris A* path finder
+    * Lots more to come!
+  * examples to show how to use it
+    * netris
+    * roids
+    * rague
+    * nario

data/Manifest.txt

@@ -0,0 +1,85 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+bin/gamebox
+docs/gamebox04_big.png
+docs/getting_started.rdoc
+docs/logo.png
+lib/gamebox.rb
+lib/gamebox/actor.rb
+lib/gamebox/actor_factory.rb
+lib/gamebox/actor_view.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/aliasing.rb
+lib/gamebox/animated.rb
+lib/gamebox/behavior.rb
+lib/gamebox/config_manager.rb
+lib/gamebox/console_app.rb
+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/gamebox_application.rb
+lib/gamebox/graphical.rb
+lib/gamebox/graphical_actor_view.rb
+lib/gamebox/inflections.rb
+lib/gamebox/inflector.rb
+lib/gamebox/input_manager.rb
+lib/gamebox/layered.rb
+lib/gamebox/level.rb
+lib/gamebox/linked_list.rb
+lib/gamebox/logo.rb
+lib/gamebox/metaclass.rb
+lib/gamebox/mode.rb
+lib/gamebox/mode_manager.rb
+lib/gamebox/numbers_ext.rb
+lib/gamebox/physical.rb
+lib/gamebox/physical_director.rb
+lib/gamebox/physical_level.rb
+lib/gamebox/physics.rb
+lib/gamebox/publisher_ext.rb
+lib/gamebox/resource_manager.rb
+lib/gamebox/score.rb
+lib/gamebox/sorted_list.rb
+lib/gamebox/sound_manager.rb
+lib/gamebox/surface_ext.rb
+lib/gamebox/svg_actor.rb
+lib/gamebox/svg_document.rb
+lib/gamebox/template_app/README
+lib/gamebox/template_app/Rakefile
+lib/gamebox/template_app/config/boot.rb
+lib/gamebox/template_app/config/environment.rb
+lib/gamebox/template_app/config/game.yml
+lib/gamebox/template_app/config/mode_level_config.yml
+lib/gamebox/template_app/config/objects.yml
+lib/gamebox/template_app/data/fonts/FONTS_GO_HERE
+lib/gamebox/template_app/data/graphics/GRAPHICS_GO_HERE
+lib/gamebox/template_app/data/music/MUSIC_GOES_HERE
+lib/gamebox/template_app/data/sounds/SOUND_FX_GO_HERE
+lib/gamebox/template_app/doc/README_FOR_APP
+lib/gamebox/template_app/lib/code_statistics.rb
+lib/gamebox/template_app/lib/diy.rb
+lib/gamebox/template_app/lib/platform.rb
+lib/gamebox/template_app/src/app.rb
+lib/gamebox/template_app/src/demo_level.rb
+lib/gamebox/template_app/src/game.rb
+lib/gamebox/template_app/src/my_actor.rb
+lib/gamebox/version.rb
+lib/gamebox/viewport.rb
+lib/gamebox/wrapped_screen.rb
+script/perf_polaris.rb
+test/helper.rb
+test/test_actor.rb
+test/test_animated.rb
+test/test_line_of_site.rb
+test/test_physical.rb
+test/test_polaris.rb
+test/test_viewport.rb

data/README.txt

@@ -0,0 +1,33 @@
+= gamebox
+
+* http://shawn42.github.com/gamebox/
+
+== DESCRIPTION:
+
+  A game template for building and distributing Rubygame games. See docs/getting_started.rdoc for help getting started.
+
+== FEATURES/PROBLEMS:
+
+* Quickly generate a game and have it up and running.
+
+== SYNOPSIS:
+
+  A game template for building and distributing Rubygame games.
+
+== REQUIREMENTS:
+
+* Rubygame (its dependancies, SDL)
+* constructor gem
+* publisher gem
+* bacon (for gamebox tests)
+* algorithms gem (optional for line of site and A*)
+
+== INSTALL:
+
+* gem install gamebox; gamebox my_cool_game
+
+== LICENSE:
+
+(GPLv2)
+
+Copyright (c) 2009 Shawn Anderson

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'hoe'
+
+module Gamebox
+  VERSION = '0.0.1'
+end
+Hoe.new('gamebox', Gamebox::VERSION) do |p|
+  p.developer('Shawn Anderson', 'shawn42@gmail.com')
+  p.author = "Shawn Anderson"
+  p.description = "Framework for building and distributing games using Rubygame"
+  p.email = 'shawn42@gmail.com'
+  p.summary = "Framework for building and distributing games using Rubygame"
+  p.url = "http://shawn42.github.com/gamebox"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Release to root
+  p.extra_deps << ['constructor']
+  p.extra_deps << ['publisher']
+  p.extra_deps << ['bacon']
+  if p.extra_rdoc_files
+    p.extra_rdoc_files << 'docs/getting_started.rdoc' 
+  end
+end
+
+STATS_DIRECTORIES = [
+  %w(Source         lib/)
+].collect { |name, dir| [ name, "#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  require 'code_statistics'
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end
+
+desc "Run all the strips of bacon"
+task :bacon do
+#  sh "bacon -Ilib:test --automatic --quiet"
+  sh "bacon -Ilib:test --automatic "
+end
+
+task :test => :bacon
+
+# vim: syntax=Ruby

data/TODO.txt

@@ -0,0 +1,29 @@
+planned features:
+change Polaris to return partial path when step max is reached
+update physical objects to use chipmunk_object.rb
+allow for repeating actors (tiles)
+allow overriding of animation timing
+ make complex Phyiscal behaviors (made up by a group of shapes/bodies pinned together?)
+	physical objects should have bodies and shapes body/shape should be shorthand for bodies.first/shapes.first
+  - add basic generator for things like actors/levels/etc with tests
+  - solidify rdocs (including tutorial)
+SVGS
+	create a DynamicPhysicalActor that can be built from external verts
+add while key down K_UP callback?	
+add nice actor debugging
+add Extra; actor with a short time to live (TTL); useful for special effects (maybe as a behavior)
+add some kind of fade in/out for actors w/ smooth interpolation
+	
+static deployment bundles (crate)
+	ruby
+	SDL
+	rubygame
+possible features:
+AI
+	 state machine
+	 rule based
+optional GUI via rubygoo
+particle system? ParticleGroupActor?
+network manager
+highscore upload system
+gamebox server (content server?)

data/bin/gamebox

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") { puts; exit }
+
+require File.dirname(__FILE__) + '/../lib/gamebox/version'
+if %w(--version -v).include? ARGV.first
+  puts "Gamebox #{Gamebox::VERSION::STRING}"
+  exit(0)
+end
+
+begin
+  require 'ftools'
+  fklass = File
+rescue LoadError
+  require 'fileutils'
+  fklass = FileUtils
+end
+
+PROJECT_NAME = ARGV[0]
+TARGET_DIR = File.expand_path(Dir.pwd + "/" + PROJECT_NAME)
+SOURCE_DIR = File.expand_path(File.dirname(__FILE__) + "/../lib/gamebox")
+
+Dir.mkdir(TARGET_DIR)
+
+# Generate the directory structure for the new application
+# Gems does not pull in empty directories so template_app only
+# contains populated directories
+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/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.chdir(SOURCE_DIR + "/template_app")
+Dir.glob("**/*").each do |file|
+  puts "#{file} => #{TARGET_DIR + "/" + file}"
+  if File.directory?(file)
+    target_dir = TARGET_DIR + "/" + file
+    Dir.mkdir(target_dir) unless File.exists? target_dir
+  else
+    fklass.copy(file, TARGET_DIR + "/" + file) 
+  end
+end
+

data/docs/getting_started.rdoc

@@ -0,0 +1,99 @@
+= Getting started with Gamebox
+
+== Purpose
+
+Why use Gamebox? Gamebox was designed to spring board game development. It allows the developer to define business rules about a game very quickly without having to worry about resource loading, sound/music management, creating windows, or messing with viewports.  Gamebox allows you to define a game's business rules within minutes.
+
+The driving idea behind Gamebox is to provide the ability to have as many of the basic common pieces of a 2D game at the developers disposal from the beginning.  
+
+The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing competitions and second, to allow me to write simple educational games for my kid(s).
+
+== Installation
+
+- gem install gamebox
+- or tar from http://shawn42.github.com/gamebox
+- or git pull from git://github.com/shawn42/gamebox.git
+
+== Game Creation
+
+- gamebox zapper
+- this will create the directory structure and needed files to get a basic actor up on the screen
+	zapper
+	|-- README
+	|-- Rakefile
+	|-- config
+	|   |-- boot.rb
+	|   |-- environment.rb
+	|   |-- game.yml
+	|   |-- mode_level_config.yml
+	|   `-- objects.yml
+	|-- data
+	|   |-- fonts
+	|   |   `-- FONTS_GO_HERE
+	|   |-- graphics
+	|   |   `-- GRAPHICS_GO_HERE
+	|   |-- music
+	|   |   `-- MUSIC_GOES_HERE
+	|   |-- sound
+	|   `-- sounds
+	|       `-- SOUND_FX_GO_HERE
+	|-- doc
+	|   `-- README_FOR_APP
+	|-- lib
+	|   |-- code_statistics.rb
+	|   |-- diy.rb
+	|   `-- platform.rb
+	|-- script
+	|-- src
+	|   |-- app.rb
+	|   |-- demo_level.rb
+	|   |-- game.rb
+	|   `-- my_actor.rb
+	`-- test
+- you now have a runnable gamebox game
+
+	cd zapper
+	ruby src/app.rb
+
+== Actors to the Stage
+
+An Actor is the base class for any game object. A building, the player, the score, the bullet are all examples of actors. Actors can even be invisible. Any number of Behavior s can be added to an Actor to define how it will react to the world via the Actor.has_behaviors method.
+
+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
+	
+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.
+
+That's great, but how do I tell my actors what to do?  They can register for events of course! A common place for this is in your actor's setup method. Here is an example from the roids example.
+
+	input_manager.reg KeyDownEvent, K_SPACE do
+		shoot
+	end
+
+== 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.
+
+	# music
+	sound_manager.play_music :overworld
+	
+	# sounds
+	sound_manager.play_sound :death
+
+or
+
+	# from an actor
+	play_sound :jump
+
+== Resources
+
+All file loading is handled by the ResourceManager.  It handles loading images, sounds, fonts, config files, and even svg files. The resource manager caches images based on their name and fonts based on their name/size pair. Example usage from the ScoreView class:
+
+	font = @mode.resource_manager.load_font 'Asimov.ttf', 30
+
+== Behaviors
+== Levels
+== Modes
+== Physics
+== SVG Levels

data/lib/gamebox.rb

@@ -0,0 +1,6 @@
+$: << File.dirname(__FILE__)+"/gamebox"
+
+# TODO or I could include all my files here... ug
+GAMEBOX_PATH = File.join(File.dirname(__FILE__),"gamebox/")
+require 'gamebox_application'
+

data/lib/gamebox/actor.rb

@@ -0,0 +1,143 @@
+require 'publisher'
+# Actor represent a game object.
+# Actors can have behaviors added and removed from them. Such as :physical or :animated.
+# They are created and hooked up to their optional View class in Level#create_actor.
+class Actor
+  extend Publisher
+  can_fire_anything
+  
+  attr_accessor :behaviors, :x, :y, :level, :input_manager,
+    :resource_manager, :alive, :opts, :sound_manager, :visible
+
+
+  def initialize(opts={}) # :nodoc:
+    @opts = opts
+    @x = @opts[:x]
+    @y = @opts[:y]
+    @x ||= 0
+    @y ||= 0
+    @level = opts[:level]
+    @input_manager = opts[:input]
+    @sound_manager = opts[:sound]
+    @resource_manager = opts[:resources]
+    @alive = true
+
+    @behaviors = {}
+    # add our classes behaviors
+    class_behaviors = self.class.behaviors.dup
+    for behavior in class_behaviors
+      is behavior
+    end
+    setup
+  end
+
+  # Called at the end of actor/behavior initialization. To be defined by the
+  # child class.
+  def setup
+  end
+
+  # Is the actor still alive?
+  def alive?
+    @alive
+  end
+
+  # Tells the actor's Director that he wants to be removed; and unsubscribes
+  # the actor from all input events.
+  def remove_self
+    @alive = false
+    fire :remove_me
+    @input_manager.unsubscribe_all self
+  end
+
+  # Does this actor have this behavior?
+  def is?(behavior_sym)
+    !@behaviors[behavior_sym].nil?
+  end
+
+  # Adds the given behavior to the actor. Takes a symbol or a Hash.
+  #  act.is(:shootable) or act.is(:shootable => {:range=>3})
+  #  this will create a new instance of Shootable and pass
+  #  :range=>3 to it
+  #  Actor#is does try to require 'shootable' but will not throw an error if shootable cannot be required.
+  def is(behavior_def)
+    behavior_sym = behavior_def.is_a?(Hash) ? behavior_def.keys.first : behavior_def
+    behavior_opts = behavior_def.is_a?(Hash) ? behavior_def.values.first : {}
+    begin
+      require behavior_sym.to_s;
+    rescue LoadError
+      # maybe its included somewhere else
+    end
+    klass = Object.const_get Inflector.camelize(behavior_sym)
+    @behaviors[behavior_sym] = klass.new self, behavior_opts
+  end
+
+  # removed the behavior from the actor.
+  def is_no_longer(behavior_sym)
+    @behaviors.delete behavior_sym
+  end
+
+  # Calls update on all the actor's behaviors.
+  def update_behaviors(time)
+    for behavior in @behaviors.values
+      behavior.update time
+    end
+  end
+
+  # Creates a new actor and returns it. (This actor will automatically be added to the Director.
+  def spawn(type, args={})
+    @level.create_actor type, args
+  end
+
+  # Plays a sound via the SoundManager.  See SoundManager for
+  # details on how to "define" sounds.
+  def play_sound(*args)
+    @sound_manager.play_sound *args
+  end
+
+  # Stops a sound via the SoundManager.
+  def stop_sound(*args)
+    @sound_manager.stop_sound *args
+  end
+
+  # to be defined in child class
+  def update(time)
+    # TODO maybe use a callback list for child classes
+    update_behaviors time
+  end
+  
+  def hide
+    fire :hide_me if visible?
+    @visible = false
+  end
+  
+  def show
+    fire :show_me unless visible?
+    @visible = true
+  end
+  
+  def visible?
+    @visible
+  end
+  
+  # magic
+  metaclass.instance_eval do
+    define_method( :behaviors ) do
+      @behaviors ||= []
+    end
+    define_method( :has_behaviors ) do |*args|
+      @behaviors ||= []
+      for a in args
+        if a.is_a? Hash
+          for k,v in a 
+            h = {}
+            h[k]=v
+            @behaviors << h
+          end
+        else
+          @behaviors << a
+        end
+      end
+      @behaviors
+    end
+  end
+end