rnd-20001205-3-src
[rocksndiamonds.git] / INSTALL
1
2 Installation instructions for Rocks'n'Diamonds 1.2.0
3 ====================================================
4
5 Compilation
6 -----------
7
8 If your system supports Linux/i386/ELF/libc5 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/Windows 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 If the above doesn't work, edit the Makefile in the top level directory.
20 If it doesn't work either, edit the Makefile in the 'src' subdirectory.
21
22 If you had to modify any Makefile to compile it, please drop me a note
23 about it to 'aeglos@valinor.owl.de'. Thanks!
24
25
26 Customization
27 -------------
28
29 The following configuration options in the top level Makefile help
30 you to customize the game to your system and your environment:
31
32 CC              Choose your favorite ANSI C compiler.
33                 Default is 'gcc'.
34
35 PLATFORM        Choose your platform, if auto detection fails.
36                 Auto detection should work for Linux and DOS
37                 (just type 'make'), on SUN/Solaris systems 'make solaris'
38                 should work. Other systems may need additional editing
39                 of 'src/Makefile' to set some additional compiler options.
40
41 X11_PATH        Specify the path to your X11 installation. Include files
42                 and libraries are searched for at $(X11_PATH)/include and
43                 $(X11_PATH)/lib, if you set this variables. If you don't
44                 set this variable, your compiler must be able to find X11
45                 by itself, which works fine for Linux, for example.
46
47 GAME_DIR        Specify the directory where the program looks for all the
48                 graphics, sounds, levels and high scores. If you leave this
49                 commented out, the current directory ('.') is used, which
50                 lets you use the game without installing it somewhere in
51                 your system (although you have to 'cd' to the game directory
52                 each time you want to play it).
53
54 JOYSTICK        Uncomment this line if your system does not support game
55                 port hardware like joysticks (and has therefore no joystick
56                 include file). Currently the game should work with joysticks
57                 on Linux and FreeBSD.
58
59 SOUNDS          Uncomment this line if your system does not support audio
60                 hardware. Currently the game should work with sound support
61                 on Linux, FreeBSD, SUN/Solaris, HP-UX and most Unix system
62                 that support '/dev/dsp' or '/dev/audio' devices.
63
64 SCORE_ENTRIES   Choose if you want to allow many entries in the high score
65                 table for one player or exactly one entry. Systems with a
66                 lot of users maybe want to limit high score entries to only
67                 one entry for each player (and therefore set 'SCORE_ENTRIES'
68                 to 'ONE_PER_NAME') where systems used by only one person
69                 maybe want to use the default of 'MANY_PER_NAME' which is
70                 automatically choosen if you leave everything commented out.
71
72 Modifications of the Makefile in the directory 'src' are normally not needed.
73 If the game fails to compile out of the box, you may have to modify some
74 of the system variables there to get it to compile.
75
76 SYSTEM          May need to be set to some system dependend values.
77
78 INCL, LIBS      Maybe some more directories for include files and libraries
79                 have to be added to this variables depending on your system.
80
81
82 If you have any comments, additions or modifications to the Makefile(s),
83 please send me mail: 'aeglos@valinor.owl.de'. Thanks!
84
85 05-DEC-1998, Holger Schemel