tea 0.6.1

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,93 @@
+= 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
+
+First, get Ruby (http://www.ruby-lang.org) if you don't have it already.  Ruby
+1.9 or later is recommended.
+
+Tea is available as a gem on Gemcutter, so add http://gemcutter.org to your
+~/.gemrc and type
+
+  gem install tea
+
+
+== 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() * 4 - 2, rand() * 4 - 2
+  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, Tea::Color::MAGENTA
+    Tea::Screen.update
+
+    sleep 0.001
+  end
+
+
+== Status
+
+All done.
+
+* Events/Input - done
+* Graphics - done
+* Sound - done
+* Fonts - done
+
+
+== More information
+
+Project page:: http://github.com/tung/tea
+Wiki::         http://wiki.github.com/tung/tea
+
+
+== 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/bitmap_new.rb

@@ -0,0 +1,19 @@
+# Test that Bitmaps can be created without an image file.
+# Expected results are a red square inside a cyan square.
+
+require 'tea'
+
+puts <<TEST
+You should see a red square in a cyan square for 2 seconds.
+TEST
+
+Tea.init
+a = Tea::Bitmap.new(200, 200, Tea::Color::CYAN)
+Tea::Screen.set_mode 400, 300
+b = Tea::Bitmap.new(150, 150, Tea::Color::RED)
+
+Tea::Screen.blit a, 100, 50
+Tea::Screen.blit b, 125, 75
+Tea::Screen.update
+
+sleep 2

data/doc/example/circle.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, Tea::Color::WHITE
+Tea::Screen.circle 100, 150,  50, Tea::Color::GREEN, :antialias => true
+Tea::Screen.circle 300, 150,  50, Tea::Color::RED, :outline => true
+
+Tea::Screen.update
+
+sleep 3

data/doc/example/circle_alpha.rb

@@ -0,0 +1,45 @@
+# Test that alpha blending works for circles.
+# Expected results: 8 green circles drawn over the edges of a white rectangle,
+# varying in outline, anti-aliasing and blend/replace alpha mixing.
+
+require 'tea'
+
+puts <<TEST
+You should see a white rectangle and circles along the edges:
+
+--b     --r     -ab
+
+-ar             o-b
+
+o-r     oab     oar
+
+o--   = outline
+-a-   = antialias
+--b/r = blend/replace
+
+Press any key to exit.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+Tea::Screen.rect 100, 75, 200, 150, Tea::Color::WHITE
+
+translucent_green = Tea::Color.mix(0, 255, 0, 128)
+Tea::Screen.circle 100,  75, 25, translucent_green, :outline => false, :antialias => false, :mix => :blend
+Tea::Screen.circle 200,  75, 25, translucent_green, :outline => false, :antialias => false, :mix => :replace
+Tea::Screen.circle 300,  75, 25, translucent_green, :outline => false, :antialias => true,  :mix => :blend
+
+Tea::Screen.circle 100, 150, 25, translucent_green, :outline => false, :antialias => true,  :mix => :replace
+Tea::Screen.circle 300, 150, 25, translucent_green, :outline => true,  :antialias => false, :mix => :blend
+
+Tea::Screen.circle 100, 225, 25, translucent_green, :outline => true,  :antialias => false, :mix => :replace
+Tea::Screen.circle 200, 225, 25, translucent_green, :outline => true,  :antialias => true,  :mix => :blend
+Tea::Screen.circle 300, 225, 25, translucent_green, :outline => true,  :antialias => true,  :mix => :replace
+
+Tea::Screen.update
+
+loop do
+  e = Tea::Event.get(true)
+  break if e.class == Tea::App::Exit || e.class == Tea::Kbd::Down
+end

data/doc/example/circle_alpha_bitmap.rb

@@ -0,0 +1,51 @@
+# Test that alpha blending works for circles.
+# Expected results: 8 green circles drawn over the edges of a white-bordered
+# blue rectangle, varying in outline, anti-aliasing and blend/replace alpha
+# mixing.
+
+require 'tea'
+
+puts <<TEST
+You should see a white-bordered blue rectangle and circles along the edges:
+
+--b     --r     -ab
+
+-ar             o-b
+
+o-r     oab     oar
+
+o--   = outline
+-a-   = antialias
+--b/r = blend/replace
+
+Press any key to exit.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 400, 300
+
+Tea::Screen.rect 100, 75, 200, 150, Tea::Color::WHITE
+
+b = Tea::Bitmap.new(Tea::Screen.w, Tea::Screen.h, Tea::Color.mix(0, 0, 0, 0))
+b.rect 105, 80, 190, 140, Tea::Color.mix(0, 0, 255)
+
+translucent_green = Tea::Color.mix(0, 255, 0, 128)
+b.circle 100,  75, 25, translucent_green, :outline => false, :antialias => false, :mix => :blend
+b.circle 200,  75, 25, translucent_green, :outline => false, :antialias => false, :mix => :replace
+b.circle 300,  75, 25, translucent_green, :outline => false, :antialias => true,  :mix => :blend
+
+b.circle 100, 150, 25, translucent_green, :outline => false, :antialias => true,  :mix => :replace
+b.circle 300, 150, 25, translucent_green, :outline => true,  :antialias => false, :mix => :blend
+
+b.circle 100, 225, 25, translucent_green, :outline => true,  :antialias => false, :mix => :replace
+b.circle 200, 225, 25, translucent_green, :outline => true,  :antialias => true,  :mix => :blend
+b.circle 300, 225, 25, translucent_green, :outline => true,  :antialias => true,  :mix => :replace
+
+Tea::Screen.blit b, 0, 0
+
+Tea::Screen.update
+
+loop do
+  e = Tea::Event.get(true)
+  break if e.class == Tea::App::Exit || e.class == Tea::Kbd::Down
+end

data/doc/example/circle_bitmap.rb

@@ -0,0 +1,18 @@
+# Test that a circle drawn to a bitmap is drawn correctly.
+# Expected result is a filled white circle.
+
+require 'tea'
+
+puts <<TEST
+You should see a filled white circle for 5 seconds.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+b = Tea::Bitmap.new(320, 240, Tea::Color.mix(0, 0, 0, 0))
+b.circle 160, 120, 100, Tea::Color::WHITE, :mix => :replace
+Tea::Screen.blit b, 0, 0
+
+Tea::Screen.update
+sleep 5