1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
# This is Woof!
[](https://github.com/fabiangreffrath/woof)
[](https://github.com/fabiangreffrath/woof)
[](https://github.com/fabiangreffrath/woof)
[](https://github.com/fabiangreffrath/woof/blob/master/COPYING.md)
[](https://github.com/fabiangreffrath/woof/releases/latest)
[](https://github.com/fabiangreffrath/woof/releases/latest)
[](https://github.com/fabiangreffrath/woof/releases/latest)
[](https://github.com/fabiangreffrath/woof/releases/latest)
[](https://github.com/fabiangreffrath/woof/commits/master)
[](https://github.com/fabiangreffrath/woof/commits/master)
[](https://github.com/fabiangreffrath/woof/actions/workflows/main.yml)
Woof! is a continuation of Lee Killough's Doom source port MBF targeted at modern systems.
## Synopsis
[MBF](https://doomwiki.org/wiki/MBF) stands for "Marine's Best Friend" and is widely regarded as the successor of the Boom source port by TeamTNT.
It serves as the code base for popular Doom source ports such as [PrBoom+](https://github.com/coelckers/prboom-plus)/[DSDA-Doom](https://github.com/kraflab/dsda-doom) or [The Eternity Engine](https://github.com/team-eternity/eternity).
As the original engine was limited to run only under MS-DOS, it has been ported to Windows by Team Eternity under the name [WinMBF](https://github.com/team-eternity/WinMBF) in 2004.
Woof! is developed based on the WinMBF code with the aim to make MBF more widely available and convenient to use on modern systems.
To achieve this goal, this source port is less strict regarding its faithfulness to the original MBF.
It is focused on quality-of-life enhancements, bug fixes and compatibility improvements.
However, all changes have been introduced in good faith that they are in line with the original author's intentions and even for the trained eye, this source port should still look very familiar to the original MBF.
In summary, this project's goal is to fast-forward `MBF.EXE` from DOS to 21st century and remove all the stumbling blocks on the way.
Furthermore, just as MBF was ahead of its time, this project dedicates itself to early adoption of new modding features such as [DEHEXTRA](https://doomwiki.org/wiki/DEHEXTRA)+[DSDHacked](https://doomwiki.org/wiki/DSDHacked), [UMAPINFO](https://doomwiki.org/wiki/UMAPINFO) and [MBF21](https://doomwiki.org/wiki/MBF21).
## What's with the name?
If you turn the [Doom logo upside down](https://www.reddit.com/r/Doom/comments/8476cr/i_would_so_olay_wood/) it reads "Wood" - which would be a pretty stupid name for a source port.
"Woof" is just as stupid a name for a source port, but at least it contains a reference to dogs - and dogs are the *Marine's Best Friend*. :wink:
# Key features
* Arbitrary resolutions up to native display resolution with dynamic resolution scaling (DRS) to automatically change the internal resolution to maintain a target framerate.
* Widescreen rendering with proper support for widescreen assets.
* Rendering with uncapped frame rate and frame interpolation.
* Adjustable field of view (FOV).
* Support for voxels in KVX format.
* 3D audio, supporting stereo and up to 7.1 surround sound with an optional HRTF mode, as well as PC speaker emulation.
* Several music backends: native MIDI, FluidSynth with a bundled soundfont, built-in OPL3 emulator. Digital music and sound formats supported by libsndfile, module music supported by libxmp.
* [Modern gamepad support](https://github.com/fabiangreffrath/woof/wiki/Gamepad) featuring rumble, gyro, flick stick, custom weapon slots, and full control of sensitivities, response curves, and deadzones.
* Mouselook.
* Autoload directories.
* Savegame backward compatibility up to `MBF.EXE`.
* Integration of the Chocolate Doom network code.
* Compatibility levels: "Vanilla", "Boom", "MBF" and "MBF21" (default).
## Capabilities
* Support for extended nodes in uncompressed XNOD or XGLN and compressed ZNOD or ZGLN formats, and DeePBSP format.
* Integration of the NanoBSP node builder (enforce with `-bsp`) for maps without nodes or with unsupported nodes (not demo compatible).
* Tall textures and sprites in DeePsea format.
* Unlimited extra states, sprites, mobjtypes and sounds for use in Dehacked patches (supporting the "DEHEXTRA" and "DSDHacked" specs).
* In-game music changing using MUSINFO.
* UMAPINFO support, compliant to Rev 2.2 of the [spec](https://github.com/kraflab/umapinfo).
* MBF21 compatibility level, compliant to Rev 1.4 of the [spec](https://github.com/kraflab/mbf21).
* Support for PNG graphics.
* SMMU-style swirling animated flats.
## Usage
* [Cheat Codes](https://github.com/fabiangreffrath/woof/wiki/Cheats)
* [Command Line Parameters](https://github.com/fabiangreffrath/woof/wiki/Command-Line-Parameters)
# Releases
Source code, Windows binaries (MSVC builds for Windows 7 and newer) and Linux AppImages for the latest release can be found on the [Release](https://github.com/fabiangreffrath/woof/releases/latest) page.
The most recent list of changes can be found in the current [Changelog](https://github.com/fabiangreffrath/woof/blob/master/CHANGELOG.md).
# Compiling
The Woof! source code is available at GitHub: <https://github.com/fabiangreffrath/woof>.
It can be cloned via
```
git clone https://github.com/fabiangreffrath/woof.git
```
## Linux, and Windows with MSYS2
The following build system and libraries need to be installed:
* [CMake](https://cmake.org) (>= 3.15)
* [SDL2](https://github.com/libsdl-org/SDL/tree/SDL2) (>= 2.0.18)
* [SDL2_net](https://github.com/libsdl-org/SDL_net)
* [openal-soft](https://github.com/kcat/openal-soft) (>= 1.22.0 for PC Speaker emulation)
* [libsndfile](https://github.com/libsndfile/libsndfile) (>= 1.1.0 for MPEG support)
* [libebur128](https://github.com/jiixyj/libebur128) (>= 1.2.0)
* [yyjson](https://github.com/ibireme/yyjson) (>= 0.10.0, optional)
* [fluidsynth](https://github.com/FluidSynth/fluidsynth) (>= 2.2.0, optional)
* [libxmp](https://github.com/libxmp/libxmp) (optional)
Usually your distribution should have the corresponding packages in its repositories, and if your distribution has "dev" versions of those libraries, those are the ones you'll need.
Once installed, compilation should be as simple as:
```
cd woof
mkdir build; cd build
cmake ..
make
```
After successful compilation the resulting binary can be found in the `src/` directory.
## Windows with Visual Studio
Visual Studio 2019 and [VSCode](https://code.visualstudio.com/) comes with built-in support for CMake by opening the source tree as a folder.
Install vcpkg <https://github.com/Microsoft/vcpkg#quick-start-windows>. Integrate it into CMake or use toolchain file:
```
cd woof
cmake -B build -DCMAKE_TOOLCHAIN_FILE="[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
cmake --build build
```
CMake will automatically download and build all dependencies for you.
# Contact
The canonical homepage for Woof! is <https://github.com/fabiangreffrath/woof>.
Woof! is maintained by [Fabian Greffrath](mailto:fabian@greffXremovethisXrath.com).
Please report any bugs, glitches or crashes that you encounter to the GitHub [Issue Tracker](https://github.com/fabiangreffrath/woof/issues).
## Acknowledgement
MBF has always been a special Doom source port for me, as it taught me how to implement 640x400 resolution rendering which was the base for my own source port project [Crispy Doom](https://github.com/fabiangreffrath/crispy-doom).
As the original MBF was limited to run only under MS-DOS, I used its pure port WinMBF by Team Eternity to study and debug the code.
Over time, I got increasingly frustrated that the code would only compile and run on 32-bit systems and still use the meanwhile outdated SDL-1 libraries.
This is how this project was born.
Many additions and improvements to this source port were taken from fraggle's [Chocolate Doom](https://www.chocolate-doom.org/wiki/index.php/Chocolate_Doom), taking advantage of its exceptional portability, accuracy and compatibility. Further sources of inspiration are [PrBoom+](https://github.com/coelckers/prboom-plus), [DSDA-Doom](https://github.com/kraflab/dsda-doom) and [The Eternity Engine](https://github.com/team-eternity/eternity).
Special thanks to @rfomin and @ceski-1 for implementing the more advanced features of this port, and @JNechaevsky and @MrAlaux for helping to port back some useful features from their own source port projects!
# Legalese
Files: `*`
Copyright:
© 1993-1996 Id Software, Inc.;
© 1993-2008 Raven Software;
© 1999 by id Software, Chi Hoang, Lee Killough, Jim Flynn, Rand Phares, Ty Halderman;
© 1999-2004 by Jess Haas, Nicolas Kalkhof, Colin Phipps, Florian Schulze;
© 2004 James Haley;
© 2005-2006 by Florian Schulze, Colin Phipps, Neil Stevens, Andrey Budko;
© 2005-2018 Simon Howard;
© 2006 Ben Ryves;
© 2007-2011 Moritz "Ripper" Kroll;
© 2008-2019 Simon Judd;
© 2017 Christoph Oelckers;
© 2020 Alex Mayfield;
© 2020-2024 Fabian Greffrath;
© 2020-2024 Roman Fomin;
© 2021-2022 Ryan Krafnick;
© 2022-2024 Alaux;
© 2022-2024 ceski;
© 2023 Andrew Apted;
© 2023 liPillON;
© 2025 Guilherme Miranda.
License: [GPL-2.0+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
Files: `src/i_flickstick.*, src/i_gyro.*`
Copyright:
© 2018-2021 Julian "Jibb" Smart;
© 2021-2024 Nicolas Lessard;
© 2024 ceski.
License: [MIT](https://opensource.org/licenses/MIT)
Files: `src/nano_bsp.*`
Copyright:
© 2023 Andrew Apted.
License: [MIT](https://opensource.org/licenses/MIT)
Files: `src/m_scanner.*`
Copyright:
© 2015 Braden "Blzut3" Obrzut.
License: [BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)
Files: `src/v_flextran.*`
Copyright:
© 2013 James Haley et al.;
© 1998-2012 Marisa Heit.
License: [GPL-3.0+](https://www.gnu.org/licenses/gpl-3.0)
Files: `src/v_video.*`
Copyright:
© 1999 by id Software, Chi Hoang, Lee Killough, Jim Flynn, Rand Phares, Ty Halderman;
© 2013 James Haley et al.
License: [GPL-3.0+](https://www.gnu.org/licenses/gpl-3.0)
Files: `base/all-all/sprites/pls*, man/simplecpp`
Copyright:
© 2001-2019 Contributors to the Freedoom project.
License: [BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)
Files: `base/all-all/dsdg*, base/all-all/sprites/dog*`
Copyright:
© 2017 Nash Muhandes;
© apolloaiello;
© TobiasKosmos.
License: [CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/) and [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/)
Files: `base/all-all/sbardef.lmp`
Copyright:
© 2024 Ethan Watson.
License: [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/)
Files: `base/all-all/dmxopl.op2`
Copyright:
© 2017 Shannon Freeman.
License: [MIT](https://github.com/sneakernets/DMXOPL/blob/DMXOPL3/LICENSE)
Files: `cmake/FindSDL2.cmake, cmake/FindSDL2_net.cmake`
Copyright:
© 2018 Alex Mayfield.
License: [BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)
Files: `base/all-all/sm*.png, data/setup.ico, data/woof-setup.png, data/woof.ico, data/woof.png, setup/setup_icon.c, src/icon.c`
Copyright:
© 2020-2024 Julia Nechaevskaya.
License: [CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/)
Files: `data/io.github.fabiangreffrath.woof.metainfo.*`
Copyright:
© 2023-2024 Fabian Greffrath.
License: [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/)
Files: `opl/*`
Copyright:
© 2005-2014 Simon Howard;
© 2013-2018 Alexey Khokholov (Nuke.YKT).
License: [GPL-2.0+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
Files: `soundfonts/TimGM6mb.sf2`
Copyright:
© 2004 Tim Brechbill;
© 2010 David Bolton.
License: [GPL-2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
Files: `textscreen/*`
Copyright:
© 1993-1996 Id Software, Inc.;
© 2002-2004 The DOSBox Team;
© 2005-2017 Simon Howard.
License: [GPL-2.0+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
Files: `third-party/md5/*`
License: public-domain
Files: `third-party/miniz/*`
Copyright:
© 2010-2014 Rich Geldreich and Tenacious Software LLC;
© 2013-2014 RAD Game Tools and Valve Software.
License: [MIT](https://opensource.org/licenses/MIT)
Files: `third-party/pffft/*`
Copyright:
© 2004 The University Corporation for Atmospheric Research ("UCAR");
© 2013 Julien Pommier.
License: [FFTPACK License](https://bitbucket.org/jpommier/pffft/src/master/pffft.h)
Files: `third-party/sha1/*`
Copyright:
© 1998-2001 Free Software Foundation, Inc.;
© 2005-2014 Simon Howard.
License: [GPL-2.0+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
Files: `third-party/spng/*`
Copyright:
© 2018-2023 Randy.
License: [BSD-2-Clause](https://opensource.org/license/bsd-2-clause)
Files: `third-party/yyjson/*`
Copyright:
© 2020 YaoYuan.
License: [MIT](https://opensource.org/licenses/MIT)
Files: `win32/win_opendir.*`
Copyright:
© 2019 win32ports.
License: [MIT](https://opensource.org/licenses/MIT)
|
