source: OGRE/trunk/ogrenew/Docs/ReadMe.html @ 692

Revision 692, 11.9 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4
5       
6  <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
7
8       
9       
10  <title>OGRE Readme</title>
11  <meta name="GENERATOR" content="OpenOffice.org 1.1.4  (Win32)">
12
13       
14  <meta name="CREATED" content="20050219;16153107">
15
16       
17  <meta name="CHANGED" content="20050219;17194093">
18
19       
20  <link rel="stylesheet" type="text/css" href="style.css">
21</head>
22
23<body bgcolor="#003300" dir="ltr" lang="en-US" link="#ffff00" text="#ccffcc">
24
25<p class="header" align="center"><img style="width: 250px; height: 100px;" alt="Logo" src="ogre-logo.gif"></p>
26<p class="header" align="center">OGRE (Object-Oriented Graphics
27Rendering Engine)</p>
28
29<p class="header" align="center">Source Distribution README file</p>
30
31<p class="header" align="center"><a href="http://www.ogre3d.org/">http://www.ogre3d.org</a></p>
32
33<p class="mainheader" align="left">Summary</p>
34
35<p>OGRE (Object-Oriented Graphics Rendering Engine) is a
36scene-oriented, flexible 3D engine written in C++ designed to make it
37easier and more intuitive for developers to produce games and demos
38utilising 3D hardware. The class library abstracts all the details of
39using the underlying system libraries like Direct3D and OpenGL and
40provides an interface based on world objects and other intuitive
41classes.
42</p>
43
44<p>This distribution contains the full original source code for OGRE
45and is the most flexible way of obtaining the engine, although it
46does require you to build it yourself. For people who want a little
47more convenience, at the expense of a larger download and slightly
48less flexibility, there is also a precompiled SDK release available
49for some compilers.</p>
50
51<p class="mainheader" align="left">Index Of Contents</p>
52
53<p class="newsdate"><a href="ChangeLog.html">What's New?</a></p>
54
55<p>A summary of the new and altered features in this release.
56</p>
57
58<p class="newsdate"><a href="http://www.ogre3d.org/index.php?option=com_content&amp;task=view&amp;id=13&amp;Itemid=62">Features</a></p>
59
60<p class="maincontent">A summary of OGRE's main features.</p>
61
62<p class="newsdate"><a href="Readme/ReadMe_Building.html">Building
63the core OGRE libraries</a></p>
64
65<p class="maincontent">This section covers building the libraries and
66plugins which make up the core OGRE system.</p>
67
68<p class="newsdate"><a href="manual/index.html">The OGRE Manual</a></p>
69
70<p>A descriptive reference to the major parts of the engine such as
71scripts.
72</p>
73
74<p class="newsdate"><a href="api/html/index.html">API Reference</a></p>
75
76<p class="maincontent">The full OGRE API documentation, as generated
77from the (heavily!) commented source.</p>
78<a style="font-weight: bold;" href="http://www.ogre3d.org/wiki">The OGRE
79Wiki</a>
80<p>A gold mine of tutorials, tips and code snippets which will help
81you get up to speed with the engine.</p>
82
83<p>If you are running on Linux, please also see the <a href="README.linux">Linux
84README</a> which will also assist you in Linux-specific issues. If
85you are running Mac OSX, read the <a href="README_MacOSX.txt">Mac
86README</a>.
87</p>
88
89<p class="mainheader" align="left">Contributing</p>
90
91<p align="left">We welcome all contributions to OGRE, be that new
92plugins, bugfixes, extensions, tutorials, documentation, example
93applications, artwork or pretty much anything else! If you would like
94to contribute to the development of OGRE, please read the <a href="ContributorLicenseAgreement.html">Contributor
95License Agreement</a>, and then contact Steve Streeting at
96<a href="steve@ogre3d.org">sinbad@ogre3d.org</a> if you agree with the
97terms. You can also submit patches against the CVS version, go the
98the <a href="http://www.ogre3d.org/">web site </a>and click on the
99'Developers' link.</p>
100
101<p class="mainheader" align="left">Keeping Up To Date</p>
102
103<p align="left">The best place to keep up to date with developments on
104OGRE is the <a href="http://www.ogre3d.org/">Official Web Site</a>.
105From there you can download the latest source code and documentation.
106You can choose between keeping bang up to date with CVS (Concurrent
107Versioning System) or by just getting the regularly released
108snapshots.</p>
109
110<p align="left">The changes included in this current version can be
111viewed on the <a href="ChangeLog.html">ChangeLog</a>.
112</p>
113
114<p class="mainheader" align="left">Getting Support</p>
115
116<p align="left">Please use our extensive forums if you need help or
117think you may have found a bug. Go to the <a href="http://ogre.sf.net/">main
118web site</a> and click on the Forums link.</p>
119
120<p class="mainheader" align="left">Licensing</p>
121
122<p>OGRE is distributed as free software under the GNU Lesser General
123Public License (see <a href="License.html">License.html</a>). In
124summary this means that you can use OGRE for any purpose, provided
125that if you make changes to OGRE itself, you must release the changes
126back into into the public domain under the LGPL and make it clear
127where you have made the changes. Your own application can be
128distributed under any license you like. Note that in the case of
129OGRE, inlining and macros in headers are used purely for performance
130or platform independence reasons, and including any of OGRE's headers
131in your projects does not result in a derived work.
132</p>
133
134<p>This program is distributed in the hope that it will be useful,
135but WITHOUT ANY WARRANTY; without even the implied warranty of
136MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
137Lesser General Public License for more details.</p>
138
139<p>You should have received a copy of the GNU Lesser General Public
140License along with this program; if not, write to the Free Software
141Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
142USA, or go to <a href="http://www.gnu.org/copyleft/lesser.txt">http://www.gnu.org/copyleft/lesser.txt</a>.</p>
143
144<p>In addition, if you use Ogre it would be nice if you displayed the
145Ogre logo somewhere in your application (start up or shutdown) for a
146minimum of 2 seconds. This splash-screen is displayed on the standard
147Ogre configuration dialog anyway, so if you use that you don't need
148to do anything extra. The logo is included in the download archive as
149Examples\Resources\ogrelogo.png.</p>
150<p class="mainheader" align="left">Acknowledgements</p>
151
152<p>The authors wish to credit the following for their work which is
153used in whole or in part in OGRE:</p>
154
155<p>Artwork:</p>
156
157<ul>
158
159        <li>
160    <p style="margin-bottom: 0cm;">Matt Anderson at
161        <a href="http://www.The3dStudio.com/">www.The3dStudio.com</a> who
162        kindly gave permission for the use of some textures. These textures are used with permission of
163    <a href="http://www.the3dstudio.com/">www.The3dStudio.com</a> and may
164not be re-distributed, sold, or given away except in the form of
165rendered images, animations, or real time 3D applications when credit
166is given to <a href="http://www.the3dstudio.com/">www.The3dStudio.com</a>.</p>
167
168        </li>
169  <li>
170    <p style="margin-bottom: 0cm;">Jonathan Clark at
171        <a href="http://www.jonathanclark.com/">http://www.jonathanclark.com</a>
172        for some Golgotha textures thet were released to the public domain.</p>
173
174        </li>
175  <li>
176    <p style="margin-bottom: 0cm;">The 'Raptor Assault Gunboat' mesh
177        &amp; texture are &copy; 2002 by Adrian 'cearny' Cearnau.</p>
178
179        </li>
180  <li>
181    <p style="margin-bottom: 0cm;">The robot andn ninja mesh and
182        animation are by <a href="http://www.psionic3d.co.uk/">Psionic</a>,
183        kindly made available from the <a href="http://www.insanesoftware.de/">CharacterFX</a>
184        site</p>
185
186        </li>
187  <li>
188    <p style="margin-bottom: 0cm;">The 'Razor 2' mesh is by Dennis
189        Verbeek</p>
190
191        </li>
192  <li>
193    <p style="margin-bottom: 0cm;">Skyboxes in cubemapJS.zip are
194        &copy;<a href="http://www.schlorb.com/">Johannes Schlorb</a>, used
195        with permission.
196        </p>
197
198        </li>
199  <li>
200    <p>Grass texture is courtesy of Mathias 'freezer' Walc</p>
201  </li>
202  <li>
203    <p>The 'Han Solo' TrueType font is &copy; 2000 by Iconian Fonts -
204Daniel Zadorozny. This font may be freely distributed and is free for
205all non-commercial uses. This font is e-mailware; that is, if you
206like it, please e-mail the author at: <a href="mailto:iconian@aol.com">iconian@aol.com</a>.</p>
207  </li>
208  <li>facial.mesh (Dr Bunsen) is provided courtesy of Avid Technology, Inc.<br>
209&copy; 2004 Avid Technology, Inc. All rights
210reserved. Avid is either a registered trademark or trademark of Avid
211Technology, Inc. in the United States and/or other countries.
212  </li>
213</ul>
214
215<p>Included as source (modified as appropriate), and credited
216appropriately in the source files affected:</p>
217
218<ul>
219
220        <li>
221    <p style="margin-bottom: 0cm;">Many of the maths/spatial routines
222        are inspired by Dr D.H. Eberley, adapted from the 'free' parts of
223        the Wild Magic engine 0.2 source provided with his book "3D
224        Engine Design" (<a href="http://www.geometrictools.com/">http://www.geometrictools.com/</a>)</p>
225
226        </li>
227  <li>
228    <p style="margin-bottom: 0cm;">Quake3 loading routines used a lot
229        of information gleaned from <a href="http://www.planetquake.com/aftershock/">Aftershock</a>
230        and <a href="http://strony.poland.com/bsekura/">Bart Sekura's ROGL</a></p>
231
232        </li>
233  <li>
234    <p style="margin-bottom: 0cm;">Singleton template class is &copy;
235        Scott Bilas 2000 from Game Programming Gems
236        </p>
237
238        </li>
239  <li>
240    <p>Memory manager is based on MMGR &copy; Paul Nettle at <a href="www.fluidstudios.com">Fluid
241        Studios</a></p>
242
243  </li>
244</ul>
245
246<p>Source not modified, but linked in as part of the complete OGRE
247system:</p>
248
249<ul>
250
251        <li>
252    <p style="margin-bottom: 0cm;">Compression is courtesy of the
253        zlib compression library &copy; 1995-1998 Jean-loup Gailly and Mark
254        Adler (<a href="http://www.gzip.org/zlib">http://www.gzip.org/zlib</a>)</p>
255
256        </li>
257  <li>
258    <p style="margin-bottom: 0cm;">Default image codecs are provided
259        by <a href="http://openil.sourceforge.net/">DevIL</a>.
260        </p>
261
262        </li>
263  <li>
264    <p style="margin-bottom: 0cm;">ZIP archive support is provided by
265        <a href="http://zziplib.sourceforge.net/">zziplib</a>.</p>
266
267        </li>
268  <li>
269    <p style="margin-bottom: 0cm;">Interactive GUI support is by
270        <a href="http://www.cegui.org.uk/">Crazy Eddies GUI</a>.</p>
271
272        </li>
273  <li>
274    <p style="margin-bottom: 0cm;">SDL is &copy; (too many to list!)
275        (<a href="http://www.libsdl.org/">http://www.libsdl.org</a>)</p>
276
277        </li>
278  <li>
279    <p style="margin-bottom: 0cm;">Freetype2 is &copy; The Freetype
280        Team (<a href="http://www.freetype.org/">http://www.freetype.org</a>)</p>
281
282        </li>
283  <li>
284    <p>ODE is &copy; Russel Smith (<a href="http://q12.org/ode/">http://q12.org/ode/</a>)</p>
285
286  </li>
287</ul>
288
289<p>Standalone tools used:</p>
290
291<ul>
292
293        <li>
294    <p style="margin-bottom: 0cm;">Document generation from C++
295        source code is by Doxygen &copy; Dimitri van Heesch
296        (<a href="http://www.doxygen.org/">http://www.doxygen.org</a>)</p>
297
298        </li>
299  <li>
300    <p>Milkshape3D for modelling &amp; exporting
301        (<a href="http://www.milkshape3d.com/">http://www.milkshape3d.com</a>)</p>
302
303  </li>
304</ul>
305
306<p>And I'd also like to thank the following just for inspiration,
307ideas, and pretty much anything else:</p>
308
309<ul>
310
311        <li>
312    <p style="margin-bottom: 0cm;">Scott Meyers for his superb
313        'Effective C++' series</p>
314
315        </li>
316  <li>
317    <p style="margin-bottom: 0cm;">Everybody who has ever written for
318        Game Developer magazine, but particularly Chris Hecker and Jeff
319        Lander whose work is consistently enlightening</p>
320
321        </li>
322  <li>
323    <p style="margin-bottom: 0cm;">Michael Abrash for his 'Zen' books
324        which inspired me to try graphics programming in the first place</p>
325
326        </li>
327  <li>
328    <p style="margin-bottom: 0cm;">Everybody at SourceForge and VA
329        Linux for providing <b>fantastic</b> facilities for developers with
330        modest budgets</p>
331
332        </li>
333  <li>
334    <p style="margin-bottom: 0cm;">Scott Adams (Dilbert) for
335        providing a humourous distraction when I've had enough for the day<br>
336    </p>
337  </li>
338</ul>
339<ul>
340  <li>
341    <p>My wife Marie for putting up with all this!</p>
342
343  </li>
344</ul>
345
346<p>Copyright &copy; 2006 by The OGRE Team
347<script>
348<!--//hide script from old browsers
349document.write( "Last modified "+ document.lastModified );
350//end hiding contents -->
351</script></p>
352
353</body>
354</html>
Note: See TracBrowser for help on using the repository browser.