------------------------------------------------------------------------------
README
------------------------------------------------------------------------------

	1. Description
	2. Homepage
	3. CVS
	4. Additional libraries & programs
	5. Configuration
	6. Contact
	7. License
	8. Controls

------------------------------------------------------------------------------

1. Description

glChess is a 3D OpenGL based chess game interfacing via the Chess Engine
Communication Protocol (CECP) by Tim Mann. This means it can currently use
Crafty and GNU Chess as AIs. You can also play Human vs. Human, but so far
not over a network (see TODO).

2. Homepage

SourceForge Homepage		-> http://glchess.sf.net
SourceForge Project Page	-> http://sf.net/projects/glchess

3. CVS

If you want to stay in touch with the current development, you should prefer
the CVS edition of glChess. You can get it by following these steps:

$ cd YOUR_SOURCES_DIR
$ export CVSROOT=":pserver:anonymous@cvs.glchess.sourceforge.net:/cvsroot/glchess"
$ cvs login
$ cvs -z3 checkout glchess

If the server asks you for a password simply hit ENTER.

Whenever you want to have the latest changes of glChess simply do the
following:

$ cd YOUR_SOURCES_DIR/glchess
$ cvs update -d

If you don't like to update and check out directly via CVS there is also a
CVS snapshot archive. Just have a look at the CVS section on the homepage.

4. Additional libraries & programs

In addition to the glChess source, you need to have GtkGLArea installed.
Also the chess engines are not included in glChess, so you need to get and
install them separately, too.

5. Configuration

For normal use the preferences dialog should be sufficient. If something
does not work as you expected it, you can also directly edit the config
file. There is one global config file '/etc/glchessrc' and additionally
there is a '.glchessrc' in each user home directory.

The config file is more or less self-explanatory so you should be able to
change it by hand.
It consists of two columns and is divided in 7 sub-sections.

6. Contact

Please direct any questions, comments, suggestions or flames (please not
that many flames ;-) to the mailing list.

You will find a link on the homepage where you can subscribe or read the
archive. If you don't want to subscribe, whysoever, simply send an email
to <glchess-devel@lists.sourceforge.net> and mention that an answer to your
mail needs to be CC'ed to you.

If you don't want to publish your problems/ideas simply contact one of the
main developers, see AUTHORS.

7. License

glChess is released under the GNU General Public License. In short, you may
copy this program (including source) freely, but see the COPYING file for
full details.

8. Controls

Firstly most of the controls are in the menus ...
If the first screen in VERY laggy press 'P' to pause, then it will be easier
to navigate the menus.

To move the camera use the following controls:

Move pieces by selecting one and afterwards its destination.

1 2 3 4  Change view.

Free View:
----------

    w   t  Move camera in directions NSEW (wasd).
  a   d g  Move camera up/down (tg).
    s      (only applicable in view mode 1)

  q   e    Pan camera left and right.
  z   x    Roll camera left and light.
  r   f    Tilt camera down and up.

TrackBall View:
---------------

Mouse 1  - Hold and drag as trackball
Mouse 3  - Zoom view

Graphical controls:
-------------------

l - toggle Lighting
j - toggle reflections
k - toggle textures
h - toggle smooth sHading
m - toggle fog