flonkerton 0.0.1

data/README.md

@@ -0,0 +1,115 @@
+# Flonkerton
+
+Gosu toys for the bored rubyist.
+
+## Requisites
+
+You'll need [Gosu](http://www.libgosu.org/).
+
+Also [Protest](http://github.com/matflores/protest), [RR](http://github.com/btakita/rr) and [Watchr](http://github.com/mynyml/watchr) for test awesomeness.
+
+## Installation
+
+    $ sudo gem install flonkerton
+
+## Features
+
+* Screens Handling
+* Auto-loads Resources
+* YAML Configuration
+* Some conventions and default values
+
+## Usage
+
+    require 'flonkerton'
+    Flonkerton::Game.start
+
+### Hello World
+
+    require 'flonkerton'
+    include Flonkerton
+
+    class HelloWorld < Screen
+      def draw
+        Fonts[:default].draw(:text => 'Hello World!')
+      end
+    end
+
+    Game.start(HelloWorld)
+
+### Basic Example
+
+    require 'flonkerton'
+    include Flonkerton
+
+    class GameScreen < Screen
+      def setup
+        @x = 0
+        @song = Songs[:intro]
+        @image = Images[:gosu_logo]
+        @sample = Samples[:beep]
+      end
+
+      def button_down(id)
+        close        if id == Gosu::KbEscape # or super
+        @song.play   if id == Gosu::KbSpace
+        @sample.play if id == Gosu::KbReturn
+      end
+
+      def update
+        @x += 10 if button_down?(Gosu::KbRight)
+      end
+
+      def draw
+        @image.draw(:x => @x)
+      end
+    end
+
+    Game.start(GameScreen)
+
+See [examples](/apillet/flonkerton/tree/master/examples/).
+
+## Related Projects
+
+* [Chingu](http://github.com/ippa/chingu)
+* [Exuberant](http://github.com/adamsanderson/lexery/tree/master/lib/exuberant)
+* [FWD](http://github.com/walski/FWD)
+* [Lotu](http://github.com/lobo-tuerto/lotu)
+* [Nimo](http://github.com/moonpxi/nimo)
+* [PuitUniverse](http://github.com/oneup/puituniverse)
+* [Ramverk](http://github.com/deps/Ramverk)
+* [Space Shooter Engine](http://github.com/belen-albeza/space-shooter/tree/master/engine/)
+* [SpriteJam](http://github.com/richardeden/spritejam)
+* [UrDoinItRite](http://github.com/actsasbuffoon/UrDoinItRite)
+
+The following projects are not based on Gosu, but worth looking into:
+
+* [Ruby Warrior](http://github.com/ryanb/ruby-warrior)
+* [Gamebox](http://github.com/shawn42/gamebox)
+* [Jemini](http://github.com/jemini/jemini-core)
+* [Zyps](http://github.com/jaymcgavren/zyps)
+
+## License
+
+Copyright (c) 2010 Ariel H. Pillet
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+task :default do
+  system %Q(ruby test/unit_tests.rb)
+end
+
+task :test do
+  system %Q(ruby test/integration_test.rb)
+end
+
+task :rcov do
+  system %Q(rcov test/unit_tests.rb --exclude gosu,protest,rr,rcov)
+end

data/TODO

@@ -0,0 +1,12 @@
+TODO
+
+- Document.
+- Clean up tests.
+- Add basic instructions to WelcomeScreen.
+- Add Font#draw_rot
+- Add Font#draw_rel
+- Add Image#draw_rot
+- Add Window#text_input
+- Add Window#update_interval
+- Add Screen#gl
+- Write some mini-games.

data/config/defaults.yml

@@ -0,0 +1,39 @@
+# Window
+#
+:width: 800
+:height: 600
+:caption: Flonkerton Example
+:font_size: 20
+:fullscreen: false
+:initial_screen: WelcomeScreen
+
+# Resources
+#
+:media_path: media
+:fonts_ext: *.ttf
+:songs_ext: *.ogg
+:tiles_ext: *.png
+:images_ext: *.png
+:samples_ext: *.wav
+
+# Defaults
+#
+:image:
+  :x: 0
+  :y: 0
+  :z: 0
+  :factor_x: 1
+  :factor_y: 1
+  :color: 0xffffffff
+  :mode: :default
+  :order: [:x, :y, :z, :factor_x, :factor_y, :color, :mode] # For 1.8.6 - Don't change this
+:font:
+  :text: ''
+  :x: 0
+  :y: 0
+  :z: 0
+  :factor_x: 1
+  :factor_y: 1
+  :color: 0xffffffff
+  :mode: :default
+  :order: [:text, :x, :y, :z, :factor_x, :factor_y, :color, :mode] # For 1.8.6 - Don't change this

data/examples/clip.rb

@@ -0,0 +1,16 @@
+require '../lib/flonkerton'
+include Flonkerton
+
+module Example
+  class GameScreen < Screen
+    def setup
+      @background = Images[:background]
+    end
+
+    def draw
+      clip_to(10, 10, 320, 200) { @background.draw }
+    end
+  end
+end
+
+Game.start

data/examples/config/defaults.yml

@@ -0,0 +1,39 @@
+# Window
+#
+:width: 800
+:height: 600
+:caption: Flonkerton Example
+:font_size: 20
+:fullscreen: false
+:initial_screen: Example::GameScreen
+
+# Resources
+#
+:media_path: ../media
+:fonts_ext: *.ttf
+:songs_ext: *.ogg
+:tiles_ext: *.png
+:images_ext: *.png
+:samples_ext: *.wav
+
+# Defaults
+#
+:image:
+  :x: 0
+  :y: 0
+  :z: 0
+  :factor_x: 1
+  :factor_y: 1
+  :color: 0xffffffff
+  :mode: :default
+  :order: [:x, :y, :z, :factor_x, :factor_y, :color, :mode] # For 1.8.6 - Don't change this
+:font:
+  :text: ''
+  :x: 0
+  :y: 0
+  :z: 0
+  :factor_x: 1
+  :factor_y: 1
+  :color: 0xffffffff
+  :mode: :default
+  :order: [:text, :x, :y, :z, :factor_x, :factor_y, :color, :mode] # For 1.8.6 - Don't change this

data/examples/extras/actor.rb

@@ -0,0 +1,47 @@
+class Actor
+  attr_accessor :x, :y, :zorder, :scale_x, :scale_y, :color, :mode
+
+  DEFAULTS = { :x       => 0,
+               :y       => 0,
+               :zorder  => 0,
+               :scale   => 1,
+               :color   => Gosu::Color::WHITE,
+               :mode    => :default }
+
+  def initialize options = {}
+    options = DEFAULTS.merge(options)
+    @x = options[:x]
+    @y = options[:y]
+    @zorder = options[:zorder]
+    scale = options[:scale]
+    @scale_x = options[:scale_x] || scale
+    @scale_y = options[:scale_y] || scale
+    @color = options[:color]
+    @mode = options[:mode]
+  end
+
+  def scale= value
+    @scale_x = value
+    @scale_y = value
+  end
+
+  def image
+    @image ||= Images[label]
+  end
+
+  def draw offset_x = 0, offset_y = 0
+    image.draw :x => @x - offset_x,
+               :y => @y - offset_y,
+               :z => @zorder,
+               :factor_x => @scale_x,
+               :factor_y => @scale_y,
+               :color => @color,
+               :mode => @mode
+  end
+
+protected
+
+  def label
+    self.class.to_s[/\w+$/].scan(/([A-Z]+[a-z]+)/).flatten.join('_').downcase.intern
+  end
+end

data/examples/extras/fill.rb

@@ -0,0 +1,5 @@
+module FillScreen
+  def fill(color = 0xffffffff)
+    @game.draw_quad(0, 0, color, width, 0, color, 0, height, color, width, height, color)
+  end
+end

data/examples/extras/input_handler.rb

@@ -0,0 +1,9 @@
+module InputHandler
+  def input
+    @input ||= Hash.new { |hash, key| hash[key] = [] }
+  end
+
+  def pressed?(key)
+    input[key].detect { |k| @game.button_down?(k) }
+  end
+end

data/examples/extras/mouse_border.rb

@@ -0,0 +1,21 @@
+module MouseBorder
+  def border
+    40
+  end
+
+  def mouse_on_left?
+    mouse_x <= border
+  end
+
+  def mouse_on_top?
+    mouse_y <= border
+  end
+
+  def mouse_on_right?
+    mouse_x >= width - border
+  end
+
+  def mouse_on_bottom?
+    mouse_y >= height - border
+  end
+end

data/examples/extras/random_color.rb

@@ -0,0 +1,27 @@
+# Ruby 1.8.6 compatibility
+#
+unless Array.new.respond_to?(:sample)
+  class Array
+    def sample
+      self.sort_by{ Kernel.rand }.pop
+    end
+  end
+end
+
+class Range
+  def rand
+    self.to_a.sample
+  end
+end
+
+module Gosu
+  class Color
+    def self.random red = (0..255), green = (0..255), blue = (0..255)
+      color = Color.new(0xff000000)
+      color.red = red.rand
+      color.green = green.rand
+      color.blue = blue.rand
+      color
+    end
+  end
+end

data/examples/extras/scrollable.rb

@@ -0,0 +1,80 @@
+module Scrollable
+  class Viewport
+
+    DEFAULTS = { :x          => 0,
+                 :y          => 0,
+                 :width      => 800,
+                 :height     => 600,
+                 :max_width  => 1600,
+                 :max_height => 1200,
+                 :speed      => 5 }
+
+    attr_reader :width, :height
+    attr_accessor :x, :y, :speed, :max_width, :max_height
+
+    def initialize options = {}
+      options = DEFAULTS.merge(options)
+      @x = options[:x]
+      @y = options[:y]
+      @speed = options[:speed]
+      @width = options[:width]
+      @height = options[:height]
+      @max_width = options[:max_width]
+      @max_height = options[:max_height]
+    end
+
+    def move_left
+      @x -= @speed if left_allowed?
+    end
+
+    def move_right
+      @x += @speed if right_allowed?
+    end
+
+    def move_up
+      @y -= @speed if up_allowed?
+    end
+
+    def move_down
+      @y += @speed if down_allowed?
+    end
+
+  protected
+
+    def left_allowed?
+      @x >= @speed
+    end
+
+    def right_allowed?
+      @x + @width + @speed <= @max_width
+    end
+
+    def down_allowed?
+      @y + @height + @speed <= @max_height
+    end
+
+    def up_allowed?
+      @y >= @speed
+    end
+  end
+
+  def viewport
+    @viewport ||= Viewport.new
+  end
+
+  def scroll_down
+    viewport.move_down
+  end
+
+  def scroll_up
+    viewport.move_up
+  end
+
+  def scroll_left
+    viewport.move_left
+  end
+
+  def scroll_right
+    viewport.move_right
+  end
+end

data/examples/font.rb

@@ -0,0 +1,25 @@
+require '../lib/flonkerton'
+include Flonkerton
+
+module Example
+  class GameScreen < Screen
+    def setup
+      @default = Fonts[:default]
+      @arcade = Fonts[:arcade_classic]
+    end
+
+    def draw
+      @arcade.draw :x => 10,
+                   :text => 'Flonkerton',
+                   :color => Gosu::Color::GREEN,
+                   :factor_x => 2,
+                   :factor_y => 2
+
+      @default.draw :x => 30,
+                    :y => 40,
+                    :text => 'default font is ' + Gosu::default_font_name
+    end
+  end
+end
+
+Game.start