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