README.md
1# ABOUT
2
3_dhewm 3_ is a _Doom 3_ GPL source port, known to work on at least Windows, Linux, macOS and FreeBSD.
4
5The goal of _dhewm 3_ is bring _DOOM 3_ with the help of SDL to all suitable
6platforms.
7
8Bugs present in the original _DOOM 3_ will be fixed (when identified) without
9altering the original gameplay.
10
11**The official homepage is:** https://dhewm3.org
12
13**Mods supported by dhewm3:** https://dhewm3.org/mods.html
14
15**Mod SDK for dhewm3:** https://github.com/dhewm/dhewm3-sdk
16
17**The project is hosted at:** https://github.com/dhewm
18
19**Download the latest release:** https://github.com/dhewm/dhewm3/releases/latest
20
21**Consult the FAQ at:** https://github.com/dhewm/dhewm3/wiki/FAQ
22
23**Report bugs here:** https://github.com/dhewm/dhewm3/issues
24
25
26# CHANGES
27
28Compared to the original _DOOM 3_, the changes of _dhewm 3_ worth mentioning are:
29
30- 64-bit port
31- SDL for low-level OS support, OpenGL and input handling
32- OpenAL for audio output, all OS-specific audio backends are gone
33- OpenAL EFX for EAX reverb effects (read: EAX-like sound effects on all platforms/hardware)
34- Better support for widescreen (and arbitrary display resolutions)
35- A portable build system based on CMake
36- (Cross-)compilation with MinGW-w64
37
38
39# GENERAL NOTES
40
41## Game data and patching
42
43This source release does not contain any game data, the game data is still
44covered by the original EULA and must be obeyed as usual.
45
46You must patch the game to the latest version (1.3.1). See the FAQ for details, including
47how to get the game data from Steam on Linux or OSX.
48
49Note that _Doom 3_ and _Doom 3: Resurrection of Evil_ are available from the Steam Store at
50
51http://store.steampowered.com/app/9050/
52
53http://store.steampowered.com/app/9070/
54
55You can also buy Steam keys at the Humble Store:
56
57https://www.humblebundle.com/store/p/doom3_storefront
58
59https://www.humblebundle.com/store/p/doom3_resofevil_storefront
60
61Note that neither Steam nor the Humble Store offer the *Resurrection of Evil* addon
62for German customers (or at least people with German IP adresses).
63
64## Compiling
65
66The build system is based on CMake: http://cmake.org/
67
68Required libraries are not part of the tree. These are:
69
70- zlib
71- libjpeg (v8)
72- libogg
73- libvorbis
74- libvorbisfile (may be part of libvorbis)
75- OpenAL (OpenAL Soft required, Creative's and Apple's versions are made of fail)
76- SDL v1.2 or 2.0 (2.0 recommended)
77- libcurl (optional, required for server downloads)
78
79For UNIX-like systems, these libraries need to be installed (including the
80developer files). It is recommended to use the software management tools of
81your OS (apt, dnf, portage, BSD ports, [Homebrew for macOS](http://brew.sh), ...).
82
83For Windows, there are two options:
84
85- Use the provided binaries (recommended, see below)
86- Compile these libraries yourself
87
88Create a distinct build folder outside of this source repository and issue
89the cmake command there, pointing it at the neo/ folder from this repository:
90
91`cmake /path/to/repository/neo`
92
93macOS users need to point CMake at OpenAL Soft (better solutions welcome):
94
95`cmake -DOPENAL_LIBRARY=/usr/local/opt/openal-soft/lib/libopenal.dylib -DOPENAL_INCLUDE_DIR=/usr/local/opt/openal-soft/include /path/to/repository/neo`
96
97## Using the provided Windows binaries
98
99Get a clone of the latest binaries here: https://github.com/dhewm/dhewm3-libs
100
101There are two subfolders:
102
103- 32-bit binaries are located in `i686-w64-mingw32`
104- 64-bit binaries are located in `x86_64-w64-mingw32`
105
106Issue the appropriate command from the build folder, for example:
107
108`cmake -G "Visual Studio 10" -DDHEWM3LIBS=/path/to/dhewm3-libs/i686-w64-mingw32 /path/to/repository/neo`
109
110`cmake -G "MinGW Makefiles" -DDHEWM3LIBS=/path/to/dhewm3-libs/x86_64-w64-mingw32 /path/to/repository/neo`
111
112The binaries are compatible with MinGW-w64 and all MSVC versions.
113
114## Cross-compiling
115
116For cross-compiling, a CMake Toolchain file is required.
117
118For the MinGW-w64 toolchain `i686-w64-mingw32` on Ubuntu 12.04, it looks like:
119
120```
121set(CMAKE_SYSTEM_NAME Windows)
122set(CMAKE_SYSTEM_PROCESSOR i686)
123
124set(CMAKE_C_COMPILER i686-w64-mingw32-gcc)
125set(CMAKE_CXX_COMPILER i686-w64-mingw32-g++)
126set(CMAKE_RC_COMPILER i686-w64-mingw32-windres)
127
128set(CMAKE_FIND_ROOT_PATH /usr/i686-w64-mingw32)
129
130set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
131set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
132set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
133```
134
135Then point CMake at your toolchain file:
136`cmake -DCMAKE_TOOLCHAIN_FILE=/path/to/Toolchain.cmake -DDHEWM3LIBS=/path/to/dhewm3-libs/i686-w64-mingw32 /path/to/repository/neo`
137
138If you want to build for x86_64 aka AMD64 aka x64, replace all instances of `i686`
139in the toolchain file with `x86_64`.
140
141## Back End Rendering of Stencil Shadows
142
143The Doom 3 GPL source code release **did** not include functionality enabling rendering
144of stencil shadows via the "depth fail" method, a functionality commonly known as
145"Carmack's Reverse".
146It has been restored in dhewm3 1.5.1 after Creative Labs' [patent](https://patents.google.com/patent/US6384822B1/en)
147finally expired.
148
149Note that this did not change the visual appearance of the game, and didn't seem to
150make a noticeable performance difference (on halfway-recent hardware) either.
151
152## MayaImport
153
154The code for our Maya export plugin is included, if you are a Maya licensee
155you can obtain the SDK from Autodesk.
156
157
158# LICENSE
159
160See COPYING.txt for the GNU GENERAL PUBLIC LICENSE
161
162ADDITIONAL TERMS: The Doom 3 GPL Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU GPL which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
163
164EXCLUDED CODE: The code described below and contained in the Doom 3 GPL Source Code release is not part of the Program covered by the GPL and is expressly excluded from its terms. You are solely responsible for obtaining from the copyright holder a license for such code and complying with the applicable license terms.
165
166## PropTree
167
168neo/tools/common/PropTree/*
169
170Copyright (C) 1998-2001 Scott Ramsay
171
172sramsay@gonavi.com
173
174http://www.gonavi.com
175
176This material is provided "as is", with absolutely no warranty expressed
177or implied. Any use is at your own risk.
178
179Permission to use or copy this software for any purpose is hereby granted
180without fee, provided the above notices are retained on all copies.
181Permission to modify the code and to distribute modified code is granted,
182provided the above notices are retained, and a notice that the code was
183modified is included with the above copyright notice.
184
185If you use this code, drop me an email. I'd like to know if you find the code
186useful.
187
188## Base64 implementation
189
190neo/idlib/Base64.cpp
191
192Copyright (c) 1996 Lars Wirzenius. All rights reserved.
193
194June 14 2003: TTimo <ttimo@idsoftware.com>
195
196modified + endian bug fixes
197
198http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=197039
199
200Redistribution and use in source and binary forms, with or without
201modification, are permitted provided that the following conditions
202are met:
203
2041. Redistributions of source code must retain the above copyright
205 notice, this list of conditions and the following disclaimer.
206
2072. Redistributions in binary form must reproduce the above copyright
208 notice, this list of conditions and the following disclaimer in the
209 documentation and/or other materials provided with the distribution.
210
211THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
212IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
213WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
214DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
215INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
216(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
217SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
218HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
219STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
220ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
221POSSIBILITY OF SUCH DAMAGE.
222
223
224## IO on .zip files using minizip
225
226src/framework/minizip/*
227
228Copyright (C) 1998-2010 Gilles Vollant (minizip) ( http://www.winimage.com/zLibDll/minizip.html )
229
230Modifications of Unzip for Zip64
231Copyright (C) 2007-2008 Even Rouault
232
233Modifications for Zip64 support
234Copyright (C) 2009-2010 Mathias Svensson ( http://result42.com )
235
236This software is provided 'as-is', without any express or implied
237warranty. In no event will the authors be held liable for any damages
238arising from the use of this software.
239
240Permission is granted to anyone to use this software for any purpose,
241including commercial applications, and to alter it and redistribute it
242freely, subject to the following restrictions:
243
2441. The origin of this software must not be misrepresented; you must not
245 claim that you wrote the original software. If you use this software
246 in a product, an acknowledgment in the product documentation would be
247 appreciated but is not required.
2482. Altered source versions must be plainly marked as such, and must not be
249 misrepresented as being the original software.
2503. This notice may not be removed or altered from any source distribution.
251
252## MD4 Message-Digest Algorithm
253
254neo/idlib/hashing/MD4.cpp
255
256Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
257rights reserved.
258
259License to copy and use this software is granted provided that it
260is identified as the "RSA Data Security, Inc. MD4 Message-Digest
261Algorithm" in all material mentioning or referencing this software
262or this function.
263
264License is also granted to make and use derivative works provided
265that such works are identified as "derived from the RSA Data
266Security, Inc. MD4 Message-Digest Algorithm" in all material
267mentioning or referencing the derived work.
268
269RSA Data Security, Inc. makes no representations concerning either
270the merchantability of this software or the suitability of this
271software for any particular purpose. It is provided "as is"
272without express or implied warranty of any kind.
273
274These notices must be retained in any copies of any part of this
275documentation and/or software.
276
277## MD5 Message-Digest Algorithm
278
279neo/idlib/hashing/MD5.cpp
280
281This code implements the MD5 message-digest algorithm.
282The algorithm is due to Ron Rivest. This code was
283written by Colin Plumb in 1993, no copyright is claimed.
284This code is in the public domain; do with it what you wish.
285
286## CRC32 Checksum
287
288neo/idlib/hashing/CRC32.cpp
289
290Copyright (C) 1995-1998 Mark Adler
291
292## Brandelf utility
293
294neo/sys/linux/setup/brandelf.c
295
296Copyright (c) 1996 Søren Schmidt
297All rights reserved.
298
299Redistribution and use in source and binary forms, with or without
300modification, are permitted provided that the following conditions
301are met:
3021. Redistributions of source code must retain the above copyright
303 notice, this list of conditions and the following disclaimer
304 in this position and unchanged.
3052. Redistributions in binary form must reproduce the above copyright
306 notice, this list of conditions and the following disclaimer in the
307 documentation and/or other materials provided with the distribution.
3083. The name of the author may not be used to endorse or promote products
309 derived from this software withough specific prior written permission
310
311THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
312IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
313OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
314IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
315INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
316NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
317DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
318THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
319(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
320THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
321
322$FreeBSD: src/usr.bin/brandelf/brandelf.c,v 1.16 2000/07/02 03:34:08 imp Exp $
323
324## makeself - Make self-extractable archives on Unix
325
326neo/sys/linux/setup/makeself/*, neo/sys/linux/setup/makeself/README
327Copyright (c) Stéphane Peter
328Licensing: GPL v2
329