2.3 External Libraries

Crystal Space may utilize several optional external, and publicly available development libraries. These libraries are:

• zlib
• libpng
• libjpeg
• Freetype2
• CG
• ODE
• Bullet
• Cal3D
• lib3ds
• Ogg/Vorbis
• libmng
• CEGUI
• wxWidgets
• CACA

Most of these libraries are optional. If you do not have them installed, then Crystal Space will still function, though features related to the missing libraries will be disabled. Despite being optional, at the very minimum, you should at least ensure that zlib, libpng, and libjpeg are installed since much useful functionality depends upon those libraries. Many computer systems come with these libraries pre-installed. If the libraries are not already available on your system, then see the following sections for information about how to obtain them.

If you need to install some of the libraries yourself pay attention to the versions states below.

• "Required" means that you need to install exactly the version stated, otherwise Crystal Space can not use the library.
• "Recommended" means that the version stated is known to work well with Crystal Space, however, older or newer versions may work as well. If you have a choice between multiple versions for a library, pick the recommended one.
• "Minimum" means that a library needs to be at least of the version stated, but newer versions are very likely to work as well and can be chosen.

The "cs-win32libs" Package

Rather than having to install these components manually, Microsoft Visual C++ 7/7.1/8, MinGW/MSYS, and Cygwin users can download a single package which contains all common headers, pre-built library files, and dynamic link libraries in pre-compiled form, all in versions known to work with this particular release of Crystal Space. You can obtain it from the following location:

http://www.crystalspace3d.org/downloads/cs-win32libs/cs-win32libs-1.0_001.exe

zlib

Version: 1.0 minimum

Crystal Space relies upon the zlib library for reading ZIP files, and for a few other uses. You can download zlib from:

http://www.gzip.org/zlib/

After downloading you can either install the package normally (i.e. `make install') or unpack it into the directory `CS/libs/zlib*'. In general, if you have permission to do so, it is best to install the library.

libpng

Version: 1.2.x minimum

Crystal Space relies upon the libpng library for reading PNG graphic files. You can download libpng from:

http://www.libpng.org/pub/png/libpng.html

After downloading you can either install the package normally (i.e. `make -f scripts/makefile.std install') or unpack it into the directory `CS/libs/libpng*'. In general, if you have permission to do so, it is best to install the library.

libjpeg

Version: 6b minimum

Crystal Space relies upon the libjpeg library for reading JPEG graphic files. You can download libjpeg from:

http://www.ijg.org/files/

After downloading you can either install the package normally (i.e. `make install') or unpack it into the directory `CS/libs/jpeg*'. In general, if you have permission to do so, it is best to install the library.

Freetype2

Version: 2.1.x minimum

Crystal Space can utilize the FreeType2 library to display TrueType fonts. You can get the latest version at:

http://www.freetype.org/

CG

Version: 1.4.1 recommended

Many Crystal Space shaders require the CG library from nVidia. Crystal Space depends on the CG library with version number at least equal to 1.4. If you're on GNU/Linux then you may not find a package with that version available, in this case you have to directly download this from http://developer.nvidia.com/object/cg_toolkit.html#downloads.

ODE

Version: 0.7 recommended

Crystal Space contains a plugin providing physics through ODE. You can get the required version at:

http://www.ode.org/

Note: You must compile ODE with OPCODE support enabled in order to use the library with Crystal Space.

Bullet

Version: 1.9f recommended

Crystal Space can also provide physics through Bullet. You can get the required version at:

http://www.continuousphysics.com/

Cal3D

Version: 0.11.x required

Crystal Space supports skeletal animation using the Cal3D library. You can obtain the required version at:

https://gna.org/projects/cal3d/

lib3ds

Version: 1.2.0 recommended

Crystal Space has support for the popular 3ds model format using the lib3ds library. It is recommended that you use the 1.2.0 release.

http://lib3ds.sourceforge.net/

Ogg/Vorbis libraries

Version: 1.1.x recommended

With this libraries you can use the Ogg/Vorbis sound plugin. You can get the latest version at:

http://www.vorbis.com/download.psp

libmng

Version: 1.0.9 recommended

Crystal Space can optionally utilize the libmng library for reading MNG/JNG graphic files. You can download libmng from:

http://www.libmng.com/

After downloading you can either install the package normally (i.e. `make install') or unpack it into the directory `CS/libs/libmng*'. In general, if you have permission to do so, it is best to install the library.

CACA Colour AsCii Art Library

This library is used for 2D rendering in text mode. This is optional and only needed for fun. libcaca can be downloaded from:

Version: 0.9 recommended

http://sam.zoy.org/libcaca/

CEGUI

Version: 0.5.x required

Crystal Space uses CEGUI for some of it's own tool programs (e.g. `viewmesh') but also allows external programs to utilize CEGUI for their user interface.

http://cegui.org.uk

wxWidgets

Version: 2.6.x recommended

Integration into wxWidgets is supported; a special canvas is provided that creates a WX window into which Crystal Space can render graphics. To compile this canvas, wxWidgets is required.

http://wxwidgets.org

Maps

Needed if you want to see examples of Crystal Space at work. A few data files are provided in the Crystal Space release itself, but more can be downloaded from the `maps' subdirectory of each release. Most files can just be placed in the `CS/data' directory.

http://www.crystalspace3d.org/support/release/

This document was generated using texi2html 1.76.