
NAEV README

   For an overview of the game, please visit http://wiki.naev.org/wiki/Main_Page
   or view the man page (If you're on a Unix-like system).
   
   An exhaustive list of command line arguments is detailed in the man page.
   
   Hardware requirements can also be found on the website.

1) DEPENDENCIES

   Naev's dependencies are intended to be relatively common. In addition to
   an OpenGL-capable graphics card and driver, Naev requires the following:
      * SDL
      * libxml2
      * freetype2
      * libpng
      * openal
      * libvorbis (>= 1.2.1 necessary for Replaygain)
      * binutils
      
   Note that several distributions ship outdated versions of libvorbis, and
   thus libvorbisfile is statically linked into the release binary.
   
   Compiling your own binary on many distributions will result in Replaygain
   being disabled.

   See http://wiki.naev.org/wiki/Compiling_Nix for package lists for several
   distributions.

   Mac Dependencies are different, see extras/macosx/COMPILE for details.

      
2) COMPILING

   Run: 

   ./autogen.sh && ./configure
   make

   If you need special settings you should pass flags to configure, using -h
   will tell you what it supports.

   On Mac OS X, see extras/macosx/COMPILE for details. Uses Xcode, not gcc.


3) INSTALLATION

   Naev currently supports make install which will install everything that
   is needed.

   If you wish to create a .desktop for your desktop environment, logos
   from 16x16 to 256x256 can be found in extras/logos

4) CRASHES & PROBLEMS

   Please take a look at the FAQ (linked below) before submitting a new
   bug report, as it covers a number of common gameplay questions and
   common issues.

   If Naev is crashing during gameplay, please file a bug report after
   reading http://wiki.naev.org/wiki/Bugs

   If Naev crashes on launch with an error such as 'undefined symbol:
   ov_read_filter', your version of libvorbis is outdated, please see
   the appropriate FAQ entry: http://wiki.naev.org/wiki/FAQ

5) KEYBINDINGS

   You can now change keybindings in game which may be more comfortable for
   you then editting the configuration file.

   5A) Introduction
      5A1) About
         Naev uses a dynamic keybinding system that allows you to set 
         the keybindings to joystick, keyboard or a mixture of both.

         This can changed via ~/.naev/conf.lua, or with the in-game editor.

   5B) Joystick
      If you have a joystick you'll have to tell Naev which joystick
      to use.  You can either use the -j or -J parameter from the
      command-line or put it in the conf.lua file.
      Examples:
         naev -j 0
         naev -J "Precision"
         joystick = "Precision" # in conf.lua
      5B1) Syntax
         KEY_IDENTIFIER = { type = KEY_TYPE, key = KEY_NUMBER,
            [reverse = KEY_REVERSE, mod = MOD_IDENTIFIER] }
         KEY_IDENTIFIER is the identifier given below
         KEY_TYPE can be one of keyboard, jaxis or jbutton
         KEY_NUMBER is the number of the key (found with xev usually, just
            convert the keysym from hex to base 10)
         KEY_REVERSE is whether it is reversed or not, which is only useful
            in the case of jaxis
         MOD_IDENTIFIER is the modifier to take into account, can be one of:
            lctrl, rctrl, lshift, rshift, lmeta, rmeta, ralt, lalt
            It isn't used with joystick bindings.
      5B2) Example
         accel = { type = "jbutton", key = 0 }
         see conf.example for more examples

   5C) Keys
      For a non-exhaustive list of default keybindings, please see
      http://wiki.naev.org/wiki/Keybinds


