1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="style.css">
<TITLE>The Osirion Project - Installation</TITLE>
</head>
<body>
<h1>
The Osirion Project - Installation
</h1>
<p>
These are the installation instructions for the Osirion Project.
There are two ways to install the program and the game data. You can
either download a precompiled package from the website, or you
can obtain the source code and compile it yourself.
<ul>
<li><a href="#precompiled">Downloading a precompiled package</a>
<li><a href="#building_from_source">Building from source code</a>
<li><a href="#gtkradiant">GtkRadiant 1.5.0 support files (optional)</a>
<li><a href="#source_data">Source data (optional)</a>
</ul>
<h2 id="precompiled">
Downloading a precompiled package
</h2>
<p>
You can find the latest version in the download section of the website:<br>
<a href="http://ingar.satgnu.net/osirion/files">http://ingar.satgnu.net/osirion/files</a>
<h3>
Windows
</h3>
<p>
Download the windows package:<br>
<a href="http://ingar.satgnu.net/osirion/files/osirion-latest-win32.zip">osirion-latest-win32.zip</a><br>
This packages contains the win32 version of the server, the client and the game data.
<p>
Unzip the package to an approriate directory. Open the directory in explorer and
click on <i>osirion.exe</i> to start the client.
<h3>
Linux
</h3>
<p>
Download the linux package:<br>
<a href="http://ingar.satgnu.net/osirion/files/osirion-latest-linux.zip">osirion-latest-linux.zip</a><br>
This packages contains the linux x86 and x86_64 version of the server, the client and the game data.
<p>
Extract the package, a new subdirectory will be created. The actual directory name will depend on
the version number. Enter the new subdirectory.
<pre>
tar jxvf osirion-latest.tar.bz2
cd osirion-0.1_258-linux
</pre>
<p>
To run the 32bit client:
<pre>
./osirion.x86
</pre>
<p>
To run the 64bit client:
<pre>
./osirion.x86_64
</pre>
<h2 id="building_from_source">
Building from source code
</h2>
<h3>
Requirements
</h3>
<p>
To build The Osirion Project from source code you will need to have
the following libraries and their header files installed on your system.
<p>
To build the client or the dedicated server:
<table>
<tr><td>zlib</td><td></td></tr>
</table>
<p>
To build the client:
<table>
<tr><td>SDL</td><td>version 1.2 or newer</td></tr>
<tr><td>OpenGL</td><td>version 1.1 or newer</td></tr>
<tr><td>OpenAL</td><td>version 1.1 or newer</td></tr>
</table>
<p>
You will also need a recent version of gcc, GNU make, automake and libtool.
<p>
In theory, the source should compile on any POSIX-compatible platform
supported by SDL, reports for other platforms (working or not)
are welcome. I have succesfully compiled it myself on the following platforms:
<table>
<tr><td>linux-x86_64</td><td>gcc 4.1.2</td></tr>
<tr><td>linux-i686</td><td>gcc 4.1.2</td></tr>
<tr><td>mingw32 </td><td>gcc 4.2.2</td></tr>
</table>
<h3>
Obtaining the source code
</h3>
<p>
You can download the osirion source code from the osirion subversion repository:<br>
<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion</a>
<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.
<pre>
svn co svn://intranifty.no-ip.org/osirion
</pre>
<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>
You can also get the source package from the website:<br>
<a href="http://ingar.satgnu.net/osirion/files/osirion-latest-src.tar.bz2">osirion-latest-src.tar.bz2</a>
<h3>
Compiling the source code
</h3>
<p>
Enter the new directory and configure the source code:
<pre>
cd osirion
autoreconf -fi
./configure
</pre>
<p>
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>:
<pre>
./configure --without-client
</pre>
<p>
If <i>configure</i> finds the ncurses library, the server will be build
with an ncurses console. To disable ncurses detection, pass the
<i>--without-ncurses</i> option to <i>configure</i>.
<p>
<b>Important</b>: <i>make install</i> is not supported. Results are unpredictable.
<p>
Compile the source code:
<pre>
make
</pre>
<p>
The binaries will be build in the <i>src</i> subdirectory of the main distribution.
<h3>
Obtaining the game data
</h3>
<p>
The game data should be located in the <i>data</i> subdirectory of the main distribution.
The data is not included with the source distribution. You will have to copy it from
a binary package or download it from the osirion-data subversion repository:<br>
<a href="svn://intranifty.no-ip.org/osirion">svn://intranifty.no-ip.org/osirion-data</a>
<p>
Run the following command from within the main distribution directory to download
the game data into the <i>data</i> subdirectory:
<pre>
svn checkout svn://intranifty.no-ip.org/osirion-data data
</pre>
</body>
<h3>
Executing
</h3>
<p>
The client and the dedicated server look for the game data in the <i>data</i> subdirectory
of the current working directory. Since the binaries are build in the <i>src</i> you will
have to copy them with the <i>src/</i> prefix.
<p>
To start the client
<pre>
src/osirion
</pre>
<p>
To start the dedicated server
<pre>
src/osiriond
</pre>
<p>
Of you are using windows, the binaries will be called <i>osirion.exe</i> and <i>osiriond.exe</i>.
<h3>
Updating
</h3>
<p>
If you downloaded and compiled the game and the game data fomr 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.
<p>
Update the source code:
<pre>
cd osirion
make distclean
svn update
</pre>
<p>
Update the game data:
<pre>
cd data
svn update
cd ..
</pre>
<p>
Rebuild the binaries:
<pre>
autoreconf
./configure
make
</pre>
<h2 id="gtkradiant">
GtkRadiant 1.5.0 support files (optional)
</h2>
<p>
You only need to install these files if you want to create models
with gtkradiant. Note that these files where made for
gtkradiant 1.5.0, they probably won't work with other versions.
You can find precompiled gtkradiant 1.5.0 binaries for linux on my
gtkradiant page:<br>
<a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a>
<p>
These instructions assume gtkradiant is installed in the directory
<i>/usr/local/games/gtkradiant-1.5.0</i>. If it is installed in a different
directory on your system, edit these instructions accordingly.
<p>
Copy the support files to the gtkradiant folder:
<pre>
cd data
cd gtkradiant
cp -vr * /usr/local/games/gtkradiant-1.5.0
</pre>
<p>
Open the file <i>/usr/local/games/gtkradiant-1.5.0/games/osirion.game</i> in
your favourite editor. Look for a line that begins with:
<pre>
enginepath_linux="
</pre>
<p>
Make sure it points to your osirion data directory. For example,
if you checked out the source code in <i>/home/user/osirion</i>,
then the data will be in <i>/home/user/osirion/data</i> and
the line should look like this:
<pre>
enginepath_linux="/home/user/games/osirion/data"
</pre>
<p>
Save the changes.
<h2 id="source_data">
Source data (optional)
</h2>
<p>
The .xcf and .svg source files used to create the game data
can also be downloaded. Note that you do not need these files
to play the game or to create .map models. You only have to
download them them if you want to create new game graphics.
<p>
To download the source data from the subversion repository:
<pre>
svn checkout svn://intranifty.no-ip.org/osirion-data-src data-src
</pre>
<h2 id="organization">
Organization of the distribution
</h2>
<pre>
/doc Documentation
index.html Documentation content
installation.html Installation instructions (this file)
license.html Copyright license
/src C++ source code
/math mathematical classes and functions
/sys low-level system functions
/filesystem filesystem library
/auxiliary auxiliary functions
/core game-independent core library
/game game-specific functions
/server osiriond dedicated server
/render render library
/audio audio library
/client osirion client
/data Data files
/base game data files
/bitmaps essential bitmaps
/ini game world description files
/maps game world models
/scripts gtkradiant shader files
/textures game world textures
/gtkradiant gtkradiant support files
</pre>
</body>
</html>
|
