Nugget Doom

Nugget Doom is a source port of Doom forked from Woof!, simply intended to implement additional features.

Note: this README and the rest of documentation are updated on a per-commit basis, meaning that they may not correspond to the latest release of Nugget Doom. If you're seeking information on the version you're using, please refer to the documentation included with it.

The build corresponding to this documentation is based on Woof! 16.0.0.

DISCLAIMER

Although the new code has been written with the intention of not breaking demo compatibility, it has not been thoroughly tested yet. RECORD DEMOS AT YOUR OWN RISK!

Main Features

• True-color Lighting
• Extra Gibbing setting, to force gibbing under certain conditions
• Bloodier Gibbing setting
• Support for high-resolution sprites between HI_START/HI_END markers
• Smart Autoaim setting
• Move Over/Under Things setting
• Hitbox-based Hitscan Collision setting
• Tag Finder from PrBoomX
• Sprite Shadows setting
• Radial Fog setting
• Thing Lighting Mode setting
• Slow Motion button
• Button to Teleport to automap pointer
• Freecam
• Flip Levels setting
• Milestone-Completion Announcements setting
• Bobbing Style setting
• Night-Vision Visor Effect setting
• Auto Save Interval setting, for periodic auto saves
• Damage Tint Cap and Bonus Tint Cap, to attenuate or disable said screen tinting
• Jumping and Crouching
• Message Lines settings, allowing a message list
• NUGHUD, an alternative lump for HUD customization (see docs/nughud.md)
• Extended custom skill
• Most of Crispy Doom's accessibility settings
• Support for weapon voxel models
• Support for SSG in Doom 1
• New cheats, such as:
  • FULLCLIP for infinite ammo
  • VALIANT for fast weapons
  • GIBBERS to force gibbing on dying enemies
  • RIOTMODE cheat, to make enemies attack all sentient entities
  • SUMMON to spawn an actor based on its type index
  • IDDF to find a key in the automap
  • MDK to perform a hitscan attack of 1-million damage
  • SAITAMA to enable the MDK Fist
  • BOOMCAN for explosive hitscan attacks
  • TURBO to change the player speed in-game

See FEATURES.md for more information.

Releases

Source code and Windows binaries (MSVC builds for Windows 7 and newer) for the latest release can be found on the Release page.

The changes currently in progress since the latest release can be found in the Changelog.

A complete history of changes and releases can be found on the Releases page.

Versioning

Nugget Doom follows a fairly simple (albeit arbitrary) X.Y.Z versioning system:

• X is increased in the event of major implementations, as were arbitrary/dynamic resolution and voxel support;
• Y is increased in the event of minor implementations, such as a new cheat;
• Z is increased in the event of bug fixes or text/code reformatting.

Incrementing any of the first values will reset the latter (i.e. a major change to 1.1.2 would shift it to 2.0.0).

The merging of changes from Woof! releases may affect any of the version values, but not necessarily in the same way as Woof!'s own version (i.e. Woof! 11.Y.Z -> 12.Y.Z doesn't necessarily mean Nugget 2.Y.Z -> 3.Y.Z).

Compiling

Building with vcpkg (Recommended - All Platforms)

Install vcpkg https://github.com/Microsoft/vcpkg?tab=readme-ov-file#get-started.

 git clone https://github.com/Microsoft/vcpkg.git
 cd vcpkg
 ./bootstrap-vcpkg.sh  # Unix/macOS
 # or
 .\bootstrap-vcpkg.bat  # Windows
 cd ..

Clone the Nugget-Doom repository:

 git clone https://github.com/MrAlaux/Nugget-Doom.git

Run the CMake configuration:

 cd Nugget-Doom
 cmake -B build -DCMAKE_TOOLCHAIN_FILE="[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"

During this step, vcpkg will build all the dependencies.

Finally, build the project:

 cmake --build build

After successful compilation, the executable will be available in the build/src directory.

Linux, and Windows with MSYS2

The following build system and libraries need to be installed:

• CMake (>= 3.15)
• SDL3 (>= 3.4.0)
• openal-soft (>= 1.22.0 for PC Speaker emulation)
• libsndfile (>= 1.1.0 for MPEG support, optional)
• yyjson (>= 0.10.0, optional)
• fluidsynth (>= 2.2.0, optional)
• libebur128 (optional)
• libxmp (optional)
• libspng (optional)
• discord-rpc (optional)

Usually your distribution should have the corresponding packages in its repositories. If "development" ("dev") versions of these libraries are available, make sure to install them.

Once installed, clone the Nugget-Doom repository, run the CMake configuration and build the project:

 git clone https://github.com/MrAlaux/Nugget-Doom.git
 cd Nugget-Doom
 cmake -B build
 cmake --build build

After successful compilation, the executable will be available in the build/src directory.

Contact

The homepage for Nugget Doom is https://github.com/MrAlaux/Nugget-Doom.

Please report any bugs, glitches or crashes that you encounter to the GitHub Issue Tracker.

Acknowledgements

Help was provided by:

• atsb (a.k.a. Gibbon)
• Ayba
• Brad Harding
• ceski
• Fabian Greffrath
• Korp
• melak47
• Mikolah
• Roman Fomin (a.k.a. rfomin)
• Ryan Krafnick (a.k.a. kraflab)

Thanks to all of you!

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;
© 2006-2025 by The Odamex Team;
© 2007-2011 Moritz "Ripper" Kroll;
© 2008-2019 Simon Judd;
© 2013-2025 Brad Harding;
© 2017 Christoph Oelckers;
© 2020 Alex Mayfield;
© 2020 Ethan Watson;
© 2020 JadingTsunami;
© 2020-2026 Fabian Greffrath;
© 2020-2026 Roman Fomin;
© 2021-2022 Ryan Krafnick;
© 2021-2026 Alaux;
© 2022 Julia Nechaevskaya;
© 2022-2025 ceski;
© 2023 Andrew Apted;
© 2023 liPillON;
© 2024 pvictress;
© 2025-2026 Guilherme Miranda.
License: GPL-2.0+

Files: src/i_flickstick.*, src/i_gyro.*
Copyright:
© 2018-2021 Julian "Jibb" Smart;
© 2021-2024 Nicolas Lessard;
© 2024 ceski.
License: MIT

Files: src/nano_bsp.*
Copyright:
© 2023 Andrew Apted.
License: MIT

Files: src/m_scanner.*
Copyright:
© 2015 Braden "Blzut3" Obrzut.
License: BSD-3-Clause

Files: src/r_srgb.*
Copyright:
© 2017 Project Nayuki.
License: MIT

Files: src/v_flextran.*
Copyright:
© 2013 James Haley et al.;
© 1998-2012 Marisa Heit.
License: 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+

Files: base/all-all/sprites/pls*, man/simplecpp
Copyright:
© 2001-2019 Contributors to the Freedoom project.
License: BSD-3-Clause

Files: base/all-all/sprites/ngcha0.png, base/all-all/sprites/ngcla0.png, base/all-all/sprites/ngtr*0.png
Copyright:
© 2023-2024 Korp.
License: CC BY-SA 4.0

Files: base/all-all/dsdg*, base/all-all/sprites/dog*
Copyright:
© 2017 Nash Muhandes;
© apolloaiello;
© TobiasKosmos.
License: CC-BY-3.0 and CC0-1.0

Files: base/all-all/sprites/bon*
Copyright:
© 2026 Amaruq Wulfe.
License: CC-BY-3.0

Files: base/all-all/sbardef.lmp
Copyright:
© 2024 Ethan Watson.
License: CC0-1.0

Files: base/all-all/dmxopl.op2
Copyright:
© 2017 Shannon Freeman.
License: MIT

Files: base/all-all/sm*.png
Copyright:
© 2024 Julia Nechaevskaya.
License: CC-BY-3.0

Files: base/id1.wad/sm*.png
Copyright:
© 2026 DragonKnightKX.
License: CC-BY-3.0

Files: data/nugget-doom.ico, data/nugget-doom.png, src/icon.c, data/setup.ico, data/nugget-doom-setup.png, setup/setup_icon.c
Copyright:
© 2022 Korp.
License: CC BY-SA 4.0

Files: data/io.github.MrAlaux.Nugget-Doom.metainfo.*
Copyright:
© 2023-2024 Fabian Greffrath.
License: CC0-1.0

Files: opl/*
Copyright:
© 2005-2014 Simon Howard;
© 2013-2018 Alexey Khokholov (Nuke.YKT);
© 2026 Tony Gies.
License: GPL-2.0+

Files: soundfonts/TimGM6mb.sf2
Copyright:
© 2004 Tim Brechbill;
© 2010 David Bolton.
License: GPL-2.0

Files: textscreen/*
Copyright:
© 1993-1996 Id Software, Inc.;
© 2002-2004 The DOSBox Team;
© 2005-2017 Simon Howard.
License: GPL-2.0+

Files: textscreen/fonts/hauge-8x18-v1-6.png
Copyright:
© 2025 Zokum.
License: CC BY-SA

Files: netlib/*
Copyright:
© 1997-2025 Sam Lantinga;
© 2012 Simeon Maxein.
License: zlib

Files: third-party/libebur128/*
Copyright:
© 2011 Jan Kokemüller.
License: MIT

Files: third-party/base64/*
Copyright:
© 2002-2012 Jouni Malinen.
License: BSD-3-Clause

Files: third-party/md5/*
License: public-domain

Files: third-party/minimp3/*
Copyright:
© 2021 lief.
License: CC0-1.0

Files: third-party/miniz/*
Copyright:
© 2010-2014 Rich Geldreich and Tenacious Software LLC;
© 2013-2014 RAD Game Tools and Valve Software.
License: MIT

Files: third-party/pffft/*
Copyright:
© 2004 The University Corporation for Atmospheric Research ("UCAR");
© 2013 Julien Pommier.
License: FFTPACK License

Files: third-party/sha1/*
Copyright:
© 1998-2001 Free Software Foundation, Inc.;
© 2005-2014 Simon Howard.
License: GPL-2.0+

Files: third-party/spng/*
Copyright:
© 2018-2023 Randy.
License: BSD-2-Clause

Files: third-party/yyjson/*
Copyright:
© 2020 YaoYuan.
License: MIT