metro 0.2.6 → 0.2.7

data/changelog.md

@@ -1,5 +1,11 @@
 # Metro
 
+## 0.2.7 / 2012/11-20
+
+* FIX to the new game template
+* Updated the game template to give more movement to the hero in the first scene
+* Added the fade-in, fade-out helper to show all the instructions
+
 ## 0.2.6 / 2012/11-20
 
 * Menus now support vertical and horizontal layout
@@ -22,12 +28,12 @@
 
 * All retrieved models from properties are now cached for better performance
 * Animations were re-vamped to accept more parameters
-* Metro models names in code are now refered to as "metro::models::*" to "metro::ui::*"
+* Metro models names in code are now referred to as "metro::models::*" to "metro::ui::*"
 
 ## 0.2.3 / 2012-11-11
 
 * FIX metro generators and templates generating out-of-date formats
-* FIX YAML views wil now return an empty hash instead of false on empty files
+* FIX YAML views will now return an empty hash instead of false on empty files
 * Added first scene and model to template.
 * FIX better error message when a directory is specified
 * Added the `g` generator shortcut: `metro g scene NAME`
@@ -54,7 +60,7 @@
 
 * Views now use position instead of `x`, `y`, and `z-order`
 * Point, Scale, and Dimensions is available in model and scenes.
-* Events are shared from superclasses to subclases.
+* Events are shared from superclasses to subclasses.
 * Templates updated to use GameScene and GameModel for each game.
 * Models are automatically added to the update loop
 * Model properties now make it easier to store/retrieve various
@@ -63,7 +69,7 @@
 
 ## 0.1.6 / 2012-11-07
 
-* Events are shared from superclasses to subclases.
+* Events are shared from superclasses to subclasses.
 * Templates updated to use GameScene and GameModel for each game.
 * Models are automatically added to the update loop
 * Model properties now make it easier to store/retrieve various

data/lib/metro/models/properties/animation_property.rb

@@ -27,7 +27,7 @@ module Metro
     #
     #     class Hero < Metro::Model
     #       property :animation, path: "star.png", dimensions: Dimensions.of(25,25)
-    #         dimensions: Metro::Dimensions.of(25,25) }
+    #         dimensions: Dimensions.of(25,25) }
     #
     #       def draw
     #         animation.image.draw text, x, y, z_order, x_factor, y_factor, color
@@ -38,7 +38,7 @@ module Metro
     #
     #     class Hero < Metro::Model
     #       property :walking, type: :animation, path: "star.png",
-    #         dimensions: Metro::Dimensions.of(25,25)
+    #         dimensions: Dimensions.of(25,25)
     #
     #       def draw
     #         walking.image.draw text, x, y, z_order, x_factor, y_factor, color

data/lib/metro/models/ui/grid_drawer.rb

@@ -15,7 +15,7 @@ module Metro
     #
     class GridDrawer < Model
 
-      property :position, default: Point.at(20,20,100)
+      property :position, default: Point.at(0,0,100)
       property :color, default: "rgba(255,255,255,0.1)"
       property :spacing, type: :numeric, default: 10
 

data/lib/metro/scene.rb

@@ -263,14 +263,14 @@ module Metro
     #
     # @example Retrieving the default scene name
     #
-    #     class ExampleScene
+    #     class ExampleScene < GameScene
     #     end
     #
     #     ExampleScene.scene_name # => "example"
     #
     # @example Setting a custom name for the Scene
     #
-    #     class RollingCreditsScene
+    #     class RollingCreditsScene < GameScene
     #       scene_name "credits"
     #     end
     #

data/lib/metro/version.rb

@@ -1,5 +1,5 @@
 module Metro
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
   WEBSITE = "https://github.com/burtlo/metro"
   CONTACT_EMAILS = ["franklin.webber@gmail.com"]
   

data/lib/templates/game/metro.tt

@@ -1,6 +1,6 @@
 #
 # This is the main game file which contains information
-# about your game. T
+# about your game.
 #
 # Remember, this is really a ruby file, so anything
 # that can be done with Ruby can be written here.

data/lib/templates/game/models/hero.rb

@@ -5,13 +5,26 @@ class Hero < Metro::Model
   property :position
   property :angle
   property :move_amount, default: 1.5
+  property :turn_amount, default: 90.0
 
   event :on_hold, KbLeft, GpLeft do
-    self.position -= move_amount
+    self.x -= move_amount
   end
 
   event :on_hold, KbRight, GpRight do
-    self.angle += move_amount
+    self.x += move_amount
+  end
+
+  event :on_hold, KbUp, GpUp do
+    self.y -= move_amount
+  end
+
+  event :on_hold, KbDown, GpDown do
+    self.y += move_amount
+  end
+
+  event :on_up, KbSpace do
+    self.angle += turn_amount
   end
 
   def draw

data/lib/templates/game/scenes/first_scene.rb

@@ -2,7 +2,20 @@ class FirstScene < GameScene
 
   draw :hero, position: Game.center
 
-  draws :first_instruction, :second_instruction
+  draws :first_instruction, :second_instruction, :third_instruction, 
+    :fourth_instruction, :fifth_instruction
+
+  after 1.second do
+    fade_in_and_out :first_instruction do
+      fade_in_and_out :second_instruction do
+        fade_in_and_out :third_instruction do
+          fade_in_and_out :fourth_instruction do
+            fade_in_and_out :fifth_instruction
+          end
+        end
+      end
+    end
+  end
 
   def update
     hero.position = Point.new (hero.x % Game.width), (hero.y % Game.height)

data/lib/templates/game/scenes/game_scene.rb

@@ -26,5 +26,17 @@ class GameScene < Metro::Scene
     end
   end
 
+  #
+  # This animation helper will fade in and fade out information.
+  # 
+  def fade_in_and_out(name)
+    animate name, to: { alpha: 255 }, interval: 2.seconds do
+      after 1.second do
+        animate name, to: { alpha: 0 }, interval: 1.second do
+          yield if block_given?
+        end
+      end
+    end
+  end
 
 end

data/lib/templates/game/views/brand_to_title.yaml

@@ -4,4 +4,5 @@ title:
   font:
     size: 40
   position: "320,100,1"
+  align: center
   color: rgba(255,255,255,0.0)

data/lib/templates/game/views/first.yaml

@@ -1,14 +1,26 @@
+# Using the power of YAML to define anchors and references it makes it easy
+# to generate a common view item and then add to it or manipulate it as needed.
+---
 instruction: &instruction
   model: metro::ui::label
   font:
     name: Arial
     size: 40
-  color: "rgba(255,255,0)"
+  color: "rgba(255,255,0,0.0)"
+  align: center
+  position: "320,300,1"
 first_instruction:
   <<: *instruction
-  text: "<- to move left |"
-  position: "60,300,1"
+  text: "Hold <- to move left"
 second_instruction:
   <<: *instruction
-  text: "| to move right ->"
-  position: "320,300,1"
+  text: "Hold -> to move right"
+third_instruction:
+  <<: *instruction
+  text: "Hold ^ (up arrow) to move up"
+fourth_instruction:
+  <<: *instruction
+  text: "Hold V (down arrow) to move down"
+fifth_instruction:
+  <<: *instruction
+  text: "Press <SPACE> to rotate yourself"

data/lib/templates/game/views/title.yaml

@@ -4,6 +4,7 @@ title:
   font:
     size: 40
   position: "320,100,1"
+  align: center
   color: rgba(255,255,255,1.0)
 menu:
   model: metro::ui::menu

data/lib/templates/model.rb.tt

@@ -103,7 +103,7 @@ class <%= model_name %> < GameModel
   def update ; end
   
   #
-  # This is called after every {#update} and when the OS wants the window to
+  # This is called after every #update and when the OS wants the window to
   # repaint itself.
   #
   def draw ; end

data/lib/templates/scene.rb.tt

@@ -1,6 +1,6 @@
 class <%= scene_class_name %> < GameScene
   # By default the Scene Name is based on the class name
-  # but that can be overriden with the scene_name class method
+  # but that can be overridden with the scene_name class method
   # scene_name "credits"
 
   draw :title
@@ -10,13 +10,16 @@ class <%= scene_class_name %> < GameScene
   #
   # @example Explicitly drawing a text label in the scene
   #
-  # draw :title, text: 'Title Screen',
+  # draw :title, model: 'metro::ui::label',
+  #   text: 'Title Screen',
   #   position: '20,20,0',
   #   font: { size: 60 },
-  #   color: 'rgb(255,255,255)',
-  #   model: 'metro::ui::label'
+  #   color: 'rgba(255,255,255,1.0)',
+  #   align: 'center',
+  #   vertical_align: 'center'
   #
-  # The draw method can be simplier for models that have content defined
+  #
+  # The draw method can be simpler for models that have content defined
   # for them in the view or the models themselves define the appropriate
   # fields.
   #
@@ -31,10 +34,26 @@ class <%= scene_class_name %> < GameScene
   #
   # @example of the title being moved to a new y position and the alpha level
   #
-  # animate :title, to: { y: 80, alpha: 50 }, interval: 120 do
+  # animate :title, to: { y: 80, alpha: 50 }, interval: 120.ticks do
   #   puts "Done Animating!"
   # end
   #
+  # @example of using nested animations and after blocks to generate a fade in
+  #   and fade out effect.
+  #
+  # after 2.seconds do
+  #   animate :title, to: { alpha: 255 }, interval: 1.second do
+  #     after 1.second do
+  #       animate :title, to: { alpha: 0 }, interval: 1.second
+  #     end
+  #   end
+  # end
+  #
+  # @note the interval can be specified in game ticks ( 1.tick, 23.ticks ) or
+  #   in seconds ( 1.second, 23.seconds ). 60 game times are roughly equivalent
+  #   to 1 second, however you should not use Metro for monitoring a nuclear
+  #   reactor.
+  #
 
   #
   # Example Event Handling Definitions
@@ -72,8 +91,8 @@ class <%= scene_class_name %> < GameScene
   # to generate the notification
   #
   # def update
-  #   if game_save.complete?
-  #     notification :save_complete
+  #   if player.x > 600 and player.y > 440
+  #     notification :player_wins
   #   end
   # end
   #
@@ -86,34 +105,36 @@ class <%= scene_class_name %> < GameScene
   def after_initialize ; end
 
   #
-  # This method is called right after the scene has been adopted by the window
+  # This method is called right after the scene has been adopted by the window.
+  # This is a great place to make changes to the scene before the update methods
+  # or draw methods have ever been called.
   #
   def show ; end
 
   #
-  # This is called every update interval while the window is being shown.
+  # This is called every update interval while the scene is being shown in the
+  # window.
   #
   def update ; end
 
   #
-  # This is called after every {#update} and when the OS wants the window to
+  # This is called after every #update and when the OS wants the window to
   # repaint itself.
   #
   def draw ; end
 
   #
-  # Before a scene is transisitioned away from to a new scene, this method is called
-  # to allow for the scene to complete any taskss, stop any actions, or pass any
+  # Before a scene is transitioned away from to a new scene, this method is called
+  # to allow for the scene to complete any tasks, stop any actions, or pass any
   # information from the existing scene to the scene that is about to replace it.
   #
   def prepare_transition_to(new_scene) ; end
 
   #
-  # Before a scene is transisitioned to it is called with the previous scene. This
-  # allows for the new scene to rerieve any data from the previous scene to assist
+  # Before a scene is transitioned to it is called with the previous scene. This
+  # allows for the new scene to retrieve any data from the previous scene to assist
   # with the layout of the current scene.
   #
   def prepare_transition_from(old_scene) ; end
 
-
 end

data/lib/templates/view.yaml.tt

@@ -3,6 +3,8 @@
 title:
   model: "metro::ui::label"
   text: "Your Scene"
+  align: center
+  vertical_align: center
   position: "190,200,4"
   font:
     size: 60

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -250,13 +250,10 @@ licenses: []
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.2.6 / 2012/11-20.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * Menus now support vertical and horizontal layout\n  * Menus
-  now support movement and selection noises\n  * Menus can now have a default selection\n
-  \ * Menus can be enabled/disabled\n  * Added Array Property, Boolean Property, and
-  Menu Options Property\n  * FIX label horizontal center and right alignments\n  *
-  Generic Models will now show a warning instead of raising an exception\n  * Removed
-  event chain debug messaging\n  \n\n  ---------------------------------------------------------------------\n"
+  metro 0.2.7 / 2012/11-20.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * FIX to the new game template\n  * Updated the game template
+  to give more movement to the hero in the first scene\n  * Added the fade-in, fade-out
+  helper to show all the instructions\n  \n\n  ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib