*********************** S O Y A   3 D ******************************
*************************** Intro **********************************

Soya 3D is a high level 3D engine for Python. It relies on OpenGL and
SDL. It is designed with games in mind, and written partly in Python
and partly in C; our goal is to provide a full architecture for making
free (GPL) game of professionnal quality entirely in Python.
Soya can also render on PyGame surface !

Soya 3D currently runs on Linux.

Soya 3D requires:
 - Python 2.2 or more (tested with 2.2.2), including Python devel
   files (i.e. -devel package, libpython2.2-devel on Mandrake)
 - OpenGL (tested with Mesa, DRI for Radeon and Nvidia drivers)
 - SDL
 - Cal3D (http://cal3d.sourceforge.net)
   (cal3d is sufficient ; cal3d_viewer, data,... are not needed)
 - libPNG
 - libFreeType2

The 3D editor (and the Blender exporter) requires also:
 - Tkinter
 - PIL     (Python imaging library
            http://www.python.org/sigs/image-sig/Imaging.html)
 - EditObj (http://oomadness.tuxfamily.org/)


*************************** Installation ***************************

Soya3D uses Python distutils for installation.
To install, type the following as root:

cd Soya3D-XXX
python ./setup.py install

You might need to edit "config.py" if some of your library are in an
exotic location (i.e. not in /usr or /usr/local), or if you want to
disable some lib supports (e.g. disabling Cal3D).


If you get an error like :

[... lots of text here ...]
distutils.errors.DistutilsPlatformError: invalid Python installation:
unable to open /usr/lib/python2.2/config/Makefile (No such file or directory)
Traceback (most recent call last):
  File "./setup.py", line 28, in ?
    do("cd %s; python setup.py %s -f" % (package_dir, " ".join(sys.argv[1:])))
  File "./setup.py", line 12, in do
    raise RuntimeError, command
RuntimeError: cd soya; python setup.py build -f

or something about "python2.2/config/Makefile", you NEED to install
the Python development package for your distribution
(libpython2.2-devel on Mandrake).


*************************** Running ********************************

There are also demos in ./tutorial


Soya 3D comes along with a small 3D editor; you can launch it as
following:

cd Soya3D-XXX
python ./soya/soya_editor


*************************** Documentation **************************

Documentation available on Soya 3D:
 - Some tutorials are available in ./tutorial
 - Some modules have already doc strings !


*************************** Blender exporter ***********************

The Blender exporter requires the Soya Editor (included with Soya,
but see upper the Editor requirement).
The Blender exporter has been tested with Blender 2.28. Here is how to
use it:
 - open your Blender scene
 - open the exporter script (import_blender.py)
 - run it (alt-p)
Your Blender object will appear in the Soya Editor. Configure the
editor (in particular the material, shape and world pathes), give a
name to your world and save it (menu pickle->save).


********************************************************************

Enjoy Soya 3D ! And stop eating meat !

Jiba -- Jean-Baptiste LAMY -- jiba@tuxfamily.org
                              http://oomadness.tuxfamily.org
