Difference between revisions of "How to build from source"

From OdaWiki
(Getting required files)
Line 1: Line 1:
 
Odamex is open source.  This means that it is possible to obtain and compile Odamex from source if you so desire.  The Odamex team wishes to make this process as painless as possible, therefore detailed instructions for how to build Odamex are provided in this section.
 
Odamex is open source.  This means that it is possible to obtain and compile Odamex from source if you so desire.  The Odamex team wishes to make this process as painless as possible, therefore detailed instructions for how to build Odamex are provided in this section.
  
== Getting the source ==
+
=Getting the source=
 
There are two ways to obtain the source to Odamex:
 
There are two ways to obtain the source to Odamex:
  
Line 7: Line 7:
 
* Get the absolute latest modifications through anonymous [[Subversion]] access
 
* Get the absolute latest modifications through anonymous [[Subversion]] access
  
== Getting required files ==
+
=Getting required files=
 
When you download Odamex, it's almost ready to go, right out of the box.  However, you need something to compile it with.  In addition, Odamex relies on extra libraries in order to function.
 
When you download Odamex, it's almost ready to go, right out of the box.  However, you need something to compile it with.  In addition, Odamex relies on extra libraries in order to function.
  
 
* [[Required Libraries]]
 
* [[Required Libraries]]
  
== Compiling Odamex ==
+
=Compiling Odamex=
 
You have all the pieces of the puzzle...now it's time to build.
 
You have all the pieces of the puzzle...now it's time to build.
  
 
Depending on what operating system and hardware you are running, you have many options of compilers.  Some of the more popular choices are below:
 
Depending on what operating system and hardware you are running, you have many options of compilers.  Some of the more popular choices are below:
  
===Windows===
+
==Windows==
====Code::Blocks IDE and MinGW====
+
===Code::Blocks IDE and MinGW===
 
This is the prefered method of compiling Odamex on Windows.  Code::Blocks project and workspace files are included in the [[Subversion]].
 
This is the prefered method of compiling Odamex on Windows.  Code::Blocks project and workspace files are included in the [[Subversion]].
* [[Compiling using Code::Blocks]] on Windows and Linux
+
* See [[Compiling using Code::Blocks]]
  
====MinGW and MSYS====
+
===MinGW and MSYS===
 
This method of compiling utilizes the command line to compile Odamex.  This is useful if you prefer not to use an IDE.
 
This method of compiling utilizes the command line to compile Odamex.  This is useful if you prefer not to use an IDE.
* [[Compiling using MSYS]] on Windows
+
* See [[Compiling using MSYS]]
  
====Microsoft Visual Studio====
+
===Microsoft Visual Studio===
 
Odamex currently supports compiling under Microsoft Visual C++ 6.0, and a Visual C++ 6.0 project file is included in [[Subversion]].  Support for later versions of Visual Studio is unconfirmed.
 
Odamex currently supports compiling under Microsoft Visual C++ 6.0, and a Visual C++ 6.0 project file is included in [[Subversion]].  Support for later versions of Visual Studio is unconfirmed.
* [[Compiling using Microsoft Visual Studio]] on Windows
+
* See [[Compiling using Microsoft Visual Studio]]
  
====Cygwin and GCC====
+
===Cygwin and GCC===
 
Support for native Cygwin binaries is not supported at this time, though is both feasable and desirable in the future.  You can, however, compile Odamex without Cygwin support under Cygwin, with minor adjustments, though this is not considered "Cygwin GCC".
 
Support for native Cygwin binaries is not supported at this time, though is both feasable and desirable in the future.  You can, however, compile Odamex without Cygwin support under Cygwin, with minor adjustments, though this is not considered "Cygwin GCC".
  
===Linux===
+
==Linux==
====GCC====
+
===GCC===
This is the prefered method of compiling Odamex in Linux. Makefiles are included in the [[Subversion]].
+
This is the prefered method of compiling Odamex in Linux. Makefiles are included in the [[Subversion]].
 +
* See [[Compiling using GCC]]
  
===FreeBSD===
+
==FreeBSD==
====GCC====
+
===GCC===
 
This is the prefered method of compiling Odamex in FreeBSD.  Makefiles are included in [[Subversion]], and should work with the FreeBSD version of GNU Make (gmake) and GCC.
 
This is the prefered method of compiling Odamex in FreeBSD.  Makefiles are included in [[Subversion]], and should work with the FreeBSD version of GNU Make (gmake) and GCC.
* [[Compiling using GCC]] on GNU/Linux, FreeBSD and Cygwin
+
* See [[Compiling using GCC]]
  
===OSX===
+
==OSX==
====Xcode====
+
===Xcode===
* [[Compiling using Xcode]] on Mac
+
* See [[Compiling using Xcode]] on Mac
  
== Compiling the Launcher ==
+
=Compiling the Launcher=
 
So you want to mess around with the Launcher?  Here's how to do it.
 
So you want to mess around with the Launcher?  Here's how to do it.
  
 
* [[Compiling the Launcher using Code::Blocks]] on Windows
 
* [[Compiling the Launcher using Code::Blocks]] on Windows
  
== Building odamex.wad ==
+
=Building odamex.wad=
 
This will show you how to build the latest odamex.wad file
 
This will show you how to build the latest odamex.wad file
  

Revision as of 15:08, 5 May 2008

Odamex is open source. This means that it is possible to obtain and compile Odamex from source if you so desire. The Odamex team wishes to make this process as painless as possible, therefore detailed instructions for how to build Odamex are provided in this section.

Getting the source

There are two ways to obtain the source to Odamex:

  • Download the latest stable version from the official Odamex website
  • Get the absolute latest modifications through anonymous Subversion access

Getting required files

When you download Odamex, it's almost ready to go, right out of the box. However, you need something to compile it with. In addition, Odamex relies on extra libraries in order to function.

Compiling Odamex

You have all the pieces of the puzzle...now it's time to build.

Depending on what operating system and hardware you are running, you have many options of compilers. Some of the more popular choices are below:

Windows

Code::Blocks IDE and MinGW

This is the prefered method of compiling Odamex on Windows. Code::Blocks project and workspace files are included in the Subversion.

MinGW and MSYS

This method of compiling utilizes the command line to compile Odamex. This is useful if you prefer not to use an IDE.

Microsoft Visual Studio

Odamex currently supports compiling under Microsoft Visual C++ 6.0, and a Visual C++ 6.0 project file is included in Subversion. Support for later versions of Visual Studio is unconfirmed.

Cygwin and GCC

Support for native Cygwin binaries is not supported at this time, though is both feasable and desirable in the future. You can, however, compile Odamex without Cygwin support under Cygwin, with minor adjustments, though this is not considered "Cygwin GCC".

Linux

GCC

This is the prefered method of compiling Odamex in Linux. Makefiles are included in the Subversion.

FreeBSD

GCC

This is the prefered method of compiling Odamex in FreeBSD. Makefiles are included in Subversion, and should work with the FreeBSD version of GNU Make (gmake) and GCC.

OSX

Xcode

Compiling the Launcher

So you want to mess around with the Launcher? Here's how to do it.

Building odamex.wad

This will show you how to build the latest odamex.wad file

Note: odamex.wad gets built automatically when using the Makefile