                              XBoing Installation
                              ===================

								23rd July 1993

Requirements
------------

- You must be using X11R4 or X11R5. It may work on X11R3 but cannot test it!
- You must have the XPM pixmap library. The XPM library can be obtained from
  the following sites:-

  avahi.inria.fr (138.96.24.30)     - Latest revision. (Europe)     V3.2g
  export.lcs.mit.edu (18.30.0.238)  - Latest revision. (America)    V3.2g
  archie.au (139.130.4.6)           - Latest revision. (Australia)  V3.2g

  I have been successfully using version 3.2f, or version 3.2g. I haven't
  tried any lower versions. The author of XPM is lehors@sophia.inria.fr

- v1.4 has now been compiled and works on the following machines :-

	+ SunOS .. 4.1.2 5 sun4c/sun4m
	+ IRIX .. 4.0.5G 12171207 IP7
	+ SGI 310/GTX
	+ HP 9000/720 HP-UX 8.07
	+ DEC 2100
	+ DEC OSF/1 AXP
	+ DECstation 5000/133 ULTRIX 4.2 0 RISC
	+ AIX 3.2.3e rs6000/350
	+ NetBSD on i486
	+ Linux on i486.

- You must have a colour display. Sorry to all those B&W dudes.

- An ANSI compiler would be nicer however I spent ages changing code with
  all those lovely #ifdefs so you can use a non-ansi compiler. :-)

- This game DOES NOT need Motif or Xt or anything except pure XLib.


Makefiles
---------

Included in this package is an Imakefile which generates a Makefile that will
compile XBoing using your system setup. For those people without imake, or
who can't get it to compile, a Makefile.std is also included. 


Compilation
-----------

Edit the Imakefile or the Makefile.std and change the default compiler to
your compiler. Also change the compiler flags if necessary. 

Change the $(XBOING_DIR) to point to the place where xboing is to be 
installed. In that directory xboing will create the highscore file and also
place the level data and sound data.

Also set the AUDIO_AVAILABLE flag to True or False to enable the audio in
the game if possible. Sound is supported only on SUN Sparc machines. SGI soon!.

If you are on a Sun SparcStation and you want sound then copy SUNaudio.c to
audio.c and the sound routines should work. I hope.

If you have imake, type:

    xmkmf
    make depend
    make all

X11R5 users can type 'xmkmf -a ; make all' if they like.

If you do not have imake, type:

    cp Makefile.std Makefile
	make depend
    make all


Installation
------------

Try 'xboing -setup' and see if the compilation has gone as you planned.
This option will print out useful information about where xboing will look
for its data files.

Please note that you must be root to install the game. If you are not root
then you can just run XBoing from your own account.

Don't forget to set the $(XBOING_DIR) in the Makefile/Imakefile and re-compile
if you don't like where it will be installed.

For imake users, type:

    make install             - install XBoing binary.
    make install.man         - install the manual page.

If you do not have imake then you must first edit the Makefile.std to check
that where you want the program to be installed.

    make install             - install XBoing binary.
    make install.man         - install the manual page.
	
You should now have XBoing installed and it's manual page. If not, then please
read Troubleshooting.


HighScore File
--------------

It is automatically created and chmoded to 0666. There will also be a personal
highscore file saved in each users account home directory. This keeps their
personal highscores. If you have problems then touch one and chmod it to
something that will work for you. ie: rw for all.

NOTE: **** The highscore file format has changed since v1.4b. Any old ones 
		   will barf! Just erase them please.

Troubleshooting
---------------

I was hoping you wouldn't be reading this but anyway ...

make depend

	Some header files in xboing were not found. Check the includes and see
	if the Imakefile/Makefile.std includes in the correct directory. If all
	else fails then xmkmf/cp Ma..std Makefile again and forget it.

xpm.h

    You must have the Xpm library as explained in the requirements section.
    XBoing uses the Xpm library extensively. If you have it then please check
    that the XPMINCLUDE dir is set correctly in the Imakefile/Makefile.std

Header Files  

    Maybe you have the X11 header files in another place. Please check the 
    Imakefile or Makefile.std and change the -I directories to your site. 
    If you are using imake then tell your sysop that imake didn't look
    in the correct place for the X11 header files. 

Highscore file is corrupt

	I have changed the highscore file format since v1.4b. Sorry but it is 
	much better now and will save times etc. Just delete the old one and 
	start again.

Strange libraries needed

	Check the Imakefile or Makefile.std and make sure the sysop has installed
	the Imake.rules correctly. If all else fails just remove them one by one
	until it compiles.

Copyright
---------

XBoing: 

/*****************************************************************************
 
          (c) Copyright 1993, Justin C. Kibell, All Rights Reserved
                           email: jck@citri.edu.au

  Permission to use, copy, modify, and distribute this software and its
  documentation without written agreement is hereby granted. You cannot sell 
  this software without written permission from the author. This entire 
  copyright notice must appear in all copies of this software.

  IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, 
  SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF 
  THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR HAS BEEN ADVISED 
  OF THE POSSIBILITY OF SUCH DAMAGE.

  THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED 
  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE 
  AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, 
  ENHANCEMENTS, OR MODIFICATIONS.

 *****************************************************************************/

Xpm:
  ----------------------------------------------------------------------------
/*
 * Copyright 1990-93 GROUPE BULL
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of GROUPE BULL not be used in advertising
 * or publicity pertaining to distribution of the software without specific,
 * written prior permission.  GROUPE BULL makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 *
 * GROUPE BULL disclaims all warranties with regard to this software,
 * including all implied warranties of merchantability and fitness,
 * in no event shall GROUPE BULL be liable for any special,
 * indirect or consequential damages or any damages
 * whatsoever resulting from loss of use, data or profits,
 * whether in an action of contract, negligence or other tortious
 * action, arising out of or in connection with the use
 * or performance of this software.
 *
 */

Arnaud LE HORS      BULL Research FRANCE -- Koala Project
                    (XPM - X PixMap format version 2 & 3)
    Internet:       lehors@sophia.inria.fr
Surface Mail:       Arnaud LE HORS, INRIA - Sophia Antipolis,
                    2004, route des Lucioles, 06565 Valbonne Cedex -- FRANCE
 Voice phone:       (33) 93.65.77.71, Fax: (33) 93 65 77 66, Telex: 97 00 50 F
  ----------------------------------------------------------------------------

-------------------------------------------------------------------------------
Justin Kibell - jck@citri.edu.au - +61 3 282 2456 - Vic - Australia
