Image What OGRE is, what you can do with it and other frequently asked beginner questions


What is Ogre?

OGRE (Object-oriented Graphics Rendering Engine) is an open-source graphics rendering engine that is written and maintained by a small core team, and contributed to by its ever growing community. Those of us that use it believe it's one of the better free and open engines out there today, but don't take our word for it - try it out for yourself.

Who are the developers?

Well, let The official Ogre Team page answer that particular question.

What tools and hardware do I need?

Ogre runs on a wide variety of hardware capable of 3D graphics, although performance will certainly vary. Look at the Hardware page to see graphics hardware requirements and recommendations.

As far as tools are concerned, you will need a supported C++ compiler (e.g. {LEX()}VisualStudio{LEX} or Code::Blocks/MinGW).

Finally, you will need an arsenal of 3D programs to create content. Look at Assembling a production pipeline to learn what other software is needed throughout the process. The most basic and commonly used one is an object modeller.

Do I have to know how to program to use Ogre?

Yes, you will need to know how to program. Ogre is not a game shell or scripting language like many game development kits out there. It will require more knowledge to use properly, but it is also many times more powerful than a scripting kit will be. A good knowledge of C++ is essential, as is an understanding of object-oriented programming. Ogre's power means that it's not something readily suited to someone who is just looking to start programming. That's not to say you can't learn to program by using Ogre, but it will be many times more difficult than if you were to start with a more traditional approach.

Can Ogre only be used with C++?

No, there are various wrappers that offer the possibility to use other programming languages than C++. However, these projects are not officially supported by the Ogre Core Team.

There are currently Ogre wrappers for Python (Python-Ogre), Java (Ogre4j) and for .NET languages - C# and VB.NET - (MOGRE).

Where can I learn how to program in C++?

There are thousands of websites and books that can teach you the needed programming skills in order to start with Ogre. Some are listed below, but don't consider this the ultimate collection, but find out yourself with which resources you can work the best.

Websites:


Introductory Books on C++:


A note to newbies. Knowing 'how' to program C++ (such as syntax, etc.) does not help you actually create a sophisticated program. Ogre will bring you a step closer to creating a 3D program, but you still need a lot of practice.

Is Ogre a game engine?

No. This is a subtle distinction that a lot of people tend to miss. Ogre is a graphics engine, and only a graphics engine. However, it can easily be tied together with other libraries to create a game engine. Some libraries you might need to create a game are:

  • Sound
  • Networking
  • Input
  • Collision

Ogre does not include these libraries natively, although it does expose an interface that makes it easy to work Ogre into an existing application. There are several reasons that Sinbad (the lead developer) has chosen to follow this route. I'll let him speak. This is from a forum post from sinbad.

''OGRE is a component in a larger development system. OGRE is not, and never was, intended to be a one-stop-shop game development platform, it's a tool for a specific purpose. I sometimes have to rabidly defend this because it seems I go against the grain of other engines, who concentrate on providing an all-in-one solution.


I think software systems should be modular and pluggable, with clear interfaces and boundaries between them. I think each team should concentrate on their core area and let others get on with specialising in theirs (I think it's pure madness to try to reinvent ODE for example, as some other engines are doing). I think the most important part of any software system is it's interface, to support all of the above. I think developers should be free to combine the tools they choose into their game development platform, not be told which sound, physics, AI etc implementation to use just because they chose a graphics engine.

I realise this approach means that as of today, it's not as fast to develop a game with OGRE than it is with another all-in-one engine. But I'm not just thinking about today. My philosophy is to build a flexible graphics component which can be used in the maximum number of situations, and to make it easy to integrate with other components - not to build an engine that can be used to make a small number of game variants. I favour flexibility over speed, because I think if you design it right, you can add the tools to make it quicker to develop in specific scenarios later. You'll find it a lot harder to extend an engine which is designed to handle only a small subset of scene types, with strongly integrated features designed from a certain perspective. I try to plan for the long term.

As time goes on I expect more 'combination' solutions to evolve naturally, and indeed that's already happening with people building their own platforms based on OGRE and other libs. Hey, maybe I'll produce my own one day which combines OGRE with my choice of sounds/network/physics libs. But my choice doesn't have to be your choice. I think that's important.''


Note that this doesn't mean that you can't use Ogre for games. In fact, it's probably going to be used for games more than anything else out there. This simply means that Ogre doesn't decide what libraries you're going to use, and allows you the flexibility to fit Ogre into your application, rather than attempting to wrap your application around Ogre.

Should I use Ogre or Game Engine X for my project?

There are a lot of factors which go into this decision. Here are some of them.

1. Programming language
How do you plan on implementing your game logic? C++? C#? Scripting? Your options may be limited with a closed source game engine. Ogre is a c++ library, and many users code in c++ directly. Other languages are available with Ogre, under community driven extensions or game engines which utilize Ogre3D for rendering.

2. Source code
Do you want or need access to the source code? Are you worried about using closed source in case you need to alter functionality or fix a bug?

Have you considered the long term ramifications for your company if you use closed source technology and the game engine company changes their licensing or goes out of business? With Ogre, you are free to use and modify the code for your own commercial projects, free of charge, and nobody can ever take that away from you.

3. Tools
Game engines usually come with a very slick package of highly integrated tools. Ogre, due to it's nature of being very flexible and community driven, has tools, but they are far less integrated and sometimes less polished. Some are free, some are not.

Some notable ogre tools:

  • Ogitor: a free world/level editor
  • OgreMeshy: a free mesh viewer
  • ParticleUniverse: a low cost particle system plugin, editing tool, and sample media packs.
  • OgreMax: commercial exporter for 3ds max and maya. Other, free exporters are also available. Some projects use a modeling tool as a level editor.
  • OgreSpeedTree: a commercial SpeedTree integration


Extensive lists of ogre tools are available elsewhere in the wiki.

4. Middleware integration
Do you like the middleware that comes integrated with your game engine? Contrast this to the work and cost associated with integrating the exact middleware you want into an Ogre3D-based engine.

Ogre3D has been integrated with a wide variety of physics, sound, user interface, networking, and input handling middleware. Which again, is an advantage for flexibility, but do not underestimate the amount of effort that is often involved in integrating middleware.

There are many existing Ogre middleware "wrappers" which can help you integrate middleware into your project.

5. License and royalty structure
Do you need to pay money to use the game engine? Do you need to pay for support?
Ogre is free to use, has a large, helpful community, and extensive documentation. However, there is no paid support, so don't expect someone on the Ogre team to drop everything to fix a problem you encounter.

6. Platforms
How do you want to publish your game? If it's PC, Mac, Linux, or various handheld devices, Ogre might be a great choice. Web deployment? Not a traditional part of Ogre's repertoire, but there have been some interesting community developments on this lately. Consoles? There has (unfortunately) never been a supported ogre console port so you're on your own there.

7. Flexibility vs. Sandbox
One of the core differences is that game engines are usually very good at doing a specific thing. If you want to create some variation of that specific thing, the game engine is almost always the right choice in terms of work efficiency. Implementing the same sandbox using Ogre as is already available with a game engine could easily be years of additional work.

Alternatively, if you're trying to build something significantly different than your standard FPS or RPG that most game engines support, using Ogre3D to construct your own game engine might be a good approach, because it is designed to be customized to different purposes much moreso than most game engines.

8. Value of Skills in the Game Industry
Having experience with a game engine like UDK is a valuable skill if you're trying to enter the game industry. However, with a closed-source game engine, you may find that your knowledge can only go so deep. So perhaps if you're interested in learning the details of graphics programming, having experience with open-source software like Ogre may be more valuable.

9. Team Skillset
If there are 10 people on your team, and 9 of them are experts in game engine x, then that is a strong factor for using game engine x.

10. Technical Skill
How technically skilled is your team? Ogre's flexibility comes at a cost, Using Ogre3D is almost always a much more technically demanding and time intensive endeavor than using a game engine, again with the potential benefit of having a more customized engine for your project once you're done.

A final note
When evaluating what to use for your game engine, ensure you have a clear understanding of:
a. what you are trying to build
b. how much time you have
c. how much money you have
Because without that, you're really just guessing.

Can I use OGRE to produce graphics too?

Ogre is a realtime rendering engine. Many of the pictures on cgtalk and other sites are rendered offline or slowly, often with ray tracing. The technology of the two are fundamentally different. One can make offline rendered pictures as detailed or realistic as one has the time to process each image. It may take several hours or longer to generate a full screen image. With realtime rendering, each image is rendered in say 1/30th to 1/100th of a second for a decent framerate. Nevertheless, the strides being made in current 3D graphics hardware have allowed realtime rendering to become very detailed and realistic looking. Ogre is bound by the hardware you run it on and your imagination. For a look at what kind of graphics you can expect, look at the images NVIDIA and ATI use to sell their graphics hardware.

Our Ogre Gallery has many screen shots that show the capabilities of the engine and graphics hardware. Some shots are impressive by themselves. Others are less so, but show a specific feature that could be used to provide powerful and flexible effects, such as post filtering, fresnel refractions and normal mapping.

Ok, you've convinced me. How do I get started?

These links are available from the Main Page as well. First select if you want to Install An SDK or Build From Source. The latter option is for those experienced in C++ development. Then move on to Setting Up An Application and Ogre Tutorials to get going.

I'm stuck! How can I get some help?!

Your main resources for information are the pages on this wiki including Installing An SDK, Building From Source, Setting Up An Application and Ogre Tutorials. The API and manual are necessary references as well. If your questions aren't answered there, Ogre has a thriving community full of helpful people, who will be more than happy to help you out. You can try the forums - most all of your questions will be answered there speedily, but read the forum rules, then use the search function! Most questions that new users ask have been answered countless times before. Make sure to provide relevant details from your Ogre.log, exceptions, error messages, and/or debugger back traces. Be specific and people will be more able to help you.

If you'd like something a little more interactive, connect to irc.freenode.net and join #ogre3d, and we'll get you patched up in no time!

What file formats does Ogre support?

Ogre supports a number of common file formats, but also makes use of Ogre specific file formats.

Common file formats supported:

  • .bsp Quake bsp file
  • .shader Quake 3 shader file
  • .ttf True type font file
  • .png, .tga, .jpg, .raw, .gif, .dds and more as supported by FreeImage. See A Brief Summary of Image File Formats
  • .cg Cg shader file
  • .asm Assembly shader file
  • .zip Packed resources
  • .xml XML file
  • .xsd XML schema file that defines Ogre specific file formats that are XML based
  • .log Text output file used for debug logs, memory logs and memory leak reports


Ogre specific file formats:


Note that the Ogre does not strive for an exhaustive support of all kinds of common file formats, but instead provides Ogre specific OGRE Exporters for popular digital content creation tools.

Can I make a game with Ogre?

Yes, you can. Unlike many other 3D engines, Ogre isn't geared towards any one kind of game. Due to its design, it can be used for everything ranging from flight simulators to first person shooters to "2.5D" games. If it can be done in 3D, chances are Ogre is capable of doing it.

Can I make an MMORPG with Ogre?

Theoretically yes, but MMORPGs require huge amounts of time, work and money to build and maintain. Just consider that when designing your project. MMORPGs are the hot item these days, and everyone is working on one. However there are very, very few that ever come close to completion. Conventional wisdom says to make at least 2 or 3 smaller "classic" games such as Tetris, Pong, etc. before even attempting something on the scale of a MMORPG, since it will give you a feel for the entire game design and implementation process, and show you how much work it is to produce even a small game. The "everyone and their mother is making an MMORPG" theme is something of a joke in the game programming community, so be forewarned that you may be met with a little skepticism when you announce that your next huge project is going to take the gaming world by storm.

If you are past that and are still convinced that you want to make an MMO, start out right. First, consider joining another team. Most likely, your great idea isn't all that revolutionary. Combining efforts will give the best chance at achieving actual results. If you are still convinced to start one yourself, start with research and more research. Once that is done, research some more. Do not start recruiting on the Ogre forums, that is a bad idea. Once you are confident with what you have learned through research, start a design document. Get your ideas in order and then start to try to get support. Gamedev.net has a recruitment area that sometimes allows newbies to get away with I-want-to-make-an-MMO-from-scratch threads, but the Ogre forums aren't so forgiving.

If you are ready to begin, pick the best tools for the job. Check out Realm Crafter, Multiverse, Project Darkstar or any other MMO engines that may be what you need. If you are still decided on Ogre, be ready for a LONG journey. Expect ridicule from other devs on Ogre's forums. Get a thick skin and believe in what your project is about.

Lastly, never stop learning. It will take you a long time. You will need to get help and start a community for support. If you have any questions, ask, but ask in the right way, with the best grammar and spelling possible. Most people will not take you seriously as it is, so try to dissuade their ridicule by being professional in the way you do things.

There is a lot more to it than this, but this should get you started if you are crazy enough to try.


Alias: GetStarted

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.