How to install

From OdaWiki
Revision as of 23:27, 12 January 2008 by Voxel (Talk | contribs) (i'll show you a bloody stub)

As of now, binary packages are avalable on the Windows and OS X platforms. For all other platforms, please refer to How to build from source for compiling instructions for your operating system. Binary packages are built from various SVN snapshots, and the source is a tarballed version of SVN snapshots as well. Please note that ss of 14:27, 23 January 2007 (CST), the releases are slightly out of sync, with the Mac version being SVN revision 73, while the Windows release and source tarball are SVN revision 35.

Downloading Odamex

Clicking on any of the operating system icons on the top right hand corner of the web page will take you to the sourceforge download page for the most recent binary or source tarball release for your platform.

Installing Odamex

Windows

Simply unzip the file into its own directory.

OS X

OSX installer in action

Extract the package, step though the installer. You'll need to enter the administrator password when prompted. To run odamex, navigate to the "/Applications/Odamex" folder.

Linux

You will need to install and configure SDL and Timidity.

Installing a Doom Resource file

Odamex requires at least one resource file in order to run. Please read the FAQ for more information about which resource files are supported.

Once you have the resource files you want, there are two methods of using the file with Odamex:

  • Copy the WAD files we wish to use into the Odamex directory. This is a bit of a kludge, but it works if you're in a hurry.
  • Copy the resource files into their own directory, and set the DOOMWADDIR environment variable to this directory. This is the prefered way of using WAD files, as it not only keeps WAD files and program files seperate, it's also recognized by many other source ports as well. Please refer to your operating systems documentation for instructions on how to set environment variables.

Running Odamex

Odamex comes with three binary executables

  • odalaunch: This is the official Odamex Launcher. Most likely, this is what you will want to use.
  • odamex: This is the Odamex executable. If you want to hop directly into the program for testing purposes, this is what you want. Please note that there is no "listen server" functionality at this time, and you must connect to a dedicated server to actually play a game.
  • odasrv: This is the dedicated server executable.