Difference between revisions of "Building Bitfighter"

From Bitfighter
(Source Code)
(Windows)
(46 intermediate revisions by 4 users not shown)
Line 2: Line 2:
  
 
This page is dedicated to getting Bitfighter to build on your system of choice.  Some useful links:
 
This page is dedicated to getting Bitfighter to build on your system of choice.  Some useful links:
*[http://code.google.com/p/bitfighter/source/list Changelog]
+
*[https://github.com/bitfighter/bitfighter Browse source]
*[http://code.google.com/p/bitfighter/source/browse Browse source]
+
*[https://github.com/bitfighter/bitfighter/commits/master Changelog]
 +
 
 +
Also, please see the README.txt included in the source.
  
 
===Source Code===
 
===Source Code===
Bitfighter now uses Mercurial (hg) to obtain the source code.  Here is some useful Mercurial information:
+
Bitfighter has migrated to Git to manage the source code, on the GitHub website.  Here is some useful Git information:
*[[Contribute_using_Mercurial]]
+
*[https://try.github.io Intro to Git]
 +
*[https://guides.github.com/activities/hello-world/ Simple GitHub usage]
 +
*[https://guides.github.com/ Other GitHub guides]
  
 
The Bitfighter code can be found here:
 
The Bitfighter code can be found here:
*[http://code.google.com/p/bitfighter/source/checkout Source Checkout]
+
*[https://github.com/bitfighter/bitfighter Source Checkout (Click 'Clone or download')]
  
At the least, you can just copy and paste this into your terminal browser, after installing Mercurial:
+
If you have Git installed, you can easily check out a copy of the source code by running this command in a terminal in a folder of your chosing:
 +
git clone https://github.com/bitfighter/bitfighter.git bitfighter
  
hg clone https://code.google.com/p/bitfighter/
+
After checking out the code, if you don't want to compile the current development version, you can update to a specific released version. To see a list of released versions, type in:
 +
git tag
  
If you don't want to compile the current development version, update to a specific released version after cloning:
+
We recommend to always chose the latest release as the build instructions for older releases will be different that what is shown here on this wiki page.  Update to a release that you want:
 
+
  git checkout bitfighter-019f
  hg up bitfighter-018
+
  
 
===Windows===
 
===Windows===
Bitfighter can be built with MS Visual C++ 2010 Express Edition, a free download from Microsoft, and a much-improved IDE over previous versions.
+
 
 +
We have migrated to [CMake http://www.cmake.org/] for Windows builds in version 019 and later (and currently in the most recent development code). Note that we recommend using Visual Studio 2017 (though other versions will work) for the building environment on Windows.  To build:
 +
 
 +
# Install CMake from http://www.cmake.org/
 +
# In a terminal, change to the 'build' directory in the bitfighter source code tree.
 +
# Run the following command (A list of CMake 'generators' for different build environments can be found [here http://www.cmake.org/cmake/help/v3.8/manual/cmake-generators.7.html#manual:cmake-generators(7)]): 
 +
#* cmake -G "Visual Studio 15 2017 Win64" ..  # Substitute a different generator if you like
 +
#** To target Windows XP, add the proper toolset to the CMake command: '''cmake -G "Visual Studio 15 2017" -T "v141_xp" ..'''
 +
# Open the resulting Visual Studio solution file
 +
# To run and debug, you may need to right click "Bitfighter" in solution explorer, and choose "Set as StartUp Project"  (the active project is shown in bold text)
  
 
===Linux===
 
===Linux===
 +
 +
====Detailed Instructions====
 
Bitfighter should build on any major flavor of Linux.  It has been tested and is known to work on Ubuntu, LinuxMint, Centos, Fedora, Debian, Mandriva and openSUSE. If you can not get it to work, you can try running it in wine: [http://www.winehq.org/]   
 
Bitfighter should build on any major flavor of Linux.  It has been tested and is known to work on Ubuntu, LinuxMint, Centos, Fedora, Debian, Mandriva and openSUSE. If you can not get it to work, you can try running it in wine: [http://www.winehq.org/]   
  
The Bitfighter client depends on SDL, libpng, libvorbis, and libspeex development libraries.  These are not needed to build the dedicated server.
+
Bitfighter has several common, open source dependencies, which can be easily installed:
  
Bitfighter must be compiled with the gcc/g++ compiler, which is usually not installed by default in most Linux distributions.  Mercurial is required to obtain the source code.
+
* sudo apt-get install cmake libphysfs-dev libsdl2-dev libopenal-dev libvorbis-dev libmodplug-dev libspeex-dev
  
 +
You must install these '''and their development headers''' using your distribution's preferred method.  The development headers for these libraries have similar names with a suffix, for example:
 +
* libvorbis-dev or vorbis-devel
  
'''Building full game client on a clean install of Ubuntu'''
 
These instructions should work on both 32 and 64 bit platforms.
 
<source lang="bash">
 
sudo apt-get update
 
sudo apt-get install mercurial g++ libreadline6-dev libncurses5-dev
 
sudo apt-get install libsdl1.2-dev libopenal-dev
 
sudo apt-get install libspeex-dev libvorbis-dev libpng-dev libmodplug-dev
 
  
# Get the source code
+
You will also need the following to compile:
hg clone https://code.google.com/p/bitfighter/
+
* cmake
 +
* make
 +
* gcc / g++
  
# Update to the tag/revision you want
+
Once your dependencies are installed, you can build bitfighter with these steps:
cd bitfighter
+
# cd build
hg up bitfighter-018
+
# cmake ..
 +
# make
  
# Build the game -- the standard options should work
+
If you want to build a dedicated server (with no GUI), replace the 'make' step above with:
make
+
# make bitfighterd
  
# Copy required files into exe folder:
+
Next, you'll need to copy the resources to where the executable was built:
cd exe
+
# cd ../exe
cp -r ../resource/* .
+
# cp -r ../resource/* .
 +
 
 +
And if you wish to run in standalone mode, create a standalone.txt file in the 'exe' folder to trigger this mode:
 +
# touch standalone.txt
 +
 
 +
====Centos Dedicated Server Instructions (Easy!)====
 +
'''Building a dedicated server on a typical clean Centos 5 or 6 virtual server instance'''
 +
<nowiki>
  
</source>
+
# We recommend that you install and run a dedicated bitfighter server with a special
Once successfully built, you shouldn't need to built it again unless you are changing version. To run Bitfighter, browse to bitfighter/exe and start bitfighter from there, or in a command, do the following:
+
# user account used only for this purpose, that does not have root access.
<source lang="bash">
+
cd bitfighter/exe
+
./bitfighter
+
</source>
+
  
 +
# First, create a bitfighter user; you can skip this step if you want to use an
 +
# existing account
 +
useradd bitfighter      # Create the account
 +
passwd bitfighter        # Set the password.  Pick a good one!
  
'''Building a dedicated server on a typical clean Centos 5 virtual server instance'''
+
# Do the following as a user that has sudo privileges
<source lang="bash">
+
yum update    # system should be up to date
+
  
# The following sets up the EPEL repository for extra packages (needed for mercurial)
+
sudo yum update    # system should be up to date
 +
 
 +
# The following sets up the EPEL repository for extra packages (needed for newer git)
 
# Choose one based on your server architecture
 
# Choose one based on your server architecture
 
# 32 bit:
 
# 32 bit:
rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
+
sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
 
# 64 bit:
 
# 64 bit:
rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm
+
sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm
  
yum install mercurial
+
sudo yum install git gcc gcc-c++ zip ncurses-devel readline-devel patch cmake screen
yum install gcc
+
yum install gcc-c++
+
yum install zip       # For archiving purposes
+
  
yum install ncurses-devel    # Needed on some servers
 
yum install readline-devel    # Needed on some servers
 
  
 +
# Do the following as the bitfighter user
 +
su bitfighter
 +
cd ~
  
# Get the source code
+
# Get the source code -- this will create a folder called bitfighter in your
hg clone https://code.google.com/p/bitfighter/
+
# current location.  This may take a couple of minutes!
 +
git clone https://github.com/bitfighter/bitfighter.git bitfighter
  
 
# Update to the tag/revision you want
 
# Update to the tag/revision you want
 
cd bitfighter
 
cd bitfighter
hg up bitfighter-018
+
git checkout bitfighter-019f
  
 
# Build the dedicated server (called bitfighterd)
 
# Build the dedicated server (called bitfighterd)
make dedicated
+
cd build
 +
cmake ..          # Creates a Makefile for the next step; may emit warnings
 +
make bitfighterd
  
# Copy required files into exe folder:
+
# Copy required files into exe folder (found at the root of the code tree):
cd exe
+
cd ../exe
 
cp -r ../resource/* .
 
cp -r ../resource/* .
</source>
+
touch standalone.txt  # Tell bitfighterd to run in portable mode (don't skip this!!)
 +
</nowiki>
  
 
===OS X===
 
===OS X===
Bitfighter builds on OS X using Xcode 3.1 or greater.  You must have developer tools installed to build bitfighter on OS X!
 
(You can get them [http://developer.apple.com/technologies/tools/xcode.html from Apple].)
 
 
'''Note:''' If you don't wish to download Xcode with iOS integration (saves about 2GB off of downloading) you can get older versions on the [http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wo/5.1.17.2.1.3.3.1.0.1.1.0.3.3.3.3.1 developer downloads page].  Xcode 3.2.2 is the latest without iOS built in.
 
 
====Getting the source====
 
 
You can grab the source the typical command line way below, or you can grab your own copy of [http://jasonfharris.com/machg/ Mac Hg], and manager your source with a GUI
 
 
Grabbing the source is just like any other terminal, simply navigate here:
 
Applications > Utilities > Terminal and paste in the HG command + url + foldername,[http://bitfighter.org/wiki/index.php?title=Building_Bitfighter#Source_Code which can be found here]
 
 
Also like normal, you can find this download in your home folder
 
 
====Building Bitfighter====
 
 
#Navigate through bitfighter > build > osx > Xcode > Bitfighter.xcodeproj
 
#Open Bitfighter.xcodeproj with Xcode.
 
#Click 'Build and Go' at the top.  Bitfighter should compile successfully and attempt to launch.
 
#*'''Note:''' building from trunk may NOT complete successfully and/or the launch may fail.
 
#Your new build will be found at Bitfighter > build > osx > build > Debug / release > *
 
 
=====Quickbuild=====
 
 
If your lazy like me, you can do this a quicker way.
 
Right after you download the source, stay in the terminal window
 
Open a new window, and click
 
 
<Code>
 
cd (filename you chose when you downloaded the game)
 
 
cd zap
 
 
xcodebuild
 
  
</Code>
+
We have migrated to CMake for OS X as well.  You must have the following software installed (in addition to the bitfighter source code):
 +
# CMake
 +
# XCode (includes development libraries and compilers)
  
It will start punching in alot of code in the window. just let this sit for a while and soon it will be built. The product will be stored in the same place you stored before
+
To build:
 +
# Open a terminal
 +
# Set up the compatibility environment by running:
 +
#* export MACOSX_DEPLOYMENT_TARGET=10.6
 +
# change into the 'build' directory within the Bitfighter source
 +
# Run CMake:
 +
#* cmake ..
 +
# Build with 'make':
 +
#* make Bitfighter
 +
# The .app will be built in the 'exe' sub-folder of the main bitfighter source directory
  
 +
Building with XCode is supported with CMake, but it is untested with Bitfighter.  To do so:
 +
# Open a terminal
 +
# Set up the compatibility environment by running:
 +
#* export MACOSX_DEPLOYMENT_TARGET=10.6
 +
# change into the 'build' directory within the Bitfighter source
 +
# Run CMake using the Xcode generator:
 +
#* cmake -G Xcode ..
 +
# This will create an Xcode project within the 'build' directory that you can open
  
Now you have successfully built your own Bitfighter game.
 
  
 
====Notes====
 
====Notes====
# The bitfighter project also builds the tnl and libtomcrypt frameworks automatically before compiling the bitfighter source itself.
+
# Bitfighter user settings are found in $HOME/Library/Application Support/Bitfighter
# The following frameworks are added automatically to the bundle:
+
#*libtomcrypt.framework
+
#*tnl.framework
+
#*Openal-Soft.framework
+
#*FreeALUT.framework
+
# Upon first launch of your newly created game, an alias is created that points to your user's bitfighter data directory.  It is located at Documents > bitfighter_settings.  The data directory contains bitfighter settings as well as the levels, scripts, and screenshots save locations.
+

Revision as of 01:21, 18 November 2018

This page is dedicated to getting Bitfighter to build on your system of choice. Some useful links:

Also, please see the README.txt included in the source.

Source Code

Bitfighter has migrated to Git to manage the source code, on the GitHub website. Here is some useful Git information:

The Bitfighter code can be found here:

If you have Git installed, you can easily check out a copy of the source code by running this command in a terminal in a folder of your chosing:

git clone https://github.com/bitfighter/bitfighter.git bitfighter

After checking out the code, if you don't want to compile the current development version, you can update to a specific released version. To see a list of released versions, type in:

git tag

We recommend to always chose the latest release as the build instructions for older releases will be different that what is shown here on this wiki page. Update to a release that you want:

git checkout bitfighter-019f

Windows

We have migrated to [CMake http://www.cmake.org/] for Windows builds in version 019 and later (and currently in the most recent development code). Note that we recommend using Visual Studio 2017 (though other versions will work) for the building environment on Windows. To build:

  1. Install CMake from http://www.cmake.org/
  2. In a terminal, change to the 'build' directory in the bitfighter source code tree.
  3. Run the following command (A list of CMake 'generators' for different build environments can be found [here http://www.cmake.org/cmake/help/v3.8/manual/cmake-generators.7.html#manual:cmake-generators(7)]):
    • cmake -G "Visual Studio 15 2017 Win64" .. # Substitute a different generator if you like
      • To target Windows XP, add the proper toolset to the CMake command: cmake -G "Visual Studio 15 2017" -T "v141_xp" ..
  4. Open the resulting Visual Studio solution file
  5. To run and debug, you may need to right click "Bitfighter" in solution explorer, and choose "Set as StartUp Project" (the active project is shown in bold text)

Linux

Detailed Instructions

Bitfighter should build on any major flavor of Linux. It has been tested and is known to work on Ubuntu, LinuxMint, Centos, Fedora, Debian, Mandriva and openSUSE. If you can not get it to work, you can try running it in wine: [1]

Bitfighter has several common, open source dependencies, which can be easily installed:

  • sudo apt-get install cmake libphysfs-dev libsdl2-dev libopenal-dev libvorbis-dev libmodplug-dev libspeex-dev

You must install these and their development headers using your distribution's preferred method. The development headers for these libraries have similar names with a suffix, for example:

  • libvorbis-dev or vorbis-devel


You will also need the following to compile:

  • cmake
  • make
  • gcc / g++

Once your dependencies are installed, you can build bitfighter with these steps:

  1. cd build
  2. cmake ..
  3. make

If you want to build a dedicated server (with no GUI), replace the 'make' step above with:

  1. make bitfighterd

Next, you'll need to copy the resources to where the executable was built:

  1. cd ../exe
  2. cp -r ../resource/* .

And if you wish to run in standalone mode, create a standalone.txt file in the 'exe' folder to trigger this mode:

  1. touch standalone.txt

Centos Dedicated Server Instructions (Easy!)

Building a dedicated server on a typical clean Centos 5 or 6 virtual server instance


# We recommend that you install and run a dedicated bitfighter server with a special 
# user account used only for this purpose, that does not have root access.

# First, create a bitfighter user; you can skip this step if you want to use an 
# existing account
useradd bitfighter       # Create the account
passwd bitfighter        # Set the password.  Pick a good one!

# Do the following as a user that has sudo privileges

sudo yum update    # system should be up to date

# The following sets up the EPEL repository for extra packages (needed for newer git)
# Choose one based on your server architecture
# 32 bit:
sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
# 64 bit:
sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm

sudo yum install git gcc gcc-c++ zip ncurses-devel readline-devel patch cmake screen


# Do the following as the bitfighter user
su bitfighter
cd ~

# Get the source code -- this will create a folder called bitfighter in your 
# current location.  This may take a couple of minutes!
git clone https://github.com/bitfighter/bitfighter.git bitfighter

# Update to the tag/revision you want
cd bitfighter
git checkout bitfighter-019f

# Build the dedicated server (called bitfighterd)
cd build
cmake ..          # Creates a Makefile for the next step; may emit warnings
make bitfighterd

# Copy required files into exe folder (found at the root of the code tree):
cd ../exe
cp -r ../resource/* .
touch standalone.txt   # Tell bitfighterd to run in portable mode (don't skip this!!)

OS X

We have migrated to CMake for OS X as well. You must have the following software installed (in addition to the bitfighter source code):

  1. CMake
  2. XCode (includes development libraries and compilers)

To build:

  1. Open a terminal
  2. Set up the compatibility environment by running:
    • export MACOSX_DEPLOYMENT_TARGET=10.6
  3. change into the 'build' directory within the Bitfighter source
  4. Run CMake:
    • cmake ..
  5. Build with 'make':
    • make Bitfighter
  6. The .app will be built in the 'exe' sub-folder of the main bitfighter source directory

Building with XCode is supported with CMake, but it is untested with Bitfighter. To do so:

  1. Open a terminal
  2. Set up the compatibility environment by running:
    • export MACOSX_DEPLOYMENT_TARGET=10.6
  3. change into the 'build' directory within the Bitfighter source
  4. Run CMake using the Xcode generator:
    • cmake -G Xcode ..
  5. This will create an Xcode project within the 'build' directory that you can open


Notes

  1. Bitfighter user settings are found in $HOME/Library/Application Support/Bitfighter