alienari / bitfighter

Automatically exported from code.google.com/p/bitfighter
Other
0 stars 0 forks source link

Bitfighter README

Many resources are found at:

http://bitfighter.org/wiki/index.php?title=Main_Page

Most is still valid... ;-)

1) DEPENDENCIES

Bitfighter has several common, open source dependencies:

2) COMPILING

The CMake build system is used for compiling on Windows and Linux. You will need to download and install CMake for these platforms.

On OSX, there is an Xcode project available.

a) Linux

You will need the development headers of the above dependencies installed as well as the following software to compile:

3) INSTALLATION AND PACKAGING

a) Linux

There is no 'make install'.

After running 'make', the bitfighter executable is put into the directory 'exe/'. Copy everything from the 'resources/' directory into the 'exe/' directory, keeping the folders intact (like sfx, scripts, etc.)

Bitfighter can now be run from the 'exe/' folder.

For distribution packaging, Bitfighter is built for a few distributions using the Open Build Service at:

https://build.opensuse.org/package/show?package=bitfighter&project=games

b) Windows

An NSIS build script is found in the following directory:

build/windows/installer

This will build a self-extracting installer for Bitfighter. You will need to build in 'Release' mode as the installer is looking for an executable named 'bitfighter.exe'

c) MacOS X

Run the target called "Create Bitfighter Game Release" to build a distributable DMG.

4) CRASHES & PROBLEMS

If you are building off of 'tip' then expect crashes and problems. Please don't report them via Google Code; instead join the IRC channel

bitfighter on freenode to ask a developer about it - we probably are

already aware.

If you are building off of a release version, please make sure you can consistently reproduce the problem, then post it, with the steps to reproduce at:

http://code.google.com/p/bitfighter/issues/list

For feature requests or similar, please post in the forums at:

http://bitfighter.org/forums/viewforum.php?f=4

5) COMPATIBILITY

TODO

6) OTHER NOTES

Come join us in the forums at:

http://bitfighter.org/forums/

Enjoy Bitfighter!