mirror of
https://github.com/RetroDECK/Wiki.git
synced 2024-11-23 22:25:41 +00:00
152 lines
4.9 KiB
Markdown
152 lines
4.9 KiB
Markdown
# The RetroDECK .doom file
|
|
|
|
The RetroDECK `.doom` file is a feature for easy loading of doom files with mods.
|
|
|
|
## The RetroDECK .doom Parser
|
|
|
|
The `.doom` parser will look for any of the `CORE IWADS` files that could be required to run a DOOM mod in the `/retrodeck/roms/doom/` directory.<br>
|
|
|
|
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"
|
|
)
|
|
```
|
|
|
|
|
|
## Recommended folder structure in retrodeck/roms/doom
|
|
|
|
It does not really matter where the files are under the `/retrodeck/roms/doom/` folder, the parser will scan all files and subfolders. But you need to make sure you don't have any files called the same thing in the folder structure. You make what ever structure you feel comfortable with or use our example:
|
|
|
|
**Example Structure:**
|
|
|
|
A good structure can be to separate the core iwads and mods into two separate folders.
|
|
|
|
---
|
|
|
|
`/retrodeck/roms/doom/core_iwads`
|
|
|
|
Here you can put all the official files core `IWAD_FILES=( )` made by ID/Bethesda and their partners that the parser users, like the full versions of doom: `DOOM.WAD`, `DOOM2.WAD`
|
|
|
|
---
|
|
|
|
`/retrodeck/roms/doom/mods`
|
|
|
|
Here you put all the extracted mod files like Project Brutality's `PB_Staging_9f2561c.pk3` file and other mods. By putting them all into one folder and no more subfolders you can make sure you are not having any duplicates of files that have the same file name.
|
|
|
|
---
|
|
|
|
`/retrodeck/roms/doom/`
|
|
|
|
In the root of the `roms/doom/` folder put all the `.doom` files you will create or download. When you launch the ES-DE interface from RetroDECK and navigate to DOOM category, the first thing that you will be listed are just the `.doom` files and the two folders.
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
### What is the recommended load order of mods the .doom file?
|
|
|
|
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.
|
|
|
|
## Project Brutality .doom example:
|
|
|
|
In this example you have already downloaded a bunch of mods and have the core doom iwads already somewhere under the `/retrodeck/roms/doom/` folder.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
`Project Brutality.doom` is accessible from the ES-DE interface.
|
|
|
|
|
|
### 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
|
|
|
|
You can customize the `.doom` how you wish with the above examples as a guideline.<br>
|
|
|
|
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>
|
|
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
|
|
```
|
|
|
|
Be sure to name the .doom files so you understand what it is and you are done:
|
|
|
|
- `Project Brutality - The Ultimate Collection.doom`
|
|
- `Project Brutality - But with Horses.doom`
|
|
- `Project Brutality - Chex Quest with a Vengeance.doom`
|
|
|
|
It is that easy.
|
|
|
|
## 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!
|