From 5b6e0a07149b148b0efa327435345f5860def895 Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Sat, 1 Dec 2012 22:23:48 +0000 Subject: Documentation update. --- doc/installation_develop.html | 199 ++++++++++++++++++++++++++---------------- 1 file changed, 126 insertions(+), 73 deletions(-) (limited to 'doc/installation_develop.html') diff --git a/doc/installation_develop.html b/doc/installation_develop.html index de25f66..70de3a5 100644 --- a/doc/installation_develop.html +++ b/doc/installation_develop.html @@ -20,80 +20,94 @@ - Home . - Downloads . - Documentation . - Forum . - Wiki . - Tracker + News . + Documentation . + Screenshots . + Downloads . + Forum . + Wiki . + Tracker -
+
-

Building the development version

+ -

+

+ +

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

+
-

+

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:

-
-

Obtaining the game data

-

+

+ +

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: -

+

+ +
+ -

Configuring the source code

-

+

+ +

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: @@ -120,77 +140,93 @@ 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

-

+

+ +

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

-

+

+ +

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

-

+

+ +

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:

@@ -200,7 +236,7 @@ cd ..
svn update
-

+

Update the game data:

@@ -208,7 +244,7 @@ svn update
cd ..
-

+

Rebuild the binaries:

@@ -218,39 +254,51 @@ make -j2
cd ..
+

+ +
-

Source data (optional)

-

+

+ +

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)

-

+

+ +

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: -

+ -

Organization of the distribution

+
+ +

Organization of the distribution

 /doc 					Documentation
@@ -324,11 +376,13 @@
 	/gtkradiant			radiant support files
 
+
+ - + - - + + \ No newline at end of file -- cgit v1.2.3