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     libvorbis         http://xiph.org/vorbis/
  10     libpng            http://www.libpng.org/pub/png/libpng.html
  11     libjpeg
  12
  13 To build Neverball  with native language support on  systems not using
  14 the GNU C library, an additional library may have to be installed:
  15
  16     libintl           http://www.gnu.org/software/gettext/
  17
  18 To  build Neverball  with Nintendo  Wii Remote  support on  Linux, the
  19 "official Linux Bluetooth protocol stack"  or BlueZ and the libwiimote
  20 library must be installed and configured:
  21
  22     BlueZ             http://www.bluez.org/
  23     libwiimote        http://libwiimote.sourceforge.net/
  24
  25
  26 * COMPILATION
  27
  28 Under Unix and Linux, simply run
  29
  30     make
  31
  32 Certain features  can be enabled/disabled  at compile time  by passing
  33 additional arguments to  Make in the form "NAME=VALUE",  where NAME is
  34 one of those listed below and VALUE is typically 0 for disabled, 1 for
  35 enabled.
  36
  37     ENABLE_NLS=1
  38
  39         Enable  native  language   support.   May  require  additional
  40         libraries.
  41
  42     ENABLE_WII=0
  43
  44         Enable Wii Remote support.   Requires additional libraries and
  45         system configuration.
  46
  47 Under Mac OS X, build using the provided Xcode project files.
  48
  49 For  Windows  builds,  the   MinGW  cross-compilation  environment  is
  50 supported. (Native builds  are theoretically possible using  MinGW and
  51 MSYS.  Although care is taken  to preserve compatibility with MSYS, no
  52 support exists and no actual testing is done.)
  53
  54 By default, an uninstalled build may be executed in place.
  55
  56
  57 * INSTALLATION
  58
  59 The game  searches for game assets  in the following three  places, in
  60 this order.  If the game is to  be installed globally, at least one of
  61 them must be set.
  62
  63  1. The directory  specified as argument to '--data'  (or '-d') option
  64     on the command line.
  65
  66  2. The directory given by the NEVERBALL_DATA environment variable.
  67
  68  3. The   directory   given  by  the  CONFIG_DATA   macro  defined  in
  69     share/base_config.h
  70
  71 A normal Linux installation would  probably copy the data directory to
  72 "/usr/local/share/games/neverball/" and  change the  CONFIG_DATA macro
  73 to match.
  74
  75
  76 * DISTRIBUTION
  77
  78 The dist subdirectory contains some miscellaneous files:
  79
  80   * "Desktop entry" or .desktop files.
  81   * Icons in PNG, SVG and ICO formats.
  82
  83
  84 Web: <http://neverball.org/>