metro 0.1.2 → 0.1.3

data/README.md

@@ -12,28 +12,44 @@ Metro is a framework built around [gosu](https://github.com/jlnr/gosu) (the 2D g
 
 > NOTE: This project is very early in development and at this point mostly a prototype to explore more of theses concepts to gain an understanding of core tools necessary to make games.
 
-Please take a look at the [example game project](https://github.com/burtlo/starry-knight) that I am building alongside of 'metro' to see how it can be used to develop games.
-
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'metro'
+    $ gem install metro
 
-And then execute:
+## Usage
 
-    $ bundle
+### Running a Game
 
-Or install it yourself as:
+By default `metro` will look for a file named 'metro' within the current working directory if no *gamefilename* has been provided.
 
-    $ gem install metro
+```
+metro [gamefilename]
+```
 
-## Usage
+Please take a look at the [example game project](https://github.com/burtlo/starry-knight) that is being built alongside of 'metro'. It currently showcases all the current features available to the game.
 
+```bash
+$ git clone git://github.com/burtlo/starry-knight.git
+$ cd starry-knight
+$ metro
 ```
-metro [gamefilename]
+
+### Creating a Game
+
+Metro contains content generators to assist you.
+
+Creating a Game can be done with a single command.
+
+```bash
+$ metro new GAMENAME
 ```
 
-By default Metro will look for a file named 'metro' within the current working directory if no *gamefilename* has been provided.
+This should generate for you a starting game with a branding scene and a title scene. The game allows the player to start the game.
+
+The game is missing the `first` scene of the game. This can be created with the scene generator:
+
+```bash
+$ metro generate scene first
+```
 
-Please take a look at the [example game project](https://github.com/burtlo/starry-knight) that I am building alongside of 'metro' to see how it can be used to develop games.
+This should generate a scene in the scenes directory. The scene file contains a lot of examples of how to draw, animate and have your scene listen to events.

data/changelog.md

@@ -1,5 +1,15 @@
 # Metro
 
+## 0.1.3 / 2012-10-28
+
+* Fade Scene Transition support added
+* Numeric#seconds and Numeric#ticks helpers added
+* Scenes can now define delayed events `after 2.seconds do ; end`
+* Labels have more defaults and more font options and size
+* Labels and images will default to center of screen
+* Able to define game controls within your metro file
+* Implicit animations support color change.
+
 ## 0.1.2 / 2012-10-26
 
 * Generators for games, scenes, models, and views

data/lib/core_ext/numeric.rb

@@ -0,0 +1,59 @@
+class Numeric
+
+  #
+  # Set the tick interval which is used in conversion of seconds to
+  # ticks. By default
+  #
+  def self.tick_interval=(value)
+    @tick_interval = value.to_f
+  end
+
+  #
+  # @return the game tick interval.
+  #
+  def self.tick_interval
+    @tick_interval.to_f == 0 ? 16.666666 : @tick_interval.to_f
+  end
+
+
+
+  #
+  # Provides the suffix 'second' which will translate seconds to
+  # game ticks. This is to allow for a number of seconds to be expressed
+  # in situations where game ticks are used (e.g. animations).
+  #
+  # @example Expressing an animation that takes place over 3 seconds (180 ticks)
+  #
+  #     class ExampleScene < Metro::Scene
+  #       draws :title
+  #
+  #       animate :title, to: { x: 320, y: 444 }, interval: 3.seconds
+  #     end
+  #
+  def second
+    (self * 1000 / Numeric.tick_interval).floor
+  end
+
+  alias_method :seconds, :second
+  alias_method :secs, :second
+  alias_method :sec, :second
+
+  #
+  # Provides the suffix 'tick' which will simply express the number
+  # with a vanity suffix.
+  #
+  # @example Expressing an animation that takes place over 60 game ticks
+  #
+  #     class ExampleScene < Metro::Scene
+  #       draws :title
+  #
+  #       animate :title, to: { x: 320, y: 444 }, interval: 60.ticks
+  #     end
+  #
+  def tick
+    self
+  end
+
+  alias_method :ticks, :tick
+
+end

data/lib/gosu_ext/gosu_constants.rb

@@ -0,0 +1,53 @@
+module Metro
+
+  #
+  # The GosuEvents module creates aliases for the Keyboard and the Gamepad events
+  # within the Gosu Namespace. This is so Metro can use the events without requiring
+  # the namespace.
+  #
+  # This makes the interface of these events more portable.
+  #
+  module GosuConstants
+
+    def self.extended(base)
+      add constants: keyboard_events, to: base
+      add constants: gamepad_events, to: base
+      add constants: mouse_events, to: base
+    end
+
+    #
+    # @return the constant from which to search for all the other constants.
+    #   This helper method is to to save sprinkling the constant value
+    #   throughout the rest of the module.
+    def self.gosu
+      Gosu
+    end
+
+    def self.keyboard_events
+      find_all_constants_with_prefix "Kb"
+    end
+
+    def self.gamepad_events
+      find_all_constants_with_prefix "Gp"
+    end
+
+    def self.mouse_events
+      find_all_constants_with_prefix "Ms"
+    end
+
+    def self.find_all_constants_with_prefix(prefix)
+      gosu.constants.find_all { |c| c.to_s.start_with? prefix }
+    end
+
+    #
+    # Alias the list of given constants within the given class.
+    #
+    def self.add(options={})
+      events = options[:constants]
+      target = options[:to]
+
+      events.each {|event| target.const_set event, gosu.const_get(event) }
+    end
+
+  end
+end

data/lib/locale/en.yml

@@ -0,0 +1,16 @@
+---
+en:
+  website: "%{website}"
+  error:
+    missing_metro_file:
+      title: "Unable to find Metro game file"
+      message: "The specified file `%{file}` which is required to run the game could not be found."
+      actions:
+      - "Ensure you have specified the correct file"
+      - "Ensure that the file exists at that location"
+    reserved_control_name:
+      title: "Unable to define control: %{name}"
+      message: "The specified control name `%{name}` is RESERVED or ALREADY DEFINED."
+      actions:
+      - "Ensure that the control name is not already defined."
+      - "Replace the use of this control name with name"

data/lib/locale/locale.rb

@@ -0,0 +1 @@
+I18n.load_path.push "#{File.dirname(__FILE__)}/en.yml"

data/lib/metro.rb

@@ -1,22 +1,32 @@
 require 'gosu'
 require 'gosu_ext/color'
+require 'gosu_ext/gosu_constants'
 require 'sender'
+require 'i18n'
+
 
 require 'core_ext/string'
+require 'core_ext/numeric'
 require 'logger'
 require 'erb'
 
+require 'locale/locale'
 require 'metro/version'
-require 'metro/error'
 require 'metro/template_message'
 require 'metro/window'
 require 'metro/game'
 require 'metro/scene'
+require 'metro/scenes'
 require 'metro/models/model'
 require 'metro/models/generic'
 
 require_relative 'metro/missing_scene'
 
+#
+# To allow an author an easier time accessing the Game object from within their game.
+# They do not have to use the `Metro::Game` an instead use the `Game` constant.
+#
+Game = Metro::Game
 
 def asset_path(name)
   File.join Dir.pwd, "assets", name
@@ -30,8 +40,19 @@ def log
   end
 end
 
+def error(messages, details = {})
+  details = { show: true }.merge details
+
+  message = TemplateMessage.new messages: messages, details: details,
+    website: Game.website, contact: Game.contact
+
+  warn message if details[:show]
+  exit 1
+end
+
 module Metro
   extend self
+  extend GosuConstants
 
   #
   # @return [String] the default filename that contains the game contents
@@ -51,6 +72,7 @@ module Metro
   def run(filename=default_game_filename)
     load_game_files
     load_game_configuration(filename)
+    configure_controls!
     start_game
   end
 
@@ -70,6 +92,10 @@ module Metro
     Game.setup game
   end
 
+  def configure_controls!
+    EventRelay.define_controls Game.controls
+  end
+
   def start_game
     window = Window.new Game.width, Game.height, Game.fullscreen?
     window.caption = Game.name
@@ -78,26 +104,14 @@ module Metro
   end
 
   def game_files_exist!(*files)
-    error_messages = files.compact.flatten.map { |file| game_file_exists?(file) }.reject {|exist| exist == true }
-    unless error_messages.empty?
-      display_error_message(error_messages)
-      exit 1
-    end
+    files.compact.flatten.each { |file| game_file_exists?(file) }
   end
 
+
   def game_file_exists?(file)
     unless File.exists? file
-      Error.new title: "Unable to find Metro game file",
-        message: "The specified file `#{file}` which is required to run the game could not be found.",
-        details: [ "Ensure you have specified the correct file", "Ensure that the file exists at that location" ]
-    else
-      true
+      error "error.missing_metro_file", file: file
     end
   end
 
-  def display_error_message(messages)
-    message = TemplateMessage.new messages: messages, website: WEBSITE, email: CONTACT_EMAILS
-    warn message
-  end
-
 end

data/lib/metro/animation/after_interval_factory.rb

@@ -0,0 +1,12 @@
+module Metro
+  
+  class AfterIntervalFactory
+    attr_reader :ticks, :block
+    
+    def initialize(ticks,&block)
+      @ticks = ticks
+      @block = block
+    end
+  end
+
+end

data/lib/metro/animation/animation_factory.rb

@@ -2,9 +2,10 @@ module Metro
 
   class AnimationFactory
 
-    attr_reader :options, :on_complete_block
+    attr_reader :actor, :options, :on_complete_block
 
-    def initialize(options = {},&block)
+    def initialize(actor,options = {},&block)
+      @actor = actor
       @options = options
       @on_complete_block = block
     end

data/lib/metro/animation/has_animations.rb

@@ -15,12 +15,12 @@ module Metro
       # @example Defining an animation that fades in and moves a logo when it is
       #   done, transition to the title scene.
       #
-      #     animate actor: :logo, to: { y: 80, alpha: 50 }, interval: 120 do
+      #     animate :logo, to: { y: 80, alpha: 50 }, interval: 120 do
       #       transition_to :title
       #     end
       #
-      def animate(options,&block)
-        scene_animation = AnimationFactory.new options, &block
+      def animate(actor_name,options,&block)
+        scene_animation = AnimationFactory.new actor_name, options, &block
         animations.push scene_animation
       end
 

data/lib/metro/animation/implicit_animation.rb

@@ -32,18 +32,11 @@ module Metro
   # is executed. In this case, upon completition, transition the scene
   # from the current one to the main scene.
   #
-  class ImplicitAnimation < Animation
+  class ImplicitAnimation < OnUpdateOperation
 
-    #
-    # @return the array of attributes that are being animated.
-    #
-    attr_reader :attributes
-
-    #
-    # @return a Hash that contains all the animation step deltas
-    #   for each attribute.
-    #
-    attr_reader :deltas
+    def animations
+      @animations ||= []
+    end
 
     #
     # @return the type of easing that the implicit animation should employ.
@@ -57,13 +50,36 @@ module Metro
     # that are going to be animated and to determine each of their deltas.
     #
     def after_initialize
-      @deltas = {}
-
-      @attributes = to.map { |attribute,final| attribute }
-
       to.each do |attribute,final|
         start = actor.send(attribute)
-        deltas[attribute] = stepping(easing).calculate(start.to_f,final.to_f,interval.to_f)
+
+        if attribute == :color
+          final = Gosu::Color.new final
+
+          animations.push build_animation_step(:"color.red",start.red,final.red)
+          animations.push build_animation_step(:"color.green",start.green,final.green)
+          animations.push build_animation_step(:"color.blue",start.blue,final.blue)
+          animations.push build_animation_step(:"color.alpha",start.alpha,final.alpha)
+        else
+          animations.push build_animation_step(attribute,start,final)
+        end
+
+      end
+    end
+
+    def build_animation_step(attribute,start,final)
+      step = AnimationStep.new
+      step.actor = actor
+      step.attribute = attribute
+      step.deltas = stepping(easing).calculate(start.to_f,final.to_f,interval.to_f)
+      step
+    end
+
+    class AnimationStep
+      attr_accessor :actor, :attribute, :deltas
+
+      def execute_step(step)
+        actor.set(attribute,deltas.at(step))
       end
     end
 
@@ -86,9 +102,7 @@ module Metro
     # current animation step.
     #
     def execute_step
-      attributes.each do |attribute|
-        actor.send "#{attribute}=", delta_for_step(attribute)
-      end
+      animations.each {|step| step.execute_step(current_step) }
     end
 
     #

data/lib/metro/animation/{animation.rb → on_update_operation.rb}

@@ -1,11 +1,13 @@
 module Metro
 
   #
-  # Animation is the motion that gives a system it's life. An animation
-  # in this case is a really a mechanism that allows for an action to
-  # be repeated for a given interval of time.
+  # OnUpdateOperation is an object that executes on the update cycle
+  # of the game. This usually take the form of an animation or some operation
+  # that needs to execute with each update of the game.
   #
-  class Animation
+  class OnUpdateOperation
+
+    def after_initialize ; end
 
     def initialize(options)
       @current_step = 0