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