BZFlag 2.4.22
			 http://BZFlag.org/
		Copyright (c) 1993-2021 Tim Riker

BZFlag is an Open Source OpenGL multiplayer multiplatform Battle Zone
capture the Flag game.  At its heart, the game is a 3D first person
tank simulation where opposing teams battle for dominance.  The game
was originally written for SGI computers running Irix, but now runs
and is actively maintained on Windows, Linux, Mac OS X, and other
platforms.

BZFlag may be redistributed under either the LGPL or MPL licenses.

This is the BZFlag README file.  This file includes introductory build
instructions, user community interaction references, information for
getting involved in BZFlag development, a manifest of the source code
layout, basic usage expectations, contact information, and more.


Table of Contents
=================
    Introduction
    Table of Contents
    Obtaining BZFlag
    Compiling and Installation
	Short Version
	Long Version
    Communication
	Internet Relay Chat
	Forums
    Bug Reports and Support
    Providing Contributions
    Source Tree Organization
    Public Internet Servers and the "list server"
    Notes on "CHEAT" servers and network abuse
    Project History and Contributions
    Contact


Obtaining BZFlag
================

Main BZFlag Website:  http://BZFlag.org
BZFlag Github Site:  https://github.com/BZFlag-Dev/bzflag

The main BZFlag website provides access to most all of the resources
available for the game.  The binary and source distributions of BZFlag
are, however, provided on the GitHub project site.  Compiled versions
are distributed as installable packages, disk images, and more, with
details varying depending on the platform.  Source code distributions
are provided and archived in various formats as well. See the project
site for the download links.

BZFlag is also available directly from GitHub.  To obtain BZFlag from
git, a bit more familiarity with software development is expected.
If you're familiar enough, anonymous GIT access is provided from the
repository:

  https://github.com/BZFlag-Dev/bzflag.git


Compiling and Installation
==========================

To compile a playable BZFlag, the following steps should get you up
and running quickly if everything external to BZFlag is properly
installed:

  ./autogen.sh
  ./configure
  make
  ./src/bzflag/bzflag

If configure detected everything it needed to build the BZFlag client,
after make the client will be sitting in src/bzflag as 'bzflag'.  The
game can be run from there, though you will probably want to "sudo
make install" or otherwise become a privileged user and install the
game properly for your system.

If you're building on a platform that has a README.* file, you should
consult that file as they usually contain additional instructions or
details specific for building on that platform.  There are often hints
for common problems specific to those platforms as well.

The Longer Version:

To build sources directly from a git clone you need to create a
configure script. You can skip this step if you grab a distribution of
BZFlag that already has a ./configure script in it, such as from a
source distribution tarball.  To generate the configure script, you
need to run the provided autogen.sh script:

  ./autogen.sh

The script will report whether sufficient versions of the GNU Build
System tools (i.e. autoconf, automake, and libtool) that were detected
and if successful, a configure script will be generated.  If the
script fails, submit a report to the developers containing the output
of "sh autogen.sh -v". This will run autogen.sh in verbose mode.  One
of the most common failures is having insufficient versions or
mismatched combinations of the GNU Build System tools, so make sure
your tools are recent.

If the previous step was successful you now have a script for
configuring BZFlag.  This command:

  ./configure --help

will list the variety of configuration options.  The script adapts
well to various system configurations, so it may be enough to simply
run it as:

  ./configure

You may want to create a 'work' directory and configure from there to
have all the build products and binary executables get placed in a
directory separate from the sources.  To do this, simply create a
directory then run configure and make from there instead.

After configure completes, it will report whether all the requisite
packages were found that it needs in order to build the client and the
server.  The client is reliant upon the following external
dependencies that should be installed before running configure:

  OpenGL 1.0+
  libSDL 1.2+

If you're on an operating system that uses a packaging system
(e.g. apt, portage, ports, etc), be sure to install the development
kit versions of each of those (e.g. xlibmesa-gl-dev package) so that
headers are made available.  You may also want to manually install
other dependencies that BZFlag automatically provides if you do not
have them pre-installed:

  c-ares
  libCURL
  libregex (usually provided as part of libc)
  zlib

The README.Linux file includes a detailed list of of the packages
needed to compile and run BZFlag on some popular Linux distributions.

The final summary at the end of running configure will report whether
the client will be built or not.  Once configure has been run, you may
compile by simply running 'make'.  If you have GNU Make and are on a
multiprocessor system, you can build in parallel with the -j option:

  make -j4

If compilation was successful, the client will be in src/bzflag and
the server will be in src/bzfs as 'bzflag' and 'bzfs' respectively.
You can run the client or the server directly from those locations
with or without installing:

  src/bzflag/bzflag

BZFlag looks for data files in a path defined during compile, in
./data/ , or in the previously specified data path only.  As part of
the tarball/git clone, the base data library is located in
<installed-locale>/bzflag/data.  This means that to test in a working
directory you need to tell bzflag where to find these files if there
is not a 'data' directory in your current directory.  This can be done
with a symbolic link:

  ln -s ./path/to/bzflag/data

After testing you can install BZFlag by running 'make install' with
sufficient system installation privileges.  Use 'sudo', 'su', or
similar methods to elevate your privileges when installing BZFlag
system-wide:

  sudo make install

You should now have BZFlag in the system directory ready to run.

If you do not have admin privileges on your platform, you can install
files in a directory that you own; for this to work, you have to
append to the configure command the prefix option:

  ./configure --prefix=YourHomeDirectoryHere

You will then be able to perform a "make install" without needing to
elevate your privileges, and all bzflag executable files will be
installed in the subdir bin of the specified path.

For additional information on installing, see INSTALL file.

Again, some platforms may be different.  See the README file
appropriate to your system for more information.

You can also build an installable package using:

  make package

The package will be placed in ./dist; the exact form of the package
depends on the platform.

There are three cleanup targets: clean, distclean, and
maintainer-clean.

`make clean' removes intermediate files but leaves bzflag and other
programs and any man pages.

`make distclean' removes everything clean does and also programs and
man pages. This should get things back to a tarball state.

`make maintainer-clean' removes everything distclean does and also
packages, directories created during the build, and the platform
configuration; this should get the source tree back to its state in
the Git repository.

To build BZFlag for an unsupported platform, see PORTING.

The ./configure script has a number of build options that you may find
interesting.


Communication
=============

The BZFlag project has several resources set up for communicating both
with other developers and with the community.  There is an IRC
channel and forums.

Internet Relay Chat
-------------------
Most of the BZFlag development activity and discussions occur over
IRC.  Join the #bzflag IRC channel on the Freenode network
(irc.freenode.net, port 6667) to get involved.

See https://webchat.freenode.net for a web based interface for
first-time users.  Individuals that intend to stay in the channel are
expected to get a non-web-based IRC client.  See http://irchelp.org or
search the web for IRC clients for your operating system.

Forums
---------------
There are extensive and active forums used by players, server
operators, administrators, and others available here:

https://forums.bzflag.org

Registering an account on the forums presently also registers your callsign
for use inside of BZFlag.  Some servers require registration in order to
play.  See the Getting Started page on our site for more about registration.


Bug Reports and Support
=======================

For reporting bugs and unexpected behavior, please go to BZFlag bug
tracking system at:

https://github.com/BZFlag-Dev/bzflag/issues

If you require assistance with some issue, please visit the BZFlag
IRC channel at #bzflag at irc.freenode.net

Alternatively, discussion forums are also available for resolving issues.


Providing Contributions
=======================

Pull Requests should be entered submitted via the GitHub pull system:

https://github.com/BZFlag-Dev/bzflag/pulls

Contributions are gladly accepted for modifications that do not
affect the core gameplay.  Interacting with the other developers in
the IRC channel is recommended for any changes which will affect
gameplay.


Source Tree Organization
========================

After unpacking a source distribution, you should have at least the
following files in the new 'bzflag' directory:

  README	- this file
  README.*	- platform specific details
  AUTHORS	- project contributors
  COPYING	- the license for BZFlag
  ChangeLog	- source code changes since previous release
  DEVINFO       - information for developers
  NEWS		- history of visible changes for each release
  PORTING	- a guide for porting BZFlag
  autogen.sh	- build system preparation script
  configure.ac	- build system configuration script template
  data/		- data files (sounds, images, etc.)
  include/	- include headers for libraries
  man/		- man pages
  misc/		- miscellaneous goo
  MSVC/		- stuff for building on the Windows platform
  package/	- stuff to build installable packages
  plugins/	- bzfs plugins
  src/		- bzflag, bzfs, etc. source code
    3D/		  - 3D code including texture manager
    bzadmin/      - bzadmin app source code (text admin/chat client)
    bzflag/	  - bzflag app source code (game client)
    bzfs/	  - bzfs app source code (game server)
    common/	  - general purpose classes
    date/         - unified version and build date stamping for apps
    game/	  - game library used by both the server and client(s)
    geometry/	  - geometry rendering classes
    mediafile/	  - classes for reading resources
    net/	  - networking classes and functions
    obstacle/	  - collision detection stuff
    ogl/	  - OpenGL utility classes
    platform/	  - platform dependent code
    scene/	  - high level rendering algorithms
  tools/	- various helper utilities
  Xcode	        - Mac OS X Xcode project and associated files

Note that include/ does not have all the include files.  If a header
is used entirely within a library (i.e. it doesn't directly provide
functionality outside the library) then the header is found in the
library's directory under src/.  An include file goes in include/ only
if it's required by another library or libraries or executables.
While this complicates locating a header file (it can be in one of two
places instead of just one place), you can instantly tell if a header
file is (can be) used by clients of the library.


Public Internet Servers and the "list server"
=============================================

The bzflag project offers a public server listing service that allows
players to find servers to play on. This service is run for the
benefit of the project. As of Version 2.4, BZFlag servers that wish to
be listed on the public list server must provide an authentication key
that ties the server to a specific global user. This is done to
provide contact information for players and project
staff. Authentication keys are automatically generated at
https://my.bzflag.org/listkeys/


Notes on "CHEAT" servers and network abuse
==========================================

While the license for BZFlag certainly allows users to run any server
modification that they wish or to modify the code in any way, we ask
that people do not publish or host "cheat" clients or servers to the
general public for use.  We also expect that users will abide by basic
usage guidelines of reasonable and tolerable behavior that are not
detrimental to the game's heritage of a fun gaming environment for
all.

We understand the desire to expand, modify, and improve the game and
its sources including the ability to test out new features publicly.
These modified clients and servers generally provide some advantage
over unmodified clients and are generally discouraged for widespread
use.  As such, we ask that anyone wishing to host or otherwise
participate in a game that involves a modified client or server to
register under a different network protocol than the current public
release by modifying BZ_PROTO_VERSION in the src/date/buildDate.cxx
file.  This will let modified games be played and prevent modified
clients from being used on public unmodified servers.

Any individuals that are found to be contributing to abuse of the
public services being provided may be subject to bans or other access
restrictions.  Abuse generally consists of any disruption to one of
BZFlag's network services including denial of service attacks,
spamming of BZFlag web sites or servers, disruptive gameplay on
multiple public servers, intrusion attempts, password sniffing, or any
other behavior that is deemed inappropriate.

The BZFlag project administrators reserve the right to remove public
listings of any game servers for any reason whatsoever, including
removal of servers or banning of individuals that do not follow this
request.  Similarly, the BZFlag project administrators also reserve
the right to limit access or otherwise block any players from public
service access at any time.  These actions may include the suspension
or removal of global accounts and limiting access to the web site
services including web site services, list server access, forum access,
and any league resources.

In general, the entire network is provided by the community for the
community as an entirely volunteer and contributed effort.  We ask
that all players recognize and respect the time, effort, and resources
involved and that we're all generally here to have a good time.


Project History and Contributions
=================================

BZFlag was primarily originally authored by Chris Schoeneman
<crs23@bigfoot.com> in the early 1990's.  After several years of
development, Chris turned over copyright and maintainership of the
game to Tim Riker.

BZFlag continues today to be maintained and developed by the Open
Source community by a project administration team with contributions coming
in from all over the world.  See the AUTHORS file for more details on
contributions to the project.


Contact
=======

Any of the core developers listed in the AUTHORS file are generally
receptive to being contacted for most matters relating to the game.
Internet Relay Chat (IRC) or e-mail is generally the expected method
of interaction with IRC being generally preferred.  The project
maintainer Tim Riker <Tim@Rikers.org> is available for most legal matters,
but day to day development is handled by the Project Administrators:

Scott Wichser (blast007) <blast007@users.sourceforge.net>
Jeff Makey (BulletCatcher) <bullet_catcher@users.sourceforge.net>

Happy Shooting!
The BZFlag Development Team

README for BeOS platforms
-------------------------

(Fran�ois Revol - 26/02/2004)

BZFlag should now compile on BeOS R5 BONE, using the software
renderer. It also works fine with MESA 6. It can also built for
the "new" OpenGL kit that was to be in R5.1d0, the configure
detects libGL2, though one should then have to replace
src/platform/BeOSWindow.cxx by src/platform/BeOSWindow2.cxx.
Note there are many issues with this beta GL stuff, and it's
totally unsupported. I keep this one in SVN because I don't
know which API will survive the other.

net_server isn't supported yet, and I don't think it will ever
be, though the configure script only links to BONE libs if they
are present.

I usually use:
configure --prefix=/boot/home/config --enable-debug

Current limitations include:
- windowed mode only, and fixed size window.
- buggy audio (samples get played in a loop, giving a headache
after some minutes.

SDL build (= without the native ui) under BeOS hasn't been
investigated yet.

BZFlag README for IRIX
----------------------

NOTE: BZFlag likely no longer builds successfully on IRIX. However,
we will keep this README file for now as a possible reference in case
someone wants to try.


Building on IRIX will work with either the SGI MIPS compiler or the
GNU gcc3 compiler.  The GNU compiler is available for download from
SGI freeware.

Note that the gcc-3.2.2 version picked up some 6.5.18-isms, so you may
need to track down the older 3.1 release, or obtain a newer version
yourself, if you are using gcc and are unable to compile.

If both the GNU compiler and the SGI MIPS compiler are installed on
the same system, the GNU compiler will be used by default.  To use the
SGI MIPS compiler, you will need to inform the configuration script of
your preference.  You can set the variables as environment variables,
or provide them directly to configure as is shown (and preferred)
below:

# to use the MIPSPro compiler
./configure  CC="cc" CXX="CC" CXXFLAGS="-O2 -OPT:Olimit=32768 -DEFAULT:abi=o32:isa=mips3:proc=r5k -LANG:std -FE:template_in_elf_section -ptused -prelink" CFLAGS="-O2 -OPT:Olimit=32768 -DEFAULT:abi=o32:isa=mips3:proc=r5k -LANG:std -ptused -prelink"
make

If you try to boost the optimization to -O3, it is likely that the
compiler will crash or hang.  The -OPT:Olimit option helps mitigate
any crashes, but some may still be experienced and need to be compiled
by hand with no optimization.  Some files will simply take a very long
time to compile no matter what optimization level, so be patient. ;)

The -LANG:std, -ptused, and -prelink options are necessary for it to
build properly.  Without them, there will be serious problems linking
the binaries with the template instantiations.  The options are not
strictly necessary on the CFLAGS variable (they are required for
CXXFLAGS), but don't hurt.

You may want to use the -no_autoinclude option on the CXXFLAGS and
CFLAGS if your version of the compiler supports that option if you run
into an error, but it should not be necessary.

The last problem that you may encounter on older IRIX systems is a
problem in the curses.h header.  This problem will cause bzadmin to
fail to build properly.  If you have no need for bzadmin, you can
ignore the failure as bzfs and bzflag will have completed before
bzadmin.  Otherwise if you do want bzadmin, the workaround is simple..
The header uses a symbol name that is not valid with the C++ compiler:

cc-1084 CC: ERROR File = /usr/include/curses.h, Line = 611
  The indicated declaration has an invalid combination of type specifiers.

		syncok(WINDOW *, int bool),

The relatively simple work around involves actually editing the
curses.h file.  Copy the /usr/include/curses.h file to the bzflag
include/ directory.  Edit the file and replace "int bool" with "int
b".  The edited file should take precedence over the system header.
Save the file, and restart make and the build should succeed.  Best of
luck.

See the generic install instructions in README for more details.

BZFlag README for Linux
=======================

BZFlag is an online multiplayer 3D tank battle game. You can play against
other people anywhere on a TCP/IP based network, including the Internet.
BZFlag is free and open source. Please read the file COPYING in the
bzflag-<version> directory of the standard doc directory (probably
/usr/share/doc).

Hardware accelerated OpenGL is *highly* recommended. Intel graphics chipsets
are well supported on Linux, with the exception of the few PowerVR-based
versions. AMD graphics cards are also well supported on Linux, but may require
additional firmware to be installed for 3D accelerated graphics to function.
For instance, on Debian this is accomplished by enabling the contrib and
non-free repositories and installing the firmware-amd-graphics package. For
nVidia, there is an open-source Nouveau driver, but you might find this does
not function well enough and may instead need the proprietary nVidia drivers.
Install those through your package/driver manager (or, less ideally, from
nvidia.com).

More information about BZFlag is available in the man pages for bzflag, bzfs,
bzadmin, and bzw. Also check:

  http://www.BZFlag.org/

Different Linux distributions use different naming conventions for the packages
that provide the dependencies needed to compile and run BZFlag. Known build
requirements include:

  Debian & Ubuntu:

    apt-get install g++ libtool automake autoconf libsdl2-dev libcurl3-dev \
    libc-ares-dev zlib1g-dev libncurses-dev libglew-dev make

  Fedora:

    dnf install SDL2-devel c-ares-devel libcurl-devel gcc-c++ libtool \
    ncurses-devel zlib-devel glew-devel

After any development packages are installed, execute the following commands
from the top-level BZFlag source directory:

  ./autogen.sh
  ./configure
  make

This will build BZFlag. The autogen.sh step can be skipped if the source code
was received from the tarball package, but must be included if the source came
directly from a git clone.

If you wish to install the executables to the usr directory after the build,
then execute as root:

  make install


Submit bug reports and comments on the GitHub site
https://github.com/BZFlag-Dev/bzflag/issues

To build bzflag on Windows Intel you can use MinGW and MSYS, both Open Source
and freely available from http://www.mingw.org

There's a troubleshooting section at the end of this file in case you run into
problems.

*** Part I: Obtain MingW and MSYS

MinGW stands for Minimalistic GNU for Windows
  it is a collection of library, header and a collection of GNU tools
MSYS stands for Minimal SYStem
  it gives the ability to run shell based program (like configure)
The MSYS DTK stands for the Developer's Toolkit
  it lets you use GNU autotools, and other utilities, on windows

MinGW gives the ability to generate a truly native windows program, without any
posix layer emulation (like the one in use by cygwin).

Now, to build bzflag, you have to procure MinGW and MSYS. Get the
whole MinGW, including the MSYS DTK (Development ToolKit), follow the instruction
to install it and stay updated.

*** Part II: Obtain necessary platform files

If you would like to build BZAdmin in curses mode, you need to download PDCurses
from http://pdcurses.sourceforge.net/.  Build it according to their instructions
for MingW, and rename the resulting library from pdcurses.a to libpdcurses.a.
Then copy libpdcurses.a and curses.h to the appropriate subdirectories of your
MingW32 install (lib and include respectively).

If you want to build using SDL support, you should get SDL at libsdl.org and
follow their instructions to install it under MinGW before configuring bzflag.
Then move on to Part III.  This is the suggested way of building BZFlag.

If you want to build without using SDL, you have to get yourself a couple of
header files to interface the MS DirectX subsystem. They are normally part
of any Microsoft development kit; you can get from your Visual C installation
if you have one, or from MSDN on internet.
Any way you got these files, you should copy either on the MinGW installation,
under the include directory or, if you don't like to clutter the MinGW
installation, just put under src/platform.

The files in question are dsound.h, dinput.h and ddraw.h.

To get the needed DirectX header files from the Microsoft DirectX SDK:
    * Go to http://msdn.microsoft.com/downloads/
    * Select the DirectX 9.0 Software Development Kit
    * Click on the Download link on the right
    * This is a 227 MB file!
    * Run the downloaded program
    * Click Unzip to extract it to the default location (C:\mssdk\temp)
    * Click "OK" and "Close" when the program finishes extracting the files
    * Copy ddraw.h, dinput.h and dsound.h from the SDK's include directory

Note that we cannot redistribute these files separate of the entire SDK.

*** Part III: Obtain BZFlag

Make sure that your BZFlag sources have correct line endings.  Use the source
tarballs rather than zipfiles if you're building from a release.  If you are
using subversion, the line endings should be correct automatically except for
src/date/buildDate.cxx, which you will need to convert with dos2unix or a
similar tool before attempting to run ./configure.

It's easiest to check out BZFlag into a subdirectory of wherever you installed
MSYS, such as <MSYS>/bzflag.

*** Part IV: Compile and Install BZFlag

Once you have the files checked out correctly, you should run this command

sh autogen.sh

from the top bzflag directory, from inside the MSYS shell (run msys.bat from
the MSYS directory).

You should have all the automake, autoconf, m4, perl stuff - they
are in DTK kit.  They may not be up to date; there are sometimes more updated
versions available if autogen refuses to run.

If you are able to find a bzflag dist kit, just run the configure script,
looking at the help (configure --help) for options.

Then run

./configure (with any desired arguments, such as --without-sdl)
make
make install

Compiled executable files are found in src/bzflag (bzflag.exe), src/bzfs/bzfs
(bzfs.exe), and src/bzadmin (bzadmin.exe).

When you are confident of the compilation result you can run make install and
then make a link to the application (e.g. on your Desktop) to run this bejoux.


--- Troubleshooting:

Q. When I run autogen.sh, I get a message like "sh: aclocal: command not found"
A. aclocal and associated programs are part of the GNU autotools package.  This
   is included in the MSYS Developer's Tool Kit (DTK), which can be downloaded
   from http://www.mingw.org.  BZFlag requires the autotools to build.

Q. When I run ./configure, it reports "No C Compiler found" or similar.
A. Make sure you install MingW32 before MSYS, and when installing MSYS, be sure
   to tell it where MingW32 is.  If this does not work (or you don't want
   to reinstall), copy the MingW32 directory into the MSYS directory as mingw.
   E.g. if you have MingW installed to c:\MingW32 and MSYS to c:\msys\1.0, copy
   the MingW32 directory to c:\msys\1.0 and rename it mingw, so you have
   c:\msys\1.0\mingw with all the MingW files in it.

Q. When I run ./configure, sed dumps the contents of version.h, configure
   continues normally for a while, and then I get repeated sed errors like
   "sed: <file>: unterminated `s' command" and others.  Make fails with
   "*** No targets.  Stop." or similar.
A. When checking out the bzflag sources from a git clone, you must check them
   out with UNIX line breaks. If you're using a source package, you need to use
   the tarball (.tar.bz2) not the zip package.  You can extract it from within
   MSYS with "bunzip2 <file>" and "tar -xvf <file>".

Q. When I run make, it reports an error about not being able to find dsound.h.
A. Follow the above directions to get the needed DirectX headers from the MS DX SDK,
   or follow the above instructions for "If you want to build using SDL support"

Q. I get errors not mentioned in this file.
A. File a support request at http://sourceforge.net/projects/bzflag or jump on
   #bzflag on irc.freenode.net and ask for help compiling on MingW.  Be sure to
   include the first few lines of error if you file a support request.

BZFlag README for Mac OS X
==========================

BZFlag is supported on Mac OS X 10.7 and later. Included below are
instructions on installing BZFlag both from a binary and from a released
source distribution.

Binary Distribution
-------------------

See the project site downloads of BZFlag at
https://github.com/BZFlag-Dev/bzflag/releases to obtain the latest binary
distribution.

Once you've obtained a binary distribution of BZFlag, installation should be a
simple matter of decompressing the downloaded file and then copying the
program to your Applications folder. If you cannot run the client at all (i.e.
it starts to a black screen, or the icon bounces but then nothing happeys),
you can try several things:

  1) Move or delete the BZFlag directory in your personal application support
     folder at ~/Library/Application Support/BZFlag. As of Mac OS X 10.7, the
     ~/Library directory is hidden by default. You can open it by navigating
     to your home directory, entering the Command-Shift-G key sequence, then
     typing "Library" and clicking "Go." Note that this directory contains
     your saved configuration, screenshots, and map files, so you may want to
     move or delete only your configuration file (stored in the directory with
     the BZFlag version number).

  2) Check your console for error messages. Open your console application at
     /Utilities/Console.app, and expand the "User Diagnostic Reports" list in
     the sidebar under "Diagnostic and Usage Information." Any crash reports
     should be listed there and will start with "BZFlag."

  3) Run the binary directly by using Terminal:
       /Applications/BZFlag-#.#.#.app/Contents/MacOS/BZFlag
       (replace "#.#.#" with your actual BZFlag version number)

Source Distribution
-------------------

You can build BZFlag from source using Xcode version 7 and later (You may also
be able to build with Xcode versions as early as 4.2, but you will need to
update the locations of libncurses, libcurl, and libz since those changed in
the Mac OS X 10.11 SDK). As of BZFlag version 2.4.4, BZFlag has a fully native
Xcode project file. The earlier method of using the Xcode project file as a
wrapper for autotools is no longer supported. If you have a version of Xcode
which includes autotools, or have installed autotools yourself, you may
additionally be able to build using the traditional autotools method. See the
README file for further information. You will still need to install the SDL 2
framework as detailed below.

BZFlag has three external dependencies: SDL 2, GLEW, and c-ares.

Download the latest version of the SDL 2 framework from
https://www.libsdl.org/download-2.0.php. Version 2.0.3 or later is required,
but version 2.0.4 or later is highly recommended because it includes a new
function for capturing mouse input to help address a mouse warping problem.
If you obtained a binary release of SDL 2, mount the disk image and place the
file "SDL2.framework" in your /Library/Frameworks directory (an administrator's
account may be required). If you built SDL 2 from source, locate the file
"SDL2.framework" and copy it into that same location.

This project expects the GLEW and c-ares libraries and header files to be
located in /usr/local. If you install them elsewhere, you must update the
library and header search paths in this project file appropriately.

Download the latest version of GLEW from
https://github.com/nigels-com/glew/releases. Extract the package, and then
build it with the following commands (WARNING: this will remove all shared
libraries for GLEW under /usr/local, even older versions you may have
installed; this is necessary because it appears there is currently no way to
configure GLEW to build without shared libraries):

$ export MACOSX_DEPLOYMENT_TARGET=10.7
$ export GLEW_DEST=/usr/local
$ make glew.lib
$ sudo make install
$ sudo rm /usr/local/lib/libGLEW*.dylib

Download the latest version of c-ares from http://c-ares.haxx.se.
Extract the package, and then build it with the following commands:

$ export MACOSX_DEPLOYMENT_TARGET=10.7
$ ./configure --disable-shared
$ make
$ sudo make install

Obtain the latest BZFlag source archive from GitHub at
https://github.com/BZFlag-Dev/bzflag. Once you have obtained the source code,
open the BZFlag.xcodeproj file located in the Xcode/ directory.

The default behavior is to build a debug client. If you want a standard
client, click the "BZFlag" scheme button at the top left corner of the screen,
scroll down, and click "Edit Scheme..." at the bottom of the pop-up menu. In
the left sidebar, click the Run phase, and in the right area select the
Info tab. Under Build Configuration, select the desired scheme of Debug or
Release.

To build the client, select Build from the Product menu or enter the Command-B
key sequence. Note that the BZFlag version is no longer automatically
appended to the build product.

If the build was successful, you can run the application from Xcode selecting
the Product menu and clicking Run or by entering the Command-R key sequence.
You will also want to locate the application you just built. Make sure the
Navigator pane is visible and select the Project Navigator, then expand the
"BZFlag" project container and the "Targets" group within it. Click the
"BZFlag.app" target. Make sure the Utilities pane is visible, and under
the Identity and Type panel it will show the full path to the application.
Click the small grey right arrow at the bottom right corner of the path to
reveal the application in the Finder.

NOTICE: If you're compiling from source, it is expected that you have
sufficient/proficient understanding of how to compile applications on the
command line or using XCode and how to perform compilation troubleshooting
without assistance.  This holds particularly true for all alpha/beta testing
releases as well as for any sources pulled directly from the Subversion source
repository checkout. If you have problems building from a checkout, you should
try building from an official release that we have posted to GitHub to
see if you can duplicate the issue, and then ask us for assistance.

Usage
-----

To install BZFlag, copy the application you obtained as a binary distribution
or built from source into your /Applications directory, or use it from another
location of your choice. Different client versions may exist simultaneously on
any system without issue.

To access the bzadmin text client or the bzflag server bzfs, right click the
application, click "Show Package Contents," and navigate to Contents/MacOS.
Server plugins are located at Contents/PlugIns. Note that while the plugin
names are different from Windows and Linux (something like "<name>.dylib"
instead of "<name>.dll or "<name>.so"), bzfs will still load them when you
specify the full plugin path.

The software included in Solaris 10 is inadequate to build BZFlag.
The version of gcc (3.4) in Solaris 10 is too old to support C++0x
features used by BZFlag, and the c-ares and cURL packages are simply
not provided.

The easiest way to fill the gaps is to use packages built by the
OpenCSW project at https://www.opencsw.org/ .  Follow the directions at
https://www.opencsw.org/manual/for-administrators/getting-started.html
to initialize the OpenCSW package management system and then run the

 /opt/csw/bin/pkgutil -i gcc4g++ libcares_dev libcurl_dev

command (as root) to install the required packages and their many
dependencies.  Applying this small patch will simplify the process of
building BZFlag:

--- /opt/csw/bin/curl-config~	Wed Aug 12 11:02:25 2015
+++ /opt/csw/bin/curl-config	Sun Sep 27 12:00:00 2015
@@ -148,7 +148,7 @@
            CURLLIBDIR=""
         fi
         if test "Xyes" = "Xyes"; then
-          echo ${CURLLIBDIR}-lcurl -lcares -lidn -lrtmp -lssh2 -lssl -lcrypto -lssl -lcrypto -L/opt/csw/lib -R/opt/csw/lib -mcpu=v9 -L/opt/csw/lib -lintl -L/opt/csw/lib -lgssapi_krb5 -lkrb5 -lk5crypto -lcom_err -llber -lldap -lz -lrt -lsocket -lnsl
+          echo ${CURLLIBDIR}-lcurl -R/opt/csw/lib -lnsl
         else
           echo ${CURLLIBDIR}-lcurl
         fi

Any of these "make" programs will get the job done:

  path               package
 /usr/ccs/bin/make  SUNWsprot
 /usr/sfw/bin/gmake SUNWgmake
 /opt/csw/bin/gmake CSWgmake

Other required programs, such as /usr/ccs/bin/ld from SUNWtoo, are all
available in standard Solaris packages.

Now put the CSW tools directory at the front of your PATH:

PATH=/opt/csw/bin:$PATH
export PATH

and run configure:

CPPFLAGS='-I/opt/csw/include' LDFLAGS='-L/opt/csw/lib -R/opt/csw/lib' ./configure --disable-client

README for Windows (32- and 64-bit) platforms
---------------------------------------------

**Compilers**
BZFlag uses Microsoft Visual C++ for its prebuilt binary releases and project
files are provided for it. The current compiler used is Visual C++ 2017 (VC15).
You can download Visual Studio Community 2017 for free from here:
https://www.visualstudio.com/downloads/

**Targets**
There are a total of 4 build targets in the VC projects. There are targets
for Release and Debug, and each has a 32-bit and 64-bit version. At this time,
only 32-bit is supported. Our dependencies don't build correctly on 64-bit with
our current script. Also, there's no real performance advantage in having a
64-bit BZFlag client as the game doesn't use much RAM.

**Required Libraries**

Various third-party libraries are needed, which are packaged in our
bzflag-dependencies repository. Either grab a pre-built binary package from
the releases section, or build the dependencies from source as described at
the repository. The BZFlag build expects that an environment variable called
BZ_DEPS exist and point to dependencies repository directory (the one that
would contain the one or more output directories and src directory containing
the third-party libraries)
  https://github.com/BZFlag-Dev/bzflag-dependencies

NSIS 3.03 is needed to build an installer, which is built as part of a release
build.
  http://nsis.sourceforge.net/

**Running and Debugging**
By default the compiler will copy the compiled executables to the root level
of the source drive ( the same place that the data dir is at). From there
you can simply double click the application to run it. If you wish to debug
the program, you must set the debug executable path and working directory
inside VC to use this executable and path.

**Installer**
If you wish to build the full release package using the fullbuild solution,
you will need to have NSIS installed. The built installer will be placed in
the bin_Release folder for the target in the root of the source tree.