INTRODUCTION

The Irrlicht Engine is an open source high performance realtime 3D engine
written and usable in C++. It is completely cross-platform, using D3D, OpenGL
and its own software renderer, and has all of the state-of-the-art features
which can be found in commercial 3d engines.

See : http://irrlicht.sourceforge.net/

Caml is a general-purpose programming language, designed with program safety
and reliability in mind. It is very expressive, yet easy to learn and use. Caml
supports functional, imperative, and object-oriented programming styles. It has
been developed and distributed by INRIA, a French research institute in computer
science and applied mathematics, since 1985.

See : http://caml.inria.fr/index.en.html

Thanks to Pierre Hauweele for his contribution.

PROJECT WEB PAGE

http://projects.tuxfamily.org/group.pl?name=ocamlirr

Here you can find the online documentation and the last sources in the GIT
repository.
 
REQUIRES

Irrlicht (it should work on 1.7.x) : http://irrlicht.sourceforge.net/
OCaml : http://caml.inria.fr/index.en.html
A C++ compiler. Only g++ ( http://gcc.gnu.org/ ) has been tested.
findlib : http://projects.camlcity.org/projects/findlib.html (recommended)

Right know the build system has been tested on Unix/Linux, and so, Windows is
yet supported. However, you should not have to do too many modifications to
built it under Windows. If you do, it would be very kind of you to send the
modifications.

BUILD AND INSTALL

To configure OCaml Irrlicht go in the root directory and just type

ocaml setup.ml -configure

If you want to use an other compiler than g++ you can add the option

-cpp-compiler OTHER_COMPILER

You can get a description of the different options by typing

ocaml setup.ml -configure -help

Then to build OCaml Irrlicht just type :

ocaml setup.ml -build

Then, if you want to build the documentation just type :

ocaml setup.ml -doc

To install the library (and the documentation if built) just type (as a
superuser or with sudo) :

ocaml setup.ml -install

To uninstall it :

ocaml setup.ml -uninstall

BUILD AND RUN THE EXAMLPLES

To build an example, go in its directory and type

make

then to execute it, just type

./main

Because most of the examples are based on the official Irrlicht ones, to run
them, you will need some media files (*.md2, *.bsp etc ...).

The media files are distributed with the official Irrlicht distribution:

http://irrlicht.sourceforge.net/downloads.html

You just have to build a symbolique lynk "media" in the root directory

USE THE LIBRARY

Currently, there are no tutorials for OCaml Irrlicht, so if you are new you can
still :

- Read the code of the examples
- Read the official Irrlicht tutorials ((almost) each example  is base on an
	official example/tutorial)
- Read the documentation
	(generated by ocamldoc, see $htmldir/ocaml-irrlicht or
	http://ocamlirr.tuxfamily.org/)

EXTEND THE BINDING

OCaml Irrlicht is far from being complete so if you want to do a real
application, you will probably have to wrap a few functions/methods yourself.

For most Irrlicht Objects in the binding, there is a method obj that returns
a pointer to the C++ object.

Please do not hesitate to send a patch.

GETTING THE LAST SOURCES FROM THE GIT REPOSITORY

You can get the last sources from the git repository by typing :

git clone git://git.tuxfamily.org/gitroot/ocamlirr/ocamlirr.git

or by going to the page :

http://git.tuxfamily.org/ocamlirr/ocamlirr.git

CONTACT

If you have any questions or request for binding a particular function/method
you contact me at :

alexis.bernadet  ate noos.fr

Or you can also use the mailing list :

ocamlirr@lists.tuxfamily.org