History: CMake Quick Start Guide

• «
• »

            {BOX(width="100%",class="Layout_box9")}{SPLIT(colsize=10%|70%)}{IMG(src="img/wiki_up/Star.png",imalign="left",link="CMake Quick Start Guide",title="CMake Quick Start Guide")}{IMG}
---
{DIV(class="bigBold")}((CMake Quick Start Guide|Quick Start Guide)){DIV}
For the impatient: Learn how to build Ogre with CMake in two minutes. If you encounter any problems or need some more advanced procedures, do read the rest of the sections below!
{SPLIT}{BOX}
!!Introduction
This guide is designed to get you building OGRE from source with the default settings in the shortest possible time, showing you the barest minimum of CMake to do that, and minus any real discussion. Remember that there is a lot more to the hows and whys of this process, so it's a good idea to go back to the ((Getting Started With CMake)) page and read the whole thing when you have time.

We assume here that you've already downloaded / extracted the OGRE source code into a folder on your local machine. From here, go to the section for your platform.

{DIV(class="Layout_box6")}
%done% Make sure that you've sorted out the ((Prerequisites)) before attempting to build Ogre with CMake!	 
{DIV}
%clear%
{VERSIONS(nav="y",default="Windows")}
%clear%
# Make sure you have downloaded, extracted and built the [http://www.ogre3d.org/forums/viewtopic.php?f=1&t=54533|dependencies package]
# [http://www.cmake.org/cmake/resources/software.html|Download CMake]. You want the 'Win32 installer' release in the binary distribution section
# Run the CMake installer, install wherever you like
# Launch CMake via Start > Program Files > CMake 2.8 > CMake
# In the "Where is the source code" box, type or browse to the root directory of your OGRE source (the one that contains the OgreMain folder)
# In the "Where to build the binaries" box, type or browse to any folder you like - this will be where the build output will go (libraries, headers, dlls & sample exes). The folder does not have to exist yet. Note that you can run this process more than once with different output folders if you want (but we won't complicate matters now)
# Hit the 'Configure' button near the bottom of the screen 
# Pick your target compiler, e.g. "Visual Studio 8 2005"
# Answer 'Ok' when asked if you want to create the build directory
# Wait for the configure process to finish
# The screen will now have a bunch of configuration options on it, which will be red (this is to indicate this is the first time you've seen them). You can see the potential for customising your build here, but for now just click the 'Configure' button again
# The values will turn grey, and the 'Generate' button at the bottom will now be enabled. Click 'Generate'
# Build files will now be generated in the location you picked, and CMake will say "Generating done"

That's it for CMake! You now have a set of project files that are very much like you're used to in previous versions of OGRE, in the output folder you chose. Just browse there and open the main project file (e.g. OGRE.sln). You can build as before, but there is now a special target called 'ALL_BUILD' which is a quick way to build all targets for a specific configuration. Note that all build output is now stored in a subfolder of this build folder, and not in the original OGRE source folder - so you can create multiple builds from one source directory now.

---(Linux)--------------------------

# [http://www.ogre3d.org/download/source|Download Ogre Source] (Instructions below assume current version of 1.7.1, update as needed)
# Decompress:{CODE(wrap="0", colors="bash")}tar xjf ogre_src_v1-7-1.tar.bz2{CODE}
# Move to source directory:{CODE(wrap="0", colors="bash")}cd ogre_src_v1-7-1{CODE}
# Create build directory:{CODE(wrap="0", colors="bash")}mkdir build{CODE}
# Move into build directory:{CODE(wrap="0", colors="bash")}cd build{CODE}
# Trigger cmake, passing path to Ogre source directory:{CODE(wrap="0", colors="bash")}cmake ..{CODE}See the ((Building Ogre With CMake|Extensive CMake)) page for a list of compilation options which can be passed to CMake at this stage, and ((Getting Started With CMake)) for even more background material.
# If the CMake results look good, build Ogre:{CODE(wrap="0", colors="bash")}make -j2{CODE}The {MONO()}-j2{MONO} specifies how many parallel compilation jobs to run.  Substitute the number of processor cores on your system, e.g. {MONO()}-j2{MONO} for a dual-core, {MONO()}-j4{MONO} for a quad core...
# Once compilation is successful, you can install into the system (by default, /usr/local):{CODE(wrap="0", colors="bash")}sudo make install{CODE}


---(Mac OS X)--------------------------

!!!Building Ogre via CMake GUI (see alt. command line below)
# [http://www.cmake.org/cmake/resources/software.html|Download CMake]. You want the 'Mac OS X Universal' release in the binary distribution section
# The .dmg will probably auto-mount when it downloads, if not, double-click it to open
# Double-click the .pkg installer, install on your main drive and opt to install the command-line tools too (in case you want to use them later, we will use the GUI here)
# Launch CMake via Applications
# In the "Where is the source code" box, type or browse to the root directory of your OGRE source (the one that contains the OgreMain folder)
# In the "Where to build the binaries" box, type or browse to any folder you like - this will be where the build output will go (libraries, headers, dlls & sample exes). The folder does not have to exist yet. Note that you can run this process more than once with different output folders if you want (but we won't complicate matters now)
# Hit the 'Configure' button near the bottom of the screen 
# Pick 'Xcode' as the generator and opt to use native compilers
# Answer 'Ok' when asked if you want to create the build directory
# Wait for the configure process to finish
# The screen will now have a bunch of configuration options on it, which will be red (this is to indicate this is the first time you've seen them). You can see the potential for customising your build here, but for now just click the 'Configure' button again
# The values will turn grey, and the 'Generate' button at the bottom will now be enabled. Click 'Generate'
# Build files will now be generated in the location you picked
# Now, open OGRE.xcodeproj in the build directory you picked, open it in Xcode. ALL_BUILD will build everything!

!!!Building Ogre via Command Line (see alt. GUI method above)
# [http://www.ogre3d.org/download/source|Download Ogre Source] (Instructions below assume current version of 1.7.1, update as needed)
# Decompress:{CODE(wrap="0", colors="bash")}tar xjf ogre_src_v1-7-1.tar.bz2{CODE}
# Move to source directory:{CODE(wrap="0", colors="bash")}cd ogre_src_v1-7-1{CODE}
# Create build directory:{CODE(wrap="0", colors="bash")}mkdir build{CODE}
# Move into build directory:{CODE(wrap="0", colors="bash")}cd build{CODE}
# Trigger cmake, specify Xcode generation and pass path to Ogre source directory:{CODE(wrap="0", colors="bash")}cmake -GXcode ..{CODE}See the ((Building Ogre With CMake|Extensive CMake)) page for a list of compilation options which can be passed to CMake at this stage, and ((Getting Started With CMake)) for even more background material.
# Build via Xcode{CODE(wrap="0", colors="bash")}xcodebuild -configuration RelWithDebInfo{CODE}(or open OGRE.xcodeproj and build within Xcode)

!!!Installing Ogre
You will find Ogre.framework in 'lib' within your build directory.  You can embed this in your application bundle, or drag it to /Library/Frameworks for system-wide installation.

You will also find plugins (Plugin_*.dylib and RenderSystem_GL.dylib) in the same location, you can copy these to the framework's Resource directory or your own application's bundle.  Be sure to configure you applications' plugins.cfg to match (e.g. /Library/Frameworks/Ogre.framework/Resources/)

---(iPhone)--------------------------
Detailed instructions on building OGRE for iPhone can be found on this page [Building From Source (for iPhone)]

{VERSIONS}