tones/bumperoo.map: fix coin values.
[neverball] / INSTALL
diff --git a/INSTALL b/INSTALL
index 64c9e9a..90f21de 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -6,15 +6,15 @@
 
     SDL               http://www.libsdl.org/download-1.2.php
     SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/
 
     SDL               http://www.libsdl.org/download-1.2.php
     SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/
+    PhysicsFS         http://icculus.org/physfs/
     libvorbis         http://xiph.org/vorbis/
     libpng            http://www.libpng.org/pub/png/libpng.html
     libjpeg
 
 To build Neverball  with native language support on  systems not using
     libvorbis         http://xiph.org/vorbis/
     libpng            http://www.libpng.org/pub/png/libpng.html
     libjpeg
 
 To build Neverball  with native language support on  systems not using
-the GNU C library, two additonal libraries may have to be installed:
+the GNU C library, an additional library may have to be installed:
 
     libintl           http://www.gnu.org/software/gettext/
 
     libintl           http://www.gnu.org/software/gettext/
-    libiconv          http://www.gnu.org/software/libiconv/
 
 To  build Neverball  with Nintendo  Wii Remote  support on  Linux, the
 "official Linux Bluetooth protocol stack"  or BlueZ and the libwiimote
 
 To  build Neverball  with Nintendo  Wii Remote  support on  Linux, the
 "official Linux Bluetooth protocol stack"  or BlueZ and the libwiimote
@@ -23,6 +23,26 @@ library must be installed and configured:
     BlueZ             http://www.bluez.org/
     libwiimote        http://libwiimote.sourceforge.net/
 
     BlueZ             http://www.bluez.org/
     libwiimote        http://libwiimote.sourceforge.net/
 
+To  build Neverball  with  Hillcrest Labs  Loop  support enabled,  the
+libfreespace and libusb libraries must be installed and configured:
+
+    libusb-1.0        http://www.libusb.org/wiki/Libusb1.0
+    libfreespace      http://libfreespace.hillcrestlabs.com/
+
+* FONTS
+
+The  Deja  Vu  font  used   by  Neverball  is  not  suitable  for  all
+translations  included with  the  game.  Due  to  file size  concerns,
+another font is not included with Neverball; however, additional fonts
+can be installed in these locations:
+
+    ttf/wqy-zenhei.ttc    Simplified Chinese
+    ttf/wqy-microhei.ttc  Traditional Chinese
+
+The Wen Quan Yi Chinese fonts may be obtained from here:
+
+    Wen Quan Yi       http://wenq.org/en/
+
 
 * COMPILATION
 
 
 * COMPILATION
 
@@ -35,21 +55,32 @@ additional arguments to  Make in the form "NAME=VALUE",  where NAME is
 one of those listed below and VALUE is typically 0 for disabled, 1 for
 enabled.
 
 one of those listed below and VALUE is typically 0 for disabled, 1 for
 enabled.
 
-    ENABLE_NLS
+    ENABLE_NLS=1
+
+        Enable  native  language   support.   May  require  additional
+        libraries.
+
+    ENABLE_TILT=wii
 
 
-        Enable  native   language  support.  May   require  additional
-        libraries. Default: enabled.
+        Enable Wii Remote support.   Requires additional libraries and
+        system configuration.
 
 
-    ENABLE_WII
+    ENABLE_TILT=loop
 
 
-        Enable Wii  Remote support. Requires additional  libraries and
-        system configuration Default: disabled .
+        Enable  Hillcrest  Labs  Loop  support.   Requires  additional
+        libraries and system configuration.
+
+    ENABLE_FS=stdio
+
+        Enable alternate  file system  backend that uses  standard I/O
+        instead  of PhysicsFS (thus  making the  dependency optional),
+        but does not provide archive support.
 
 Under Mac OS X, build using the provided Xcode project files.
 
 For  Windows  builds,  the   MinGW  cross-compilation  environment  is
 
 Under Mac OS X, build using the provided Xcode project files.
 
 For  Windows  builds,  the   MinGW  cross-compilation  environment  is
-supported. (Native  builds are theoretically possible  using MinGW and
-MSYS. Although care  is taken to preserve compatibility  with MSYS, no
+supported. (Native builds  are theoretically possible using  MinGW and
+MSYS.  Although care is taken  to preserve compatibility with MSYS, no
 support exists and no actual testing is done.)
 
 By default, an uninstalled build may be executed in place.
 support exists and no actual testing is done.)
 
 By default, an uninstalled build may be executed in place.
@@ -57,8 +88,8 @@ By default, an uninstalled build may be executed in place.
 
 * INSTALLATION
 
 
 * INSTALLATION
 
-The game  searches for game assets  in the following  three places, in
-this order.  If the game is  to be installed globally, at least one of
+The game  searches for game assets  in the following three  places, in
+this order.  If the game is to  be installed globally, at least one of
 them must be set.
 
  1. The directory  specified as argument to '--data'  (or '-d') option
 them must be set.
 
  1. The directory  specified as argument to '--data'  (or '-d') option
@@ -66,12 +97,12 @@ them must be set.
 
  2. The directory given by the NEVERBALL_DATA environment variable.
 
 
  2. The directory given by the NEVERBALL_DATA environment variable.
 
- 3. The   directory   given  by  the  CONFIG_DATA   macro  defined  in
-    share/base_config.h
+ 3. The directory given by the CONFIG_DATA macro defined in
+    share/base_config.h (which corresponds to the DATADIR Makefile
+    variable).
 
 
-A normal Linux installation would  probably copy the data directory to
-"/usr/local/share/games/neverball/" and  change the  CONFIG_DATA macro
-to match.
+A normal Linux installation would probably copy the data directory to
+"/usr/local/share/games/neverball/" and set DATADIR to match.
 
 
 * DISTRIBUTION
 
 
 * DISTRIBUTION
@@ -82,5 +113,4 @@ The dist subdirectory contains some miscellaneous files:
   * Icons in PNG, SVG and ICO formats.
 
 
   * Icons in PNG, SVG and ICO formats.
 
 
-http://neverball.org/
-
+Web: <http://neverball.org/>