Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2025-04-10 19:15:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doom

Browse source
This commit is contained in:
laz 2025-02-11 14:22:08 +01:00
parent 924247269f
commit e3124ea517
2 changed files with 48 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
wiki-rtd/docs/wiki_engine_guides/gzdoom/extract-doom-wads.md
View file

@ -76,18 +76,17 @@ The main game folder contains the following (Master Levels in one wad and Legacy
| Legacy of Rust | id Software, Nightdive Studios, MachineGames | `ID1.WAD`, `ID1-WEAP.WAD`, `ID1-RES.WAD`, `ID24RES.WAD`, `IDDM1.WAD` | Uses the new ID24 Standard|
### KEX Engine - Getting the downloaded bnetwads
### KEX Engine - Getting the Downloaded bnetwads
**Prerequisite:** You first need to download the addons from the featured mods list.
**Prerequisite:** First, download the addons from the featured mods list.
Go from the `Main Menu` -> Select a game like DOOM II -> `Mods Menu` -> `Featured Mods`
Navigate from the `Main Menu` -> Select a game like DOOM II -> `Mods Menu` -> `Featured Mods`.
Some of the mods you will also need to click on `Mods Menu` -> `Browse` and search for them if they are no longer on the `Featured Mods`
list to match the Unity set.
For some mods, you may need to click on `Mods Menu` -> `Browse` and search for them if they are no longer on the `Featured Mods` list to match the Unity Version set.
#### Where are the bnetwads located?
Each `.wad` downloaded have it's own sub-folder based on an internal ID and contains the `.wad` file and a `index.json` file.
Each `.wad` downloaded has its own sub-folder based on an internal ID and contains the .wad file and an `index.json` file.
Opening the `index.json` file in each folder will tell you what game the `.wad` is.

95
wiki-rtd/docs/wiki_engine_guides/gzdoom/retrodeck-doomfile.md
View file

@ -2,13 +2,13 @@
<img src="../../../wiki_images/logos/gzdoom-logo.png" width="150">
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.
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.
## The RetroDECK .doom Parser
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>
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.
Here is what files it is currently looking for:
Here are the files it is currently looking for:
```
IWAD_FILES=("DOOM1.WAD" "DOOM.WAD" "DOOM2.WAD" "DOOM2F.WAD" "DOOM64.WAD" "TNT.WAD"
@ -20,94 +20,89 @@ IWAD_FILES=("DOOM1.WAD" "DOOM.WAD" "DOOM2.WAD" "DOOM2F.WAD" "DOOM64.WAD" "TNT.WA
```
## Recommended folder structure in retrodeck/roms/doom
## Recommended Folder Structure in retrodeck/roms/doom
- It does not really matter where the files are under `/roms/doom/` the parser will scan all files and subfolders.
- Make sure you don't have any files that share the same filename in any subfolder under `/roms/doom/`.
- You make whatever structure you feel comfortable with or use our example.
- 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.
**Example two folder structure:**
### Example two folder structure
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.
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.
---
`/retrodeck/roms/doom/iwads/`
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.
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.
---
`/retrodeck/roms/doom/mods/`
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.
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.
---
`/retrodeck/roms/doom/`
In the root of the `roms/doom/` folder put all the `.doom` files you will create or download.
In the root of the roms/doom/ folder, place all the `.doom` files you create or download.
---
Result
**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.
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.
## 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.
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.
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.
Each line represents one file. As long as the mods are compatible with each other, you can add as many lines as you want.
**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.
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.
### What is the recommended load order of mods the .doom file?
### What is the recommended load order of mods in the .doom file?
The general guidelines on most mod pages is:
The general guidelines on most mod pages are:
- Map WAD (Like DOOM2.WAD or DOOM.WAD).
- Map WAD (like DOOM2.WAD or DOOM.WAD).
- Bigger mods like Project Brutality.
- Any other mini-mods like huds, graphics or other tweaks.
- 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.
However, this can vary, so check where you download the mods for any recommended order requirements.
### 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.
### Questio - I come from one of the ELEC's what does RetroDECK do different with the .doom file, can I migrate?
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.
## Project Brutality .doom example:
In this example you have already downloaded a bunch of mods and have the iwads already somewhere under the `/retrodeck/roms/doom/` folder.
In this example, you have already downloaded a bunch of mods and have the IWADs 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/`.
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
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.
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
@ -122,12 +117,9 @@ 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.
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.
For example, you might want to have Project Brutality with DOOM and DOOM 2 as separate entries in the ES-DE interface.
`Project Brutality DOOM 2.doom`
@ -143,8 +135,7 @@ 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:
If you want to add more minor mods to Project Brutality, just keep adding the lines with the mod file names, like this example:
`Project Brutality - But with Horses.doom`
@ -155,27 +146,27 @@ horse_armor.pk3
pinkgui.pk3
```
Be sure to name the .doom files so you understand what it is and you are done:
Be sure to name the `.doom` files so you understand what they are:
- `Project Brutality - The Ultimate Collection.doom`
- `Project Brutality - But with Horses.doom`
- `Project Brutality - Chex Quest with a Vengeance.doom`
It is that easy.
It's that easy!
**Sharing is caring**
## Sharing is Caring
Have you made a cool `.doom` file modpack?
- 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!
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!
## Adding .doom files to Steam as seperate games
## Adding .doom Files to Steam as Separate Games
<img src="../../../wiki_images/systems/srm/brutaldoom.png" width="800">
You can use the built in `Steam Sync` function to add .doom files as seperate games in Steam with art.
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.
**Check the:**