o-----------------------------------------------------------------------------o
|                                                                             |
|                           c a l 3 d - miniviewer                            |
|                                                                             |
|                              Version 0.10.0                                 |
|                                                                             |
|        Copyright (C) 2001, 2002, 2003 Bruno 'Beosil' Heidelberger           |
|                                                                             |
o-----------------------------------------------------------------------------o

o-----------------------------------------------------------------------------o
| Table of Contents                                                           |
o-----------------------------------------------------------------------------o

  1 License
  2 What is 'cal3d-miniviewer'?
  3 Usage
  4 Model Configuration File
  5 Requirements
  6 Website
  7 Author


o-----------------------------------------------------------------------------o
| 1 License                                                                   |
o-----------------------------------------------------------------------------o

  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; either version 2 of the License, or (at your option)
  any later version.

  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 GNU General Public License for
  more details.

  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation Inc., 59
  Temple Place, Suite 330, Boston, MA 02111-1307 USA


o-----------------------------------------------------------------------------o
| 2 What is 'cal3d-miniviewer'?                                               |
o-----------------------------------------------------------------------------o

  Cal3d-MiniViewer is a simple model viewer tool that renders animated models
  with the help of the cal3d character animation library and OpenGL/GLUT.


o-----------------------------------------------------------------------------o
| 3 Usage                                                                     |
o-----------------------------------------------------------------------------o

  The miniviewer tool is started from a shell with the following arguments:

  cal3d_miniviewer [--fullscreen]              : run in fullscreen mode
                   [--window]                  : run in window mode
                   [--dimension width height]  : dimension of the window
                   [--help]                    : show this usage info
                   model-configuration-file    : the model definition file


o-----------------------------------------------------------------------------o
| 4 Model Configuration File                                                  |
o-----------------------------------------------------------------------------o

  The model configuration file contains the definition of a model. This
  includes paths to one skeleton, one or more animation, mesh and material
  files.

  The whole file consists of comment lines that start with a leading '#'
  character or lines with a 'key=value' pair. Here is a list of the possible
  keys:

  path=...       : a relative path to the data files below
  scale=...      : a scale factor that is used to fit the model to the screen
  skeleton=...   : a cal3d skeleton file
  animation=...  : a cal3d animation file
  mesh=...       : a cal3d mesh file
  material=...   : a cal3d material file

  There should only be one skeleton line in the file. If you define multiple
  animations they will be executed one after another.


o-----------------------------------------------------------------------------o
| 5 Requirements                                                              |
o-----------------------------------------------------------------------------o

  You need a hardware accelerated 3d graphic card (with OpenGL support) to
  get a decent framerate.


o-----------------------------------------------------------------------------o
| 6 Website                                                                   |
o-----------------------------------------------------------------------------o

  The official website of cal3d can be found at: http://cal3d.sourceforge.net


o-----------------------------------------------------------------------------o
| 7 Author                                                                    |
o-----------------------------------------------------------------------------o

  This project was originally started by Bruno 'Beosil' Heidelberger. You can
  find a list of all people contributing to cal3d in the AUTHORS file.


o-----------------------------------------------------------------------------o
