INSTALL for Defendguin

by Bill Kendrick
bill@newbreedsoftware.com
http://www.newbreedsoftware.com/defendguin/

Version 0.0.5

June 6, 2000


REQUIREMENTS
------------
  "Defendguin" was programed using the "Simple Direct Media" layer
  libraries by Sam Lantinga.  This means that the game can
  theoretically run under any environment that the SDL libraries support.

    (As of this program's release, this includes: Linux X11/DGA,
    Win32 WinDIB/DirectX, BeOS BWindow, and Solaris X11, as well
    as unofficually supported: Linux SVGAlib, IRIX 6.x X11,
    FreeBSD 3.x X11, and MacOS.)

  The game is played with a keyboard.

  Sound and music are available, but are not required (see below).
  You will need the "SDL_mixer" library compiled and installed.

  You can download the SDL library at:
    http://www.devolution.com/~slouken/SDL/download.html

  You can download the SDL_mixer library at:
    http://www.devolution.com/~slouken/SDL/projects/SDL_mixer/


INSTALLING
----------
  -----------------------------------------------------------------
  Note: Read this entire section before you start issuing commands!
  -----------------------------------------------------------------

  The "Makefile" that comes with "Defendguin" assumes a number
  of defaults about your system.  You can edit their values in
  the "Makefile" itself, or specify their values when you run
  the "make" command (ie, "make VARIABLE=value").

  The things you may wish to edit are:

    JOY=YES

      This compiles the game with joystick support.
      (SDL 1.1.2 or higher is necessary!)

    PREFIX=/usr/local/

      If you're going to be installing "Defendguin" using the
      "install" target in "Makefile" (see below), you can set
      where you'd like the program and data to be copied.

      The program will be copied into $(PREFIX)/bin.  That
      means the resulting file using the default PREFIX will
      be "/usr/local/bin/defendguin".

      The data files will be copied into $(PREFIX)/share/defendguin.
      That means the files will end up in "/usr/local/share/defendguin/"...

    DATA_PREFIX=$(PREFIX)/share/defendguin/

      This defines where "Defendguin"'s datas directories are
      to be found.  The default assumes that you are going to
      be installing "Defendguin" using the make target "install"
      (see above and below).

      If you're installing 'locally' (ie, within a home directory),
      you'll want to set this to "$(PWD)/data".  That way,
      the data files, where they are now, will be used.

      Or, you can pick somewhere else and set "DATA_PREFIX" to that,
      but then make sure to copy and, if applicable, set permissions of,
      the data files after you compile the program!


  To compile the game, type the command:

    make           [ with whatever variable changes you want, if any ]


  Note: If you do not have the SDL_mixer library, or wish to not
  compile sound support into the game, you can compile it like this:

    make nosound   [ with whatever variable changes you want, if any ]


  To install the game into the location specified by "PREFIX" in Makefile,
  run this command, probably as "root" user:

    make install

  This will create the data directory the data files will be copied into
  (by default, "/usr/local/share/defendguin"), and recursively copy
  the data files from the local "data/" directory into that directory.

  It will then copy the "defendguin" program itself, which you just
  compiled in the steps above, into the appropriate directory
  (by default, "/usr/local/bin/").


  If you wish to return the directory to its distribution state,
  (remove the ".o" object files, and the "defendguin" executable program
  file), you can run:

    make clean


  To uninstall Defendguin, you can run (probably as "root" user):

    make uninstall

  Make sure the "PREFIX" and "DATA_PREFIX" variables are set the
  same as when you ran "make install"!


That's it!
