Gobligine/doc/install.html

179 lines
7.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<!--
---- $Id$
---- (c) Copyright 2002-2003 by Nehal Mistry.
---- This program is free software; you can redistribute it and/or modify
---- it under the terms of the GNU General Public License as published by
---- the Free Software Foundation; version 2 dated June, 1991.
----
---- This program is distributed in the hope that it will be useful,
---- but WITHOUT ANY WARRANTY; without even the implied warranty of
---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
---- GNU General Public License for more details.
----
---- You should have received a copy of the GNU General Public License
---- along with this program; if not, write to the Free Software
---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
---- 02111-1307, USA.
-->
<title>Stratagus Installation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<h1>Installation instructions for Stratagus 1.18</h1><p>
<hr>
<h2>Software Requirements</h2>
<ul>
<li><b>A supported operating system:</b> Win32, Linux, Mac OS X, BSD,
Possibly any other Unix/POSIX OS.<br>
<font color=red>NOTE: some features of Winsock2 (WS2_32.DLL) are used. So even
if you plan to play single player only,
WinNT4.0 users will need Service Pack 3 or higher and Windows 95 users
will need the winsock 2 update from
<a href="http://www.microsoft.com/windows95/downloads/contents/WUAdminTools/S_WUNetworkingTools/W95Sockets2/Default.asp">here</a>.</font><p>
<li><b>A supported graphics library:</b> SDL, svgalib, X11/Xlib
(although X11 is supported, SDL is recommended).<br>
<font color=red>NOTE: remote displays aren't supported.</font><p>
<li><a href="http://www.libpng.org/pub/png/">libpng</a> (required).<p>
<li><a href="http://www.gzip.org/zlib/">zlib</a> (required).<p>
<li><a href="http://www.xiph.org/ogg/vorbis/">libogg/libvorbis</a> (recommended).<p>
<li><a href="http://sources.redhat.com/bzip2/">libbzip2</a> (optional).<p>
<li><a href="http://flac.sourceforge.net/">libFLAC</a> (optional).<p>
<li><a href="http://www.underbit.com/products/mad/">libmad</a> (optional).<p>
<li><a href="http://zziplib.sourceforge.net/">zziplib</a> (optional).<p>
<li>Either the original or expansion W*rcr*ft 2 CD, or the FcMP data.<br>
<font color="red">NOTE: the Battle.net CD edition is not supported.</font><p>
</ul>
<h2>Hardware Requirements</h2>
<ul>
<li><b>Processor:</b> A 133 MHz CPU (faster recommended).<br>
<font color="red">NOTE: Stratagus is believed to be endian and word size safe, so other
architectures like (big endian) PPC or (64bit) Alpha should also
work at least with Linux.</font><p>
<li><b>Memory:</b> 16 MB of RAM (32 MB for mp3/ogg support).<br><p>
<li><b>Video Card:</b> Any graphics card that can handle 8 bpp
and 640x480 is supported.<p>
<li><b>Sound Card:</b> Optional. Windows (for Win32) or SDL
(for unix or Mac OS X) compatible sound cards are supported.<p>
</ul>
<h2>Installation</h2>
Mac OS X users: Extract the "contrib/macosx.tgz" file to the
top-level directory and read "Read Me.rtf".<p>
Binary users may skip to step 3.<p>
<ul>
<li><b>Step 1, Download and Extract:</b><p>
<ul>
<li>Download the source from
<a href="http://www.nongnu.org/stratagus/download.html">here</a>.<br>
<font color="red">NOTE: both the tar.gz and zip files are the same,
we provide both formats for convenience.</font><p>
<li>Unpack the source stratagus-DATE.tar.gz with
<pre> tar -zxvf stratagus-DATE.tar.gz</pre>
</ul>
<li><b>Step 2, Compile:</b><p>
<ul>
<li><b>GCC/Mingw users:</b> run the 'setup' script and answer
the questions instructions to create the Makefile.
When complete, type 'make depend && make' to compile, and it
should compile a working 'stratagus' (or 'stratagus.exe' for win32)
binary. To see all options of setup, type 'setup --help'.<p>
<li><b>MSVC users:</b>
<ul>
<li>Extract the VC++ project and workspace files from stratagus\contrib\msvc.zip
into the root stratagus directory.</li>
<li><a href="http://savannah.nongnu.org/files/?group=stratagus">
Download</a> the VC++ libraries and extract them into the root
stratagus directory.
<li>Copy stratagus\contrib\stratagus.ico to stratagus\src.
<li>You should now be able to compile stratagus by opening
the stratagus.dsw file.<p>
</ul>
<li><b>Windows CE(tm) / PocketPc(tm)</b>
<ul>
<li>You need eMbedded Visual C++ 3.0. You can download or order it
<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnppc2k/html/ppc_alc.asp">here</a>.
CE support for Visual C++ or Visual Studio isn't supported yet.
If you know how to compile with this, please inform us.
<li>You also need the
<a href="http://savannah.nongnu.org/files/?group=stratagus">emVC++ project</a> and
<a href="http://savannah.nongnu.org/files/?group=stratagus">emVC++ workbench</a> for Stratagus.<p>
</ul>
</ul>
<li><b>Step 3, Extract data:</b><p>
Now that you have a working engine, you need some media data before
you can actually play the game. There are two options, use the data
from the W*rcr*ft 2 CD, or use FcMP.<p>
<ul>
<li><b>Using W*rcr*ft 2 data:</b><p>
For Win32, run:
<pre> build.bat DIR</pre>
where DIR is the directory to your CD or your
installation, (eg, 'e:' or 'c:\war2').<p>
For Unix, run:
<pre> build.sh -p DIR</pre>
where DIR is the directory to your mounted CD or your
installation, (eg, '/cdrom/' or '/mnt/win/war2').<p>
<font color="red">NOTE: You will need to execute this
script from within your root stratagus directory or
you will run into problems. It will take some
time to extract everything.</font><p>
<li><b>Using FcMP data:</b><p>
Download FcMP from the download page and extract it to
the stratagus root directory (where the stratagus
binary exists).<br>
<font color="red">NOTE if you extract to a different directory,
you will need to specify the directory by passing '-d DIR' flag
when you run the stratagus binary, by default the binary
looks for 'data' in the current directory.</font><p>
If you are using the CVS engine, you may need to checkout
the 'fcmp' module from CVS. Then edit the locations at the top
of 'buildfcmp.sh' and run it, this will create a working
FcMP dir called: 'data.fcmp' , you may then rename this to
'$FCDIR/data' where $FCDIR is the directory where the stratagus
binary exists, or run stratagus with the '-d' option.<p>
</ul>
<li><b>Step 4, Run:</b><p>
You may now go into the toplevel stratagus dir and run the binary. Remember,
if the data dir is not './data', you will need to run stratagus with
the '-d' option.<p>
</ul>
<hr>
(C) Copyright 1998-2003 by The <a href="http://stratagus.sf.net">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>