rubygame 2.3.0-x86-linux

data/NEWS

@@ -0,0 +1,252 @@
+= NEWS
+
+== Rubygame 2.3.0
+
+Release focus: Media resources.
+
+=== Features
+
+- Add: Rubygame::NamedResource mixin module
+  - Provides per-class resource repository and on-demand auto-loading
+    behavior.
+
+- Add: Rubygame::Music class.
+  - Intended as a full replacement for Rubygame::Mixer::Music.
+  - Includes NamedResources mixin.
+  - NOTE: Requires SDL_mixer support.
+
+- Add: Rubygame::Sound class.
+  - Intended as a full replacement for Rubygame::Mixer::Sample.
+  - Includes NamedResources mixin.
+  - NOTE: Requires SDL_mixer support.
+
+- Update: Rubygame::Surface class.
+  - Includes NamedResources mixin.
+  - Add: Surface.load_from_string (NOTE: Requires SDL_image support.)
+
+=== Fixes
+
+- ColorBase had been accidently placed in the top level namespace in
+  Rubygame 2.2.0. It is now correctly placed in the Rubygame::Color
+  module.
+
+=== Other Stuff
+
+- Deprecation (will be removed in Rubygame 3.0):
+  - Rubygame::Mixer module and methods are deprecated.
+  - Rubygame::Mixer::Music class is deprecated.
+    Use Rubygame::Music class instead.
+  - Rubygame::Mixer::Sample class is deprecated.
+    Use Rubygame::Sound class instead.
+  - Rubygame::Surface.load_image is deprecated.
+    Use Rubygame::Surface.load instead.
+
+- NOTE: Run ruby with -w flag or set $_v = true to enable run-time
+  deprecation warnings.
+
+
+
+
+== Rubygame 2.2.0
+
+Release focus: Colors.
+
+=== Features
+
+- Add: Rubygame::Color module
+  - ColorRGB, ColorHSV, and ColorHSL classes.
+  - X11 and CSS palettes of pre-defined colors.
+  - Surface methods can accept ColorRGB etc. for colors.
+  - Automatic lookup of color names when a string or symbol
+    is passed for a color to Surface methods.
+- Add: Surface#set_at().
+
+- Add: Screen#icon=().
+
+=== Bug Fixes
+
+- Fix: Surface#draw_arc was incorrectly documented as Surface#draw_pie
+
+=== Improvements
+
+- Rect#collide_rect? is now faster.
+- Sprites::Group#collide_group can take a block; arguments are deprecated.
+
+=== Other Stuff
+
+- Build system correctly recompiles if source has changed.
+- Build system option syntax has changed. See the README: Advanced Install.
+- Build system will correctly exit with an error status if it can't compile;
+  fixes Rubygems trying to install even when compile failed.
+
+=== Acknowledgements
+
+- Michael Swiger (mokkan) for Screen#icon=.
+- ippa for optimizing Rect#collide_rect?.
+
+
+
+
+== Rubygame 2.1.0
+
+=== Features
+
+- Add: Mixer::Music module.
+- Add: Mixer.driver_name method.
+- Add: Depth sorting for sprites.
+- Add: Sprite#undraw.
+- Add: TTF#size_utf8 and TTF#size_unicode.
+- Add: Rubygame.key_name.
+
+=== Bug Fixes
+
+- Fix: Bug with dirty rectangles in UpdateGroup.
+- Fix: Incorrect docs for joy-hat direction value.
+- Fix: Segfaults when Joysticks are garbage-collected after Rubygame has quit.
+- Fix: Segfaults when using Surface#convert, #to_display, or #to_display_alpha
+  when no video mode has been set.
+- Fix: Surface#get_at returning [0,0,0,0] when it shouldn't.
+- Fix: Sprites::Group#collide_group behaving incorrectly (again).
+- Fix: Build system doesn't correctly handle quoted spaces in --cflags/--lflags.
+  (NOTE: Use CFLAGS/LDFLAGS environment variables now, instead.)
+
+=== Known Issues
+
+- Build system won't detect changed source files and recompile as necessary;
+  you must "rake clobber build" after a change.
+
+=== Other Stuff
+
+- Added argument checks to several Rect methods.
+- Surfaces can be created with no Screen mode set.
+- Mixer.open_audio has default values.
+- TTF style getting/setting refactored under the hood.
+- Added demo_music.rb and a sample song.ogg to try out music.
+
+=== Acknowledgements
+
+- Johan Berntsson for adding Mixer::Music.
+- Daniel Neis Araujo for adding Sprite#undraw.
+- Roger Ostrander (denor) for and bug fixes and adding Rubygame.key_name.
+- Bjorn De Meyer (beoran) for numerous patches and improvements.
+
+
+ 
+
+== Rubygame 2.0.1
+
+=== Bug Fixes
+
+- Fix: Segfaults in several C methods when passed an unexpected argument type.
+- Fix: Segfaults in Screen#update and Screen#update_rects when the Rect(s)
+  extended out of the Screen bounds.
+- Fix: Ftor#magnitude= behaving incorrectly.
+- Fix: Rect#clip! behaving incorrectly.
+- Fix: Sprites::Group#collide_group behaving incorrectly.
+- Fix: Surface#savebmp wanting too many arguments.
+
+=== Other Stuff
+
+- Argument handling for C methods is now more robust under the hood.
+- C methods which expect Array arguments will now also work with objects
+  that can be converted to an Array (with #to_ary), such as Ftor.
+
+
+
+
+== Rubygame 2.0.0:
+
+*NOTICE*: version 2.0.0 is not totally backward-compatible with 1.1.0.
+You may have to update existing applications to the new syntax.
+(Hence the major version number going up.)
+
+=== API Changes
+
+==== Basic audio playback with SDL_mixer
+
+- Add: Rubygame::Mixer module (basic SDL_mixer audio playback).
+- Add: Rubygame::Mixer::Sample class (load audio samples).
+
+==== Event management system revamped
+
+- Add: Rubygame.fetch_sdl_events()
+- Add: Rubygame::EventQueue class.
+- Add: Rubygame::MailQueue mixin.
+- Retire: Rubygame::Queue class.
+
+==== Surface swallows Draw, Transform, and Image methods
+
+- Updated: Rubygame::Surface class
+  - Add: Surface.load_image() (migrated from Image).
+  - Add: ##savebmp (migrated from Image).
+  - Add: ##draw_* (migrated from Draw).
+  - Add: ##rotozoom, ##zoom (migrated from Transform).
+  - Add: ##zoom_to method.
+
+- Retire: Draw module (methods merged into Surface).
+- Retire: Transform module (methods merged into Surface).
+- Retire: Image module (methods merged into Surface).
+
+==== Clock class improved
+
+- Updated: Rubygame::Clock class
+  - Clock is now directly under Rubygame (not Rubygame::Time).
+  - Clock.new() takes no arguments, but yields self if a block is given.
+  - framerate limiting with ##tick is now much more accurate.
+  - Add: Clock.runtime(), Clock.wait(), Clock.delay() (migrated from Time)
+  - Rename: ##fps to ##framerate.
+  - Rename: ##desired_fps to ##target_framerate.
+  - Rename: ##desired_mspf to ##target_frametime.
+  - Rename: ##time to ##lifetime.
+
+- Retire: Time module (methods merged into Clock).
+
+==== Experimental classes/modules
+
+- Add: Rubygame::MediaBag class.
+- Add: Rubygame::Ftor class.
+- Add: Rubygame::Hotspot mixin.
+- Change: Rubygame::SFont class must be explicitly imported
+  (require 'rubygame/sfont').
+
+==== New system for version and capability detection
+
+- Rubygame::VERSIONS: a hash table with the version numbers of rubygame, 
+  SDL, and any SDL_* libraries that were compiled in.
+- Methods which are not supported will no be defined in the namespace; 
+  formerly, they would be defined but nonfunctional (issued a warning and
+  returned nil).
+
+==== Miscellaneous other changes and additions
+
+- Add: Rubygame.quit (cleanly exit SDL; resets resolution after fullscreen).
+
+- Updated: Rubygame::Surface class
+  - Argument list for Surface.new() has changed.
+  - Add: ##clip and ##clip=.
+  - Add: ##convert, ##to_display, and ##to_display_alpha.
+
+- Updated: Rubygame::Screen class
+  - Rename: Screen.set_mode() to Screen.new().
+  - Add: Screen.set_mode() and Screen.instance() (aliases for Screen.new()).
+  - Add: ##title, ##title= (replaces ##caption and ##set_caption)
+
+- Updated: Rubygame::TTF class
+  - Add: ##render_utf8 and ##render_unicode methods.
+  - Add: ##size_text method.
+
+=== Bug Fixes
+
+- Fix several erroneous Rect methods.
+- Fix "bignum out of range of unsigned long (RangeError)" when using
+  Rubygame::FULLSCREEN.
+
+=== Other Stuff
+
+- New build/install system with Rake.
+- Split the monolithic rubygame extension into modules:
+  rubygame_core::  main SDL interface.
+  rubygame_gfx::   SDL_gfx interface.
+  rubygame_image:: SDL_image interface.
+  rubygame_mixer:: SDL_mixer interface.
+  rubygame_ttf::   SDL_ttf interface.

data/README

@@ -0,0 +1,123 @@
+ = Rubygame README
+
+ == What is Rubygame?
+
+ Rubygame is a cross-platform game-development extension and library for Ruby,
+ inspired by Pygame. The purpose of Rubygame is to empower game developers by
+ providing them with powerful and flexible high-level concepts. Instead of
+ worrying about low-level technical details, you can focus your energy on
+ more interesting things (like making a fun game).
+
+ Rubygame's core is written in C to bind low-level SDL functions into Ruby.
+ On top of that is a pure Ruby library for higher-level behavior like
+ event and game object management.
+
+ === Relevant Links
+ 1. Rubygame: http://rubygame.sourceforge.net
+ 2. Ruby: http://www.ruby-lang.org
+ 3. Pygame: http://www.pygame.org
+ 4. SDL: http://www.libsdl.org
+
+ == Requirements
+
+ You will definitely need these software packages to compile Rubygame:
+
+ * ruby        >= 1.8 
+ * SDL         >= 1.2.7
+ * rake        >= 0.7.0    (for build/install system)
+
+ It's highly recommended that you have these packages as well, or some
+ cool features won't be available!
+
+ * SDL_gfx     >= 2.0.10
+ * SDL_image   >= 1.2.3
+ * SDL_mixer   >= 1.2.7
+ * SDL_ttf     >= 2.0.6
+
+ (If you don't have some of those, you have to disable those features
+ by passing some flags to the build process. See "Advanced Install", below.)
+
+ If you are compiling source on a binary-based Linux ditribution,
+ you will also need the "dev" packages of ruby, SDL, SDL_gfx, SDL_image,
+ SDL_mixer, and SDL_ttf. (Really, you just need the header files.)
+
+ And of course, if you are compiling the source, you will need a C compiler!
+ These versions of gcc worked fine when I tried them; other compilers might
+ work too:
+
+ * gcc 3.3, 3.4, 4.0, 4.1
+
+
+ == Install
+
+ === Basic Install
+
+ Extract the archive and enter its top directory.
+ Then run ($ indicates as user, # as root):
+
+  $ rake build
+  # rake install
+
+ === Advanced Install
+
+ The build and install tasks can be configured by providing certain commands
+ to rake:
+
+ no-sdl-gfx::    do not build modules which depend on SDL_gfx
+ no-sdl-image::  do not build modules which depend on SDL_image
+ no-sdl-mixer::  do not build modules which depend on SDL_mixer
+ no-sdl-ttf::    do not build modules which depend on SDL_ttf
+ no-opengl::     do not build modules which depend on OpenGL
+
+ no-sdl-config:: do not guess compiler/linker flags using `sdl-config'
+
+ debug::         build modules with debbugging flags enabled
+ universal::     on MacOS X, try to compile for both PPC and Intel
+ verbose::       display the build commands as they are run
+
+ Additionally, the build process respects certain environmental variables.
+ In particular, CFLAGS and LDFLAGS are important for users compiling with
+ the no-sdl-config command.
+
+ CC::            C compiler command
+ CFLAGS::        flags passed to the C compiler
+ LDSHARED::      linker command
+ LDFLAGS::       flags passed to the linker
+ RUBYARCHDIR::   where to install platform-specific compiled extensions
+ RUBYLIBDIR::    where to install platform-independent interpreted libs
+
+ IMPORTANT: if you are missing any optional SDL_* libraries, you must specify
+ "no-*" flags for those libraries. For example, if you don't have SDL_gfx:
+
+  $ rake no-sdl-gfx build
+
+ If you don't disable the features, the compile will probably fail when it
+ looks for the headers and libraries. (The build system is not smart enough to
+ automatically disable missing features.)
+
+ === Generating documentation
+
+ You can generate documentation for Rubygame's API by running:
+
+  # rake rdoc
+
+ Documentation will be generated as HTML in the 'html' directory.
+ Open 'html/index.html' in a web browser to get started.
+
+ == Usage
+ 
+ See the documentation (online at http://rubygame.sourceforge.net, or
+ generated locally with the 'rake rdoc' command). 
+
+ We also recommend that you take a peek at the demo applications in
+ the 'samples' directory, especially chimp.rb.
+
+ == License
+
+ Rubygame is distributed under the terms of the GNU Lesser GPL.
+ See LICENSE for more details.
+
+ Some of the sample files are distributed under licenses other than the
+ GNU Lesser GPL. See 'samples/README' and 'samples/GPL' for more details.
+
+ John Croisant (jacius at users.sourceforge.net)

data/ROADMAP

@@ -0,0 +1,109 @@
+= ROADMAP
+
+This represents the direction Rubygame will be going in, but
+keep in mind that specific details may change over time.
+
+
+== 2.4.0 (next minor release)
+
+Release focus: Events.
+
+- New EventHook class, has 3 parts: owner, trigger, and action.
+  - New trigger classes, e.g. KeyPressedTrigger (matches key presses)
+  - New action classes, e.g. MethodAction (calls a method on owner)
+
+- New EventHandler class
+  - Holds many EventHook instances, feeds the event to each
+    matching hook.
+
+- New HasEventHandler mixin, can embed in sprite, etc. classes
+  for easy event handling and hook creation.
+
+- New Events module, with a suite of new and revised event classes.
+
+  - Eliminate integer constants in favor of symbols
+    - Keyboard keys are symbols (e.g. :up, :a, :space)
+    - Mouse buttons are symbols (e.g. :mouse_left, :mouse_wheel_up)
+
+  - Nicer, more natural naming scheme
+    - Drop the word "Event" from the class names.
+    - "Down" and "Up" (e.g. in KeyDownEvent) become "Pressed"
+      and "Released" (e.g. KeyPressed).
+    - MouseMotionEvent becomes MouseMoved.
+    - Other miscellaneous changes.
+
+  - Better unicode / international keyboard support
+    - KeyPress#string gives a UTF8 bytestring with the glyph that was
+      generated by the keypress (useful for text input in GUIs).
+
+- Old versions of the event classes stay the same, but are deprecated.
+
+
+
+== 2.X.0 (_possible_ minor releases before 3.0.0)
+
+=== Focus: Time
+
+- New Events::Tick class with lots of information
+  - Time since last frame, in both seconds and milliseconds.
+  - Current time
+  - Current framerate
+
+- New clock class
+  - Based on Ruby's timer (allows multi-threading).
+  - Better framerate calculation algorithm
+  - #tick returns an instance of Events::Tick.
+
+=== Focus: Sprites
+
+- New sprite system
+  - New Sprite, Scene, and Camera classes.
+  - More powerful and simpler to use.
+  - Integration with the Chipmunk physics library.
+
+
+
+== 3.0.0 (next major release)
+
+- Backwards compatibility is broken:
+  - Deprecated classes / methods retired:
+    - Rubygame::Mixer module.
+    - Rubygame::Mixer::Sample class. Use Rubygame::Sound.
+    - Rubygame::Mixer::Music class. Use Rubygame::Music.
+    - Rubygame::Surface.load_image method. User Rubygame::Surface.load.
+  - Surface#get_at
+  - Sprites::Group#collide_group
+
+- Change Sprites::Group#collide_group to scrap the 'killa/killb' stuff,
+  take a block instead.
+
+
+
+== On the horizon...
+
+- Polygon, circle, and other geometric primitives
+  - Drawing, with styles?
+  - OpenGL drawing?
+  - Collision detection?
+  - Physical shapes w/ Chipmunk?
+  - Generate bounding Polygon from an image automatically?
+
+- Path (Curve?) (graphs/plots for tracing position and other uses)
+  - Can find the position N units along the path.
+  - Can draw a line showing the path.
+  - LinearPath (connect the dots, linear interpolation)
+  - BezierPath (chain of continuous cubic Bézier curves)
+  - CodePath (calculated from a code block)
+
+- Effect (Action?)
+  - "Attach" to an instance, does something over time.
+  - E.g. moves a sprite from point A to point B over N seconds.
+  - Many types of effects, easy to define custom ones.
+  - Takes parameters: start/end time, others depending on effect.
+
+- C equivalent of Rect.new_from_object (see rect.rb)
+  - Screen#update (cannot pass object with rect attribute)
+  - Screen#update_rects (same as above)
+  - Why not just call the ruby function from within C?
+
+