From 836799946d9da0d68ba93a6857b2c0ba3617c89d Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Tue, 1 May 2012 19:07:53 +0000 Subject: Updated documentation, match documentation style with website stylesheet. --- AUTHORS | 12 +- COPYING | 6 +- developer/STORYLINE | 25 +- developer/TODO | 11 +- doc/attributions.html | 723 +++++++++++++++++++++++------------------- doc/images/background.jpg | Bin 0 -> 51597 bytes doc/images/banner.png | Bin 3511 -> 3372 bytes doc/images/bullet.png | Bin 0 -> 120 bytes doc/index.html | 256 ++++++++++----- doc/installation.html | 3 +- doc/installation_develop.html | 347 ++++++++++++++++++++ doc/installation_release.html | 138 ++++++++ doc/installation_source.html | 276 ++++++++++++++++ doc/osirion.css | 282 ++++++++++++++++ doc/starsystem_roadmap.html | 69 ++++ 15 files changed, 1711 insertions(+), 437 deletions(-) create mode 100644 doc/images/background.jpg create mode 100644 doc/images/bullet.png create mode 100644 doc/installation_develop.html create mode 100644 doc/installation_release.html create mode 100644 doc/installation_source.html create mode 100755 doc/osirion.css create mode 100644 doc/starsystem_roadmap.html diff --git a/AUTHORS b/AUTHORS index 6d7bc56..0156f10 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,8 @@ -Project::OSiRiON -http://osirion.org -Stijn 'Ingar' Buys -Michael 'Thorn' Rodenhurst -Evan 'Mega' Goers +Project::OSiRiON - AUTHORS + + http://osirion.org + + Stijn 'Ingar' Buys + Michael 'Thorn' Rodenhurst + Evan 'Mega' Goers diff --git a/COPYING b/COPYING index 43cea36..a18df9f 100644 --- a/COPYING +++ b/COPYING @@ -1,12 +1,12 @@ -Project::OSiRiON - License +Project::OSiRiON - COPYING - PRojecT::OSiRiON consists of two major parts: the source + Project::OSiRiON consists of two major parts: the source code and the game data. Each part is licenced differently. Source Code - The source code is licenced under the GENERAL PUBLIC LICENSE. + The source code is licenced under the GENERAL PUBLIC LICENSE, version 2. The full text of this licence can be found in the file named GPL. Please refer to diff --git a/developer/STORYLINE b/developer/STORYLINE index bdd73a9..7aff528 100644 --- a/developer/STORYLINE +++ b/developer/STORYLINE @@ -144,9 +144,10 @@ ------------------------------------------------------------------ TIMELINE - Exodus -5000 years - The Year of War -300 years - The Karelian Incident -50 years + Exodus 0 AE (After Exodus) + The Year of War 480 AE + The Karelian Incident 510 AE + Today 545 AE ------------------------------------------------------------------ @@ -160,11 +161,11 @@ Reaching for the Stars there are few written accounts of the events before the Exodus, it wouldn't be hard to imagine why the Homeworld would have been abandoned in the first place: wars for power, territory and resources would be commonplace - for almost five millenia to come. + for almost five centuries to come. The Year of War - For the Tsu-Khan, this war was no different. Around 300 years ago, + For the Tsu-Khan, this war was no different. About a century ago, The Empire had depleted most of its natural resources and had launched an ambitious project to find a suitable new homeworld. @@ -214,7 +215,7 @@ The Alliance tradition, where the Lords of the Major Houses used to work out their differences with dialog, or discuss current events. In the years before the Great War, this tradition had been neglected and oposing views were usually solved with a friendly - border skirmish followed by royal monetary compensation. + border skirmish followed by a royal monetary compensation. These times were over. This war wasn't about money, power or territory. It was about survival and it was clear by now that none of the Major Houses possessed @@ -291,7 +292,7 @@ Project Osirion The ship's first test flight was a major event. Most secret projects did not generate a lot of attentention, but this flight was a higly anticipated by - the top brass from all parties involved, military, political and corporate alike. + the top brass from all parties involved: military, political and corporate alike. The ship had left the construction yard as planned and had almost arrived at departure point on the edge of the star system when suddenly all communication @@ -299,9 +300,9 @@ Project Osirion source of the malfunction, and everything that happened after this point is the result of long-range sensor telemetry. - The ship arrived at the departure point and the flight continued as planned. + Sensors hat detected the ship arriving at the departure point and the flight continued as planned. A few moments later a massive energy discharge was registered, indicating - that the experimental jump drive was activated. Unfortunatly, the order + the experimental jump drive was activated. Unfortunatly, the order to return to the point of departure after the initial jump, seems to be a part of the plan that never got executed. The ship had literally vanished into thin air. @@ -494,6 +495,12 @@ II. Surprises "1"... "0" ..."-1, Docking Bay". The low, humming noise of the elevator ended abruptly and the doors opened again. +III. The Docking Bay + + The warm arid air of the docking bay filled the elevator. Contemporary generator technology + tends to ionize the atmosphere and the distinct smell of a recently landed ship was + noticably present //..more//. + Temporary notes: III about getting stunned in the cargo bay diff --git a/developer/TODO b/developer/TODO index 171b135..1703171 100644 --- a/developer/TODO +++ b/developer/TODO @@ -25,7 +25,7 @@ filesystem: fs_base, fs_mod, fs_game, to be used by modules model: - .obj support + (ok) .obj support .md3 support (ok) .ase submaterials (ok) @@ -94,11 +94,11 @@ render: ui: unify event handlers, expand Event class and make derived event classes - listview scrolling + (ok) listview scrolling - make modelview and slider dragging work when the mouse leaves the widget - if the mouse button is pressed, mouse focus should stick to the last clicked widget - until the button is released + (ok) make modelview and slider dragging work when the mouse leaves the widget: + if the mouse button is pressed, mouse focus should stick to the last clicked widget + until the button is released (ok) slider mouse dragging (ok) correct modelview lighting @@ -113,6 +113,7 @@ sound: game: add Ship::ship_dock, making docking independent of player->view() -> relates to player-to-player trading have the goto command check the target's Docked state -> ties into ship dock awereness + move Ship::dock() functionality into core::EntityControlable ship health/shield/armor add fleet support diff --git a/doc/attributions.html b/doc/attributions.html index 02474ab..8888c74 100644 --- a/doc/attributions.html +++ b/doc/attributions.html @@ -2,18 +2,39 @@ - - Project::OSiRiON - Attributions + + + + Project::OSiRiON - Attributions - +
+ + + + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
-
+
+ + + +

Attributions

The game data is distributed under the terms and conditions of the Create Commons Attribution-Share Alike 3.0 License. @@ -22,341 +43,349 @@ Sound effects from the Freesound project are distributed under the terms and conditions of the Creative Commons Sampling Plus 1.0 license.

-
-
- List of data files -
+ -
+

List of data files

A list of game data files in the data/base directory, with their original author and/or source.

- - - - - - +
Directory
+ + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -380,6 +409,12 @@ + + + @@ -421,7 +456,13 @@ - + + + + - + - +
Directory File(s) Original author
maps/cargocrate.mapIngar
maps/cargopod.mapIngar
maps/colonialalexandria.mapMega
maps/colonialalexandria_storage.mapIngar
maps/colonialcantor.mapIngar
maps/colonialcustodian.mapMega
maps/colonialhelianthos.mapIngar
maps/colonialikarus.mapIngar
maps/colonialjumpgate.mapIngar
maps/colonialregula.mapIngar
maps/colonialregula_storage.mapIngar
maps/colonialsharkan.mapIngar
maps/derelictares.mapMega
maps/derelicthades.mapMega
maps/independentavenger.mapMega
maps/independentbetelgeuse.mapMega
maps/independentbumblebee.mapSupertanker
maps/independentensor.mapIngar
maps/independentgalaxy.mapMega
maps/independenthorizon.mapThorn
maps/independentjupiter.mapMega
maps/independentorion.mapIngar
maps/independentresearchstation.mapMega
maps/independentshootingstar.mapMega
maps/independenttrident.mapYour_Face
maps/lindbladeavatar.mapSupertanker
maps/lindbladehalcyon.mapSupertanker
maps/lindbladelindblade_central.mapSupertanker
maps/lindbladelindblade_dock.mapSupertanker
maps/lindbladepowersat.mapSupertanker
maps/lindbladestation15.mapSupertanker
maps/lindbladesupertanker.mapSupertanker
maps/mercenaryarcher.mapMega
maps/mercenaryenforcer.mapMega
maps/mercenarylongbow.mapMega
maps/mercenarypod.mapIngar
maps/mercenarytalon.mapMega
maps/merchantmatrix.mapIngar
maps/merchantscalar.mapMega
maps/merchantvector.mapIngar
maps/minerscruiser.mapMega
maps/piratejuggernaut.mapMega
maps/piratejumpgate.mapMega
maps/pirateraider.mapMega
maps/racecheckpoint.mapIngar
maps/staticcannon001.map
maps/staticcannon002.map
maps/staticcargopod001.map
maps/staticnavpoint.mapMega
maps/staticturret001.map
maps/staticturret002.map
maps/tsukhancamel.mapMega
maps/tsukhancivilian_housing.mapMega
maps/tsukhancivilian_starscraper.mapMega
maps/tsukhancolosus.mapMega
maps/tsukhanimp.mapMega
maps/tsukhaninquisitor.mapMega
maps/tsukhanobliterator.mapMega
maps/tsukhanpanzer.mapMega
maps/tsukhanravager.mapMega
maps/tsukhantsukhan_central.mapMega
maps/tsukhanwarbringer.mapMega
+

Maps

+
+
maps/cargocrate.mapIngar
maps/cargopod.mapIngar
maps/colonialalexandria.mapMega
maps/colonialalexandria_storage.mapIngar
maps/colonialcantor.mapIngar
maps/colonialcustodian.mapMega
maps/colonialhelianthos.mapIngar
maps/colonialikarus.mapIngar
maps/colonialjumpgate.mapIngar
maps/colonialregula.mapIngar
maps/colonialregula_storage.mapIngar
maps/colonialsharkan.mapIngar
maps/derelictares.mapMega
maps/derelicthades.mapMega
maps/independentavenger.mapMega
maps/independentbetelgeuse.mapMega
maps/independentbumblebee.mapSupertanker
maps/independentensor.mapIngar
maps/independentgalaxy.mapMega
maps/independenthorizon.mapThorn
maps/independentjupiter.mapMega
maps/independentorion.mapIngar
maps/independentresearchstation.mapMega
maps/independentshootingstar.mapMega
maps/independenttrident.mapYour_Face
maps/lindbladeavatar.mapSupertanker
maps/lindbladehalcyon.mapSupertanker
maps/lindbladelindblade_central.mapSupertanker
maps/lindbladelindblade_dock.mapSupertanker
maps/lindbladepowersat.mapSupertanker
maps/lindbladestation15.mapSupertanker
maps/lindbladesupertanker.mapSupertanker
maps/mercenaryarcher.mapMega
maps/mercenaryenforcer.mapMega
maps/mercenarylongbow.mapMega
maps/mercenarypod.mapIngar
maps/mercenarytalon.mapMega
maps/merchantmatrix.mapIngar
maps/merchantscalar.mapMega
maps/merchantvector.mapIngar
maps/minerscruiser.mapMega
maps/piratejuggernaut.mapMega
maps/piratejumpgate.mapMega
maps/pirateraider.mapMega
maps/racecheckpoint.mapIngar
maps/staticcannon001.map
maps/staticcannon002.map
maps/staticcargopod001.map
maps/staticnavpoint.mapMega
maps/staticturret001.map
maps/staticturret002.map
maps/tsukhancamel.mapMega
maps/tsukhancivilian_housing.mapMega
maps/tsukhancivilian_starscraper.mapMega
maps/tsukhancolosus.mapMega
maps/tsukhanimp.mapMega
maps/tsukhaninquisitor.mapMega
maps/tsukhanobliterator.mapMega
maps/tsukhanpanzer.mapMega
maps/tsukhanravager.mapMega
maps/tsukhantsukhan_central.mapMega
maps/tsukhanwarbringer.mapMega
+

Models

+
+
models/asteroid asteroid1
+

Sounds

+
+
sounds/engines loop00.wav
+

Textures

+
+
textures/kuroto all files @@ -429,7 +470,7 @@ (released under CC-BY-SA-3.0 with permission)
textures/planets albion.jpg @@ -438,7 +479,7 @@ Chance Ragen
(released under CC-BY-SA-3.0 with permission)
textures/planets antwerp.png @@ -529,8 +570,26 @@
+ + +
+ + + +
+
+ diff --git a/doc/images/background.jpg b/doc/images/background.jpg new file mode 100644 index 0000000..5536114 Binary files /dev/null and b/doc/images/background.jpg differ diff --git a/doc/images/banner.png b/doc/images/banner.png index c702afa..7c3e8b1 100644 Binary files a/doc/images/banner.png and b/doc/images/banner.png differ diff --git a/doc/images/bullet.png b/doc/images/bullet.png new file mode 100644 index 0000000..2f6655e Binary files /dev/null and b/doc/images/bullet.png differ diff --git a/doc/index.html b/doc/index.html index 50db56f..b571dd5 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,27 +2,47 @@ - - Project::OSiRiON - Documentation + + + + Project::OSiRiON - Documentation +
- + - + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
+ +
+ + -
+
+

About

Project::OSiRiON is a free space trading and combat simulation under development. Its goal is to create an immersive universe with open gameplay inspired by classic titles such as Privateer and Freelancer.

+

The engine is written from scratch in C++ and uses SDL, OpenGL, OpenAL, libjpeg, libpng, zlib and the Bullet physics library. It is @@ -30,9 +50,9 @@

The basic components are already in place: players can start a single-player game, - or join a network server. They can purchase a ship and explore the universe and can even earn - some cash trading cargo. Other important parts are still missing: games can not be saved and - there are no weapon nor combat features. + or join a network server. They can purchase a ship, explore the universe and earn + some cash trading cargo. Other important parts, like weapons and combat features, + are still missing.

The game aims to be fully customizable. Common and easy to edit file formats @@ -43,40 +63,66 @@

-
- Content -
-
-

-

- - - -

-
+ + +
+

Installation

+ + +
+

Manual

+ + +
+

Editing

+ + +
+

General information

+ + + + + +

Internet

-
- Internet -
-

The website for Project::OSiRiON can be found at http://osirion.org

+

+ The community forums can be foudn at + http://osirion.org/forum +

The official IRC channel is #osirion on the FreeNode IRC network.

+ + + +

Development

SVN activity is monitored by CIA.vc, the project pages can be found here:

-
- - -
-

- The source code is distributed under the terms and conditions of the - GNU General Public License. -

-

- The game data is distributed under the terms and conditions of the - Creative Commons Attribution-Share Alike 3.0 License.
-

- A few files are distributed under the terms of a different license. - Please read the list of attributions for a complete overview - of authors and copyright. + The repositories can also be viewed online: +

- Copyright © 2007-2011, Stijn 'Ingar' Buys <ingar@telenet.be> -

-
- + The project development roadmap and an overview of open issues can be found on the + tracker. -
- Team -
+ -
- +

Team

+

+ The core team, these people work on the game and decide about its future: +

+
- - + + - + - + -
Stijn 'Ingar' BuysProgramming, modeling, graphics, soundsStijn 'Ingar' BuysProgramming, modeling, graphics, sound
Michael 'Thorn' RodenhurstMichael 'Thorn' Rodenhurst Modeling, graphics, web server
Evan 'Mega' GoersEvan 'Mega' Goers Modeling, graphics
-
+ -
- Contributors -
-
- + + +

Contributors

+ +

+ These people created new content for the game: +

+ +
- + - + +
Cody 'Supertanker' JacksonCody 'Supertanker' Jackson Modeling
Antti 'Karvajalka' LahtiAntti 'Karvajalka' Lahti Modeling, graphics
- -
+ + +

Credits

+ +

+ People who made their existing work available: +

+ + + + + + + + + + + + + +
Robert Kuroto
Georges 'TRaK' Grondin
Jeremy 'Jestr' Gardner
Chance Ragen
NASA Jet Propulsion Laboratory
+ + + + + +

+ The source code is distributed under the terms and conditions of the + GNU General Public License. +

+

+ The game data is distributed under the terms and conditions of the + Creative Commons Attribution-Share Alike 3.0 License. +

+

+ Copyright © 2007-2012, Project::OSiRiON +

+ + + +

Acknowledgements

-
- Acknowledgements -
-

This project could not have been possible without the work of others:

    @@ -192,6 +265,25 @@ and is not affiliated with these companies.

    + + +
+ + + +
+ +
diff --git a/doc/installation.html b/doc/installation.html index 4cd386e..20464f1 100644 --- a/doc/installation.html +++ b/doc/installation.html @@ -7,6 +7,7 @@ + diff --git a/doc/installation_develop.html b/doc/installation_develop.html new file mode 100644 index 0000000..de03251 --- /dev/null +++ b/doc/installation_develop.html @@ -0,0 +1,347 @@ + + + + + + + + Project::OSiRiON - Building the development version + + + +
+ + + + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
+ +
+ +

Building the development version

+ +

+ The latest release is usually lagging behind current development. If you want to check + the latest developments for yourself, you can get the most recent source code and game + data from the subversion repository. +

+

+ Building the development version is very similar to building + from source code. The system requirements still apply. Additionally you will need + a subversion client. +

+ +

+ + + + +

Obtaining the source code

+ +

+ On linux, you can use the Subversion command line client tool. The following + command will create a new subdirectory osirion and download the source code into it. +

+
+ svn checkout svn://osirion.org/osirion osirion +
+

+ On windows, you can use the Turtoisesvn SubVersion client to access the + SVN repositories. You can download it here: +

+ +

+ Enter the new directory: +

+
+ cd osirion +
+ + + +

Obtaining the game data

+

+ The game data should be located in the data subdirectory of the main distribution. + You can use the game data package from the website or get it from the osirion-data subversion repository: +

+

+

+ Run the following command from within the main distribution directory to download + the game data into the data subdirectory: +

+
+ svn checkout svn://osirion.org/osirion-data data +
+ + + +

Configuring the source code

+

+ Create the configure script: +

+
+ autoreconf -fi +
+

+ Create a build directory, If something goes wrong, or building doesn't work any more after updating, + you can just delete the build directory and start over without destorying the working copy. + Enter the build directory and configure the source code: +

+
+ mkdir build
+ cd build
+ ../configure --with-bullet=/usr/local --enable-static-bullet +
+

+ Use the --help option to get a list of all available options: +

+
+ ../configure --help +
+ + + +

Building the binaries

+

+ Compile the source code: +

+
+ make -j2 +
+

+ The -j2 options tells make to use two threads while building, if you have a + quad-core cpu, you can use -j4. +

+

+ The binaries will be built in the src/ subdirectory of the build directory. +

+

+ Important:
+ make install is not supported. Results are unpredictable. +

+

+ Leave the build directory: +

+
+ cd .. +
+ + + +

Running

+

+ The client and the dedicated server will look for game data in the data subdirectory + of the current working directory. Since the binaries are build in the src you will + have start them with the src/ prefix. +

+

+ To start the client: +

+
+ ./build/src/osirion +
+

+ If the client opens a new window and immediatly close it again, it probably could not find + the game data and exited. Check your installation. +

+

+ To start the dedicated server: +

+
+ ./build/src/osiriond +
+

+ If you are using windows, the binaries will be called osirion.exe and osiriond.exe. +

+ + + +

Updating

+

+ Once you downloaded the source code and the game data from the subversion repository, + there is no need to re-download the entire distribution when there are updates available. + You can update your local copy and rebuild it. +

+

+ Update the source code: +

+
+ cd osirion
+ cd build
+ make clean
+ cd ..
+ svn update +
+

+ Update the game data: +

+
+ cd data
+ svn update
+ cd .. +
+

+ Rebuild the binaries: +

+
+ autoreconf
+ cd build
+ ../configure --with-bullet=/usr/local --enable-static-bullet
+ make -j2
+ cd .. +
+ + + +

Source data (optional)

+

+ There is a seperate repository for files that are used to + create the game data, like blender, gimp or vector graphics files. + It is not necessary to download these files to play the game, + but if you are interested in contributing to the game you + might want to get them. +

+

+ To download the source data from the subversion repository: +

+
+ svn checkout svn://osirion.org/osirion-data-src data-src +
+ + + +

Radiant support files (optional)

+

+ You can skip this section if you do not intent to create models with netradiant or + gtkradiant 1.5. These files probably won't work with other versions. You can find precompiled + netradiant packages here: +

+

+ These instructions assume gtkradiant is installed in the directory + /usr/local/games/netradiant. If it is installed in a different + directory on your system, edit these instructions accordingly. +

+ Copy the support files to the gtkradiant folder: +

+
+ cd data
+ cd gtkradiant
+ cp -vr * /usr/local/games/netradiant +
+

+ Open the file /usr/local/games/netradiant/games/osirion.game in + your favourite editor. Look for a line that begins with: +

+
+ enginepath_linux= +
+

+ Make sure it points to your osirion data directory. For example, + if you checked out the source code into /home/user/osirion, + then the data will be in /home/user/osirion/data and + the line should look like this: +

+
+ enginepath_linux="/home/user/osirion/data" +
+

+ Save the changes. +

+ + + +

Organization of the distribution

+ +
+/doc 					Documentation
+
+	index.html			Documentation content
+	attributions.html		List of game data attributions
+	installation_release.html	Installing the latest release
+	installation_source.html	Building from source code
+	installation_develop.html	Building the development version (this file)
+	guide.html			Player guide
+	manual.html			User manual
+
+/src 					C++ source code
+
+	/audio				audio library
+	/auxiliary			auxiliary functions
+	/client				osirion client
+	/core				game-independent core library
+	/dedicated			osiriond dedicated server
+	/filesystem			filesystem library
+	/game				game-specific functions 
+		/base			base game module
+		/example		example game module
+		/intro			intro game module
+	/math				mathematical classes and functions
+	/sys				low-level system functions
+	/render				render library
+	/ui				user interface library
+
+/data					Data files
+
+	/base				game data files
+		/bitmaps		essential textures
+		/ini			game world definitions
+		/maps			3D models (.map format)
+		/materials		material definitions
+		/models			3D models (.ase and .obj format)
+		/particles		particle definitions
+		/textures		game world textures
+
+	/gtkradiant			radiant support files
+
+ + + +
+ + + +
+ +
+ + diff --git a/doc/installation_release.html b/doc/installation_release.html new file mode 100644 index 0000000..39554bf --- /dev/null +++ b/doc/installation_release.html @@ -0,0 +1,138 @@ + + + + + + + + Project::OSiRiON - Installing the latest release + + + +
+ + + + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
+ +
+ + + +

Installing the latest release

+

+ Before you can run the game, you must have working OpenGL libraries. + These are usually installed by the driver package for your videocard. +

+

+ You can find the latest release in the downloads section of the website:
+ http://osirion.org/index.php?page=downloads +

+ + + +

Windows

+

+ Download for 32-bit windows
+ osirion-latest-win32.zip (32-bit)
+ This package should work on most windows systems. +

+ Download for 64-bit windows
+ osirion-latest-win64.zip (64-bit)
+

+

+ Dowload the game data package:
+ osirion-latest-data.zip
+

+

+ Unzip the executables package to an approriate directory. Unzip the game data package + in the new directory. For example, if the game was unzipped to + D:\Osirion then there should be + a directory D:\Osirion\data\base containing the game data. +

+

+ Open the game directory in explorer and click on osirion.exe to start the client. +

+ + + +

Linux

+

+ Requirements:
+ To run the client, tour system will need to have the following packages installed: libSDL, libjpeg, libpng and libz. + To run the dedicated server you need libz and ncurses. These are common packages and most systems will already have them installed. + You do not need to have the bullet libraries installed. +

+

+ Linux download:
+ osirion-latest-linux.tar.bz2 (32- and 64-bit)
+ This package contains the linux version of the client and the server. +

+

+ Extract the package, a new subdirectory will be created. The actual directory name will depend on + the version number. Enter the new subdirectory. +

+
+tar jxvf osirion-latest-linux.tar.bz2
+cd osirion-linux-875
+
+

+ Dowload the game data package:
+ osirion-latest-data.zip
+

+

+ Unzip it: +

+
+unzip ../osirion-latest-data.zip
+
+

+ To run the 32 bit client: +

+
+./osirion.x86
+
+

+ To run the 64 bit client: +

+
+./osirion.x86_64
+
+ + + +
+ + + +
+ + + + + diff --git a/doc/installation_source.html b/doc/installation_source.html new file mode 100644 index 0000000..a8c4be2 --- /dev/null +++ b/doc/installation_source.html @@ -0,0 +1,276 @@ + + + + + + + + Project::OSiRiON - Building from source code + + + +
+ + + + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
+ +
+ +

Building from source code

+ +

+ To build Project::OSiRiON from source code you need a working C++ compiler + and have the necessary libraries and header files installed. + The official binaries are compiled with gcc on linux, and mingw on windows. +

+

+ + + +

Requirements

+ +

+ The following packages are required to build the the dedicated server: +

+ +

+ Additionally, the client requires: +

+
    +
  • libjpeg +
  • libpng +
  • libSDL 1.2 +
  • OpenGL +
  • OpenAL or OpenAL Soft +
  • Ogg Vorbis +
+

+ You will also need gcc, GNU make, automake and libtool. +

+ + + + +

Building on Ubuntu Linux

+ +

+ To build the game on Ubuntu, you can install the required tools and dependencies by running the following commands in a terminal window: +

+
+sudo su -
+apt-get install autoconf automake libtool subversion
+apt-get install libjpeg8 libjpeg8-dev
+apt-get install libpng3 libpng3-dev
+apt-get install libvorbisfile3 libvorbis-dev
+apt-get install libglu1-mesa-dev
+apt-get install libopenal1 libopenal-dev
+apt-get install libsdl1.2debian libsdl1.2-dev
+
+ + + +

Building on Windows

+ +

+ You can build the game on windows using a MinGW/MSYS environment. You can use + the instructions in this document + to create a complete environment, capable of building the Project::OSiRiON source code. + You need to install the base system described in part one, + and the following packages described in part two: + pkg-config, DirectX development files, zlib, SDL, libpng, libjpeg, OpenAL Soft, + libogg, libvorbis, pdcurses and bullet. +

+ + + +

Building the Bullet physics library

+ +

+ The engine uses the Bullet Physics Library + for physics support. You can download the bullet source code here: +

+

+

+ To download and install the library: +

+
+wget http://bullet.googlecode.com/files/bullet-2.79-rev2440.tgz
+tar zxvf bullet-2.79-rev2440.tgz
+cd bullet-2.79
+./autogen.sh
+./configure --prefix=/usr/local --disable-demos
+make
+sudo make install
+cd ..
+
+

+ If you do not want to install bullet in /usr/local, + you can edit the --prefix option here. + Edit the the --with-bullet option + when configuring the Project::OSiRiON source code accordingly. +

+

+ It is recommended you use this specific version of the library, + physics behaviour could be different in other versions. +

+ + + +

Obtaining the source code

+ +

+ Download the source package from the website: +

+ +

+ Unzip the package into a directory of your liking and enter the new directory: +

+
+ wget http://osirion.org/files/osirion-0.2.1-svn1082-src.tar.bz2
+ tar xf osirion-0.2.1-svn1082-src.tar.bz2
+ cd osirion-0.2.1-svn1082-src
+
+ + + +

Configuring the source code

+

+ Enter the new directory and configure the source code: +

+
+./configure --with-bullet=/usr/local --enable-static-bullet
+
+

+ If you do not need the client and want to build the dedicated server only you can pass + the --without-client option to configure: +

+
+./configure --with-bullet=/usr/local --enable-static-bullet --without-client
+
+

+ If configure finds ncurses or pdcurses, the dedicated server will use this library and a have a curses console. + To disable curses detection, pass the --without-curses option to configure. +

+
+./configure --with-bullet=/usr/local --enable-static-bullet --without-client --without-curses
+
+

+ You can use the --help option to get a list of all available options: +

+
+./configure --help
+
+ + + +

Building the binaries

+

+ Compile the source code: +

+
+make
+
+

+ The binaries will be built in the src/ subdirectory of the main distribution. +

+

+ Important: make install is not supported. Results are unpredictable. +

+ + + +

Obtaining the game data

+

+ Download the game data package from the website: +

+ +

+ Unzip the package into the osirion directory. + The game data should be located in the data/ subdirectory of the main distribution. +

+ + + +

Running

+

+ The client and the dedicated server will look for game data in the data subdirectory + of the current working directory. Since the binaries are build in the src you will + have start them with the src/ prefix. +

+

+ To start the client: +

+
+src/osirion
+
+

+ If the client opens a new window and immediatly close it again, it probably could not find + the game data and exited. Check your installation. +

+

+ To start the dedicated server: +

+
+src/osiriond
+
+

+ If you are using windows, the binaries will be called osirion.exe and osiriond.exe. +

+ + +
+ + + +
+ + + + diff --git a/doc/osirion.css b/doc/osirion.css new file mode 100755 index 0000000..e6ce165 --- /dev/null +++ b/doc/osirion.css @@ -0,0 +1,282 @@ +/* + main stylesheet for the Project::OSiRiON website + ingar@telenet.be +*/ + +/* + global defaults +*/ + +body { + background-image: url('images/background.jpg'); + background-color: #000000; + background-repeat: no-repeat; + background-position: center top; + font-family: "DejaVu Sans", "BitStream Vera Sans", "sans-serif"; + text-align: center; + font-size: 12pt; + color: #c0c0c0; + padding: 0; +} + +img { + border: 0px; +} + +a:link +{ + color: #fbff99; + text-decoration: none; +} +a:visited +{ + color: #c6c978; + text-decoration: none; +} +a:hover +{ + text-decoration: underline; +} + +#content p { + padding-left: 8px; +} + +#content dl { + padding-left: 8px; +} + +#content dt { + font-weight: bold; + color: white; +} + +#content dd { + padding-top: 4px; + padding-bottom: 4px; +} + +#content h1 { + color: #ffffff; + font-size: 14pt; + font-weight: bold; +} + +#content h2 { + color: #ffffff; + font-size: 12pt; + font-weight: bold; +} + +#content h3 { + color: #ffffff; + font-size: 12pt; + font-style: italic; +} + +#content table { + padding-left: 8px; +} + +#content td { + padding-right: 16px; + vertical-align: top; +} + +#content hr { + border: 0px; + height: 2px; + background-color: #808080; + color: #808080; +} + +/* from the wiki theme css */ +#content ul { + line-height: 1.5em; + list-style-type: square; + margin: .3em 0 0 1.5em; + padding: 0; + list-style-image: url(images/bullet.png); +} +/* + global div definitions +*/ + +div.floatright { + text-align: center; + vertical-align: middle; + margin-left: auto; + margin-right: 8px; + margin-top: 8px; + margin-bottom: auto; + float: right; +} + +div.newsitem { + color: #ffffff; + font-size: 12pt; + font-weight: bold; +} + +div.newsdate { + color: #ffffff; + font-family: "Courier New", "Courier", "fixed", "monospace"; + font-size: 10pt; +} + +div.newstext { + font-size: 12pt; +} + +table.screenshot { + text-align: center; + font-family: "Courier New", "Courier", "fixed", "monospace"; + margin-left:auto; + margin-right:auto; +} + +td.screenshot { + text-align: center; + font-size: 10pt; +} + +img.screenshot { + vertical-align: top; + padding: 16px; + clear: both; +} + +/* + page structure +*/ + +div#page { + background-color: #000000; + margin-top: 16px; + margin-right: 8%; + margin-left: 8%; + margin-bottom: 32px; + width: 84%; + padding-left: 0px; + padding-right: 0px; + + border: 2px solid #505050; +} + +/* + menu +*/ + +table.osirionmenu { + text-align: center; + margin: 0px; + margin-bottom: 16px; + margin-top: 16px; + padding: 0px; +} + +td.osirionmenu { + text-align: center; + font-size: 10pt; + font-weight: bold; + border-top: 1px solid #808080; + border-bottom: 1px solid #808080; + background-color: #202020; + padding: 8px; + margin: 0px; +} + +a.osirionmenu { + color: #fbff99; +} + +a.osirionmenu:visited { + color: #fbff99; +} + +a.osirioncurrent { + color: #ffffff; +} + +a.osirioncurrent:visited { + color: #ffffff; +} + + +img.osirionmenu { + margin: 0px; + margin-bottom: 12px; +} + + +/* + content +*/ + +div#content { + text-align: left; + margin-bottom: 32px; + padding-left: 16px; + padding-right: 16px; +} + +.fullwidth { + width: 100%; + vertical-align: top; +} + +.halfwidth { + width: 50%; + vertical-align: top; +} + +.quarterwidth { + width: 25%; + vertical-align: top; +} + + +/* + misc style elements +*/ + +.superscript { + color: #ff0000; + vertical-align: top; + font-size: 8pt; +} + +.fixed { + font-family: "Courier New", "Courier", "fixed"; + font-size: 12pt; +} + +#content pre, div.fixed { + border-top: 1px solid #808080; + border-bottom: 1px solid #808080; + border-left: 1px solid #808080; + border-right: 1px solid #808080; + background-color: #202020; + margin-left: 48px; + margin-right: 48px; + margin-top: 8px; + margin-bottom: 8px; + padding: 8px; + font-family: "Courier New", "Courier", "fixed"; + font-size: 12pt; + vertical-align: text-top; +} + +/* + footer +*/ + +div#footer { + text-align: left; + font-size: 8pt; + padding-top: 0px; + padding-left: 16px; + height: 48px; + border-top: 1px solid #808080; + background-color: #202020; +} diff --git a/doc/starsystem_roadmap.html b/doc/starsystem_roadmap.html new file mode 100644 index 0000000..207fd18 --- /dev/null +++ b/doc/starsystem_roadmap.html @@ -0,0 +1,69 @@ + + + + + + + + Project::OSiRiON - Attributions + + + +
+ + + + + + + + + +
+ Project::OSiRiON +
+ Home . + Downloads . + Documentation . + Forum . + Wiki . + Tracker +
+ +
+ + + +

Starsystem roadmap

+ + + +
+ + + +
+ + + +
+ + + +
+ + + + + + -- cgit v1.2.3