2011-08-16 05:17:17 +00:00
|
|
|
//This file is formatted for processing with doxygen.
|
|
|
|
|
//unfortunatly, have to wrap the docs in a C comment for doxygen
|
2011-09-08 01:17:58 +00:00
|
|
|
// vim:tw=74:formatoptions-=l
|
2011-08-16 05:17:17 +00:00
|
|
|
/**
|
|
|
|
|
\page build-install Building and Installing QuakeForge
|
2002-09-30 04:55:41 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
This is our new development tree (we're back to "quakeforge"), where we're
|
|
|
|
|
again in the process of merging Quake and QuakeWorld ... but this time,
|
|
|
|
|
it's much better. :), and will eventually provide the 0.6 versions of
|
|
|
|
|
QuakeForge.
|
2002-09-30 04:55:41 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
While almost always in working order, it's under heavy development so be
|
|
|
|
|
prepared to encounter some issues (Wear your hard hat!). Please check the
|
|
|
|
|
docs.
|
2002-09-30 04:55:41 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
\note UNIX users: because of the diversity of machines on which QuakeForge
|
|
|
|
|
runs , we do not provide UNIX binaries. You need to compile QuakeForge
|
|
|
|
|
yourself, however QuakeForge is very easy to compile once you have the
|
|
|
|
|
necessary packages installed.
|
|
|
|
|
|
|
|
|
|
\section req-pack Required Packages
|
|
|
|
|
The following packages are required to build QuakeForge:
|
|
|
|
|
\li GNU autoconf 2.50 or later
|
|
|
|
|
\li GNU automake 1.6 or later
|
|
|
|
|
\li GNU libtool 1.4 or later
|
|
|
|
|
\li GNU bison
|
|
|
|
|
\li GNU flex
|
|
|
|
|
\li GNU make (BSD make doesn't like some constructs used)
|
|
|
|
|
\li C compiler and preprocessor (gcc and cpp recommended)
|
|
|
|
|
\li libsamplerate
|
|
|
|
|
|
|
|
|
|
\section rec-pack Recommended Packages
|
2002-09-30 04:55:41 +00:00
|
|
|
The following are recommended:
|
2011-08-16 05:17:17 +00:00
|
|
|
\li git (highly recommended for staying up to date with current changes)
|
|
|
|
|
\li zlib devel (highly recommended for compressed file and download support)
|
|
|
|
|
\li curl (for http download support (\ref qw_download_spec))
|
|
|
|
|
\li Ogg Vorbis libs (for compressed sound effects support)
|
|
|
|
|
\li X11 devel (for X11-based clients: software and OpenGL)
|
|
|
|
|
\li glide and mesa or other GL compatible lib
|
|
|
|
|
\li svgalib (for console-based clients: software and 3dfx)
|
|
|
|
|
|
|
|
|
|
\section package-names Relevant Package Names
|
|
|
|
|
The following is the list of relevant package names in debian.
|
|
|
|
|
\li build-essential
|
|
|
|
|
\li autoconf
|
|
|
|
|
\li automake
|
|
|
|
|
\li libtool
|
|
|
|
|
\li flex
|
|
|
|
|
\li bison
|
|
|
|
|
\li git
|
|
|
|
|
|
|
|
|
|
\li libasound2-dev
|
|
|
|
|
\li libjack-dev
|
|
|
|
|
|
|
|
|
|
\li libsamplerate0-dev
|
|
|
|
|
|
|
|
|
|
\li libflac-dev
|
|
|
|
|
\li libogg-dev
|
|
|
|
|
\li libvorbis-dev
|
|
|
|
|
\li libpng12-dev
|
|
|
|
|
\li zlib1g-dev
|
|
|
|
|
|
|
|
|
|
\li libcurl4-openssl-dev (or libcurl4-gnutls-dev)
|
|
|
|
|
\li libncurses5-dev
|
2010-12-09 06:21:20 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
\li libsdl1.2-dev
|
|
|
|
|
\li libsvga1-dev
|
2012-07-08 07:06:29 +00:00
|
|
|
\li libxext-dev
|
2011-08-16 05:17:17 +00:00
|
|
|
\li libxxf86dga-dev
|
|
|
|
|
\li libxxf86vm-dev
|
2010-12-09 06:21:20 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
\section building-and-installing Build and Install Procedure
|
2002-09-30 05:00:44 +00:00
|
|
|
Basic process to build and install QuakeForge:
|
2011-08-16 05:17:17 +00:00
|
|
|
\verbatim
|
2002-09-30 05:00:44 +00:00
|
|
|
./bootstrap
|
|
|
|
|
./configure
|
|
|
|
|
make install
|
2011-08-16 05:17:17 +00:00
|
|
|
\endverbatim
|
2002-09-30 05:00:44 +00:00
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
You may want to check <code>./configure --help</code> and select options.
|
2003-02-10 22:00:38 +00:00
|
|
|
|
2010-01-13 06:42:26 +00:00
|
|
|
To build and install only the quakeworld server:
|
2011-08-16 05:17:17 +00:00
|
|
|
\verbatim
|
2003-02-10 22:00:38 +00:00
|
|
|
./bootstrap
|
2003-02-11 04:12:55 +00:00
|
|
|
./configure --without-clients --without-tools --with-servers=qw
|
2003-02-10 22:00:38 +00:00
|
|
|
make install
|
2011-08-16 05:17:17 +00:00
|
|
|
\endverbatim
|
2007-03-07 04:58:21 +00:00
|
|
|
|
2012-07-09 06:10:27 +00:00
|
|
|
To build documentation (doxygen, graphviz, mscgen and transfig are required),
|
|
|
|
|
in an already configured source tree:
|
2011-08-16 05:17:17 +00:00
|
|
|
\verbatim
|
2007-03-07 04:58:21 +00:00
|
|
|
cd doc
|
|
|
|
|
make doc
|
2011-08-16 05:17:17 +00:00
|
|
|
\endverbatim
|
2007-03-07 04:58:21 +00:00
|
|
|
|
2012-12-06 02:50:29 +00:00
|
|
|
If the tree has not been configured and doing so is not desirable or
|
|
|
|
|
possible, then the documentation may be configured separately:
|
|
|
|
|
\verbatim
|
|
|
|
|
cd doc
|
|
|
|
|
./docstrap
|
|
|
|
|
./configure
|
|
|
|
|
make doc
|
|
|
|
|
\endverbatim
|
|
|
|
|
|
2011-08-16 05:17:17 +00:00
|
|
|
Then either point your webbrowser to <code>doxygen/html/index.html</code>, or
|
|
|
|
|
copy/move <code>doxygen/html</code> to a webserver and point your browser
|
|
|
|
|
to that. The documentation is currently grossly inadequate, but hopefully
|
|
|
|
|
it is of some help.
|
|
|
|
|
*/
|
