SDK/OSX/Attic/ReadMe.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3 <head>
   4
   5   <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
   6   <title>OGRE Readme</title>
   7
   8
   9   <link rel="stylesheet" type="text/css" href="style.css">
  10
  11 </head>
  12
  13
  14 <body >
  15
  16 <p class="header" align="center">OGRE
  17 (Object-Oriented Graphics
  18 Rendering Engine)</p>
  19
  20 <p class="header" align="center">SDK Distribution
  21 README file</p>
  22
  23 <p class="header" align="center"><a href="http://www.ogre3d.org/">http://www.ogre3d.org</a></p>
  24
  25 <p class="mainheader" align="left">Getting Started</p>
  26
  27 <p>This distribution contains the precompiled SDK release of OGRE for Mac OS X. Just drag the 'OgreSDK' folder to the location on your drive where you want to install the SDK. Please do drag the entire folder rather than opening it and copying any subfolders, since the internal folder structure is relevant when building the samples.</p>
  28
  29 <p class="mainheader" align="left">Building the Samples</p>
  30
  31 <p>After installing the SDK, you can build the samples simply by navigating to the OgreSDK/Samples folder and double-clicking on Samples.xcodeproj. In XCode you can then build all the samples. </p>
  32
  33 <p class="mainheader" align="left">Runtime configuration</p>
  34
  35 <p>In order to run the samples, or to run your own applications based on Ogre, you will need to copy the frameworks in OgreSDK/Frameworks into your framework path. This could be /Library/Frameworks if you have admin access, otherwise put it your local ~/Library/Frameworks and make sure that's on your framework path.</p>
  36
  37 <p class="mainheader" align="left">Building your own applications</p>
  38 <p>Because of a limitation in XCode, it is not possible to reference different versions of a single framework from a central location, so the best way to organise your builds is to add Ogre.framework to your application and reference it from the SDK location, not from /Library/Frameworks. This is because if you add a different version of Ogre later you still want to be in control of which one your application is building against (at runtime multiple versions can resolve successfully).
  39
  40 You should also add the Ogre.framework/Headers location to your include path, since this avoids needing to use the 'Ogre/' prefix to access the headers.</p>
  41
  42 <p class="mainheader" align="left">Limitations of the SDK</p>
  43
  44 <ul><li><b>Only Release Configurations</b>: only the release mode build is included for size reasons. You can still build debug code of your own against the release mode SDK, but you can only build the release mode samples.</li>
  45 <li><b>Single Architecture</b>: only a single architecture (i386) is included in the SDK, again for size reasons.</li>
  46 </ul>
  47
  48 You can build multiple architectures and the debug version by obtaining the source release.
  49
  50
  51 <p class="mainheader" align="left">Index Of Contents</p>
  52
  53 <p class="newsdate"><a href="ChangeLog.html">What's
  54 New?</a></p>
  55
  56 <p>A summary of the new and altered features in this release.<br>
  57
  58 </p>
  59
  60 <p class="newsdate"><a href="http://www.ogre3d.org/wiki">The
  61 OGRE
  62 Wiki</a></p>
  63
  64 <p>A gold mine of tutorials, tips and code snippets which will
  65 help
  66 you get up to speed with the engine. This is probably the best place to
  67 start learning OGRE. <br>
  68
  69 </p>
  70
  71 <p class="newsdate"><a href="manual/index.html">The
  72 OGRE Manual</a></p>
  73
  74 <p>A descriptive reference to the major parts of the engine such
  75 as
  76 scripts. </p>
  77
  78 <p class="newsdate"><a href="api/OgreAPIReference.chm">API
  79 Reference</a></p>
  80
  81 <p class="maincontent">The full OGRE API documentation, as
  82 generated
  83 from the (heavily!) commented source.</p>
  84
  85 <p class="mainheader" align="left">Keeping Up To Date</p>
  86
  87 <p align="left">The best place to keep up to date with
  88 developments on
  89 OGRE is the <a href="http://www.ogre3d.org/">Official Web
  90 Site</a>.
  91 From there you can download the latest source code and documentation.
  92 You can choose between keeping bang up to date with CVS (Concurrent
  93 Versioning System) or by just getting the regularly released
  94 snapshots.</p>
  95
  96 <p align="left">The changes included in this current
  97 version can be
  98 viewed on the <a href="ChangeLog.html">ChangeLog</a>.
  99 </p>
 100
 101 <p class="mainheader" align="left">Getting Support</p>
 102
 103 <p align="left">Please use our extensive forums if you
 104 need help or
 105 think you may have found a bug. Go to the <a href="http://ogre.sf.net/">main
 106 web site</a> and click on the Forums link.</p>
 107
 108 <p class="mainheader" align="left">Licensing</p>
 109
 110 <p>OGRE is available&nbsp;free (both 'free as in beer' and
 111 'free as in speech')&nbsp;under the GNU Lesser General
 112 Public License or LGPL&nbsp;(see Docs/licenses/lgpl.txt).
 113 By downloading and using the software, you are subject to these
 114 licensing conditions, so please read the license text carefully. The
 115 LGPL is compatible with almost all possible uses of the library
 116 (including commercial uses), but there are some responsibilities placed
 117 upon the user to maintain the&nbsp;freedom of the software for
 118 downstream users.</p>
 119
 120 <p>Alternatively, you may license OGRE under the OGRE
 121 Unrestricted
 122 License (OUL) which comes with fewer conditions than the LGPL. This
 123 license is commercial and&nbsp;basically allows you to&nbsp;pay
 124 for the
 125 privilege of side-stepping the responsibilities of the LGPL. The
 126 software in both cases is identical, only the licensing conditions
 127 vary. If you wish to discuss this option&nbsp; please mail
 128 licensing@ogre3d.org for more details.</p>
 129
 130 <p class="mainheader" align="left">Licensing for
 131 3rd-party libraries used in OGRE</p>
 132
 133 Several 3rd-party libraries are used in OGRE for various purposes, and
 134 the licensing details of each are given here.<br>
 135
 136 <br>
 137
 138 <span style="text-decoration: underline; font-weight: bold;">Core
 139 Dependencies<br>
 140
 141 </span><br>
 142
 143 These are the libraries which the core of OGRE depends on, and are
 144 therefore prerequisites for any use of OGRE. None of these libraries
 145 have been modified from their original distributions, and they are all
 146 licensed under liberal terms. You should read the detail of the
 147 licenses when distributing an application since most require you to
 148 include the license in your documentation. All the license texts are
 149 included in the Docs/licenses folder.<br>
 150
 151 <br>
 152
 153 <span style="font-weight: bold;">FreeImage</span><br>
 154
 155 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 156
 157   <tbody>
 158
 159     <tr>
 160
 161       <td style="width: 20%;">Original Authors:</td>
 162
 163       <td>Herv&eacute; Drolon and Floris van den Berg<br>
 164
 165       </td>
 166
 167     </tr>
 168
 169     <tr>
 170
 171       <td>Website:</td>
 172
 173       <td>http://freeimage.sourceforge.net<br>
 174
 175       </td>
 176
 177     </tr>
 178
 179     <tr>
 180
 181       <td>Licensed Under:</td>
 182
 183       <td>FreeImage Public License&nbsp;</td>
 184
 185     </tr>
 186
 187   </tbody>
 188 </table>
 189
 190 <br>
 191
 192 <span style="font-weight: bold;">FreeType</span><br>
 193
 194 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 195
 196   <tbody>
 197
 198     <tr>
 199
 200       <td style="width: 20%;">Original Authors:</td>
 201
 202       <td>David Turner, Robert Wilhelm, and Werner Lemberg<br>
 203
 204       </td>
 205
 206     </tr>
 207
 208     <tr>
 209
 210       <td>Website:</td>
 211
 212       <td>http://www.freetype.org<br>
 213
 214       </td>
 215
 216     </tr>
 217
 218     <tr>
 219
 220       <td>Licensed Under:</td>
 221
 222       <td>FreeType License</td>
 223
 224     </tr>
 225
 226   </tbody>
 227 </table>
 228
 229 <br>
 230
 231 <span style="font-weight: bold;">LibJPEG</span><br>
 232
 233 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 234
 235   <tbody>
 236
 237     <tr>
 238
 239       <td style="width: 20%;">Original Authors:</td>
 240
 241       <td>Thomas G. Lane, Independent JPEG Group<br>
 242
 243       </td>
 244
 245     </tr>
 246
 247     <tr>
 248
 249       <td>Website:</td>
 250
 251       <td>http://www.ijg.org/<br>
 252
 253       </td>
 254
 255     </tr>
 256
 257     <tr>
 258
 259       <td>Licensed Under:</td>
 260
 261       <td>LibJPEG License<br>
 262
 263       </td>
 264
 265     </tr>
 266
 267   </tbody>
 268 </table>
 269
 270 <br>
 271
 272 <span style="font-weight: bold;">LibMNG</span><br>
 273
 274 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 275
 276   <tbody>
 277
 278     <tr>
 279
 280       <td style="width: 20%;">Original Authors:</td>
 281
 282       <td>Gerard Juyn, Glenn Randers-Pehrson, Raphael Assenat,
 283 John Stiles<br>
 284
 285       </td>
 286
 287     </tr>
 288
 289     <tr>
 290
 291       <td>Website:</td>
 292
 293       <td>http://www.libmng.com<br>
 294
 295       </td>
 296
 297     </tr>
 298
 299     <tr>
 300
 301       <td>Licensed Under:</td>
 302
 303       <td>LibJPEG License<br>
 304
 305       </td>
 306
 307     </tr>
 308
 309   </tbody>
 310 </table>
 311
 312 <br>
 313
 314 <span style="font-weight: bold;">LibPNG</span><br>
 315
 316 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 317
 318   <tbody>
 319
 320     <tr>
 321
 322       <td style="width: 20%;">Original Authors:</td>
 323
 324       <td>Guy Eric Schalnat, Andreas Dilger, Glenn
 325 Randers-Pehrson and others<br>
 326
 327       </td>
 328
 329     </tr>
 330
 331     <tr>
 332
 333       <td>Website:</td>
 334
 335       <td>http://www.libpng.org<br>
 336
 337       </td>
 338
 339     </tr>
 340
 341     <tr>
 342
 343       <td>Licensed Under:</td>
 344
 345       <td>LibPNG License<br>
 346
 347       </td>
 348
 349     </tr>
 350
 351   </tbody>
 352 </table>
 353
 354 <br>
 355
 356 <span style="font-weight: bold; text-decoration: underline;"></span><span style="font-weight: bold;">LibTIFF</span><br>
 357
 358 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 359
 360   <tbody>
 361
 362     <tr>
 363
 364       <td style="width: 20%;">Original Authors:</td>
 365
 366       <td>Sam Leffler, Silicon Graphics Inc<br>
 367
 368       </td>
 369
 370     </tr>
 371
 372     <tr>
 373
 374       <td>Website:</td>
 375
 376       <td>http://www.libtiff.org/<br>
 377
 378       </td>
 379
 380     </tr>
 381
 382     <tr>
 383
 384       <td>Licensed Under:</td>
 385
 386       <td>LibTIFF License<br>
 387
 388       </td>
 389
 390     </tr>
 391
 392   </tbody>
 393 </table>
 394
 395 <br>
 396
 397 <span style="font-weight: bold; text-decoration: underline;"></span><br>
 398
 399 <span style="font-weight: bold;">Zlib<br>
 400
 401 </span>
 402 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 403
 404   <tbody>
 405
 406     <tr>
 407
 408       <td style="width: 20%;">Original Authors:</td>
 409
 410       <td>Jean-loup Gailly and Mark Adler</td>
 411
 412     </tr>
 413
 414     <tr>
 415
 416       <td>Website:</td>
 417
 418       <td>http://www.zlib.net</td>
 419
 420     </tr>
 421
 422     <tr>
 423
 424       <td>Licensed Under:</td>
 425
 426       <td>Zlib License&nbsp;</td>
 427
 428     </tr>
 429
 430   </tbody>
 431 </table>
 432
 433 <span style="font-weight: bold;"><br>
 434
 435 Zziplib</span><br>
 436
 437 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 438
 439   <tbody>
 440
 441     <tr>
 442
 443       <td style="width: 20%;">Original Author:</td>
 444
 445       <td>Guido Draheim</td>
 446
 447     </tr>
 448
 449     <tr>
 450
 451       <td>Website:</td>
 452
 453       <td>http://zziplib.sourceforge.net<br>
 454
 455       </td>
 456
 457     </tr>
 458
 459     <tr>
 460
 461       <td>Licensed Under:</td>
 462
 463       <td>Mozilla Public License 1.1&nbsp;</td>
 464
 465     </tr>
 466
 467   </tbody>
 468 </table>
 469
 470 <br>
 471
 472 <span style="font-weight: bold;"></span><span style="font-weight: bold; text-decoration: underline;">Optional
 473 Plugin Dependencies<br>
 474
 475 <span style="text-decoration: underline;"><span style="font-weight: bold;"><br>
 476
 477 </span></span></span>These dependencies are only
 478 needed if you use the plugins they relate to.<br>
 479
 480 <br>
 481
 482 <span style="font-weight: bold;">NVidia Cg<br>
 483
 484 </span>
 485 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 486
 487   <tbody>
 488
 489     <tr>
 490
 491       <td style="width: 20%;">Original Authors:</td>
 492
 493       <td>NVidia</td>
 494
 495     </tr>
 496
 497     <tr>
 498
 499       <td>Website:</td>
 500
 501       <td>http://developer.nvidia.com</td>
 502
 503     </tr>
 504
 505     <tr>
 506
 507       <td>Licensed Under:</td>
 508
 509       <td>Custom free license (binary only)<br>
 510
 511       </td>
 512
 513     </tr>
 514
 515     <tr>
 516
 517       <td>Needed By:</td>
 518
 519       <td>Plugin_CgProgramManager</td>
 520
 521     </tr>
 522
 523   </tbody>
 524 </table>
 525
 526 <br>
 527
 528 <span style="font-weight: bold; text-decoration: underline;"><span style="text-decoration: underline;"><span style="font-weight: bold;"></span></span>Sample
 529 Program Dependencies<br>
 530
 531 <br>
 532
 533 </span>These dependencies are only used by our sample programs,
 534 and
 535 thus you do not need to use them to use OGRE,&nbsp;if you don't
 536 want to.<br>
 537
 538 <br>
 539
 540 <span style="font-weight: bold;">OIS</span><br>
 541
 542 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 543
 544   <tbody>
 545
 546     <tr>
 547
 548       <td style="width: 20%;">Original Authors:</td>
 549
 550       <td>Phillip Castaneda</td>
 551
 552     </tr>
 553
 554     <tr>
 555
 556       <td>Website:</td>
 557
 558       <td>http://www.wreckedgames.com/wiki/index.php/WreckedLibs:OIS<br>
 559
 560       </td>
 561
 562     </tr>
 563
 564     <tr>
 565
 566       <td>Licensed Under:</td>
 567
 568       <td>Zlib License</td>
 569
 570     </tr>
 571
 572   </tbody>
 573 </table>
 574
 575 <br>
 576
 577 <span style="font-weight: bold; text-decoration: underline;"></span><span style="font-weight: bold;">CEGUI</span><br>
 578
 579 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 580
 581   <tbody>
 582
 583     <tr>
 584
 585       <td style="width: 20%;">Original Authors:</td>
 586
 587       <td>Paul D Turner, Tomas Lindquist Olsen and others<br>
 588
 589       </td>
 590
 591     </tr>
 592
 593     <tr>
 594
 595       <td>Website:</td>
 596
 597       <td>http://www.cegui.org.uk<br>
 598
 599       </td>
 600
 601     </tr>
 602
 603     <tr>
 604
 605       <td>Licensed Under:</td>
 606
 607       <td>MIT License</td>
 608
 609     </tr>
 610
 611   </tbody>
 612 </table>
 613
 614 <br>
 615
 616 <span style="font-weight: bold;">ODE</span><br>
 617
 618 <table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 619
 620   <tbody>
 621
 622     <tr>
 623
 624       <td style="width: 20%;">Original Authors:</td>
 625
 626       <td>Russell Smith<br>
 627
 628       </td>
 629
 630     </tr>
 631
 632     <tr>
 633
 634       <td>Website:</td>
 635
 636       <td>http://www.ode.org/<br>
 637
 638       </td>
 639
 640     </tr>
 641
 642     <tr>
 643
 644       <td>Licensed Under:</td>
 645
 646       <td>BSD License</td>
 647
 648     </tr>
 649
 650   </tbody>
 651 </table>
 652
 653 <br>
 654
 655 <p class="mainheader" align="left">Acknowledgements</p>
 656
 657 <p>The authors wish to credit the following for their work which
 658 is
 659 used in whole or in part in OGRE:</p>
 660
 661 <p>Artwork:</p>
 662
 663 <ul>
 664
 665   <li>
 666     <p style="margin-bottom: 0cm;">Matt Anderson at <a href="http://www.the3dstudio.com/">www.The3dStudio.com</a>
 667 who kindly gave permission for the use of some textures. These textures
 668 are used with permission of <a href="http://www.the3dstudio.com/">www.The3dStudio.com</a>
 669 and may
 670 not be re-distributed, sold, or given away except in the form of
 671 rendered images, animations, or real time 3D applications when credit
 672 is given to <a href="http://www.the3dstudio.com/">www.The3dStudio.com</a>.</p>
 673
 674   </li>
 675
 676   <li>
 677     <p style="margin-bottom: 0cm;">Jonathan Clark at <a href="http://www.jonathanclark.com/">http://www.jonathanclark.com</a>
 678 for some Golgotha textures thet were released to the public domain.</p>
 679
 680   </li>
 681
 682   <li>
 683     <p style="margin-bottom: 0cm;">The 'Raptor Assault
 684 Gunboat' mesh &amp; texture are &copy; 2002 by Adrian 'cearny'
 685 Cearnau.</p>
 686
 687   </li>
 688
 689   <li>
 690     <p style="margin-bottom: 0cm;">The robot andn ninja
 691 mesh and animation are by <a href="http://www.psionic3d.co.uk/">Psionic</a>,
 692 kindly made available from the <a href="http://www.insanesoftware.de/">CharacterFX</a>
 693 site</p>
 694
 695   </li>
 696
 697   <li>
 698     <p style="margin-bottom: 0cm;">The 'Razor 2' mesh is
 699 by Dennis Verbeek</p>
 700
 701   </li>
 702
 703   <li>
 704     <p style="margin-bottom: 0cm;">Skyboxes in
 705 cubemapJS.zip are &copy;<a href="http://www.schlorb.com/">Johannes
 706 Schlorb</a>, used with permission. </p>
 707
 708   </li>
 709
 710   <li>
 711     <p>Grass texture is courtesy of Mathias 'freezer' Walc</p>
 712
 713   </li>
 714
 715   <li>
 716     <p>The 'Han Solo' TrueType font is &copy; 2000 by Iconian
 717 Fonts -
 718 Daniel Zadorozny. This font may be freely distributed and is free for
 719 all non-commercial uses. This font is e-mailware; that is, if you
 720 like it, please e-mail the author at: <a href="mailto:iconian@aol.com">iconian@aol.com</a>.</p>
 721
 722   </li>
 723
 724   <li>SoftImage|XSI sample media files (facial.mesh, jaiqua.mesh
 725 and associated files) are provided courtesy of Avid Technology, Inc.<br>
 726
 727 &copy; 2004 Avid Technology, Inc. All rights
 728 reserved. Avid is either a registered trademark or trademark of Avid
 729 Technology, Inc. in the United States and/or other countries. </li>
 730
 731 </ul>
 732
 733 <p>Included as source (modified as appropriate), and credited
 734 appropriately in the source files affected:</p>
 735
 736 <ul>
 737
 738   <li>
 739     <p style="margin-bottom: 0cm;">Many of the
 740 maths/spatial routines are inspired by Dr D.H. Eberley, adapted from
 741 the 'free' parts of the Wild Magic engine 0.2 source provided with his
 742 book "3D Engine Design" (<a href="http://www.geometrictools.com/">http://www.geometrictools.com/</a>)</p>
 743
 744   </li>
 745
 746   <li>
 747     <p style="margin-bottom: 0cm;">Quake3 loading routines
 748 used a lot of information gleaned from <a href="http://www.planetquake.com/aftershock/">Aftershock</a>
 749 and <a href="http://strony.poland.com/bsekura/">Bart
 750 Sekura's ROGL</a></p>
 751
 752   </li>
 753
 754   <li>
 755     <p style="margin-bottom: 0cm;">Singleton template
 756 class is &copy; Scott Bilas 2000 from Game Programming Gems </p>
 757
 758   </li>
 759
 760   <li>
 761     <p>Memory manager is based on MMGR &copy; Paul Nettle at <a href="../../../Docs/www.fluidstudios.com">Fluid Studios</a></p>
 762
 763   </li>
 764
 765 </ul>
 766
 767 <p>Standalone tools used:</p>
 768
 769 <ul>
 770
 771   <li>
 772     <p style="margin-bottom: 0cm;">Document generation
 773 from C++ source code is by Doxygen &copy; Dimitri van Heesch (<a href="http://www.doxygen.org/">http://www.doxygen.org</a>)</p>
 774
 775   </li>
 776
 777   <li>
 778     <p>Milkshape3D for modelling &amp; exporting (<a href="http://www.milkshape3d.com/">http://www.milkshape3d.com</a>)</p>
 779
 780   </li>
 781
 782 </ul>
 783
 784 <p>And I'd also like to thank the following just for inspiration,
 785 ideas, and pretty much anything else:</p>
 786
 787 <ul>
 788
 789   <li>
 790     <p style="margin-bottom: 0cm;">Scott Meyers for his
 791 superb 'Effective C++' series</p>
 792
 793   </li>
 794
 795   <li>
 796     <p style="margin-bottom: 0cm;">Everybody who has ever
 797 written for Game Developer magazine, but particularly Chris Hecker and
 798 Jeff Lander whose work is consistently enlightening</p>
 799
 800   </li>
 801
 802   <li>
 803     <p style="margin-bottom: 0cm;">Michael Abrash for his
 804 'Zen' books which inspired me to try graphics programming in the first
 805 place</p>
 806
 807   </li>
 808
 809   <li>
 810     <p style="margin-bottom: 0cm;">Everybody at
 811 SourceForge and VA Linux for providing <b>fantastic</b>
 812 facilities for developers with modest budgets</p>
 813
 814   </li>
 815
 816   <li>
 817     <p style="margin-bottom: 0cm;">Scott Adams (Dilbert)
 818 for providing a humourous distraction when I've had enough for the day<br>
 819
 820     </p>
 821
 822   </li>
 823
 824 </ul>
 825
 826 <ul>
 827
 828   <li>
 829     <p>My wife Marie for putting up with all this!</p>
 830
 831   </li>
 832
 833 </ul>
 834
 835 Copyright &copy; 2007 by The OGRE Team
 836 <p>&nbsp;
 837 <script><!--//hide script from old browsers
 838 document.write( "Last modified "+ document.lastModified );
 839 //end hiding contents -->
 840 </script></p>
 841
 842 </body>
 843 </html>