git.maemo.org Git - neverball/blob - INSTALL

   1
   2                             * Neverball *
   3
   4
   5 * REQUIREMENTS
   6
   7     SDL               http://www.libsdl.org/download-1.2.php
   8     SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/
   9     PhysicsFS         http://icculus.org/physfs/
  10     libvorbis         http://xiph.org/vorbis/
  11     libpng            http://www.libpng.org/pub/png/libpng.html
  12     libjpeg
  13
  14 To build Neverball  with native language support on  systems not using
  15 the GNU C library, an additional library may have to be installed:
  16
  17     libintl           http://www.gnu.org/software/gettext/
  18
  19 To  build Neverball  with Nintendo  Wii Remote  support on  Linux, the
  20 "official Linux Bluetooth protocol stack"  or BlueZ and the libwiimote
  21 library must be installed and configured:
  22
  23     BlueZ             http://www.bluez.org/
  24     libwiimote        http://libwiimote.sourceforge.net/
  25
  26 To  build Neverball  with  Hillcrest Labs  Loop  support enabled,  the
  27 libfreespace and libusb libraries must be installed and configured:
  28
  29     libusb-1.0        http://www.libusb.org/wiki/Libusb1.0
  30     libfreespace      http://libfreespace.hillcrestlabs.com/
  31
  32 * FONTS
  33
  34 The  Deja  Vu  font  used   by  Neverball  is  not  suitable  for  all
  35 translations  included with  the  game.  Due  to  file size  concerns,
  36 another font is not included with Neverball; however, additional fonts
  37 can be installed in these locations:
  38
  39     ttf/wqy-zenhei.ttc    Simplified Chinese
  40     ttf/wqy-microhei.ttc  Traditional Chinese
  41
  42 The Wen Quan Yi Chinese fonts may be obtained from here:
  43
  44     Wen Quan Yi       http://wenq.org/en/
  45
  46
  47 * COMPILATION
  48
  49 Under Unix and Linux, simply run
  50
  51     make
  52
  53 Certain features  can be enabled/disabled  at compile time  by passing
  54 additional arguments to  Make in the form "NAME=VALUE",  where NAME is
  55 one of those listed below and VALUE is typically 0 for disabled, 1 for
  56 enabled.
  57
  58     ENABLE_NLS=1
  59
  60         Enable  native  language   support.   May  require  additional
  61         libraries.
  62
  63     ENABLE_TILT=wii
  64
  65         Enable Wii Remote support.   Requires additional libraries and
  66         system configuration.
  67
  68     ENABLE_TILT=loop
  69
  70         Enable  Hillcrest  Labs  Loop  support.   Requires  additional
  71         libraries and system configuration.
  72
  73     ENABLE_FS=stdio
  74
  75         Enable alternate  file system  backend that uses  standard I/O
  76         instead  of PhysicsFS (thus  making the  dependency optional),
  77         but does not provide archive support.
  78
  79 Under Mac OS X, build using the provided Xcode project files.
  80
  81 For  Windows  builds,  the   MinGW  cross-compilation  environment  is
  82 supported. (Native builds  are theoretically possible using  MinGW and
  83 MSYS.  Although care is taken  to preserve compatibility with MSYS, no
  84 support exists and no actual testing is done.)
  85
  86 By default, an uninstalled build may be executed in place.
  87
  88
  89 * INSTALLATION
  90
  91 The game  searches for game assets  in the following three  places, in
  92 this order.  If the game is to  be installed globally, at least one of
  93 them must be set.
  94
  95  1. The directory  specified as argument to '--data'  (or '-d') option
  96     on the command line.
  97
  98  2. The directory given by the NEVERBALL_DATA environment variable.
  99
 100  3. The directory given by the CONFIG_DATA macro defined in
 101     share/base_config.h (which corresponds to the DATADIR Makefile
 102     variable).
 103
 104 A normal Linux installation would probably copy the data directory to
 105 "/usr/local/share/games/neverball/" and set DATADIR to match.
 106
 107
 108 * DISTRIBUTION
 109
 110 The dist subdirectory contains some miscellaneous files:
 111
 112   * "Desktop entry" or .desktop files.
 113   * Icons in PNG, SVG and ICO formats.
 114
 115
 116 Web: <http://neverball.org/>