README						Mon Dec 18 14:07:35 PST 2000

by David J. Goehrig and Wayne Keenan

Preface

	What is contained within this directory tree, this assorted
tangle of C and perl, forms the basis for the SDL bindings for the
perl language.  This collection is considered to be the 'current stable
branch' and will continue to be as such for a while.  

Prerequisites

	Before attempting to install this monstrosity, please make sure
you have the following properly installed:


SDL-1.1.3 or greater 
	http://www.devolution.com/~slouken/SDL

	smpeg-0.3.4 or greater
		http://www.lokisoft.com/

	SDL_mixer-1.0.5 
		http://www.devolution.com/~slouken/SDL/projects/SDL_mixer	

	SDL_image-1.0.0
		http://www.devolution.com/~slouken/SDL

	www.libsdl.org

Open GL libraries
	
	Mesa 3.1 or greater  (GLX accelration is (ahem) 'optional'!!! )
		http:/www.mesa3d.org


Perl Open GL Module

        OpenGL-0.5.0  or greater
		http://www.perl.com/CPAN/
		(or use CPAN Shell:  type "install OpenGL" at the prompt)


Optional, but highly recommended anyway:

                
PDL Modules  
        
	CPAN
        http://pdl.perl.org
	
        (has dependancy on 'at least' OpenGL)



Image Magick and bindings for perl.

	CPAN

Gtk
	CPAN  for perl bindings
	www.gtk.org


Installation

	Once you have that bundle installed, simply build and install this
module as specified in the perlmod manpage:

			perl Makefile.PL
			make
			make install

Testing

	I can't be bothered to write a test script for this entire thing.
There are simply too many things that can go wrong, and I'd rather write
more useful code, so if it built OK then assume it is all OK and get
on with it.

Examples

	In the directory /examples/ I have placed a few samplers which
show the basic usage of each piece of the puzzle.  Reading the man
pages should give a information regarding each funciton.  When in doubt
read the code, and consult the SDL documentation.  If you are still
having trouble track me down and email me.

More examples are available seperately from  
http://www.metaverse.fsnet.co.uk/sdlpl/
email: wayne@metaverse.fsnet.co.uk.


On Version Numbers

	This is now version 1.08, and should build out of the box
with SDL 1.15.  Please forward all bug reports to dgoehrig@users.sourceforge.net
or dgoehrig@valinux.com.

The Future

	As the SDL 1.2 API has been frozen, the next few revisions to this
codebase shall reflect the changes in the API.

	More importantly is the fabled sdlpl 2.0 release, which shall break
the horrible cycle of XS creation.  Future development shall be taking
place at:

	http://www.sourceforge.net/projects/sdlpl



Bug fixing:



Greatest Sentance in Documentation:

Similary, 

	$mixer->group_channels(from,to,group) 

will add channels from 'from' to 'to' to group 'group'. <line 356 in Mixer.pm>

CREDITS

	David J. Goehrig (dave@cthulhu-burger.org)	Copyright (C) 2000,2001,2002
	Wayne Keenan               			Added OpenGL & Glut like support
	Guillaume Cottenceau <gc@mandrakesoft.com>	Bug fixes and advice
							and numerous examples, suggestions
