bowenzhang23 / adonthell Goto Github PK

                          Adonthell 0.4 Alpha


    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    COPYING file for more details.



Installation:
=============

See the INSTALL file for details.

Note that this package alone doesn't allow you to play anything -
you'll need a game package in addition to this one. However, there
are a few sample scripts and programs in the test directory that
you can try. See test/README for further information.


Configuring Adonthell:
======================

The first time you run Adonthell, a configuration file is created:
adonthell.xml. Edit it to customise the game to your convenience.

The available options and their default values are:

* Audio

  <Channels>2</Channels>
  Whether sound should be mono or stereo.
  
  <Format>16</Format>
  Whether audio output should be 8 or 16 bit.
  
  <Rate>44100</Rate>
  The sample rate in Hz. Valid values are 44100, 22050 and 11025.

* General

  <Backend>sdl</Backend>
  Library to use for low level hardware access. For now, only 'sdl'
  is available.

* Input

  Map physical controls such as keyboards or gamepads to a virtual
  controller. Multiple physical controls can be assigned to a virtual 
  control by separating them with a pipe '|' character.

  <move_east>right</move_east>
  <move_north>up</move_north>
  <move_south>down</move_south>
  <move_west>left</move_west>
  Movement controls; defaults to arrow keys.

  <a_button>left shift|right shift</a_button>
  Run while this key is pressed.

  <b_button>space</b_button>
  Interact.

  <c_button>left control</c_button>
  Jump.

  <d_button>escape</d_button>
  Unused

* Video

  <Fullscreen>1</Fullscreen>
  Enable Fullscreen mode. Set to 0 to switch to Windowed mode.


Directories:
============

- $HOME/.adonthell
  contains the configuration file and your saved games.

- Global data directory
  You can get this directory by invoking 'adonthell -d' (by default
  /usr/local/share/adonthell). This is the directory where games will
  install to. If you have a game installed somewhere else, you can
  play it by invoking 'adonthell -g </full/path/to/my/game>'


Environment Variables:
======================

- ADONTHELL_MODULES_PATH
  directory to search for Adonthell backend modules. Overwrites the
  default path ($prefix/lib/adonthell).


Release Notes:
==============

The main purpose of this release is to attract new programmers,
artists and writers in order to shorten the time until the next
version.  So if you have experience in C++ (and optionally Python),
or if you are good at computer graphics or writing we would like to
hear from you.  Please have a look at our development Wiki

    http://adonthell.sourceforge.net/doc/

for further details.

You're greatly invited to report us bugs, problems, or anything you
think we should know. Any feedback is appreciated, so don't hesitate!


Contact:
========

You can reach us in various ways:

IRC Channel:   #adonthell at irc.freenode.net
Mailing list:  [email protected]
Web site:      http://adonthell.nongnu.org
Wiki:          http://adonthell.sourceforge.net/doc/
Tech support:  http://savannah.gnu.org/support/?group_id=702

If you want to rate Adonthell, feel free to do so at
    http://www.happypenguin.org/show?Adonthell


Reporting Bugs:
===============

We hope you'll never have to, but if you discover a problem, we
would like to hear about it. Please use the bug tracker at 

    http://savannah.nongnu.org/bugs/?group=adonthell



Thank you for trying this software.
- The Adonthell Team.