This page should support the development of the Mogre SDK.
Table of contents
- About the SDK
- The installer
- Example applications
- Mogre dependencies
- Known problems
- Todo list
- Dependency checker/installer
- 1. Definitions
- 2. Fair Use Rights
- 3. License Grant
- 4. Restrictions
- 5. Representations, Warranties and Disclaimer
- 6. Limitation on Liability.
- 7. Termination
- 8. Miscellaneous
The SDK should be user friendly, especially for newcomers.
For questions and suggestions use this forum thread
- check for installed Mogre depencies
- offer installation of needed depencies
- install the Mogre SDK (in best case without need of manual system changes)
- contain different libraries
- contain sample applications
Currently related to Mogre 1.6.4
Download of the MOGRE SDK 1.6.4 Beta Installer in this forum post.
Current Mogre maintainer: GantZ
Current SDK developer: kwertz
The SDK related stuff is available on this google code project.
Direct SVN link: http://mogresdk.googlecode.com/svn/trunk/
- demo starter
- depency checkers
- sdk_fs ??
Ask user Kwertz to get write access.
The SDK installer contains:
The installed folder contains the following files and folders:
- D: bin - Contains the MOGRE binaries (debug and release)
- D: includes - Contains the include files to compile plugins against MOGRE
- D: Lib - Contains the static library files of MOGRE
- D: Media - Contains the media files required to run the MOGRE demos which can be compiled with the "BuildSamples.cmd" command script (see below)
- D: Samples - Contains the source code of the MOGRE samples
- BuildSamples.cmd - Lets you build the MOGRE samples with only one click
- BuildSamplesX86.cmd - The same as above, but explicitly for 32-bit processors. Try this, if you get a "FileNotFoundException" or a "BadImageFormatException".
- ChangeLog.txt - This is the change log
- License.html - Contains the LGPL license text
- MOGRE SDK.url - This is a link to the MOGRE homepage
- MogreSamples.sln - The solution containing the sample projects
- ReadMe.txt - This provides an overview of the MOGRE SDK. Read it!
If i install the SDK, then use the build.bat it builds everything, and i can then run the exe's directly from the release dir.
You can also download the installer script (Inno Setup, not NSIS) on this sourceforge page.
These example applications are currently included:
- TODO: include a text that the user can move by WASD and turn by mouse
TODO: Add Examples from wiki:
Good would be to add the Mogre wiki tutorials to the project, including
(And add a readme.txt file to inform the user about the related wiki page. And he should report problems in the forum)
All basic tutorials can be downloaded here.
They are runnable for Mogre 1.4 (hosted by smiley80). Maybe it's easy to update them to Mogre 1.6.
TODO: Add examples of user smiley80:
- Managed Hydrax Wrapper - great water simulation
- Myrddin Landscape Plugin - great looking terrain (wiki page is outdated, look here and here)
- MOGRE Editable Terrain Manager
- collision detection by
- add buttons for demonstrating (enable) Newton debugger
- other Newton examples ...
- some GUIs
- Hikari (show content by HTML/CSS/JS code; also useful for GUIs; nice, but sometimes it crashes at application shutdown)
- Awesomium (show Flash content, also useful for GUIs)
- particles - look to ParticleFX plugin and Particle Accelerator
User Beauty suggest to create the demo starter like this:
- each sample is a stand alone application with its own subdirectory
- the dll files (Mogre and Add-ons) are only in MogreSDK/bin (instead of the sample directories)
- we use a starter application for the demos
- Button for checking the Mogre depencies (but don't check for .NET - so we can write the starter in C# - The .NET check should only be done by the SDK installer, not by the demo starter)
- Button for compile the demos
- List with all available demos (including Mogre tutorial projects)
- Short description for the selected demo (e.g. what it shows and which keys can be used)
- Preview picture (nice to have, but not needed. Can be stored in an image file of the demo subdirectory.)
- Links (e.g. to Mogre forum, Mogre wiki page, Mogre tutorials)
- use an XML config file for the demo starter
- XML is easy to parse with XML libraries of .NET
- contains all informations about each demo
Here is my proposal for the config file:
(in an editor with syntax highlighting its looking nicer)
<demoStarter> <demo> <name>Fog demo</name> <directory>fog</directory> <description>Demostrate fog modes. Use space to switch.</description> <previewPic>fog/thumbnail.png</previewPic> <binary>fog/bin/release/fog.exe</binary> <more>...</more> </demo> <demo> <name>...</name> <directory>...</directory> <description>...</description> <previewPic>...</previewPic> <binary>...</binary> <more>...</more> </demo> </demoStarter>
Needed downloads for Mogre 1.6.x:
- .Net Framework 2.0 (or higher version)
- DirectX 9.0c (March 2009 - update your version!)
- Alternatively: DirectX web installer (300KB, can download/install the newest package of DirectX)
- Special runtime libraries are needed. Install one of these downloads:
In the binary directory of your application you need:
... TODO: improve text ...
- VC++ 2008 redist + OgreMain.dll
- RenderSystem_Direct3D9.dll needs the DirectX 9.0c redist (I believe, March 2009 is sufficient)
- RenderSystem_GL.dll needs some -OpenGL dlls which should come with the driver of your graphics card
- Plugin_CgProgramManager.dll needs cg.dll
- Microsoft .NET 2.0
Find unknown dependencies:
The Assembly Binding Log Viewer should show any bind failures (at least for managed assemblies).
make lists for
- dependencies for developers (Visual Studio with all updates etc.)
- dependencies for end users (vcredist instead of VS - works only for bin/release)
- dependencies for building Mogre
also update the dependencies on related pages:
- Mogre Basic Tutorial 0
- MOGRE Installation
- The zero knowledge guide to making a game##Setting it all up
- Mogre Basic Tutorial VB 0
- Mogre Basic Tutorial VB 6
Here are possibly needed download links:
- Mogre 1.4.8 thread
- DirectX Redist (March 2008)
- DirectX Redist (November 2008)
- Visual Studio 2008 Service Pack 1 and .NET Framework 3.5 Service Pack 1
- DirectX SDK - (November 2008)
- Microsoft Visual C++ 2005 Redistributable Package
- Microsoft Visual C++ 2008 SP1 Redistributable Package (vcredist_x86.exe)
Sll you need to wrap ogre and build mogre is on the svn.
Set the "Platform target" to "Any CPU" and the "Output Path" to "..\..\bin\release\"
- autowrap Ogre
- use of the Mogre XML commentation tool to create Mogre comments for Visual Studio
- maybe by existence of a specific dll file?
- How to find out if a DirectX Redistributable package is installed? (and which version)
- dxdiag.exe shows no information about (Microsoft DirectX diagnosis programm, is included by WinXP (Vista/7?))
- Maybe include the DirectX web installer
It would be nice to have a C++ application that checks which dependencies are still installed and which ones are missing.
The application should show an overview to the user and offer the possiblility to install them (or show download links for it).
The advantage of a plain C++ application is: It shurely can be run, because all dependencies are still in Windows.
This checker application could be used for:
- including to the SDK
- including to shipped Ogre applications (end user installer)
- help to solve problems if Mogre applications doesn't work
Graphic card drivers
The installer should remind to update the driver of graphic card (and show links of related download pages):
Visual C++ 200x Redistributable
Check if vcredist is installed:
- Search in this path of registry
- Microsoft Visual C++ 2008 Redistributable - x86 9.0.21022 (ignore version number on search)
- Microsoft Visual C++ 2005 Redistributable
- vcredist 2005 maybe is needed for dll file created by Visual Studio 2005
Maybe on other Windows versions it's different.
.NET Framework Installer for InnoSetup
Look to this page on codeproject.com.
A boostrapper doesn't replace tools like InstallShield, Wise, Visual Studio Setup and Deployment Project or Wix. The goal is to create an application to help users with installing the correct prerequisites. Most real world applications need to install several components to work properly, including Windows Service Packs, Internet Explorer, MDAC or .NET Framework. This kind of applications are most commonly known as bootstrappers. dotNetInstaller is such a bootstrapper.
This is also interesting for shipping Mogre applications.
checker by user smiley80
Command line tool, written with FreeBasic.
- registry check for .NET
- file check for DirectX
- file check for VCRedist (VC++ 2008 SP1 Redist)
- Win XP, 32bit
- Win 7, 64bit
Download: check.zip (source, exe)
.Net Framework 2.0 found.
DirectX 9.0c (March 2009) found.
VC++ 2008 SP1 Redist not found.
Press any key to continue.
checker by user kwertz
Command line tool, written with C++.
- check for the .NET Framework 2.0.50727.
- If .NET is installed, the managed C# GUI application is called.
- If .NET is not installed, the application will show a Windows message box asking the user if he would like to install .NET. If he clicks 'Yes', the .NET Framework installer is called. (see source code)
netchecker.exe <MOGRE sample GUI executable> <dotnetfx.exe|dotnetfx35setup.exe>
checker 2 by user kwertz
Full dependency checker, written with PureBasic.
- Check for Mogre 1.6.x depencies
- If one dependency is missing, a message box is shown asking the user if he likes to download the dependency.
- It takes the path to the managed executable as the only command line parameter.
- Mogre 1.6.4 forum thread
- Mogre 1.6.2 binaries for testing forum thread
- MOGRE and OGRE 1.6
- Building MOGRE 1.6 from source
- Building MOGRE from source of version 1.4
- how to use the auto wrapper (TODO: add related links, create wiki page about auto wrapping process)
- Mogre SVN (including autowrapper code)
- Strange CLI/C++ issue... - forum thread about wrapper
- Possible AutoWrap bug - forum thread
- ShoggothNotes - Ogre 1.6 porting notes by sinbad
- suggestion of wrapping Mogre - forum post of user Spanky
- Mogre Autowrapper and beyond - Bekas wrote about his wrapper
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.
- "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.
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.
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.
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.
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.
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.
- 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.
- 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.