metro-ld25 0.3.3

data/lib/templates/game/README.md.tt

@@ -0,0 +1,52 @@
+# <%= name %>
+
+## Details
+
+Additional information or backstory about the game that you
+are creating. This file's intention is to allow a user to 
+refer to this for more information related to the game or 
+possibly any notes or caveats about the game.
+
+## Contact
+
+
+### Programming
+
+* [YAML for Ruby](http://www.yaml.org/YAML_for_ruby.html) reference which can help you define views in the game.
+* [JSONLint](http://jsonlint.com/) is a JSON Validator
+
+### Art
+
+* [Lost Garden](http://www.lostgarden.com/2007/05/dancs-miraculously-flexible-game.html)
+* [Text to ASCII Art Generator](http://patorjk.com/software/taag)
+* [Icons](http://css-tricks.com/flat-icons-icon-fonts/)
+* [Subtle Patterns](http://subtlepatterns.com/) various backgrounds and textures.
+
+### Drawing
+
+* [Tiled Map Editor](http://www.mapeditor.org/) generates tile maps.
+* [Pixen](http://pixenapp.com/) generates sprites and animations.
+* [Zwoptex](http://www.zwopple.com/zwoptex/) generates sprite sheets.
+
+### Animation
+
+* [TimelieFX](http://www.rigzsoft.co.uk/) particle editor allows you to export animations.
+
+### Sound
+
+* [as3sfxr](http://www.superflashbros.net/as3sfxr/) generates unique sounds.
+* [bfxr](http://www.bfxr.net/) generates unique sounds.
+* [Audacity](http://audacity.sourceforge.net/) for recording and editing.
+* [Ableton](https://www.ableton.com/en/) music generation tool.
+
+### Books
+
+* [Rules of Play](http://www.amazon.com/dp/0262240459)
+* [Game Programming Gems 8](http://www.amazon.com/dp/1584507020)
+* [Game Feel](http://www.amazon.com/dp/0123743281)
+* [Game Coding Complete](http://www.amazon.com/dp/1584506806)
+* [Game Design Workshop](http://www.amazon.com/dp/0240809742)
+* [Challenges For Game Designers](http://www.amazon.com/dp/158450580X)
+* [The Art of Game Design: A book of lenses](http://www.amazon.com/dp/0123694965)
+* [A Theory of Fun](http://www.theoryoffun.com)
+* [Andrew Rollings and Ernest Adams on Game Design](http://www.amazon.com/dp/1592730019)

data/lib/templates/game/lib/custom_easing.rb

@@ -0,0 +1,32 @@
+#
+# The lib folder is a great place for you to define:
+#
+# * New Units
+# * Monkey Patches for Metro
+# * New model properties
+# * Custom Easings
+# * Custom View Parers/Writers
+# * Anything that isn't quite a model, scene, or view
+#
+
+#
+# This custom easing is an exact copy of the 'Ease In' easing defined in Metro.
+# It is present here as an example.
+#
+class CustomEasing < Metro::Easing
+
+  #
+  # @param [Float] moment the point in time within the interval. For example for
+  #   a 60 tick interval, this would be the values 0, 1, 2, 3, 4, 5, 6, ... 59.
+  # @param [Float] start the starting value of the property
+  # @param [Float] change the final value for the property
+  # @param [Float] interval the total length of the interval
+  #
+  # @return [Float] the value at the particular moment of the interval
+  def self.calculation(moment,start,change,interval)
+    # @note this is the exact same as the already defined Ease In
+    change * (moment = moment / interval) * moment + start
+  end
+end
+
+Metro::Easing.register :custom, CustomEasing

data/lib/templates/game/metro.tt

@@ -0,0 +1,63 @@
+#
+# This is the main game file which contains information
+# about your game.
+#
+# Remember, this is really a ruby file, so anything
+# that can be done with Ruby can be written here.
+# 
+# "With great power comes great responsibility" ~ Uncle Ben
+
+#
+# This is the name of your game...
+name "<%= name %>"
+
+#
+# The author of the game. This method can be executed
+# twice if more people are working on this game.
+#
+author "Your Name"
+
+#
+# The website where the person playing this game
+# could learn more about this game, other games, the
+# authors, or perhaps ask for help or support.
+#
+website "www.idsoftware.com"
+
+#
+# The contact email address where a person that is
+# playing the game might want to contact to thank
+# or reach out for help.
+#
+contact "person@personemail.com"
+
+#
+# This sets the resolution for the game
+#
+resolution 640, 480
+
+#
+# The scene that will be shown first when the game
+# starts.
+#
+first_scene :brand
+
+#
+# Defines controls which are meta events. They can be used group button
+# events together under a single name so that you can use it throughout
+# the game and also will allow for players of your game to redefine the
+# keys.
+#
+controls do
+  # NAME_OF_EVENT, is: EVENT TYPE, with: [ ALL_EVENTS ]
+  confirmation is: :button_up, with: [ KbReturn, KbEnter, KbSpace, GpButton0 ]
+  cancel is: :button_up, with: [ KbEscape, KbDelete ]
+end
+
+#
+# Enable debug mode for the game. Which could
+# allow different logic. When this is set the
+# Game.debug? method will return a true
+# value.
+#
+debug true

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

@@ -0,0 +1,62 @@
+class Hero < Metro::UI::Sprite
+
+  # A Metro::UI::Sprite predefines a number of commmon properties:
+  #
+  # * position
+  # * dimensions
+  # * color
+  # * angle
+  # * scale
+  #
+  # These properties add getter and setter methods of the following:
+  #
+  # * position, x, y, z and z_order (both z and z_order are the same)
+  # * dimensions, width, and height
+  # * color, red, green, blue, alpha
+  # * angle
+  # * scale, x_factor, y_factor
+
+  property :image, path: "hero.png"
+
+  property :move_amount, default: 1.5
+  property :turn_amount, default: 90.0
+
+  event :on_hold, KbLeft, GpLeft do
+    self.x -= move_amount
+  end
+
+  event :on_hold, KbRight, GpRight do
+    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
+
+  # By default a Metro::UI::Sprite defines a #draw method which will
+  # draw the associated image with the position, rotation, and scale.
+  #
+  # If you would like to maintain the current draw functionality but augment
+  # it, you can define a draw method which calls to super.
+  #
+  # def draw
+  #   super
+  #   # custom drawing alongside the image
+  # end
+  #
+  # You may find it necessary to replace the existing draw functionality.
+  # Here you could define your own draw that overrides the original.
+  #
+  # def draw
+  #   # custom drawing without the original image draw
+  # end
+
+end

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

@@ -0,0 +1,19 @@
+class BrandScene < GameScene
+
+  draws :brand
+
+  after 2.seconds do
+    transition_to_brand_to_title
+  end
+
+  event :confirmation do
+    transition_to_brand_to_title
+  end
+
+  def transition_to_brand_to_title
+    animate :brand, to: { alpha: 0 }, interval: 1.second do
+      transition_to :brand_to_title
+    end
+  end
+
+end

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

@@ -0,0 +1,13 @@
+class BrandToTitleScene < GameScene
+
+  draws :title
+
+  animate :title, to: { alpha: 255 }, interval: 2.seconds do
+    transition_to :title
+  end
+
+  event :cancel do
+    transition_to :title
+  end
+
+end

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

@@ -0,0 +1,28 @@
+class FirstScene < GameScene
+  
+  if Game.debug?
+    draw :fps, model: "metro::ui::fps", placement: 'bottom_right'
+  end
+
+  draw :hero, position: Game.center
+
+  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)
+  end
+
+end

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

@@ -0,0 +1,43 @@
+class GameScene < Metro::Scene
+
+  #
+  # The game scene is a place where you can define actors and
+  # events here that will be present within all the subclassed
+  # scenes.
+
+  #
+  # @example Setting up the ability for all subclassed scenes
+  #   to be reloaded with the 'Ctrl+R' event
+  #
+  event :on_up, KbR do |event|
+    if event.control?
+      if Metro.game_has_valid_code?
+        after(1.tick) { Metro.reload! ; transition_to(scene_name) }
+      end
+    end
+  end
+
+  #
+  # @example Setting up the ability for all subclassed scenes
+  #   to be edited with the 'Ctrl+E' event
+  #
+  event :on_up, KbE do |event|
+    if event.control?
+      transition_to scene_name, with: :edit
+    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/scenes/title_scene.rb

@@ -0,0 +1,15 @@
+class TitleScene < GameScene
+
+  draw :title
+
+  draw :menu, options: [ 'Start Game', 'Exit' ]
+
+  event :on_up, KbEscape do
+    exit
+  end
+
+  def start_game
+    transition_to :first
+  end
+
+end

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

@@ -0,0 +1,4 @@
+brand:
+  model: metro::ui::image
+  image: brand.jpg
+  position: "320,240,1"

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

@@ -0,0 +1,8 @@
+title:
+  model: metro::ui::label
+  text: "#{Game.name}"
+  font:
+    size: 40
+  position: "320,100,1"
+  align: center
+  color: rgba(255,255,255,0.0)

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

@@ -0,0 +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,0.0)"
+  align: center
+  position: "320,300,1"
+first_instruction:
+  <<: *instruction
+  text: "Hold <- to move left"
+second_instruction:
+  <<: *instruction
+  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

@@ -0,0 +1,11 @@
+title:
+  model: metro::ui::label
+  text: "#{Game.name}"
+  font:
+    size: 40
+  position: "320,100,1"
+  align: center
+  color: rgba(255,255,255,1.0)
+menu:
+  model: metro::ui::menu
+  position: "260,200,1"

data/lib/templates/message.erb

@@ -0,0 +1,23 @@
+********************************************************************************
+    ______  ___      _____
+    ___   |/  /_____ __  /_______________
+    __  /|_/ / _  _ \_  __/__  ___/_  __ \
+    _  /  / /  /  __// /_  _  /    / /_/ /
+    /_/  /_/   \___/ \__/  /_/     \____/
+
+--------------------------------------------------------------------------------
+<% messages.each do |message| %>
+## <%= message.title %>
+
+<%= message.message %>
+
+<% unless message.actions.empty? %>## Details
+
+<%= message.actions %><% end %><% end %>
+<% if website.present? || email.present? %>
+## Contact
+
+<%= website %>
+<%= email %>
+<% end %>
+********************************************************************************

data/lib/templates/model.rb.tt

@@ -0,0 +1,111 @@
+class <%= model_name %> < GameModel
+
+  #
+  # Properties
+  #
+  # Models commonly have properties that you want to be able to get, set, and save.
+  # Usually within ruby you would write attr_accessor methods and initialize them.
+  # Metro provides some shorthand class helper methods that allow you to quickly
+  # define these properties with the added benefit that they will be persisted when
+  # the model is saved within the view and the type will be maintained.
+  #
+  # # @example of adding a `position` property to your model
+  # # Property defines a `position` accessor as well as `x`, `y`, and `z` (or `z_order`)
+  # # accessors.
+  # property :position
+  #
+  # # @example of adding an `image` property to your model
+  # # An image property can be set up with an image path or that can be set later
+  # # through the `image` accessor that is added.
+  #
+  # property :image, path: "player.png"
+  #
+  # # @example of adding an `numeric` property to your model
+  # # A lot of times you want to track some numeric value like score. Here we
+  # # create a `score` accessor and assign a default value.
+  # property :score, type: numeric, default: 0
+  #
+  # # @example of adding an `text` property to your model
+  # # A lot of times you want to track some numeric value like score. Here we
+  # # create a `text` accessor and assign a default value.
+  # property :description, type: text, default: 'Greetings Earthling!'
+  #
+  # For more information see the other defined properties.
+  #
+  # @see Metro::Model::AnimationProperty
+  # @see Metro::Model::ImageProperty
+  # @see Metro::Model::SongProperty
+  # @see Metro::Model::SampleProperty
+  # @see Metro::Model::NumericProperty
+  # @see Metro::Model::ScaleProperty
+  # @see Metro::Model::TextProperty
+  # @see Metro::Model::PositionProperty
+  # @see Metro::Model::FontProperty
+  #
+
+  #
+  # Events
+  #
+  # # @example Registering the keyboard down event to execute a block of code
+  # event :on_down, GpLeft, GpUp, do
+  #   turn_left
+  # end
+  #
+  # # @example Registering the keyboard up key to execute the method `jump`
+  # event :on_up, KbEscape, do: :jump
+  #
+  # # @example Registering for button held events that would build the model's acceleration
+  # event :on_hold, KbRight, GpRight do
+  #   acceleration += 1
+  # end
+  #
+  # Keystroke and Game Event Reference
+  #
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsMac.hpp
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsX.hpp
+  # @see https://github.com/jlnr/gosu/blob/master/Gosu/ButtonsWin.hpp
+  #
+  #
+  # # @example Registering for an event called 'save_complete' event that anyone
+  # #   can generate and this scene block will execute this code.
+  #
+  # event :notification, :game_over do
+  #   puts "Game is Over!"
+  # end
+  #
+  # Within the models you could use the method `notification`
+  # to generate the notification
+  #
+  # def update_score
+  #   @score = score + 1
+  #   if score >= winning_score
+  #     notification :game_over
+  #   end
+  # end
+  #
+
+  #
+  # As model does a lot of work for you with regarding to setting up content, it is
+  # best not to override #initialize and instead define an #after_initialize method
+  # within the subclasses of Scene.
+  #
+  def after_initialize ; end
+
+  #
+  # This method is called right after the model has been added to the scene and added
+  # to the window.
+  #
+  def show ; end
+
+  #
+  # This is called every update interval while the window is being shown.
+  #
+  def update ; end
+  
+  #
+  # This is called after every #update and when the OS wants the window to
+  # repaint itself.
+  #
+  def draw ; end
+
+end