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 iPhone SDK. 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.

Important:If you have used a previous version of OGRE, make sure you remove Ogre.framework, CEGUI.Framework, Cg.framework and OgreCEGUIRenderer.framework from your /Library/Frameworks folder or any other 'root' folder. From version 1.4.5, all frameworks are referenced and deployed locally which is much more flexible when dealing with multiple versions, and also reflects how you would want to deploy an end application (see below).

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.

Limitations of the SDK

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

Deploying your own applications

In order to conform with standard iPhone application behaviour, applications should contain all the dependencies they need inside the .app file in order to be installable via drag & drop. The Samples provided with this SDK cheat here to avoid copying dependencies verbatim into every single sample .app folder - instead we use a Run Script build phase to create a symbolic link in the Fo.app/Contents/Frameworks location which points to each framework in the Dependencies folder. You can do something similar for development but when you distribute a real application, obviously you will need to actually copy the dependencies properly into Foo.app so it can be deployed as a unit.

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

Please see the full license documentation for details.

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 © 2009 by The OGRE Team