Update INSTALL.
[neverball] / INSTALL
1
2                             * Neverball *
3
4
5 * COMPILATION
6
7 Requirements:
8
9     SDL               http://www.libsdl.org/download-1.2.php
10     SDL_image         http://www.libsdl.org/projects/SDL_image/
11     SDL_mixer         http://www.libsdl.org/projects/SDL_mixer/
12     SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/
13
14 Under Unix, Linux, and OSX, simply run
15
16     make
17
18 Under Windows, build using the provided Visual Studio solution.
19
20 By default, an uninstalled build may be executed in place.
21
22
23 * INSTALLATION
24
25 The game  searches for game assets  in the following  three places, in
26 this order.  If the game is  to be installed globally, at least one of
27 them must be set.
28
29  1. The directory specified as argument to '--data' (or '-d') option
30     on the command line.
31
32  2. The directory given by the NEVERBALL_DATA environment variable.
33
34  3. The directory given by the CONFIG_DATA variable defined in
35     base_config.h
36
37
38 A normal Linux installation would  probably copy the data directory to
39 "/usr/local/games/neverball/" and  change the CONFIG_DATA  variable to
40 match.
41
42 A  normal  Windows installation  would  simply  copy  the entire  game
43 directory  to "C:\Program Files\Neverball"  and leave  the CONFIG_DATA
44 variable to its default value "./data".
45
46
47 * DISTRIBUTION
48
49 The dist directory contains some miscellaneous files:
50
51   * manual pages;
52   * .desktop files;
53   * icons.
54
55 Contact: <robert.kooima@gmail.com>