source: OGRE/trunk/ogrenew/Docs/Readme/ReadMe_Building.html @ 657

Revision 657, 12.2 KB checked in by mattausch, 19 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<HTML>
3<HEAD>
4        <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
5        <TITLE>Building OGRE</TITLE>
6        <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.4  (Win32)">
7        <META NAME="CREATED" CONTENT="20050219;16550753">
8        <META NAME="CHANGED" CONTENT="20050219;17080725">
9        <link rel="stylesheet" type="text/css" href="../style.css">
10</HEAD>
11<BODY LANG="en-US" TEXT="#ccffcc" LINK="#ffff00" BGCOLOR="#003300" DIR="LTR">
12<P CLASS="header" ALIGN=CENTER>OGRE (Object-Oriented Graphics
13Rendering Engine)</P>
14<P CLASS="header" ALIGN=CENTER>Building OGRE
15</P>
16<P CLASS="header" ALIGN=CENTER><A HREF="http://www.ogre3d.org/">http://www.ogre3d.org</A></P>
17<P CLASS="mainheader" ALIGN=LEFT>Building and Installing OGRE</P>
18<P ALIGN=LEFT>This release of OGRE builds under the following
19configurations:</P>
20<TABLE WIDTH=100% BORDER=1 BORDERCOLOR="#996600" CELLPADDING=0 CELLSPACING=0>
21        <TR>
22                <TD WIDTH=33% BGCOLOR="#999900">
23                        <P ALIGN=CENTER><FONT COLOR="#333300"><FONT SIZE=1 STYLE="font-size: 8pt"><B>Platform</B></FONT></FONT></P>
24                </TD>
25                <TD WIDTH=20% BGCOLOR="#999900">
26                        <P ALIGN=CENTER><FONT COLOR="#333300"><FONT SIZE=1 STYLE="font-size: 8pt"><B>Compiler</B></FONT></FONT></P>
27                </TD>
28                <TD BGCOLOR="#999900">
29                        <P ALIGN=CENTER><FONT COLOR="#333300"><FONT SIZE=1 STYLE="font-size: 8pt"><B>Extra
30                        Notes</B></FONT></FONT></P>
31                </TD>
32        </TR>
33        <TR>
34                <TD WIDTH=33%>
35                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
36                        <A HREF="#VC"><FONT SIZE=1 STYLE="font-size: 8pt"><FONT COLOR="#66cc33">Windows
37                        95/98/Me/2000/XP</FONT></FONT></A></P>
38                </TD>
39                <TD WIDTH=20%>
40                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
41                        <FONT COLOR="#66cc33"><FONT SIZE=1 STYLE="font-size: 8pt">Microsoft
42                        Visual C++ 6 SP3+<BR>Microsoft Visual C++.Net<BR>Microsoft Visual
43                        C++.Net 2003</FONT></FONT></P>
44                </TD>
45                <TD>
46                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
47                        <FONT SIZE=1 STYLE="font-size: 8pt"><FONT COLOR="#66cc33">Requires
48                        DirectX 9.0 SDK. Note that the last version of the DirectX 9 SDK
49                        supported for VC6 is the <B>Summer 2004 version</B>.<BR><A HREF="http://www.stlport.org/">STLport</A>
50                        required for versions prior to .Net 2003<BR>You should also
51                        download the latest 3rd-party libraries from the site.</FONT></FONT></P>
52                </TD>
53        </TR>
54        <TR>
55                <TD WIDTH=33%>
56                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
57                        <A HREF="#Linux"><FONT SIZE=1 STYLE="font-size: 8pt"><FONT COLOR="#66cc33">Linux</FONT></FONT></A></P>
58                </TD>
59                <TD WIDTH=20%>
60                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
61                        <FONT COLOR="#66cc33"><FONT SIZE=1 STYLE="font-size: 8pt">gcc (GNU
62                        Compiler Collection)</FONT></FONT></P>
63                </TD>
64                <TD>
65                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
66                        <FONT COLOR="#66cc33"><FONT SIZE=1 STYLE="font-size: 8pt">Requires
67                        gcc 3.x</FONT></FONT></P>
68                </TD>
69        </TR>
70        <TR>
71                <TD WIDTH=33%>
72                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
73                        <A HREF="#Mac"><FONT SIZE=1 STYLE="font-size: 8pt"><FONT COLOR="#66cc33">Mac
74                        OSX </FONT></FONT></A>
75                        </P>
76                </TD>
77                <TD WIDTH=20%>
78                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
79                        <FONT COLOR="#66cc33"><FONT SIZE=1 STYLE="font-size: 8pt">gcc (GNU
80                        Compiler Collection)</FONT></FONT></P>
81                </TD>
82                <TD>
83                        <P ALIGN=CENTER STYLE="border-top: none; border-bottom: 1.00pt solid #666600; border-left: 1.00pt solid #666600; border-right: 1.00pt solid #666600; padding-top: 0cm; padding-bottom: 0.26cm; padding-left: 0.05cm; padding-right: 0.05cm">
84                        <FONT COLOR="#66cc33"><FONT SIZE=1 STYLE="font-size: 8pt">Requires
85                        gcc 3.x</FONT></FONT></P>
86                </TD>
87        </TR>
88</TABLE>
89<P ALIGN=LEFT>&nbsp;</P>
90<P CLASS="mainheader" ALIGN=LEFT><A NAME="VC"></A>Building with
91Visual C++ 6 or Visual C++.Net</P>
92<P ALIGN=LEFT>If you're building with Visual C++, follow these steps:</P>
93<OL>
94        <LI><P STYLE="margin-bottom: 0cm">Make sure you have downloaded and
95        installed <A HREF="http://www.stlport.org/">STLport</A>, version
96        4.6.2 if you are not using .Net 2003. The instructions for building
97        and installing STLport are in the <A HREF="../FAQ.html">FAQ</A></P>
98        <LI><P STYLE="margin-bottom: 0cm">Download and install the <A HREF="http://msdn.microsoft.com/directx">DirectX9
99        SDK</A>, get the latest if you're using VC7+, the Summer 2004
100        version plus the 'Extras' if using VC6.</P>
101        <LI><P STYLE="margin-bottom: 0cm">Download and extract the latest
102        3rd party libraries distribution (you can find this in the downloads
103        section of the <A HREF="http://www.ogre3d.org/">OGRE hompage</A>).
104        See the <A HREF="../FAQ.html">FAQ</A> for more details.</P>
105        <LI><P STYLE="margin-bottom: 0cm">Open either Ogre.dsw (VC6) or
106        Ogre.sln (VC7+)</P>
107        <LI><P STYLE="margin-bottom: 0cm">Check the ordering of your include
108        and library paths (in Tools | Options). The ordering should be
109        STLport (if applicable), DirectX, then everything else.</P>
110        <LI><P>Perform a Batch Build for <B>all</B> the projects. The
111        dependencies should ensure everything is built in the right order.</P>
112</OL>
113<P CLASS="mainheader"><A NAME="Linux"></A>Building under Linux</P>
114<P ALIGN=LEFT>If you're building under Linux with gcc, here's a very
115quick overview:</P>
116<OL>
117        <LI><P STYLE="margin-bottom: 0cm">If you're using gcc version 2.9x,
118        make sure you've installed <A HREF="http://www.stlport.org/">STLport</A>.
119        However, if you can we advise using gcc 3.2+.</P>
120        <LI><P STYLE="margin-bottom: 0cm">Confirm that you have SDL 1.2.4,
121        Freetype2, DevIL, zziplib, CEGUI 0.2.0 and pkg-config available on
122        your system (if not, install them!)</P>
123        <LI><P STYLE="margin-bottom: 0cm">Change to the 'ogrenew' directory,
124                </P>
125        <LI><P STYLE="margin-bottom: 0cm">If you are installing from CVS,
126        run './bootstrap'</P>
127        <LI><P STYLE="margin-bottom: 0cm">type './configure'.</P>
128        <LI><P>Run 'make' and 'make install' (the latter as root)</P>
129</OL>
130<P>For more detailed instructions, see the<A HREF="../README.linux">
131Linux README</A>.</P>
132<P CLASS="mainheader" ALIGN=LEFT><A NAME="Mac"></A>Building under Mac
133OSX</P>
134<P ALIGN=LEFT>Please read the <A HREF="../README_MacOSX.txt">Mac
135README</A>.</P>
136<P CLASS="mainheader" ALIGN=LEFT>Explanation of the Core libraries</P>
137<P ALIGN=LEFT>OGRE compiles into a number of shared
138dynamically-linked libraries for use by OGRE applications. It also
139has a number of optional plugin libraries, which are used to provide
140rendering system implementations (e.g. an interface to DirectX) and
141special features (e.g. a BSP-oriented scene manager). Plugins are
142configured using the 'plugins.cfg' file located in the same folder as
143your application. Here's an example:</P>
144<P ALIGN=LEFT>-----snip------------------------------------------------------</P>
145<P ALIGN=LEFT>PluginFolder=plugins\</P>
146<P># Define particle system plugin<BR>Plugin=Plugin_ParticleFX</P>
147<P>-----snip------------------------------------------------------</P>
148<P>This simple plugins.cfg tells Ogre to load all plugins from the
149'plugins' folder directly under the application's folder, and to load
150Plugin_ParticleFX (.dll in Windows, .so in Linux), the particle
151system implementation.</P>
152<P>The best way to get started with OGRE is to look at the example
153applications which are included. These should make it clear to you
154how easy it is to get an OGRE application running in a surprisingly
155small amount of code!</P>
156<P CLASS="mainheader">Libraries in detail</P>
157<P ALIGN=LEFT>The libraries are:</P>
158<TABLE WIDTH=100% BORDER=1 CELLPADDING=2 CELLSPACING=0>
159        <COL WIDTH=37*>
160        <COL WIDTH=219*>
161        <TR>
162                <TD WIDTH=14%>
163                        <P>OgreMain</P>
164                </TD>
165                <TD WIDTH=86%>
166                        <P>The core dll which includes all the basic classes, and
167                        abstractions of all the engine components which will be refined
168                        per OS platform, rendering API, or per scene type. This library
169                        must be on the path or in the current folder to be loaded at
170                        startup. The source for this is completely cross-platform.
171                        </P>
172                </TD>
173        </TR>
174        <TR>
175                <TD WIDTH=14%>
176                        <P>OgrePlatform</P>
177                </TD>
178                <TD WIDTH=86%>
179                        <P>This library implements concrete versions of the classes
180                        required to be implemented for each platform. There are currently
181                        implementations for Win32 and Linux platforms.</P>
182                        <P>This library is loaded dynamically by the PlatformManager class
183                        (in OgreMain) and must either be on the path or in the current
184                        folder.</P>
185                </TD>
186        </TR>
187        <TR>
188                <TD WIDTH=14%>
189                        <P>RenderSystem_Direct3D7/9</P>
190                </TD>
191                <TD WIDTH=86%>
192                        <P>Plugin library which adds a RenderSystem implementation for
193                        Direct3D. This library is loaded dynamically by the plugin
194                        architecture described above, and must be located in the folder
195                        specified in plugins.cfg. You may use any of these render systems
196                        on Windows, but the more recent version support extra features.</P>
197                </TD>
198        </TR>
199        <TR>
200                <TD WIDTH=14%>
201                        <P>RenderSystem_GL</P>
202                </TD>
203                <TD WIDTH=86%>
204                        <P>Implementation of the RenderSystem which is based on OpenGL.
205                        Used for the Linux &amp; Mac platforms primarily but can be used
206                        in Windows too.</P>
207                </TD>
208        </TR>
209        <TR>
210                <TD WIDTH=14%>
211                        <P>Plugin_BspSceneManager</P>
212                </TD>
213                <TD WIDTH=86%>
214                        <P>Plugin specialisation of the general-purpose SceneManager for
215                        rendering indoor levels based on a BSP tree. Allows Quake3 maps to
216                        be loaded and rendered very efficiently whilst exposing none of
217                        the complexity to the core Ogre system. This library is loaded
218                        dynamically by the plugin architecture described above, and must
219                        be located in the folder specified in plugins.cfg.</P>
220                </TD>
221        </TR>
222        <TR>
223                <TD WIDTH=14%>
224                        <P>Plugin_ParticleFX</P>
225                </TD>
226                <TD WIDTH=86%>
227                        <P>Plugin which provides a range of particle system tools such as
228                        standard emitters and affectors.</P>
229                </TD>
230        </TR>
231        <TR>
232                <TD WIDTH=14%>
233                        <P>Plugin_OctreeSceneManager</P>
234                </TD>
235                <TD WIDTH=86%>
236                        <P>Plugin which provides scene management based on an octree
237                        system.</P>
238                </TD>
239        </TR>
240        <TR>
241                <TD WIDTH=14%>
242                        <P>ReferenceAppLayer</P>
243                </TD>
244                <TD WIDTH=86%>
245                        <P>This is a utility library which is a client of the OgreMain
246                        library, and can be used by your application to add additional
247                        non-graphics related features to your application. It is designed
248                        to be an example of how you might tie together other libraries
249                        with OGRE in order to build a larger system; in this case we
250                        implement collision and physics using ODE.</P>
251                </TD>
252        </TR>
253</TABLE>
254<P CLASS="maincontent" ALIGN=LEFT>There are also several other
255plugins, tools and demos which are built as part of the standard
256batch build process.</P>
257<P CLASS="maincontent" ALIGN=LEFT>More tips and information can be
258obtained from the <A HREF="http://www.ogre3d.org/wiki">OGRE Wiki</A>.
259</P>
260<P CLASS="maincontent" ALIGN=CENTER><A HREF="../ReadMe.html">Back to
261Readme.html</A></P>
262<P CLASS="mainheader">&nbsp;</P>
263<P>Copyright &copy; 2005 by The OGRE Team<SCRIPT>
264<!--//hide script from old browsers
265document.write( "Last modified "+ document.lastModified );
266//end hiding contents -->
267</SCRIPT></P>
268</BODY>
269</HTML>
Note: See TracBrowser for help on using the repository browser.