Debian Codegraph @

doc/install.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <!--
5
6 ---- (c) Copyright 2002-2013 by Nehal Mistry, Francois Beerten.
7
8 ---- This program is free software; you can redistribute it and/or modify
9 ---- it under the terms of the GNU General Public License as published by
10 ---- the Free Software Foundation; only version 2 of the License.
11 ----
12 ---- This program is distributed in the hope that it will be useful,
13 ---- but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ---- GNU General Public License for more details.
16 ----
17 ---- You should have received a copy of the GNU General Public License
18 ---- along with this program; if not, write to the Free Software
19 ---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 ---- 02111-1307, USA.
21 -->
22 <title>Bos Wars Installation</title>
23 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
24 </head>
25
26 <body>
27
28 <h1>Installation instructions for Bos Wars</h1>
29
30 <h2>Hardware Requirements</h2>
31 <ul>
32 <li><b>Processor:</b> A 300 MHz CPU (faster recommended).<br>
33 NOTE: Bos Wars is believed to be endian and word size safe, so other
34 architectures like (big endian) PPC or (64bit) Alpha should also
35 work, at least with Linux.</li>
36
37 <li><b>Memory:</b> 128 MB of RAM (more is better).</li>
38
39 <li><b>Video Card:</b> Any graphics card that can handle 16 bpp or 32 bpp
40 and 640x480 is supported. (OpenGL is supported, and requires a 32MB Card)</li>
41
42 <li><b>Sound Card:</b> Recommended. SDL compatible sound cards are supported.</li>
43 </ul>
44
45 <h2>Software Requirements</h2>
46 <ul>
47 <li><b>A supported operating system:</b> Linux or Microsoft Windows (2000 or higher).
48 Possibly any other Unix/POSIX OS.
49 </li>
50
51 <li><a href="http://www.libsdl.org/index.php">SDL</a> (required).</li>
52 <li><a href="http://www.libpng.org/pub/png/">libpng</a> (required).</li>
53 <li><a href="http://www.gzip.org/zlib/">zlib</a> (required).</li>
54 <li><a href="http://www.lua.org/">Lua 5.1</a> (required).</li>
55 <li><a href="http://www.xiph.org/downloads/">libvorbis</a> (recommended).</li>
56 <li><a href="http://www.theora.org/">libtheora</a> (recommended).</li>
57 <li><a href="http://www.xiph.org/downloads/">libogg</a> (recommended).</li>
58 </ul>
59
60 <p>
61 On Debian based distributions, you can easily obtain the required dependencies by installing the following packages:
62 libsdl liblua5.1 libtheora libogg libpng12 libsdl1.2 libvorbis libgl1-mesa
63 </p>
64
65 <p>
66 On OpenSuse you can obtain the required dependencies by installing with the following command line:<pre>
67 zypper in libSDL-devel lua51-devel libogg-devel
68 </pre>
69 </p>
70
71 <h2>Running Bos Wars</h2>
72 Run the boswars binary in the root boswars direcory.
73 By default, the engine looks in the current working directory,
74 if your data is in a different location you
75 will need to run boswars with <i>'-d /path_to_data'</i>.<p>
76
77 <h1>Build instructions for Bos Wars</h1>
78
79 <h2>Software Requirements for Development</h2>
80 In addition to the software requirements listed above, you will also need:
81 <ul>
82 <li>Compiler suite: GCC or MINGW or MSVC</li>
83 <li>The development files for the libraries listed above.</li>
84 <li><a href="http://www.codenix.com/~tolua/">toLua++</a> version 1.0.93 if you plan to change the Lua API</li>
85 </ul>
86
87 <p>
88 On Debian based distributions, you can easily obtain the required dependencies by installing
89 the following packages: <i>liblua5.1-dev libtolua++5.1-dev libtheora-dev libogg-dev
90 libpng12-dev libsdl1.2-dev libvorbis-dev libx11-dev libgl1-mesa-dev
91 x11proto-core-dev build-essential.</i>
92 </p>
93
94 <p>
95 On Fedora 13, these packages should help: <i>lua-devel
96 tolua++-devel libtheora-devel libogg-devel libpng-devel SDL-devel
97 libvorbis-devel libX11-devel mesa-libGL-devel</i>.
98 </p>
99
100 <h2>Building</h2>
101
102 <h3>Step 1: Download and Extract:</h3>
103 <ul>
104 <li><a href="http://www.boswars.org/download.shtml">
105 Download</a> the source code.</li>
106 <li>Extract the source boswars-version.tar.gz with
107 'tar -xzvf boswars-DATE.tar.gz'</li>
108 </ul>
109 Alternatively you can get the latest <a href="http://www.boswars.org/development.shtml">
110 development version</a> from subversion.
111
112 <h3>Step 2: Generate toLua binding</h3>
113 If you changed one of the pkg files in engine/tolua, you must rerun
114 the tolua++ tool in the engine/tolua directory:
115 <pre>
116 tolua++ -L stratagus.lua -o tolua.cpp stratagus.pkg
117 </pre>
118 If you did not change the pkg files, you can safely skip this step.
119
120 <h3>Step 3: Compile:</h3>
121 <ul>
122 <li><b>On Posix systems like Linux:</b>
123 <ul>
124 <li>Run 'make.py' for the release build.</li>
125 <li>Run 'make.py debug' for the debug build.</li>
126 </ul>
127 The build results are stored in the <i>fbuild/</i> directory.
128 </li>
129 <li><b>Microsoft Visual Studio 2005:</b>
130 <ul>
131 <li><a href="http://www.boswars.org/dev/msvc-libs.zip">
132 Download</a> the precompiled VC++ libraries and extract them into the root
133 boswars directory. You can also fetch all the libs and
134 compile them manually if you want.</li>
135 <li>Open the workspace file boswars.sln and compile.</li>
136 </ul>
137 </li>
138 </ul>
139
140 <br>
141
142 <hr>
143 (C) Copyright 1998-2013 by The <a href="http://boswars.org">Bos Wars</a> Project
144 under the <a href="gpl.html">GNU General Public License</a>.<br>
145 All trademarks and copyrights on this page are owned by their respective owners.<br>
146 </body>
147 </html>