yeah 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ca889c593c853c056b2945402f87240a708abc3
-  data.tar.gz: 1a215b41c68cf68ff4ead5d5a77589dcfc2f92c4
+  metadata.gz: 9db2fc8ff3354619333aa00a484931deae0ac046
+  data.tar.gz: 2a63e5a1070e65dbc01b6a201e9b40b4d6ec38f4
 SHA512:
-  metadata.gz: c4d99208cb6cbd3f8e86b37f4dcb0b7492233d4a3879cf1cd00fca8662306bcf5c4302c8a9c877c56cf7b81dd89b300f59b57343fb50f1d9fa8c2f9442c7ee83
-  data.tar.gz: 172905029424fa4dbad2bd7b9db2b892a4f963a14c9d72ddc4645506124996ee46c4ce96d84bb7ec1fe4b38a7674bfddfcf77e7bbf4d0864d60f3eb943979c2e
+  metadata.gz: 5e96c8e05061378a88ac5f87ced6d1b3cc46d1e6bf02735b160a46024b3ff004f1022fb4f50e55a80b2f3b64a64890c8490c2dea444ddb913c47c642033d3beb
+  data.tar.gz: 174bacd2f5af289ad36e34e8bacb399df47f3ad4e83992af01882b4e6e8de420ca28c7de8899a2ce844b00d1938bede3af3c393b669bc47bd6078f6ae8f09e19

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Artur Ostrega
+Copyright (c) 2013 - 2014 Artur Ostrega
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,20 +1,52 @@
-Yeah
-====
-An early-stage Ruby video game framework that optimizes for development efficiency.
-
-It is in very early stages, but at version 0.3.0 the Vyzer demo should be functional. Any version below 1.0.0 is unstable and lacks backward compatibility.
-
-Planned features
-----------------
-* An opinionated, modular API that makes common tasks easy and everything else possible.
-* Command line initialization script to help one hit the ground running.
-* Graphical tools for creating video game resources like sprites and maps.
-* Multiple target platforms, starting with desktop and web.
-
-Installation
-------------
-Install with `gem install yeah`. Yeah depends on Rubygame, which depends on SDL; see [these guides](https://github.com/rubygame/rubygame/wiki/Install).
-
-Blog
-----
-[Why am I making Yeah?](http://skofo.github.io/blog/why-am-i-making-yeah)
+# Yeah
+
+Practical Ruby video game framework, alpha stage
+
+
+## Features
+
+* Designed to be easy to learn and fast to build games with
+* Embraces Ruby's strengths (object-orientation, duck typing, focus on developer happiness)
+* Platform-agnostic (currently compiles to web pages through [Opal](http://opalrb.org); PC executables and mobile apps planned)
+* Convention (over configuration)-oriented
+* Processing/HTML5 Canvas-style drawing API
+* Command-line utilities (no monolithic IDE)
+* Open source under MIT license
+
+
+## Examples
+
+[![Asteroids](https://cdn.mediacru.sh/IkYZP46TmCsd.png)](https://yeahrb.github.io/yeah/examples/asteroids/runner.html)
+
+[*Asteroids*](https://yeahrb.github.io/yeah/examples/asteroids/runner.html)
+[(code)](https://github.com/yeahrb/yeah/tree/examples/examples/asteroids)
+
+[![Random](https://cdn.mediacru.sh/KW9M6TndLry0.png)](https://yeahrb.github.io/yeah/examples/random/runner.html)
+
+[*Random*](https://cdn.mediacru.sh/ZpyKf2TtdLqJ.png)
+[(code)](https://github.com/yeahrb/yeah/tree/examples/examples/random)
+
+
+## Usage
+
+NOTE: This is alpha-stage software, expect changes!
+
+### Installation
+
+1. Install Ruby 2.0+, visit [the Ruby website](http://ruby-lang.org/) for more info.
+2. In a command line, enter `gem install yeah`.
+3. Enter `yeah` to view list of commands.
+
+### Making a game
+
+1. In a command line, enter `yeah new` to generate a new game project.
+2. Change into the new `game` directory, then enter `bundle install`.
+3. Add game code to `code/game.rb`. No tutorials yet; please take a look at the [example code](https://github.com/yeahrb/yeah/tree/examples/examples) and [API reference](http://rdoc.info/github/yeahrb/yeah/9f065a6/frames).
+4. Enter `yeah serve` and visit [http://localhost:1234](http://localhost:1234) to try the game.
+
+
+## API Reference
+
+[0.3.3](http://rdoc.info/github/yeahrb/yeah/9f065a6/frames)
+
+[Edge](http://rdoc.info/github/yeahrb/yeah/master/frames)

data/bin/yeah

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+options = {}
+
+options[:command] = ARGV.shift
+
+case options[:command]
+when 'new'
+  if Dir['game'].any?
+    puts "Error: `game` directory already exists."
+  else
+    template_path = File.expand_path('../../lib/yeah/_template', __FILE__)
+    FileUtils.cp_r(template_path, './game')
+    puts "Created new game project at `game`."
+  end
+when 'serve'
+  require 'yeah/web/server'
+  Yeah::Web::Server.new.start
+when 'version'
+  puts Yeah::VERSION
+else
+  puts "Usage: yeah <command>"
+  puts ""
+  puts "Commands:"
+  puts "  new - create a new game project"
+  puts "  serve - serve a game over the Internet"
+  puts "  version - print installed version"
+end

data/lib/yeah.rb

@@ -1,11 +1,8 @@
-module Yeah
-  VERSION = '0.2.2'
-end
+module Yeah; end
 
-require 'monkey/numeric'
+require 'yeah/version'
 
-yeah_requires = %i(vector color surface rectangle entity map desktop game
-                   basic_physics)
-yeah_requires.each do |req|
-  require "yeah/#{req}"
-end
+require 'yeah/vector'
+require 'yeah/color'
+require 'yeah/constants'
+require 'yeah/game'

data/lib/yeah/_platform/asset.rb

@@ -0,0 +1,24 @@
+module Yeah
+
+# An `Asset` represents a file found in a project's `assets` directory.
+# @abstract Provided by a `Platform`, subclassed to more specific assets.
+class Asset
+  def initialize(path)
+    raise NotImplementedError
+  end
+
+  class << self
+    # @!method [](*args)
+    # @param arguments catch-all
+    # @return [Asset]
+    # Alias for ::new.
+  end
+
+  # @!attribute path
+  # @param [String] path to asset relative to `assets`
+  # @return [String] path to asset relative to `assets`
+
+  # @!method to_n
+  # @return [Native] native representation of asset for platform
+end
+end

data/lib/yeah/_platform/display.rb

@@ -0,0 +1,181 @@
+module Yeah
+
+# The `Display` is responsible for drawing to a game display. It provides a
+# procedural drawing API similar to Processing or HTML5 Canvas.
+# @abstract Provided by a `Platform`.
+class Display
+  # @param [Hash] options for new object
+  # @option options [Vector] :size (V[1280, 720]) of display
+  # @option options [String] :canvas_selector ('canvas') for canvas HTML
+  #   element (applicable only to `Web::Display`)
+  def initialize(options = {})
+    raise NotImplementedError
+  end
+
+  # @!attribute size
+  # @param [Vector] size to make display
+  # @return [Vector] size of display
+
+  # @!attribute width
+  # @param [Vector] width to make display
+  # @return [Vector] width of display
+
+  # @!attribute height
+  # @param [Vector] height to make display
+  # @return [Vector] height of display
+
+  # @!attribute fill_color
+  # @param [Color] color for fill
+  # @return [Color] color for fill
+
+  # @!attribute stroke_color
+  # @param [Color] color for stroke
+  # @return [Color] color for stroke
+
+  # @!attribute stroke_width
+  # @param [Numeric] width for stroke
+  # @return [Numeric] width for stroke
+
+  # @!attribute font_family
+  # @param [String] font family for text
+  # @return [String] font family for text
+
+  # @!attribute font_size
+  # @param [String] font size for text
+  # @return [String] font size for text
+
+  # @!method color_at(position)
+  # @param [Vector] position of pixel from which to get color
+  # @return [Color] color of pixel
+
+  # @!attribute [r] transformation
+  # @return [Array] transformation matrix
+
+  # @!method translate(displacement)
+  # @param [Vector] displacement in 2D
+  # @return [nil]
+  # @todo Make this work in 3D.
+  # Move the transformation by a 2D displacement.
+
+  # @!method scale(multiplier)
+  # @param [Vector] multiplier in 2D
+  # @return [nil]
+  # @todo Make this work in 3D.
+  # Scale the transformation by a 2D multiplier.
+
+  # @!method rotate(radians)
+  # @param [Numeric] radians in 2D
+  # @return [nil]
+  # @todo Make this work in 3D.
+  # Rotate the transformation by radians.
+
+  # @!method push
+  # @return [nil]
+  # Push transformation to the transformation stack.
+
+  # @!method pop
+  # @return [nil]
+  # Pop a transformation off the transformation stack.
+
+  # @!method stroke_line(start_pos, end_pos)
+  # @param [Vector] start position in 2D
+  # @param [Vector] end position in 2D
+  # @return [nil]
+  # Stroke a line between two positions.
+
+  # @!method stroke_rectangle(position, size)
+  # @param [Vector] position in 2D
+  # @param [Vector] size in 2D
+  # @return [nil]
+  # Stroke a rectangle at a position and size.
+
+  # @!method fill_rectangle(position, size)
+  # @param [Vector] position in 2D
+  # @param [Vector] size in 2D
+  # @return [nil]
+  # Fill a rectangle at a position and size.
+
+  # @!method stroke_ellipse(center, radius)
+  # @param [Vector] center position in 2D
+  # @param [Vector] radius in 2D
+  # @return [nil]
+  # Stroke an ellipse at a center position and 2D radius.
+
+  # @!method fill_ellipse(center, radius)
+  # @param [Vector] center position in 2D
+  # @param [Vector] radius in 2D
+  # @return [nil]
+  # Fill an ellipse at a center position and 2D radius.
+
+  # @!method clear
+  # @return [nil]
+  # Clear display with fill color.
+
+  # @!method begin_shape
+  # @return [nil]
+  # Begin new shape.
+
+  # @!method end_shape
+  # @return [nil]
+  # End shape.
+
+  # @!method move_to(position)
+  # @param [Vector] position
+  # @return [nil]
+  # Move shape cursor to position.
+
+  # @!method line_to(position)
+  # @param [Vector] position
+  # @return [nil]
+  # Draw line to position as part of shape.
+
+  # @!method curve_to(position, control)
+  # @param [Vector] position
+  # @param [Vector] control point position
+  # @return [nil]
+  # Draw curve with a control point to position as part of shape.
+
+  # @!method curve2_to(position, control1, control2)
+  # @param [Vector] position
+  # @param [Vector] first control point position
+  # @param [Vector] second control point position
+  # @return [nil]
+  # Draw curve with 2 control points to position as part of shape.
+
+  # @!method stroke_shape
+  # @return [nil]
+  # Stroke previously made shape.
+
+  # @!method fill_shape
+  # @return [nil]
+  # Fill previously made shape.
+
+  # @!method image(image, position)
+  # @param [Image] image to draw
+  # @param [Vector] position
+  # @return [nil]
+  # @example Draw a duck within a game
+  #   display.image Image['images/duck.png'], V[80, 80]
+  # Draw an image at a position.
+
+  # @!method image_cropped(image, position, crop_position, crop_size)
+  # @param [Image] image to draw
+  # @param [Vector] position
+  # @param [Vector] start point of crop
+  # @param [Vector] size of crop
+  # @return [nil]
+  # Draw a cropped image at a position.
+
+  # @!method fill_text(text, position)
+  # @param [String] text value
+  # @param [Vector] position
+  # @return [nil]
+  # Fill text at a position.
+
+  # @!method stroke_text(text, position)
+  # @param [String] text value
+  # @param [Vector] position
+  # @return [nil]
+  # Stroke text at a position.
+end
+end

data/lib/yeah/_platform/image.rb

@@ -0,0 +1,16 @@
+module Yeah
+
+# An `Image` is an asset that a `Display` can draw.
+# @abstract Provided by a `Platform`.
+# @see Yeah::Display#image
+class Image < Asset
+  # @!attribute [r] size
+  # @return [Vector] size of image
+
+  # @!attribute [r] width
+  # @return [Integer] width of image
+
+  # @!attribute [r] height
+  # @return [Integer] height of image
+end
+end

data/lib/yeah/_platform/keyboard.rb

@@ -0,0 +1,37 @@
+module Yeah
+
+# The `Keyboard` provides keyboard input handling.
+# @example Playing sound on key press within game
+#   neigh.play if keyboard.pressed? :scroll_lock
+# @abstract Provided by a `Platform`.
+class Keyboard
+  KEYS = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, :a, :alt, :b, :backquote, :backslash,
+          :backspace, :c, :caps_lock, :comma, :ctrl, :d, :delete, :dot, :down,
+          :e, :end, :enter, :equals, :escape, :f, :f1, :f10, :f11, :f12, :f2,
+          :f3, :f4, :f5, :f6, :f7, :f8, :f9, :fn, :g, :h, :home, :i, :insert,
+          :j, :k, :l, :left, :left_bracket, :m, :minus, :n, :num0, :num1,
+          :num2, :num3, :num4, :num5, :num6, :num7, :num8, :num9,
+          :num_asterisk, :num_dot, :num_lock, :num_minus, :num_plus,
+          :num_slash, :o, :p, :page_down, :page_up, :pause, :q, :quote, :r,
+          :right, :right_bracket, :s, :scroll_lock, :semicolon, :shift, :slash,
+          :super, :t, :tab, :u, :up, :v, :w, :x, :y, :z]
+
+  # @param [Hash] options for new object
+  # @option options [Ticker] :ticker for one-shot input handling
+  def initialize(options = {})
+    raise NotImplementedError
+  end
+
+  # @!method pressing?(key)
+  # @param [Symbol, Numeric] key to check
+  # @return [Boolean] whether key is pressed
+
+  # @!method pressed?(key)
+  # @param [Symbol, Numeric] key to check
+  # @return [Boolean] whether key was just pressed
+
+  # @!method released?(key)
+  # @param [Symbol, Numeric] key to check
+  # @return [Boolean] whether key was just released
+end
+end

data/lib/yeah/_platform/mouse.rb

@@ -0,0 +1,30 @@
+module Yeah
+
+# `Mouse` provides mouse input handling.
+# @example Attack on button press within game
+#   attack if mouse.pressed? :left
+# @abstract Provided by a `Platform`.
+class Mouse
+  BUTTONS = [:left, :middle, :right, 4, 5]
+
+  # @param [Hash] options for new object
+  # @option options [Ticker] :ticker for one-shot input handling
+  # @option options [String] :canvas_selector ('canvas') for canvas HTML
+  #   element (applicable only to `Web::Mouse`)
+  def initialize(options = {})
+    raise NotImplementedError
+  end
+
+  # @!method pressing?(button)
+  # @param [Symbol, Numeric] button to check
+  # @return [Boolean] whether button is pressed
+
+  # @!method pressed?(button)
+  # @param [Symbol, Numeric] button to check
+  # @return [Boolean] whether button was just pressed
+
+  # @!method released?(button)
+  # @param [Symbol, Numeric] button to check
+  # @return [Boolean] whether button was just released
+end
+end

data/lib/yeah/_platform/sound.rb

@@ -0,0 +1,15 @@
+module Yeah
+
+# A `Sound` is an audio asset, which can be used to provide music and sound
+# effects for a game.
+# @example Playing a sound
+#   Sound['sounds/neigh.wav'].play
+# @abstract Provided by a `Platform`.
+class Sound < Asset
+  # @!method play
+  # Play sound.
+
+  # @!method pause
+  # Pause sound. A following call to {#play} will resume.
+end
+end