mirror of
https://github.com/odamex/odamex
synced 2026-08-19 02:23:09 -04:00
117 lines
4.5 KiB
Text
117 lines
4.5 KiB
Text
===============================================================================
|
|
Odamex v12.1.0 README
|
|
https://odamex.net
|
|
===============================================================================
|
|
|
|
Odamex is a modification of DOOM to allow players to compete with each other
|
|
over the Internet using a client/server architecture. Thanks to the source code
|
|
release of DOOM by id Software in December 1997, there have been many
|
|
modifications that enhanced DOOM in various ways. These modifications are known
|
|
as "source ports", as early modifications mainly ported DOOM to other platforms
|
|
and operating systems such as Windows and Macintosh.
|
|
|
|
Odamex is based on the CSDoom 0.62 source code originally created by Sergey
|
|
Makovkin, which is based on the ZDoom 1.22 source code created by Marisa Heit.
|
|
|
|
Features
|
|
--------
|
|
|
|
Odamex supports the following features:
|
|
|
|
* Full Client/Server multiplayer architecture with network compensation
|
|
features (unlagged, client interpolation and prediction)
|
|
* Support for up to 255 players
|
|
* Various compatibility settings, to emulate vanilla Doom, Boom, or ZDoom
|
|
physics and fixes
|
|
* Playback and recording of vanilla demos
|
|
* A fully-featured client netdemo record system with playback control
|
|
* Removal of most vanilla Doom Static limits
|
|
* Support for most Boom and MBF mapping features
|
|
* The traditional old-school style of Deathmatch and a Cooperative mode, but
|
|
also other game modes such as Team Deathmatch and Capture the Flag
|
|
* Support for Survival, Last Man Standing, Last Team Standing, LMS CTF,
|
|
3-WAY CTF, and Attack & Defend game modes.
|
|
* Competitive-ready features, such as a warmup mode, round system, player
|
|
queue, or playercolor overriding
|
|
* Several modern ZDoom additions, such as slopes, LANGUAGEv2 or MAPINFOv2
|
|
lump support
|
|
* An array of editing features, including the Hexen map format, DeHackEd and
|
|
BEX patch support and ACS up to ZDoom 1.23
|
|
* Native Joystick support
|
|
* Several additional music formats, such as MOD and OGG
|
|
* In-Engine WAD downloader
|
|
* Allow on-the-fly WAD loading
|
|
* A 32-bit Color depth/true color renderer
|
|
* Full Widescreen support
|
|
* Ultra high resolution support (up to 8K)
|
|
* Uncapped and raised framerate
|
|
* Takes advantage of widely used libraries to port it to new devices with ease
|
|
|
|
Compilation instructions
|
|
------------------------
|
|
|
|
Clone the repositories, with all submodules:
|
|
|
|
git clone https://github.com/odamex/odamex.git --recurse-submodules
|
|
|
|
If you downloaded the zip, use these commands on the git directory:
|
|
|
|
git submodule init
|
|
git submodule update
|
|
|
|
Odamex requires the following tools and libraries:
|
|
|
|
* CMake 3.13 or later: <https://cmake.org/download/>
|
|
* SDL 2.0: <https://www.libsdl.org/download-2.0.php>
|
|
* SDL2-Mixer: <https://libsdl.org/projects/SDL_mixer/>
|
|
* cURL: <https://curl.se/>
|
|
* libPNG: <http://www.libpng.org/pub/png/libpng.html>
|
|
* zlib: <https://zlib.net/>
|
|
* DeuTex (for building the WAD): <https://github.com/Doom-Utils/deutex/releases/>
|
|
* wxWidgets (for the launcher): <https://www.wxwidgets.org/downloads/>
|
|
|
|
`cURL`, `libPNG` and `zlib` are automatically included in-tree as submodules.
|
|
|
|
On Windows, all libraries are automatically downloaded if not found. On
|
|
*nix/MacOSX, you will need to download through your package manager
|
|
`libsdl2-dev`, `libsdl2-mixer-dev` and `libwxgtk3.0-dev`.
|
|
|
|
Please check this page for further instructions on how to compile Odamex
|
|
for your platform.
|
|
|
|
<https://github.com/odamex/odamex/wiki/Compiling-Odamex>
|
|
|
|
Contributing to the project
|
|
---------------------------
|
|
|
|
Please report any oddity, physics inaccuracies, bugs or game-breaking glitches
|
|
to our issues page. You can also submit patches as a Pull Request.
|
|
|
|
<https://github.com/odamex/odamex/issues>
|
|
|
|
Before submitting a pull request, please make sure it follows our coding
|
|
standards!
|
|
|
|
<https://github.com/odamex/odamex/wiki/Coding-Standard>
|
|
|
|
For historical purposes, you can also view our bugtracker's archive.
|
|
|
|
<https://odamex.net/bugs/>
|
|
|
|
External Links
|
|
--------------
|
|
|
|
Please visit the following websites for more information about the development
|
|
of the port and our community:
|
|
|
|
* Odamex Website: <https://odamex.net>
|
|
* Wiki: <https://github.com/odamex/odamex/wiki>
|
|
* Forums: <https://odamex.net/boards/>
|
|
* Discord: <https://discord.gg/aMUzcZE>
|
|
* Twitter: <https://twitter.com/odamex>
|
|
|
|
License
|
|
-------
|
|
|
|
Odamex is released under the GNU General Public License v2. Please read
|
|
LICENSE for further details regarding the license.
|