diff options
| -rw-r--r-- | doc/STORYLINE | 7 | ||||
| -rw-r--r-- | doc/TASKS | 15 | ||||
| -rw-r--r-- | doc/attributions.html | 555 | ||||
| -rw-r--r-- | doc/installation.html | 117 |
4 files changed, 438 insertions, 256 deletions
diff --git a/doc/STORYLINE b/doc/STORYLINE index 1006650..b95602b 100644 --- a/doc/STORYLINE +++ b/doc/STORYLINE @@ -22,7 +22,7 @@ Great Houses - House Lindblade - - House Illia + - House Praetoria - Council Protectorate Tsu-Khan Empire @@ -45,6 +45,11 @@ - Dover system + HOUSE PRAETORIA (protected by the Praetorian Guard) + + - Praetoria system + planet Praetoria + PROTECTORATE (protected by the Ordinators) The seat of the Council and the capital of the central planets. @@ -33,4 +33,19 @@ Ship definitions Cargo definitions + Add cargo definitions to ini/cargo.ini. + Trade definitions + + Add trade definitions to the world ini files. + +Documentation + + The list of attributions needs updating + + Most of the documentation needs updating: + doc/attribution.html List of attributions + doc/guide.html Player guide + doc/manual.html Engine user manual + doc/world.html Editing the world + diff --git a/doc/attributions.html b/doc/attributions.html index aa39211..58f2777 100644 --- a/doc/attributions.html +++ b/doc/attributions.html @@ -19,277 +19,418 @@ of the <a href="http://creativecommons.org/licenses/by-sa/3.0/">Create Commons Attribution-Share Alike 3.0 License</a>. </p> <p> + Files by <a href="http://www.nasa.gov">NASA</a> are in the + <a href="http://www.nasa.gov/audience/formedia/features/MP_Photo_Guidelines.html">public domain</a>. +</p> +<p> Files by <a href="http://freesound.iua.upf.edu/usersViewSingle.php?id=731">nathanshadow</a> are distributed under the terms of the <a href="http://creativecommons.org/licenses/sampling+/1.0/">Creative Commons Sampling Plus 1.0</a> license. </p> -<p> - Files by <a href="http://www.nasa.gov">NASA</a> are in the - <a href="http://www.nasa.gov/audience/formedia/features/MP_Photo_Guidelines.html">public domain</a>. -</p> </div> -<div id="contributions" class="title"> - Contributions +<div class="title"> + List of data files </div> + <div class="text"> <p> - These files were contributed to the project: + A list of game data files in the data/base directory, + with their original author and/or source. </p> -<p> + <div class="code"> <table> - <tr> - <TD><i>directory</i></td> - <td><i>file</i></t> - <td><i>contributor</i></td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>avatar.map</td> - <td> - supertanker - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>bomber.map</td> - <td> - Odin - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>bumblebee.map</td> - <td> - supertanker - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>carrier.map</td> - <td> - Odin - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>destroyer.map</td> - <td> - Odin - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>freighter.map</td> - <td> - Odin - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>halcyon.map</td> - <td> - supertanker - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>heavycruiser.map</td> - <td> - Odin<br> - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>horizon.map</td> - <td> - Thorn<br> - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>interceptor.map</td> - <td> - Odin<br> - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>scout.map</td> - <td> - Odin<br> - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>sharkan.map</td> - <td> - Thorn<br> - </td> - </tr> - <tr> - <td>/base/maps/ships</td> - <td>supertanker.map</td> - <td> - supertanker<br> - </td> - </tr> - <tr> - <td>/base/maps/stations</td> - <td>station15.map</td> - <td> - supertanker<br> - </td> - </tr> - - <tr> - <td>/base/maps/stations</td> - <td>civilian_housing.map</td> - <td> - Odin<br> - </td> - </tr> - <tr> - <td>/base/maps/stations</td> - <td>lindblade_central.map</td> - <td> - supertanker<br> - </td> - </tr> - <tr> - <td>/base/maps/stations</td> - <td>tsukhan_central.map</td> - <td> - Odin<br> - </td> - </tr> +<!-- MAPS ========================================================== --> <tr> - <td>/base/textures/env</td> - <td>sky12.tga</td> - <td> - Thorn - </td> - </tr> - <tr> - <td>/base/textures/env</td> - <td>sky17.tga</td> - <td> - Thorn - </td> - </tr> - <tr> - <td>/base/textures/env</td> - <td>sky20.tga</td> - <td> - Thorn - </td> - </tr> - <tr> - <td>/base/textures/env</td> - <td>sky21.tga</td> - <td> - Thorn - </td> - </tr> - <tr> - <td>/base/textures/env</td> - <td>sky31.tga</td> - <td> - Thorn - </td> - </tr> -</table> -</div> + <TD><i>Directory</i></td> + <td><i>File(s)</i></t> + <td><i>Original author</i></td> + </tr> +<tr> + <td>maps/cargo</td> + <td>crate.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/cargo</td> + <td>pod.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>alexandria.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>alexandria_storage.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>cantor.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>custodian.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>helianthos.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>ikarus.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>jumpgate.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>regula.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>regula_storage.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/colonial</td> + <td>sharkan.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/derelict</td> + <td>ares.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/derelict</td> + <td>hades.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>avenger.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>betelgeuse.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>bumblebee.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/independent</td> + <td>ensor.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/independent</td> + <td>galaxy.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>horizon.map</td> + <td>Thorn</td> +</tr> +<tr> + <td>maps/independent</td> + <td>jupiter.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>orion.map</td> + <td>(?)</td> +</tr> +<tr> + <td>maps/independent</td> + <td>researchstation.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/independent</td> + <td>shootingstar.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>avatar.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>halcyon.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>lindblade_central.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>lindblade_dock.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>powersat.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>station15.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/lindblade</td> + <td>supertanker.map</td> + <td>Supertanker</td> +</tr> +<tr> + <td>maps/mercenary</td> + <td>archer.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/mercenary</td> + <td>enforcer.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/mercenary</td> + <td>longbow.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/mercenary</td> + <td>pod.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/mercenary</td> + <td>talon.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/merchant</td> + <td>matrix.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/merchant</td> + <td>scalar.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/merchant</td> + <td>vector.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/miners</td> + <td>cruiser.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/pirate</td> + <td>juggernaut.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/pirate</td> + <td>jumpgate.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/pirate</td> + <td>raider.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/race</td> + <td>checkpoint.map</td> + <td>Ingar</td> +</tr> +<tr> + <td>maps/static</td> + <td>cannon001.map</td> + <td></td> +</tr> +<tr> + <td>maps/static</td> + <td>cannon002.map</td> + <td></td> +</tr> +<tr> + <td>maps/static</td> + <td>cargopod001.map</td> + <td></td> +</tr> +<tr> + <td>maps/static</td> + <td>navpoint.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/static</td> + <td>turret001.map</td> + <td></td> +</tr> +<tr> + <td>maps/static</td> + <td>turret002.map</td> + <td></td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>camel.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>civilian_housing.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>civilian_starscraper.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>colosus.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>imp.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>inquisitor.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>obliterator.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>panzer.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>ravager.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>tsukhan_central.map</td> + <td>Odin</td> +</tr> +<tr> + <td>maps/tsukhan</td> + <td>warbringer.map</td> + <td>Odin</td> +</tr> -</p> - -</div> +<!-- MODELS ======================================================== --> -<div id="derived_works" class="title"> - Derived works -</div> -<div class="text"> -<p> - These files are available on the internet or are based on freely available works: -</p> -<p> -<div class="code"> -<table> +<!-- SOUNDS ======================================================== --> + <tr> - <TD><i>directory</i></td> - <td><i>file</i></t> - <td><i>source</i></td> - </tr> - <tr> - <td>/base/sounds/engines</td> + <td>sounds/engines</td> <td>loop00.wav</td> <td> <a href="http://freesound.iua.upf.edu/samplesViewSingle.php?id=22454">nathanshadow</a> </td> </tr> <tr> - <td>/base/sounds/engines</td> + <td>sounds/engines</td> <td>loop01.wav</td> <td> <a href="http://freesound.iua.upf.edu/samplesViewSingle.php?id=22455">nathanshadow</a> </td> </tr> <tr> - <td>/base/sounds/engines</td> + <td>sounds/engines</td> <td>loop02.wav</td> <td> <a href="http://freesound.iua.upf.edu/samplesViewSingle.php?id=22456">nathanshadow</a> </td> </tr> + +<!-- TEXTURES ====================================================== --> + <tr> - <td>/base/textures/env</td> - <td>sky.tga</td> + <td>textures/kuroto</td> + <td>all files</td> <td> - <a href="http://svs.gsfc.nasa.gov/vis/a000000/a003400/a003442/index.html">The Tycho Catalog Skymap</a><br> - NASA/Goddard Space Flight Center Scientific Visualization Studio + <a href="http://www.kurotorobert.com/">Robert Kuroto</a><br> + (released under CC-BY-SA-3.0 with permission) </td> </tr> <tr> - <td>/base/textures/planets</td> - <td>ghant.tga</td> + <td>textures/planets</td> + <td>ghant.png</td> <td> <a href="http://maps.jpl.nasa.gov/">JPL Solar System Simulator</a> (Phobos)<br> NASA/JPL-Caltech </td> <tr> <tr> - <td>/base/textures/planets</td> - <td>lindblade.tga</td> + <td>textures/planets</td> + <td>lindblade.png</td> <td> <a href="http://maps.jpl.nasa.gov/">JPL Solar System Simulator</a> (Saturn)<br> NASA/JPL-Caltech </td> </tr> <tr> - <td>/base/textures/planets</td> - <td>seymour.tga</td> + <td>textures/planets</td> + <td>seymour.png</td> <td> <a href="http://maps.jpl.nasa.gov/">JPL Solar System Simulator</a> (Venus)<br> NASA/JPL-Caltech </td> </tr> <tr> - <td>/base/textures/planets</td> - <td>brogha.tga</td> + <td>textures/planets</td> + <td>brogha.png</td> <td> <a href="http://www.celestiamotherlode.net/catalog/show_creator_details.php?creator_id=153">Chance Ragen</a> (Orion's Paradise)<br> - from the <a href="http://galaxistar.googlepages.com/">GalaxyStar</a> project (with permission) + from the <a href="http://galaxistar.googlepages.com/">GalaxyStar project</a> + (released under CC-BY-SA-3.0 with permission) </td> </tr> <tr> - <td>/base/textures/kuroto</td> - <td>all files</td> + <td>textures/planets</td> + <td>finnmark.png</td> <td> - <a href="http://www.kurotorobert.com/">Robert Kuroto</a><br> - (with permission) + <a href="http://www.celestiamotherlode.net/catalog/show_creator_details.php?creator_id=5">Jeremy "Jestr" Gardner</a> (Sedna)<br> + from the <a href="http://www.celestiamotherlode.net/catalog/show_addon_details.php?addon_id=227">Celestia Motherlode</a> + (released under CC-BY-SA-3.0 with permission) </td> </tr> </table> diff --git a/doc/installation.html b/doc/installation.html index 838c754..8631686 100644 --- a/doc/installation.html +++ b/doc/installation.html @@ -55,10 +55,13 @@ <div class="text"> <p> - Download the windows package:<br> - <a href="http://ingar.satgnu.net/osirion/files/osirion-win32-latest.zip">osirion-win32-latest.zip</a> (32 bit)<br> - <a href="http://ingar.satgnu.net/osirion/files/osirion-win32-latest.zip">osirion-win64-latest.zip</a> (64 bit)<br> - This package contains the win32 version of the server and the client. + Download for 32-bit windows<br> + <a href="http://ingar.satgnu.net/osirion/files/osirion-win32-latest.zip">osirion-win32-latest.zip</a> (32-bit)<br> + This package should work on most windows systems. +</p><p> + Download for 64-bit windows<br> + <a href="http://ingar.satgnu.net/osirion/files/osirion-win64-latest.zip">osirion-win64-latest.zip</a> (64-bit)<br> +</p> <p> Dowload the game data package:<br> <a href="http://ingar.satgnu.net/osirion/files/osirion-data-latest.zip">osirion-data-latest.zip</a><br> @@ -78,9 +81,9 @@ <div class="text"> <p> - Download the linux packages:<br> - <a href="http://ingar.satgnu.net/osirion/files/osirion-linux-latest.zip">osirion-linux-latest.zip</a>(32 and 64 bit)<br> - This package contains the linux 32 and 64 bit versions of the client and the server. + Linux download:<br> + <a href="http://ingar.satgnu.net/osirion/files/osirion-linux-latest.zip">osirion-linux-latest.zip</a>(32- and 64-bit)<br> + This package contains the linux version of the client and the server. <p> Extract the package, a new subdirectory will be created. The actual directory name will depend on the version number. Enter the new subdirectory. @@ -128,6 +131,7 @@ unzip ../osirion-data-latest.zip To build the client or the dedicated server: <ul> <li>zlib + <li><a href="http://www.bulletphysics.com/">Bullet Physics Library</a> </ul> </p> <p> @@ -135,10 +139,10 @@ unzip ../osirion-data-latest.zip <ul> <li>libSDL 1.2 <li>libpng - <li>libjpeg-6b + <li>libjpeg <li>OpenGL - <li><A href="http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx">OpenAL</a> - or <a href="http://kcat.strangesoft.net/openal.html">OpenAL Soft</a> + <li><a href="http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx">OpenAL</a> + or <a href="http://kcat.strangesoft.net/openal.html">OpenAL Soft</a> </ul> </p> <p> @@ -149,60 +153,63 @@ unzip ../osirion-data-latest.zip </div> <div class="subtitle"> - Obtaining the source code + Building the Bullet physics library </div> + <div class="text"> <p> - You can get the osirion project source code from the subversion repository:<br> - <a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a> + The engine uses the <a href="http://www.bulletphysics.com/">Bullet Physics Library</a> + for physics support. You can download the bullet source code here: + <ul> + <li><a href="http://code.google.com/p/bullet/downloads/list">http://code.google.com/p/bullet/downloads/list</a> + </ul> </p> <p> - On linux, you can use the Subversion command line client tool. The following - command will create a new subdirectory <i>osirion</i> and download the source code into it. + To download and install the library: </p> <div class="code"> -svn co svn://intranifty.no-ip.org/osirion osirion +wget http://bullet.googlecode.com/files/bullet-2.77.tgz<br> +tar zxvf bullet-2.77.tgz<br> +cd bullet-2.77<br> +./autogen.sh<br> +./configure --prefix=/usr/local<br> +make<br> +sudo make install<br> </div> -<p> - On windows, you can use the Turtoisesvn SubVersion client to access the - SVN repositories. You can download it here:<br> - <a href="http://tortoisesvn.tigris.org">http://tortoisesvn.tigris.org</a> -</p> -<p> - You can also download the source package from the website:<br> - <a href="http://ingar.satgnu.net/osirion/files/osirion-src-latest.tar.bz2">osirion-src-latest.tar.bz2</a> -</p> </div> -<!-- + <div class="subtitle"> - Bullet physics support (depricated) + Obtaining the source code </div> <div class="text"> <p> - Experimental support for the <a href="http://www.bulletphysics.com/wordpress/">Bullet Physics Library</a> - is under development. You can download the source code here:<br> - <a href="http://code.google.com/p/bullet/downloads/list">http://code.google.com/p/bullet/downloads/list</a> + You can get the osirion project source code from the subversion repository: + <ul> + <li><a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a> + </ul> </p> <p> - To download and install the library: + On linux, you can use the Subversion command line client tool. The following + command will create a new subdirectory <i>osirion</i> and download the source code into it. +</p> <div class="code"> -wget http://bullet.googlecode.com/files/bullet-2.77.tgz<br> -tar zxvf bullet-2.77.tgz<br> -cd bullet-2.77<br> -./autogen.sh<br> -./configure --prefix=/usr/local<br> -make<br> -sudo make install<br> -sudo install --mode=644 src/BulletDynamics/Dynamics/btActionInterface.h /usr/local/include/bullet/BulletDynamics/Dynamics +svn co svn://intranifty.no-ip.org/osirion osirion </div> +<p> + On windows, you can use the Turtoisesvn SubVersion client to access the + SVN repositories. You can download it here: + <ul> + <li><a href="http://tortoisesvn.tigris.org">http://tortoisesvn.tigris.org</a> + </ul> </p> <p> - The osirion configure script will automaticly detect the bullet library in <i>/usr/local</i>. - If you use a different prefix, like <i>/opt/bullet</i>, you will have to call the osirion - configure script using the <i>--with-bullet=/opt/bullet</i> option. + You can also download the source package from the website:<br> + <ul> + <li><a href="http://ingar.satgnu.net/osirion/files/osirion-src-latest.tar.bz2">osirion-src-latest.tar.bz2</a> + <ul> </p> </div> ---> + <div class="subtitle"> Compiling the source code </div> @@ -219,6 +226,16 @@ autoreconf -fi<br> If you do not need the client and want to build the dedicated server only you can pass the <i>--without-client</i> option to <i>configure</i>: </p> +<p> + Configure will automaticly detect the bullet library if itwass installed in <i>/usr/local</i>. + If it was installed somewhere else you will have to pass the <i>--with-bullet=directory</i> option + to configure. +</p> +</p> + For example, if you want to use the system-provided package on Arch linux, use + <i>--with-bullet=/usr</i>. +</p> + <div class="code"> ./configure --without-client </div> @@ -247,8 +264,10 @@ make <div class="text"> <p> The game data should be located in the <i>data</i> subdirectory of the main distribution. - You can use the game data package from the website or get it from the osirion-data subversion repository:<br> - <a href="svn://intranifty.no-ip.org/osirion-data">svn://intranifty.no-ip.org/osirion-data</a> + You can use the game data package from the website or get it from the osirion-data subversion repository: + <ul> + <li><a href="svn://intranifty.no-ip.org/osirion-data">svn://intranifty.no-ip.org/osirion-data</a> + </ul> </p> <p> Run the following command from within the main distribution directory to download @@ -329,8 +348,10 @@ make <p> You can skip this section if you do not intent to create to create models with netradiant or gtkradiant 1.5. Note that these files probably won't work with other versions. You can find precompiled - netradiant packages here:<br> - <a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a> + netradiant packages here: + <ul> + <li><a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a> + </ul> <p> These instructions assume gtkradiant is installed in the directory <i>/usr/local/games/netradiant</i>. If it is installed in a different @@ -415,8 +436,8 @@ Organization of the distribution /bitmaps essential bitmaps /ini game world description files /maps 3D models (.map format) + /materials material definitions /models 3D models (ase and other formats) - /scripts radiant compatible shader files /textures game world textures /gtkradiant radiant support files |