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