INSTALL

   1
   2 Installation instructions for Rocks'n'Diamonds
   3 ==============================================
   4
   5 Compilation
   6 -----------
   7
   8 If your system supports Linux/i386/ELF/glibc executables (Linux package)
   9 or if you run DOS/Windows (DOS package), you can directly use the included
  10 precompiled binary.
  11
  12 If you use a different system, just recompile the game:
  13
  14 If you use Linux with gcc or DOS or Windows 3.x with djgpp, just try 'make'
  15 which should work without problems.
  16
  17 If you use SUN/Solaris with gcc and GNU make, try 'make solaris'.
  18
  19 To build the game with SDL support (needed for fullscreen and MOD support),
  20 type "make sdl". You need at least SDL version 1.1.x and the additional
  21 SDL libraries SDL_image and SDL_mixer. To get a recent version of the SDL
  22 library, see http://www.libsdl.org.
  23
  24 If the above doesn't work, edit the Makefile in the top level directory.
  25 If it doesn't work either, edit the Makefile in the 'src' subdirectory.
  26
  27 If you had to modify any Makefile to compile it, please drop me a note
  28 about it to 'info@artsoft.org'. Thanks!
  29
  30
  31 Customization
  32 -------------
  33
  34 The following configuration options in the top level Makefile help
  35 you to customize the game to your system and your environment:
  36
  37 CC              Choose your favorite ANSI C compiler.
  38                 Default is 'gcc'.
  39
  40 PLATFORM        Choose your platform, if auto detection fails.
  41                 Auto detection should work for Linux and DOS
  42                 (just type 'make'), on SUN/Solaris systems 'make solaris'
  43                 should work. Other systems may need additional editing
  44                 of 'src/Makefile' to set some additional compiler options.
  45
  46 X11_PATH        Specify the path to your X11 installation. Include files
  47                 and libraries are searched for at $(X11_PATH)/include and
  48                 $(X11_PATH)/lib, if you set this variables. If you don't
  49                 set this variable, your compiler must be able to find X11
  50                 by itself, which works fine for Linux, for example.
  51
  52 GAME_DIR        Specify the directory where the program looks for all the
  53                 graphics, sounds, levels and high scores. If you leave this
  54                 commented out, the current directory ('.') is used, which
  55                 lets you use the game without installing it somewhere in
  56                 your system (although you have to 'cd' to the game directory
  57                 each time you want to play it).
  58
  59 JOYSTICK        Uncomment this line if your system does not support game
  60                 port hardware like joysticks (and has therefore no joystick
  61                 include file). Currently the game should work with joysticks
  62                 on Linux and FreeBSD.
  63
  64 SOUNDS          Uncomment this line if your system does not support audio
  65                 hardware. Currently the game should work with sound support
  66                 on Linux, FreeBSD, SUN/Solaris, HP-UX and most Unix system
  67                 that support '/dev/dsp' or '/dev/audio' devices.
  68
  69 SCORE_ENTRIES   Choose if you want to allow many entries in the high score
  70                 table for one player or exactly one entry. Systems with a
  71                 lot of users maybe want to limit high score entries to only
  72                 one entry for each player (and therefore set 'SCORE_ENTRIES'
  73                 to 'ONE_PER_NAME') where systems used by only one person
  74                 maybe want to use the default of 'MANY_PER_NAME' which is
  75                 automatically choosen if you leave everything commented out.
  76
  77 Modifications of the Makefile in the directory 'src' are normally not needed.
  78 If the game fails to compile out of the box, you may have to modify some
  79 of the system variables there to get it to compile.
  80
  81 SYSTEM          May need to be set to some system dependend values.
  82
  83 INCL, LIBS      Maybe some more directories for include files and libraries
  84                 have to be added to this variables depending on your system.
  85
  86
  87 If you have any comments, additions or modifications to the Makefile(s),
  88 please send me mail: 'info@artsoft.org'. Thanks!