README

   1
   2 NAEV README
   3
   4    For an overview of the game, please visit http://code.google.com/p/naev/
   5    or view the man page (If you're on a Unix-like system).
   6
   7    An exhaustive list of command line arguments is detailed in the man page.
   8
   9    Hardware requirements can also be found on the website.
  10
  11 1) DEPENDENCIES
  12
  13    NAEV's dependencies are intended to be relatively common. In addition to
  14    an OpenGL-capable graphics card and driver, NAEV requires the following:
  15       * SDL
  16       * SDL_image
  17       * SDL_mixer
  18       * libxml2
  19       * freetype2
  20       * libpng
  21       * openal
  22       * libvorbis (>= 1.2.1 necessary for Replaygain)
  23       * binutils
  24
  25    Note that several distributions ship outdated versions of libvorbis, and
  26    thus libvorbisfile is statically linked into the release binary.
  27
  28    Compiling your own binary on many distributions will result in Replaygain
  29    being disabled.
  30
  31    See http://code.google.com/p/naev/ for package lists for several distributions.
  32
  33 2) COMPILING
  34
  35    Run:
  36
  37    ./autogen.sh && ./configure
  38    make
  39
  40    If you need special settings you should pass flags to configure, using -h
  41    will tell you what it supports.
  42
  43
  44 3) INSTALLATION
  45
  46    NAEV currently supports make install which will install everything that
  47    is needed.
  48
  49    If you wish to create a .desktop for your desktop environment, logos
  50    from 16x16 to 256x256 can be found in extras/logos
  51
  52 4) CRASHES & PROBLEMS
  53
  54    Please take a look at the FAQ (linked below) before submitting a new
  55    bug report, as it covers a number of common gameplay questions and
  56    common issues.
  57
  58    If NAEV is crashing during gameplay, please file a bug report after
  59    reading http://code.google.com/p/naev/wiki/Debugging.
  60
  61    If NAEV crashes on launch with an error such as 'undefined symbol:
  62    ov_read_filter', your version of libvorbis is outdated, please see
  63    the appropriate FAQ entry: http://code.google.com/p/naev/wiki/FAQ
  64
  65 5) KEYBINDINGS
  66
  67    You can now change keybindings in game which may be more comfortable for
  68    you then editting the configuration file.
  69
  70    5A) Introduction
  71       5A1) About
  72          NAEV uses a dynamic keybinding system that allows you to set
  73          the keybindings to joystick, keyboard or a mixture of both.
  74
  75          This can changed via ~/.naev/conf.lua, or with the in-game editor.
  76
  77    5B) Joystick
  78       If you have a joystick you'll have to tell NAEV which joystick
  79       to use.  You can either use the -j or -J parameter from the
  80       command-line or put it in the conf.lua file.
  81       Examples:
  82          naev -j 0
  83          naev -J "Precision"
  84          joystick = "Precision" # in conf.lua
  85       5B1) Syntax
  86          KEY_IDENTIFIER = { type = KEY_TYPE, key = KEY_NUMBER,
  87             [reverse = KEY_REVERSE, mod = MOD_IDENTIFIER] }
  88          KEY_IDENTIFIER is the identifier given below
  89          KEY_TYPE can be one of keyboard, jaxis or jbutton
  90          KEY_NUMBER is the number of the key (found with xev usually, just
  91             convert the keysym from hex to base 10)
  92          KEY_REVERSE is whether it is reversed or not, which is only useful
  93             in the case of jaxis
  94          MOD_IDENTIFIER is the modifier to take into account, can be one of:
  95             lctrl, rctrl, lshift, rshift, lmeta, rmeta, ralt, lalt
  96             It isn't used with joystick bindings.
  97       5B2) Example
  98          accel = { type = "jbutton", key = 0 }
  99          see conf.example for more examples
 100
 101    5C) Keys
 102       For an exhaustive list of default keybindings, please see
 103       http://code.google.com/p/naev/wiki/Keybinds
 104
 105