OGRE (Object-Oriented Graphics Rendering Engine)

SDK Distribution README file

http://www.ogre3d.org

Getting Started

This distribution contains the precompiled SDK release of OGRE for Mac OS X. Just drag the 'OgreSDK' folder to the location on your drive where you want to install the SDK. Please do drag the entire folder rather than opening it and copying any subfolders, since the internal folder structure is relevant when building the samples.

Building the Samples

After installing the SDK, you can build the samples simply by navigating to the OgreSDK/Samples folder and double-clicking on Samples.xcodeproj. In XCode you can then build all the samples.

Runtime configuration

In order to run the samples, or to run your own applications based on Ogre, you will need to copy the frameworks in OgreSDK/Frameworks into your framework path. This could be /Library/Frameworks if you have admin access, otherwise put it your local ~/Library/Frameworks and make sure that's on your framework path.

Building your own applications

Because of a limitation in XCode, it is not possible to reference different versions of a single framework from a central location, so the best way to organise your builds is to add Ogre.framework to your application and reference it from the SDK location, not from /Library/Frameworks. This is because if you add a different version of Ogre later you still want to be in control of which one your application is building against (at runtime multiple versions can resolve successfully). You should also add the Ogre.framework/Headers location to your include path, since this avoids needing to use the 'Ogre/' prefix to access the headers.

Limitations of the SDK

You can build multiple architectures and the debug version by obtaining the source release.

Index Of Contents

What's New?

A summary of the new and altered features in this release.

The OGRE Wiki

A gold mine of tutorials, tips and code snippets which will help you get up to speed with the engine. This is probably the best place to start learning OGRE.

The OGRE Manual

A descriptive reference to the major parts of the engine such as scripts.

API Reference

The full OGRE API documentation, as generated from the (heavily!) commented source.

Keeping Up To Date

The best place to keep up to date with developments on OGRE is the Official Web Site. From there you can download the latest source code and documentation. You can choose between keeping bang up to date with CVS (Concurrent Versioning System) or by just getting the regularly released snapshots.

The changes included in this current version can be viewed on the ChangeLog.

Getting Support

Please use our extensive forums if you need help or think you may have found a bug. Go to the main web site and click on the Forums link.

Licensing

OGRE is available free (both 'free as in beer' and 'free as in speech') under the GNU Lesser General Public License or LGPL (see Docs/licenses/lgpl.txt). By downloading and using the software, you are subject to these licensing conditions, so please read the license text carefully. The LGPL is compatible with almost all possible uses of the library (including commercial uses), but there are some responsibilities placed upon the user to maintain the freedom of the software for downstream users.

Alternatively, you may license OGRE under the OGRE Unrestricted License (OUL) which comes with fewer conditions than the LGPL. This license is commercial and basically allows you to pay for the privilege of side-stepping the responsibilities of the LGPL. The software in both cases is identical, only the licensing conditions vary. If you wish to discuss this option  please mail licensing@ogre3d.org for more details.

Licensing for 3rd-party libraries used in OGRE

Several 3rd-party libraries are used in OGRE for various purposes, and the licensing details of each are given here.

Core Dependencies

These are the libraries which the core of OGRE depends on, and are therefore prerequisites for any use of OGRE. None of these libraries have been modified from their original distributions, and they are all licensed under liberal terms. You should read the detail of the licenses when distributing an application since most require you to include the license in your documentation. All the license texts are included in the Docs/licenses folder.

FreeImage
Original Authors: Hervé Drolon and Floris van den Berg
Website: http://freeimage.sourceforge.net
Licensed Under: FreeImage Public License 

FreeType
Original Authors: David Turner, Robert Wilhelm, and Werner Lemberg
Website: http://www.freetype.org
Licensed Under: FreeType License

LibJPEG
Original Authors: Thomas G. Lane, Independent JPEG Group
Website: http://www.ijg.org/
Licensed Under: LibJPEG License

LibMNG
Original Authors: Gerard Juyn, Glenn Randers-Pehrson, Raphael Assenat, John Stiles
Website: http://www.libmng.com
Licensed Under: LibJPEG License

LibPNG
Original Authors: Guy Eric Schalnat, Andreas Dilger, Glenn Randers-Pehrson and others
Website: http://www.libpng.org
Licensed Under: LibPNG License

LibTIFF
Original Authors: Sam Leffler, Silicon Graphics Inc
Website: http://www.libtiff.org/
Licensed Under: LibTIFF License


Zlib
Original Authors: Jean-loup Gailly and Mark Adler
Website: http://www.zlib.net
Licensed Under: Zlib License 

Zziplib

Original Author: Guido Draheim
Website: http://zziplib.sourceforge.net
Licensed Under: Mozilla Public License 1.1 

Optional Plugin Dependencies

These dependencies are only needed if you use the plugins they relate to.

NVidia Cg
Original Authors: NVidia
Website: http://developer.nvidia.com
Licensed Under: Custom free license (binary only)
Needed By: Plugin_CgProgramManager

Sample Program Dependencies

These dependencies are only used by our sample programs, and thus you do not need to use them to use OGRE, if you don't want to.

OIS
Original Authors: Phillip Castaneda
Website: http://www.wreckedgames.com/wiki/index.php/WreckedLibs:OIS
Licensed Under: Zlib License

CEGUI
Original Authors: Paul D Turner, Tomas Lindquist Olsen and others
Website: http://www.cegui.org.uk
Licensed Under: MIT License

ODE
Original Authors: Russell Smith
Website: http://www.ode.org/
Licensed Under: BSD License

Acknowledgements

The authors wish to credit the following for their work which is used in whole or in part in OGRE:

Artwork:

Included as source (modified as appropriate), and credited appropriately in the source files affected:

Standalone tools used:

And I'd also like to thank the following just for inspiration, ideas, and pretty much anything else:

Copyright © 2007 by The OGRE Team