Difference between revisions of "How to install"
(→Running Odamex) |
m (→Windows) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | 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 | + | 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 GitHub snapshots, and the source is a tarballed version of GitHub snapshots as well. |
== Downloading Odamex == | == Downloading Odamex == | ||
| Line 7: | Line 7: | ||
===Windows=== | ===Windows=== | ||
| − | You have a few options when installing Odamex on Windows. You may either use the 32/64-bit unified installer, or the flat zip file. The unified installer will install the executables and libraries that best match your system. For the flat zip file, simply unzip the contents into its own directory. | + | You have a few options when installing Odamex on Windows. You may either use the 32/64-bit unified installer (recommended), or the flat zip file. The unified installer will install the executables and libraries that best match your system. For the flat zip file, simply unzip the contents into its own directory. We recommend not allowing Odamex to be installed under Program Files, as it can cause conflict with saving your Odamex personal settings and downloading patches required to play in many servers. |
===OS X=== | ===OS X=== | ||
| Line 20: | Line 20: | ||
Once you have the resource files you want, there are two methods of using the file with Odamex: | 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 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 | + | * 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 separate, 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. |
==Obtaining a resource file from Doom versions installed from Steam== | ==Obtaining a resource file from Doom versions installed from Steam== | ||
| − | If you have installed [http://store.steampowered.com/app/2280/ The Ultimate DOOM], [http://store.steampowered.com/app/2300/ DOOM 2: Hell on Earth], or [http://store.steampowered.com/app/2290/ Final DOOM] from Steam, | + | If you have installed [http://store.steampowered.com/app/2280/ The Ultimate DOOM], [http://store.steampowered.com/app/2300/ DOOM 2: Hell on Earth], or [http://store.steampowered.com/app/2290/ Final DOOM] from Steam, Odamex will be able to auto-detect the installations. In the event autodetection does not work, the iwads can be found in the following locations to be grabbed manually: |
{| class="table table-striped table-inverse" | {| class="table table-striped table-inverse" | ||
| Line 46: | Line 46: | ||
==Running Odamex== | ==Running Odamex== | ||
Odamex comes with three binary executables : | Odamex comes with three binary executables : | ||
| − | *• '''Odalaunch''': This is the official Odamex Launcher. | + | *• '''Odalaunch''': This is the official Odamex Launcher. You will use this to see online servers and join online games. |
*• '''Odamex''': This is the Odamex executable. If you want to hop directly into the program for Singleplayer or 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 multiplayer game. | *• '''Odamex''': This is the Odamex executable. If you want to hop directly into the program for Singleplayer or 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 multiplayer game. | ||
*• '''Odasrv''': This is the dedicated server executable. | *• '''Odasrv''': This is the dedicated server executable. | ||
Latest revision as of 20:17, 27 December 2019
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 GitHub snapshots, and the source is a tarballed version of GitHub snapshots as well.
Contents
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
You have a few options when installing Odamex on Windows. You may either use the 32/64-bit unified installer (recommended), or the flat zip file. The unified installer will install the executables and libraries that best match your system. For the flat zip file, simply unzip the contents into its own directory. We recommend not allowing Odamex to be installed under Program Files, as it can cause conflict with saving your Odamex personal settings and downloading patches required to play in many servers.
OS X
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
Once you have built or obtained the binaries, you will need to install and configure Timidity for music playback.
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 separate, 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.
Obtaining a resource file from Doom versions installed from Steam
If you have installed The Ultimate DOOM, DOOM 2: Hell on Earth, or Final DOOM from Steam, Odamex will be able to auto-detect the installations. In the event autodetection does not work, the iwads can be found in the following locations to be grabbed manually:
| Resource File | File Location |
|---|---|
| DOOM.WAD | C:\Program Files\Steam\steamapps\common\Ultimate Doom\base\DOOM.WAD* |
| DOOM2.WAD | C:\Program Files\Steam\steamapps\common\Doom 2\base\DOOM2.WAD* |
| PLUTONIA.WAD | C:\Program Files\Steam\steamapps\common\Final Doom\base\PLUTONIA.WAD* |
| TNT.WAD | C:\Program Files\Steam\steamapps\common\Final Doom\base\TNT.WAD* |
(*) If you have a 64-bit operating system installed, the correct Program Files folder will be labeled as "Program Files (x86)."
Running Odamex
Odamex comes with three binary executables :
- • Odalaunch: This is the official Odamex Launcher. You will use this to see online servers and join online games.
- • Odamex: This is the Odamex executable. If you want to hop directly into the program for Singleplayer or 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 multiplayer game.
- • Odasrv: This is the dedicated server executable.