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

Soya 3D is a high level 3D engine for Python ; it aims at being to 3D
what Python is to programming.

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 (tested with 2.3.3), including Python devel
 - Pyrex 0.9.2 (http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex)
 - OpenGL (or Mesa)
 - SDL (http://libsdl.org)
 - Cal3D (http://cal3d.sourceforge.net ; cal3d is sufficient,
   cal3d_viewer, data,... are not needed)
 - libFreeType2 (http://www.freetype.org)
 - Freefonts font package (http://www.nongnu.org/freefont, for
   default font)
 - PIL (Python Imaging Library, for loading images from image files
   http://www.pythonware.com/products/pil/index.htm)


*************************** What doesn't work in SOya 0.7a *********

The following features were in Soya 0.6.2 and are still not
implemented in Soya 0.7 :
 - Animation stuff (NOT Cal3D animation)
 - WaterCube
 - Cell-shading
 - Shadow
 - The Soya editor
 - Face cutter (=model beautifier)


The file format is totally different ; the script
soya0.6.1_2_soya0.7.py can be use to export your data into Python
script (though it is quite a hack, i've used it to export SLune
data !!).
Edit soya0.6.1_2_soya0.7.py, run it with Soya 0.6.x installed, then
install Soya 0.7 and runs the generated scripts.


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

Pyrex is not strictly needed to compile Soya, since the C code
generated by Pyrex is included in the source. But compiling Soya
without Pyrex would require to hack the setup.py ; if someone does
this, please mail me or commit the change in the CVS.


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).


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 & Documentation ****************

Documentation available on Soya 3D:
 - Some modules have already doc strings !
 - Tutorials are now available in a separate package ; grab it on the
   Soya website !
   The tutorials package is totally new and redesigned for Soya 0.7.


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

The Blender exporter has been tested with Blender 2.33 ; you need a
Blender with a separate Python (i.e. Blender must be able to import
Soya).
Here is how to use it:
 - open your Blender scene
 - open the exporter script (blender2soya.py)
 - run it (alt-p) and fill in the form


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

Enjoy Soya 3D ! And stop eating meat !

Jiba -- Jean-Baptiste LAMY -- jiba@tuxfamily.org

http://gna.org/projects/soya/