Build custom WADs for embedding in a Doom 64 ROM.

This program works by merging custom resources into the base game resources to create a new N64-compatible IWAD. Thus, an original copy of the game ROM is required to use it. All known commercial versions of the N64 ROM are supported. Data files from the 2020 remaster by Nightdive can also be used.

Install Rust, check out the repository to a folder, then run cargo in the folder:

cargo install --path .

d64make --help
# inspect data in a ROM or IWAD
d64make inspect ROM_OR_IWAD
# extract ROM or IWAD into editable PC formats
d64make extract ROM_OR_IWAD -o OUT_DIR
# build PC format data into N64 format WAD
d64make build WORK_DIR -o path/to/DOOM64.WAD

It's recommended to use the data from the 2020 remaster due to its higher quality sound files.

To simplify workflows, d64make only supports reading/merging WADs that are already in the N64 data format. It does not support WADs in the PC Doom format. To merge in custom resources, d64make can load and extract individual assets from a directory tree or ZIP/PK3 file with a specific structure.

d64make extract /path/to/DOOM64.WAD -o ./mymod

d64make is able to extract resources from the original data files and convert assets back into the N64 formats. It will output four data files that can be used to build the Doom 64 sources:

# Resources stored in folder
d64make build ./mymod -o /path/to/DOOM64-RE/data/
# Resources stored in PK3 file
d64make build ./mymod.pk3 -o /path/to/DOOM64-RE/data/

Adding new resources has some limitations.

• Sprites larger than 15 tiles require support with a patch or the RSP will overflow and crash the game (a tile is each scanline-rounded 2kb portion of the image to fit in TMEM, thus the number of tiles in an image is roughly ceil(height / floor(2048 / width)) )
• Some WAD entry names can contain characters that are disallowed in Windows file paths. For now, when extracting entries on Windows, ? will be replaced with @ and \ will be replaced with ^. The reverse replacement will always be applied when building a WAD.
• Adding more sounds and music increases the size of the audio tables and thus requires increasing the audio heap size to prevent heap overflow. Effects and music are both triggered in the game by a sequence number. These numbers must be unique. The extracted files include them as SFX_###.WAV and MUS_###.WAV. New effects and music should have names in this format starting from one after the last number (117 for the base game)
• Maps must be in native N64 format. Map conversion is currently outside the scope of this tool.
• The order of textures and flats is significant since maps uses indexes instead of names. Textures and flats used by the base game will automatically have their order preserved when building a WAD. New textures and flats will be sorted by name and placed after all the base resources.
• Extra soundfonts will all be merged together into the WMD file. The MIDI program and bank numbers are used directly by any MIDI songs you provide. MIDI programs 0-53 are used by the base game so make sure any extra instruments come after this and compose your MIDI songs accordingly. This does mean that General MIDI-compatible soundfonts will conflict with the base game instruments.