tung-tea 0.0.4

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,99 @@
+= tea
+
+<i>For simpler games from a simpler age.</i>
+
+Tea is a simple 2D game development library for Ruby.  It's designed with these
+things in mind:
+
+* 0 is better than 1, and 1 is better than 2.
+* Simplicity beats speed.
+* Value and convenience can sometimes beat simplicity.
+* Procedural beats object-oriented in a dead-heat.
+
+The aim of Tea is to bring back some of the grass roots game development that
+things like QBASIC fostered.  By staying unobtrusive and out of the way, Tea
+lets you focus on your game or demo, and not the pointy bits that are part of
+many game engines and APIs.
+
+
+== Installing
+
+TODO
+
+
+== Using Tea
+
+First, require 'tea'.  This allows you to start using the rest of the Tea API.
+
+From there, you have access to all of Tea's modules, objects and methods.
+Below is a simple bouncing circle demo.
+
+  require 'tea'
+
+  Tea.init
+  Tea::Screen.set_mode 640, 480
+
+  x, y = 320, 240
+  dx, dy = rand() * 2 - 1, rand() * 2 - 1
+  r = 20
+
+  loop do
+    if e = Tea::Event.get
+      break if e.class == Tea::App::Exit
+    end
+
+    x += dx
+    y += dy
+    dx = -dx if x - r < 0 || x + r >= Tea::Screen.w
+    dy = -dy if y - r < 0 || y + r >= Tea::Screen.h
+
+    Tea::Screen.clear
+    Tea::Screen.circle x, y, r, 0xff00ffff
+    Tea::Screen.update
+
+    sleep 0.001
+  end
+
+
+== Status
+
+What's done:
+
+* Graphics
+  - Tea::Screen
+  - Tea::Bitmap (loaded from PNGs)
+  - Drawing of bitmaps on the screen/other bitmaps.
+  - Drawing of primitive shapes (rects, lines, circles).
+* Events
+  - Tea::Event.get.
+  - Tea::App::Minimized, Restored.
+  - Tea::Kbd::Down, Up.
+  - Tea::Mouse::Move, Down, Up, Scroll.
+  - State checking of App, Kbd, Mouse.
+
+What isn't done yet:
+
+* Sound
+* Screen resizing
+* Handling of alpha in colours for primitives
+
+What's still on the drawing board:
+
+* Timed game loop code
+* Resource management
+
+
+== License
+
+Tea is free software: you can redistribute it and/or modify it under the terms
+of the GNU Lesser General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.  Tea is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with Tea.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright (c) 2009 Tung Nguyen.

data/doc/example/bitmap_draw.rb

@@ -0,0 +1,21 @@
+# Test if an image can be loaded and drawn to the screen.
+# Expected result is a 320x240 display with a smile in the middle for 2
+# seconds.
+
+require 'tea'
+
+puts <<TEST
+You should see a 320x240 window with a smile in the centre.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+image = Tea::Bitmap.new('smile.png')
+x = (Tea::Screen.w - image.w) / 2
+y = (Tea::Screen.h - image.h) / 2
+
+Tea::Screen.blit image, x, y
+Tea::Screen.update
+
+sleep 2

data/doc/example/bitmap_load.rb

@@ -0,0 +1,14 @@
+# Test if a bitmap can be loaded.
+# Expected result
+#
+#   image size is 32x32
+
+require 'tea'
+
+puts <<TEST
+The following line should read "image size is 32x32"
+TEST
+
+Tea.init
+image = Tea::Bitmap.new('smile.png')
+puts "image size is #{image.w}x#{image.h}"

data/doc/example/circles.rb

@@ -0,0 +1,24 @@
+# Test circle drawing.
+# Expected results are a large white circle behind 2 smaller green and red
+# circles, in a 400x300 window for 3 seconds.
+
+require 'tea'
+
+puts <<TEST
+You should see a 400x300 window for 3 seconds with:
+
+ * A large white circle
+ * A small green circle on the left, antialiased
+ * A small red circle on the right, outlined
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+Tea::Screen.circle 200, 150, 100, 0xffffffff
+Tea::Screen.circle 100, 150,  50, 0x00ff00ff, :antialias => true
+Tea::Screen.circle 300, 150,  50, 0xff0000ff, :outline => true
+
+Tea::Screen.update
+
+sleep 3

data/doc/example/event_app.rb

@@ -0,0 +1,45 @@
+# Test that app events are being picked up.
+# This test is interactive, and should display messages for:
+#
+#  * Gaining and losing mouse focus
+#  * Gaining and losing keyboard focus
+#  * Minimising and restoring the screen window
+#  * App exit
+
+require 'tea'
+
+puts <<TEST
+This is an interactive event test.  It should display messages for:
+
+  * Gaining and losing mouse focus
+  * Gaining and losing keyboard focus
+  * Minimising and restoring the screen window
+  * App exit
+
+Go ahead and start doing things like changing focus.
+
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+loop do
+  case (e = Tea::Event.get)
+  when Tea::Mouse::Gained
+    puts 'Mouse::Gained event received'
+  when Tea::Mouse::Lost
+    puts 'Mouse::Lost event received'
+  when Tea::Kbd::Gained
+    puts 'Kbd::Gained event received'
+  when Tea::Kbd::Lost
+    puts 'Kbd::Lost event received'
+  when Tea::App::Restored
+    puts 'App::Restored event received'
+  when Tea::App::Minimized
+    puts 'App::Minimized event received'
+  when Tea::App::Exit
+    puts 'App::Exit event received'
+    exit
+  end
+  sleep 0.01
+end

data/doc/example/event_keyboard.rb

@@ -0,0 +1,43 @@
+# Test that keyboard events are being picked up.
+# Expected results are messages responding to key presses.
+
+require 'tea'
+
+puts <<TEST
+You should see a small window.  Try pressing some keys, or Esc to exit.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+loop do
+  e = Tea::Event.get(true)
+
+  break if e.class == Tea::App::Exit
+  next unless e.class == Tea::Kbd::Down || e.class == Tea::Kbd::Up
+  break if e.key == Tea::Kbd::ESCAPE
+
+  out = []
+
+  if e.class == Tea::Kbd::Down
+    out << 'down:'
+  else
+    out << '  up:'
+  end
+
+  out << '(' << e.key.to_s << ')'
+
+  if RUBY_VERSION =~ /1\.8/
+    mods = (e.mods.select { |mod, down| down }).map { |pair| pair[0] }
+  else
+    mods = (e.mods.select { |mod, down| down }).keys
+  end
+  out << "++ #{mods.join(' + ')}" if mods.length > 0
+
+  if e.respond_to?(:char)
+    out << '='
+    out << "\"#{e.char}\""
+  end
+
+  puts out.join(' ')
+end

data/doc/example/event_mouse.rb

@@ -0,0 +1,85 @@
+# Test that mouse events are being picked up.
+# Expected output is reporting of mouse move/down/up/scroll events, with
+# position and relevant buttons.
+
+require 'tea'
+
+puts <<TEST
+Move the mouse in the window.  Mouse move/down/up events should be reported,
+with position and relevant buttons.  Mouse wheel scrolling should also be
+picked up, with at least the cursor position.
+TEST
+
+##############################################################################
+
+# We can avoid flooding the terminal with VT100 codes.  Sorry Windows.
+$windows = RUBY_PLATFORM =~ /w(?:in)?32/
+SAVE_POSITION = "\x1b[s"
+RESTORE_POSITION = "\x1b[u"
+HIDE_CURSOR = "\x1b[?25l"
+UNHIDE_CURSOR = "\x1b[?25h"
+CLEAR_TO_LINE_END = "\x1b[K"
+
+# VT100-enhanced printing function that overwrites the current terminal line.
+def pr(*args)
+  print HIDE_CURSOR, SAVE_POSITION if !$windows
+  print *args
+  if $windows
+    puts
+  else
+    print CLEAR_TO_LINE_END, RESTORE_POSITION, UNHIDE_CURSOR
+  end
+end
+
+##############################################################################
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+# Event tracking to only put newlines when the event class changes.
+mouse_events = [Tea::Mouse::Move,
+                Tea::Mouse::Down,
+                Tea::Mouse::Up,
+                Tea::Mouse::Scroll]
+handled = false
+last_event_class = Tea::Mouse::Move
+
+# Track repeated scrolling in the same direction.
+scroll_pos = 0
+
+loop do
+  e = Tea::Event.get(true)
+
+  if e.class == Tea::App::Exit
+    puts
+    break
+  end
+
+  # Put a newline when the event class changes.
+  if handled && mouse_events.include?(e.class) && e.class != last_event_class
+    puts
+    last_event_class = e.class
+    scroll_pos = 0
+  end
+
+  handled = true
+  case e
+  when Tea::Mouse::Move
+    if RUBY_VERSION =~ /1\.8/
+      buttons = (e.buttons.select { |button, down| down }).map { |pair| pair[0] }
+    else
+      buttons = (e.buttons.select { |button, down| down }).keys
+    end
+    pr "mouse move : x = #{e.x}, y = #{e.y}, buttons = #{buttons.join(',')}"
+  when Tea::Mouse::Down
+    pr "mouse down : x = #{e.x}, y = #{e.y}, button = #{e.button}"
+  when Tea::Mouse::Up
+    pr "mouse up   : x = #{e.x}, y = #{e.y}, button = #{e.button}"
+  when Tea::Mouse::Scroll
+    dir = e.delta == 1 ? 'down' : 'up  '
+    scroll_pos += e.delta
+    pr "scroll #{dir}: x = #{e.x}, y = #{e.y}, position = #{scroll_pos} (#{e.delta})"
+  else
+    handled = false
+  end
+end

data/doc/example/init.rb

@@ -0,0 +1,10 @@
+# Test if Tea can initialise.
+# Expected result is nothing.
+
+require 'tea'
+
+puts <<TEST
+This line should be the only output of this test.
+TEST
+
+Tea.init

data/doc/example/lines.rb

@@ -0,0 +1,49 @@
+# Test that lines of various colours can be drawn.
+# Expected results are a 400x300 for 5 seconds with:
+#
+# * 3 vertical lines on the left:         red, green, blue
+# * 3 horizontal lines at the top-right:  yellow, magenta, cyan
+# * 2 diagonal lines at the bottom-right: white and grey
+#
+# The white line should be antialiased.
+
+require 'tea'
+
+puts <<TEST
+You should see a 400x300 window for 5 seconds with:
+
+ * 3 vertical lines on the left:         red, green, blue
+ * 3 horizontal lines at the top-right:  yellow, magenta, cyan
+ * 2 diagonal lines at the bottom-right: white and grey
+
+The white line should be antialiased.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+grid_x = Tea::Screen.w / 10
+grid_y = Tea::Screen.h / 10
+
+lines = [[1,   1,   1,   9, 0xff0000ff],
+         [2,   1,   2,   9, 0x00ff00ff],
+         [3,   1,   3,   9, 0x0000ffff],
+         [6,   1,   9,   1, 0xffff00ff],
+         [6,   2,   9,   2, 0xff00ffff],
+         [6,   3,   9,   3, 0x00ffffff],
+         [6,   9,   9,   6, 0x808080ff]]
+
+lines.each do |line|
+  Tea::Screen.line grid_x * line[0], grid_y * line[1],
+                    grid_x * line[2], grid_y * line[3],
+                    line[4]
+end
+
+Tea::Screen.line grid_x * 6, grid_y * 6,
+                  grid_x * 9, grid_y * 9,
+                  0xffffffff,
+                  :antialias => true
+
+Tea::Screen.update
+
+sleep 5

data/doc/example/point.rb

@@ -0,0 +1,26 @@
+# Test that Tea can plot points on bitmaps, e.g. the screen.
+# Expected result is 4 points drawn as a rectangle in a 400x300 window for 2
+# seconds.
+
+require 'tea'
+
+puts <<TEST
+4 coloured points should appear in a rectangle formation, in a 400x300 window
+for 2 seconds.  Point formation:
+
+    red --- green
+    |           |
+    blue -- white
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+Tea::Screen.point 100,  75, 0xff0000ff
+Tea::Screen.point 300,  75, 0x00ff00ff
+Tea::Screen.point 100, 225, 0x0000ffff
+Tea::Screen.point 300, 225, 0xffffffff
+
+Tea::Screen.update
+
+sleep 2

data/doc/example/rect.rb

@@ -0,0 +1,15 @@
+# Test that filled rectangles can be drawn.
+# Expected results are a 400x300 window, with a filled yellow rectangle in it.
+
+require 'tea'
+
+puts <<TEST
+A 400x300 window should appear with a yellow rectangle for 2 seconds.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+Tea::Screen.rect 50, 50, 300, 200, 0xffff00ff
+Tea::Screen.update
+
+sleep 2

data/doc/example/screen_set_mode.rb

@@ -0,0 +1,18 @@
+# Test if the screen can initialise.
+# Expected results:
+#
+#  * output of "screen size is 320x240"
+#  * a blank 320x240 display window for 2 seconds.
+
+require 'tea'
+
+puts <<TEST
+You should see a 320x240 window for 2 seconds, and the text "screen size is 320x240"
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+puts "screen size is #{Tea::Screen.w}x#{Tea::Screen.h}"
+
+sleep 2

data/doc/example/screen_update.rb

@@ -0,0 +1,14 @@
+# Test if the screen can be updated without problems.
+# Expected result is a 320x240 graphical window shown for 2 seconds.
+
+require 'tea'
+
+puts <<TEST
+You should see a 320x240 window appear for 2 seconds.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+Tea::Screen.update
+
+sleep 2

data/doc/example/smile_bounce.rb

@@ -0,0 +1,44 @@
+# This is a demo of 5 smiley faces bouncing around a small screen.
+
+require 'tea'
+
+puts <<TEST
+You should see 5 smiley faces bouncing around on a 320x240 screen for 5 seconds.
+TEST
+
+class Smiley
+  def initialize(bitmap, start_x=0, start_y=0)
+    @bitmap = bitmap
+    @x = start_x
+    @y = start_y
+    @dx = rand() * 2 - 1
+    @dy = rand() * 2 - 1
+  end
+
+  def update
+    @x += @dx
+    @y += @dy
+    @dx = -@dx if @x < 0 || @x + @bitmap.w >= Tea::Screen.w
+    @dy = -@dy if @y < 0 || @y + @bitmap.h >= Tea::Screen.h
+  end
+
+  def draw
+    Tea::Screen.blit @bitmap, @x, @y
+  end
+end
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+smile_bitmap = Tea::Bitmap.new('smile.png')
+smiles = []
+5.times { smiles << Smiley.new(smile_bitmap, rand(288), rand(208)) }
+
+start = Time.now
+until Time.now >= start + 5
+  smiles.each { |s| s.update }
+  Tea::Screen.clear
+  smiles.each { |s| s.draw }
+  Tea::Screen.update
+  sleep 0.001
+end