*******************************************************
*** vgagames: package for coding vga games for UN*X ***
*** Copyright (C) 2000-2005 Kurt Nienhaus           ***
*******************************************************

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


*******************************************************

Overview
~~~~~~~~
Use the vgagames package to code your own games
with a resolution of 320x200 pixels and 256 colors
for UN*X systems (Linux, FreeBSD, OpenBSD).

vgagames includes the basic functions you would need
to do this job without taking account into
which operating system, which graphic or sound library
are used.
Call these functions to
 - open or close your game window
 - load graphics or create and draw them
 - load sprites (animated graphics)
 - repaint your game window and flush it to the screen
 - play sound files (wave,mp3,midi) to up to 8 channels
 - load another colormap
 - change brightness
 - handle key (and eventually mouse) events
 - make your game loop taking always the same time
 - permit up to 8 players connected via network (tcp/ip)
 - ... (see doc/index.html)

See doc/index.html how to use the vgagames functions in your program
and how to compile.

See 0-INSTALL how to install vgagames.


You must have installed one of the following graphic libraries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - svgalib for Linux (svgalib-1.4.2 or higher)
   Get it from www.svgalib.org (or www.vgagames.de).
   (for gcc-3.3 or higher please refer to 0-SVGALIB.PATCH included in vgagames)

   After installing svgalib you have to modify /etc/vga/libvga.config:
     - change your mouse type, e.g.:   "mouse IMPS2" or "mouse PS2"
     - define your monitor type, e.g.: "HorizSync 31.5 35.5"
                                       "VertRefresh 50 70"
     - define your chipset, e.g.:      "chipset VESA"
                                       "VesaText"
       or, if your console
       uses 80x25 text:                "chipset VGA"

 - libvgl for FreeBSD
   should be included in any FreeBSD installation

 - X window for Linux/FreeBSD/OpenBSD
   to be able to compile your game with X window, you must have installed
   the development header files (Linux: *-devel-* package)

Note: For svgalib and libvgl your game must be owned by root with setuid-root.


Required sound support
~~~~~~~~~~~~~~~~~~~~~~
 - OSS support (kernel or emulation), using /dev/dsp
   (Linux, FreeBSD)
 - ALSA (since 0.9.0rc4) support
   with installed development header files to be able to compile
   (Linux)
 - Sun audio, using /dev/audio
   (OpenBSD)

There is a wave configuration file: /usr/share/vgagames/wave.conf
