vcs.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 the Simplified
  35 Chinese translation.   Due to file size concerns,  an appropriate font
  36 is  not included  with Neverball;  however, if  a font  with  the name
  37 "ttf/wqy-zenhei.ttc"  is  found in  the  search  path, Neverball  will
  38 attempt  to use  that  font.  The  Wen  Quan Yi  Chinese  font can  be
  39 obtained from here:
  40
  41     Wen Quan Yi       http://wenq.org/en/
  42
  43
  44 * COMPILATION
  45
  46 Under Unix and Linux, simply run
  47
  48     make
  49
  50 Certain features  can be enabled/disabled  at compile time  by passing
  51 additional arguments to  Make in the form "NAME=VALUE",  where NAME is
  52 one of those listed below and VALUE is typically 0 for disabled, 1 for
  53 enabled.
  54
  55     ENABLE_NLS=1
  56
  57         Enable  native  language   support.   May  require  additional
  58         libraries.
  59
  60     ENABLE_TILT=wii
  61
  62         Enable Wii Remote support.   Requires additional libraries and
  63         system configuration.
  64
  65     ENABLE_TILT=loop
  66
  67         Enable  Hillcrest  Labs  Loop  support.   Requires  additional
  68         libraries and system configuration.
  69
  70 Under Mac OS X, build using the provided Xcode project files.
  71
  72 For  Windows  builds,  the   MinGW  cross-compilation  environment  is
  73 supported. (Native builds  are theoretically possible using  MinGW and
  74 MSYS.  Although care is taken  to preserve compatibility with MSYS, no
  75 support exists and no actual testing is done.)
  76
  77 By default, an uninstalled build may be executed in place.
  78
  79
  80 * INSTALLATION
  81
  82 The game  searches for game assets  in the following three  places, in
  83 this order.  If the game is to  be installed globally, at least one of
  84 them must be set.
  85
  86  1. The directory  specified as argument to '--data'  (or '-d') option
  87     on the command line.
  88
  89  2. The directory given by the NEVERBALL_DATA environment variable.
  90
  91  3. The directory given by the CONFIG_DATA macro defined in
  92     share/base_config.h (which corresponds to the DATADIR Makefile
  93     variable).
  94
  95 A normal Linux installation would probably copy the data directory to
  96 "/usr/local/share/games/neverball/" and set DATADIR to match.
  97
  98
  99 * DISTRIBUTION
 100
 101 The dist subdirectory contains some miscellaneous files:
 102
 103   * "Desktop entry" or .desktop files.
 104   * Icons in PNG, SVG and ICO formats.
 105
 106
 107 Web: <http://neverball.org/>