
                             * Neverputt *

Neverputt requires:

    SDL               http://www.libsdl.org/download-1.2.php
    SDL_image         http://www.libsdl.org/projects/SDL_image/
    SDL_mixer         http://www.libsdl.org/projects/SDL_mixer/
    SDL_ttf           http://www.libsdl.org/projects/SDL_ttf/



* BUILDING

    make                     (Unix)
or
    nmake /fMakefile-W32     (Windows with MSVC)

The executables  will be copied to  the base directory.   Maps will be
processed and copied into data/sol/.  By default, an uninstalled build
may be executed in place.



* RUNNING

    ./neverputt

Click  Play to  begin.  Spacebar  pauses and  resumes.  Escape  ends a
game,  and escape  at  the title  screen  exits.  F9  toggles a  frame
counter.  F10 takes a screenshot.



* INSTALLATION

The game executable may be moved as desired.

However, game  assets are described  using relative path  names.  Thus
the game must  run within the data directory in  order for asset names
to resolve correctly.  Upon starting,  the game will attempt to change
into this directory, as defined in config.h.

If the data directory is to  be renamed or moved for installation, the
CONFIG_PATH variable in config.h must be changed to match.

Alternatively, the CONFIG_PATH variable may  be set to "." if the game
is started  from within the data directory.   Even MORE alternatively,
the data path may be specified as the first command line option.



* CONFIGURATION

Global settings  are stored  in the file  .neverputtrc.  This  file is
created  when  the  game exits,  and  should  be  found in  your  home
directory under Unix, or in the game data directory under Windows.  It
consists of key / value  pairs.  Some of these values are configurable
using  the in-game options  screen.  Other  meaningful keys  and their
default values follow.

    mouse_sense 300

        This  key controls  mouse  sensitivity.  The  value gives  the
        number of screen pixels the  mouse pointer must move to rotate
        the floor  through its entire  range.  A smaller  number means
        more sensitive.

    fps 0

        This key enables an on-screen frames-per-second counter. Press
        F9 to toggle this flag in-game.

    nice 1

        This  key  enables  a  delay  function  after  each  frame  is
        rendered, forcing a context  switch and ensuring that the game
        does not utilize 100% of the CPU.  0 is off, 1 is on.

        If the  frame rate is not  fast enough for you,  or you simply
        want to  test the  performance of the  game on  your hardware,
        disable it.

        Press F8 to toggle this flag in-game.


<rlk@snth.net>
