Wiki/wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md

175 lines
6.1 KiB
Markdown
Raw Normal View History

2024-03-14 21:10:17 +00:00
# The .doom file
2024-03-10 17:26:18 +00:00
2025-02-25 11:57:46 +00:00
<img src="../../../wiki_images/logos/gzdoom-logo.png" width="75">
2025-01-18 14:17:51 +00:00
2025-02-11 13:22:08 +00:00
The `.doom` file is a feature for easy loading of DOOM files with mods. It is based on the work done by [AmberELEC .doom](https://amberelec.org/systems/doom.html) and others, with additional improvements made by RetroDECK.
2024-03-10 17:26:18 +00:00
## The RetroDECK .doom Parser
2025-02-11 13:22:08 +00:00
The `.doom` parser will look for any of the iwads files that could be required to run a DOOM mod in the `retrodeck/roms/doom/` directory.
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
Here are the files it is currently looking for:
2024-03-10 17:26:18 +00:00
```
IWAD_FILES=("DOOM1.WAD" "DOOM.WAD" "DOOM2.WAD" "DOOM2F.WAD" "DOOM64.WAD" "TNT.WAD"
"PLUTONIA.WAD" "HERETIC1.WAD" "HERETIC.WAD" "HEXEN.WAD" "HEXDD.WAD"
"STRIFE0.WAD" "STRIFE1.WAD" "VOICES.WAD" "CHEX.WAD"
"CHEX3.WAD" "HACX.WAD" "freedoom1.wad" "freedoom2.wad" "freedm.wad"
"doom_complete.pk3"
)
```
2024-03-10 17:46:47 +00:00
2025-02-11 13:22:08 +00:00
## Recommended Folder Structure in retrodeck/roms/doom
2024-03-12 18:44:11 +00:00
2025-02-11 13:22:08 +00:00
- The parser will scan all files and subfolders under `/roms/doom/`, so the exact location of the files doesn't matter.
- Ensure that no files share the same filename in any subfolder under `/roms/doom/`.
- You can create any structure you feel comfortable with, or use the example below.
2024-03-12 18:44:11 +00:00
2025-02-11 13:22:08 +00:00
### Example two folder structure
2024-03-12 18:44:11 +00:00
2025-02-11 13:22:08 +00:00
In this example, we create two folders under the `/roms/doom/` folder, with the goal of using `.doom` files as the primary way to play DOOM games.
2024-03-12 18:44:11 +00:00
---
2024-03-14 21:10:17 +00:00
`/retrodeck/roms/doom/iwads/`
2024-03-12 18:44:11 +00:00
2025-02-11 13:22:08 +00:00
In the `iwads` folder, you can place one or all of the official game WADs made by ID Software/Bethesda, their addons, and/or Freedoom so they are not mixed up with the mods.
2024-03-12 18:44:11 +00:00
---
2024-03-12 20:49:14 +00:00
`/retrodeck/roms/doom/mods/`
2024-03-12 18:44:11 +00:00
2025-02-11 13:22:08 +00:00
In the `mods` folder, you can place all the extracted mod files. By putting them all into one folder and no subfolders, you can easily ensure there are no duplicate files that could cause conflicts.
2024-03-12 18:44:11 +00:00
---
`/retrodeck/roms/doom/`
2025-02-11 13:22:08 +00:00
In the root of the roms/doom/ folder, place all the `.doom` files you create or download.
2024-03-12 20:49:14 +00:00
---
2025-02-11 13:22:08 +00:00
**Result:**
2024-03-12 20:49:14 +00:00
2025-02-11 13:22:08 +00:00
When you launch the ES-DE interface from RetroDECK and navigate to the DOOM category, all the .doom files will be listed first as your primary game list, while the rest of the files are in their respective subfolders.
2024-03-12 18:44:11 +00:00
2024-03-10 17:26:18 +00:00
## What is the .doom file and how do you create it?
2025-02-11 13:22:08 +00:00
The `.doom`file is an empty file that lists the exact filenames of the files you want to load, in the order you want them to load, from top to bottom.
2024-03-10 17:26:18 +00:00
You should name the `.doom` file so you understand what it is, for example: `Project Brutality.doom`.
2025-02-11 13:22:08 +00:00
Each line represents one file. As long as the mods are compatible with each other, you can add as many lines as you want.
2024-03-10 17:26:18 +00:00
2024-03-15 16:05:44 +00:00
**NOTE: No spaces in mod file names**
2025-02-11 13:22:08 +00:00
The parser does not currently allow spaces in the mod files. If your mod file is called, for example, `PB Staging 9f2561c.pk3`, rename it to `PB_Staging_9f2561c.pk3` using underscores `_` instead of spaces.
2024-03-15 16:05:44 +00:00
2025-02-11 13:22:08 +00:00
### What is the recommended load order of mods in the .doom file?
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
The general guidelines on most mod pages are:
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
- Map WAD (like DOOM2.WAD or DOOM.WAD).
2024-03-10 17:26:18 +00:00
- Bigger mods like Project Brutality.
2025-02-11 13:22:08 +00:00
- Any other mini-mods like HUDs, graphics, or other tweaks.
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
However, this can vary, so check where you download the mods for any recommended order requirements.
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
### Questio - I come from one of the ELEC's what does RetroDECK do different with the .doom file, can I migrate?
2024-03-15 16:05:44 +00:00
2025-02-11 13:22:08 +00:00
RetroDECK has written a new parser from the ground up. You no longer need to write the path in the `.doom` files. RetroDECK scans all folders and subfolders of `/roms/doom/`, so you only need to put the name of the mod file. If you are migrating to RetroDECK, all you need to do is remove the path in your `.doom` files.
2025-01-18 14:17:51 +00:00
## Project Brutality .doom example:
2024-03-15 15:14:37 +00:00
2025-02-11 13:22:08 +00:00
In this example, you have already downloaded a bunch of mods and have the IWADs somewhere under the `retrodeck/roms/doom/` folder.
2024-03-10 17:26:18 +00:00
You want to play [Project Brutality](https://www.moddb.com/mods/project-brutality) on DOOM 2 levels.
2025-02-11 13:22:08 +00:00
All you need to do is create an empty file called `Project Brutality.doom` in `/retrodeck/roms/doom/`.
2024-03-10 17:26:18 +00:00
Each line the the file will be the order the mods are loaded, make each lines value is called exactly what the file name is called.
2025-02-11 13:22:08 +00:00
So in the case of `Project Brutality.doom`, the contents will look like this:
2024-03-10 17:26:18 +00:00
```
DOOM2.WAD
PB_Staging_9f2561c.pk3
```
2025-02-11 13:22:08 +00:00
The DOOM2.WAD is first loaded, then the Project Brutality PB_Staging_9f2561c.pk3 file, and the game starts.
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
Project Brutality.doom is accessible from the ES-DE interface.
2024-03-10 17:26:18 +00:00
### Another Example: Doom Infinite
[Doom Infinite](https://www.moddb.com/mods/doom-infinite)
Create the `Doom Infinite.doom` file in `/retrodeck/roms/doom/`
```
DOOM2.WAD
DOOM_Infinite_DEMO_0978_6.pk3
```
## Customize the RetroDECK .doom files
2025-02-11 13:22:08 +00:00
You can customize the `.doom` files as you wish, using the above examples as a guideline. There is nothing stopping you from adding more mods or creating an infinite number of .doom files.
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
For example, you might want to have Project Brutality with DOOM and DOOM 2 as separate entries in the ES-DE interface.
2024-03-10 17:26:18 +00:00
`Project Brutality DOOM 2.doom`
```
DOOM2.WAD
PB_Staging_9f2561c.pk3
```
`Project Brutality DOOM.doom`
```
DOOM.WAD
PB_Staging_9f2561c.pk3
```
2025-02-11 13:22:08 +00:00
If you want to add more minor mods to Project Brutality, just keep adding the lines with the mod file names, like this example:
2024-03-10 17:32:22 +00:00
`Project Brutality - But with Horses.doom`
```
doom_complete.pk3
PB_Staging_9f2561c.pk3
horse_armor.pk3
pinkgui.pk3
```
2024-03-10 17:26:18 +00:00
2025-02-11 13:22:08 +00:00
Be sure to name the `.doom` files so you understand what they are:
2024-03-10 17:26:18 +00:00
- `Project Brutality - The Ultimate Collection.doom`
- `Project Brutality - But with Horses.doom`
- `Project Brutality - Chex Quest with a Vengeance.doom`
2025-02-11 13:22:08 +00:00
It's that easy!
2024-03-10 18:31:28 +00:00
2025-02-11 13:22:08 +00:00
## Sharing is Caring
2024-03-10 18:31:28 +00:00
2025-02-11 13:22:08 +00:00
- Have you made a cool `.doom` file modpack?
- Maybe you have found the perfect combination of over 50+ mods in one .doom file?
- Share the .doom file and where to download the mods with the RetroDECK Community!
2024-03-10 18:31:28 +00:00
2025-02-11 13:22:08 +00:00
## Adding .doom Files to Steam as Separate Games
2025-01-24 08:05:28 +00:00
<img src="../../../wiki_images/systems/srm/brutaldoom.png" width="800">
2025-02-11 13:22:08 +00:00
You can use the built-in `Steam Sync` function to add .doom files as separate games in Steam with art.
Check the SRM Guide for more information.
2025-01-24 08:05:28 +00:00
**Check the:**
[SRM Guide](../../wiki_system_guides/srm/srm-guide.md) for more information.
2025-01-18 14:17:51 +00:00