# Installation instructions for Bos Wars

## Hardware Requirements

- Processor: A 300 MHz CPU (faster recommended).
  NOTE: Bos Wars 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.
- Memory: 128 MB of RAM (more is better).
- Video Card: Any graphics card that can handle 16 bpp or 32 bpp and 640x480 is supported. (OpenGL is supported, and requires a 32MB Card)
- Sound Card: Recommended. SDL compatible sound cards are supported.

## Software Requirements

- A supported operating system: Linux or Microsoft Windows (98SE, 2000 or XP). Possibly any other Unix/POSIX OS.
- SDL (required).
- libpng (required).
- zlib (required).
- Lua 5.1 or later (required).
- libvorbis (recommended).
- libtheora (recommended).
- libogg (recommended).

On Debian based distributions, you can easily obtain the required dependencies by installing the following packages: libsdl liblua5.1 libtheora libogg libpng12 libsdl1.2 libvorbis libgl1-mesa

## Running Bos Wars

Run the boswars binary in the root boswars direcory. By default, the engine looks in the current working directory, if your data is in a different location you will need to run boswars with '-d /path_to_data'.

# Build instructions for Bos Wars

## Software Requirements for Development

In addition to the software requirements listed above, you will also need:

- Compiler suite: GCC or MINGW or MSVC
- The development files for the libraries listed above.
- toLua++ version 1.0.92 if you plan to change the Lua API
- Scons version 0.98.1 or higher.

On Debian based distributions, you can easily obtain the required dependencies by installing the following packages: liblua5.1-dev libtheora-dev libogg-dev libpng12-dev libsdl1.2-dev libvorbis-dev libx11-dev libgl1-mesa-dev x11proto-core-dev gnulib build-essential. The toLua tool is currently not available as a package from the distributions.

## Building

### Step 1: Download and Extract:

- Download the source code.
- Extract the source boswars-version.tar.gz with 'tar -xzvf boswars-DATE.tar.gz'

Alternatively you can get the latest development version from subversion.

### Step 2: Generate toLua binding

If you changed one of the pkg files in engine/tolua, you must rerun the tolua++ tool in the engine/tolua directory:

    		tolua++ -L stratagus.lua -o tolua.cpp stratagus.pkg

If you did not change the pkg files, you can safely skip this step.

### Step 3: Compile:

- On Posix systems like Linux using scons:
  - Run 'scons'.
- Microsoft Visual Studio 2005:
  - Download the precompiled VC++ libraries and extract them into the root boswars directory. You can also fetch all the libs and compile them manually if you want.
  - Open the workspace file boswars.sln and compile.

(C) Copyright 1998-2008 by The Bos Wars Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.