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

175 lines
5.7 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
2024-03-14 21:10:17 +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
2024-03-14 21:10:17 +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.<br>
2024-03-10 17:26:18 +00:00
Here is what files it is currently looking for:
```
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
2024-03-12 18:44:11 +00:00
## Recommended folder structure in retrodeck/roms/doom
2024-03-12 20:49:14 +00:00
- It does not really matter where the files are under `/roms/doom/` the parser will scan all files and subfolders.
2024-03-12 21:01:21 +00:00
- Make sure you don't have any files that share the same filename in any subfolder under `/roms/doom/`.
2024-03-12 20:49:14 +00:00
- You make whatever structure you feel comfortable with or use our example.
2024-03-12 18:44:11 +00:00
2024-03-12 20:49:14 +00:00
**Example two folder structure:**
2024-03-12 18:44:11 +00:00
2024-03-12 20:49:14 +00:00
In this example we are making two folders under the `/roms/doom/` folder, with the goal of just 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
2024-03-14 21:10:17 +00:00
In the `iwads` folder you can put one or all of the official files game wads made by ID Software/Bethesda their addons and/or freedom 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
2024-03-12 20:49:14 +00:00
In the `mods` folder you can put all the extracted mod files. By putting them all into one folder and no subfolders you easily make sure you have no duplicate files as they would be in conflict.
2024-03-12 18:44:11 +00:00
---
`/retrodeck/roms/doom/`
2024-03-12 20:49:14 +00:00
In the root of the `roms/doom/` folder put all the `.doom` files you will create or download.
---
Result
When you launch the ES-DE interface from RetroDECK and navigate to 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 subfolder.
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?
The `.doom` file is just an empty text file that is populated with the exact filenames of the files you want to load and in what order from top to bottom.
You should name the `.doom` file so you understand what it is, for example: `Project Brutality.doom`.
Each line represent one file, as long as the mods are compatible with each other you can add how lines as you want.
2024-03-15 16:05:44 +00:00
**NOTE: No spaces in mod file names**
The parser does not allow spaces currently in the mod files so if your modfile is called for example `PB Staging 9f2561c.pk3` rename it to `PB_Staging_9f2561c.pk3` with `_` instead of spaces.
2024-03-10 17:32:22 +00:00
### What is the recommended load order of mods the .doom file?
2024-03-10 17:26:18 +00:00
The general guidelines on most mod pages is:
- Map WAD (Like DOOM2.WAD or DOOM.WAD).
- Bigger mods like Project Brutality.
- Any other mini-mods like huds, graphics or other tweaks.
But this can be different, check the where you download the mods if they have any recommended order requirement.
2024-03-15 16:05:44 +00:00
### I come from one of the ELEC's what does RetroDECK do different with the .doom file, can I migrate?
RetroDECK have 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/` only 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.
2024-03-10 17:26:18 +00:00
## Project Brutality .doom example:
2024-03-15 16:05:44 +00:00
2024-03-15 15:14:37 +00:00
---
2024-03-14 21:10:17 +00:00
In this example you have already downloaded a bunch of mods and have the iwads already 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.
All you need to do is create an empty file called `Project Brutality.doom` in `/retrodeck/roms/doom/`.
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.
2024-03-15 15:14:37 +00:00
2024-03-10 17:26:18 +00:00
So in the case of `Project Brutality.doom`
The contents will look like this
```
DOOM2.WAD
PB_Staging_9f2561c.pk3
```
The DOOM2.WAD is first loaded then the Project Brutality PB_Staging_9f2561c.pk3 file and the game starts.
2024-03-10 18:19:02 +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
2024-03-10 17:32:22 +00:00
You can customize the `.doom` how you wish with the above examples as a guideline.<br>
2024-03-10 17:26:18 +00:00
There is nothing stopping you from adding more mods or create an infinite amount of `.doom` files.
Maybe you want to have Project Brutality with DOOM and Doom 2 as separate entries in the ES-DE interface.
`Project Brutality DOOM 2.doom`
```
DOOM2.WAD
PB_Staging_9f2561c.pk3
```
`Project Brutality DOOM.doom`
```
DOOM.WAD
PB_Staging_9f2561c.pk3
```
Want to have more minor mods into Project Brutality?<br>
2024-03-10 17:32:22 +00:00
Just keep adding the lines with the mod file names how many you want like this fake example:
`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
2024-03-10 17:32:22 +00:00
Be sure to name the .doom files so you understand what it is and you are done:
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`
It is that easy.
2024-03-10 18:31:28 +00:00
## Sharing is caring
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!