Doom Addon ZIP Integration (DAZI) for RetroPie

RapidEdwin08 · 28 Mar 2022, 18:37

D00M Addon ZIP Integration (DAZI)

Integration of D00M-M0D ZIP/7z files into RetroPie.
Includes D00M M0D Loader Menu that can be Launched from anywhere or Installed.
Additionally make use of the Runcommand Launch Menu to Pre-Load D00M M0Ds.
Press [A] to Configure -> EXIT WITHOUT LAUNCHING to Pre-Load One or MORE D00M M0Ds.
Additionally Manage [srb2] and [srb2kart] AddOns along with D00M M0Ds.

Before you get started:
A D00M P0RT such as lzdoom lr-prboom prboom-plus should be INSTALLED
Place your [M0D].ZIP/PK3/PK7 Files in: ~/RetroPie/roms/ports/doom/mods/*

HOW DOES IT WORK?
DAZI will Extract [ZIPs] [7z] Files and Load [M0Ds] into Doom [AddOnDIRs]

LZDOOM:
[lzdoom-addon] Loads M0Ds from ADDON [..roms/ports/doom/addon/]
[lzdoom-dazi] Loads M0Ds from TMPFS [/dev/shm/addon/]
[lzdoom-dazi+] Loads M0Ds from BOTH [TMPFS+ADDON] in that 0rder
[lzdoom-dazi+warp] Loads from [TMPFS+ADDON] and Includes [-WARP -SKILL]
PRBOOM-PLUS:
[prboom-plus] Loads M0Ds from [..configs/prboom-plus/autoload/doom-all]
[prboom-plus+warp] Loads from [../doom-all] and Includes [-WARP -SKILL]
LR-PRBOOM:
[lr-prboom] Loads M0Ds based on the Config File [DOOMWADDIR/prboom.cfg]
DAZI can AutoGenerate a [prboom.cfg] based on [addonDIR] when Installed

INSTALLATION

Can be ran from retropiemenu:

wget https://raw.githubusercontent.com/RapidEdwin08/dazi/main/lzdoom-dazi.sh -P ~/RetroPie/retropiemenu
wget https://raw.githubusercontent.com/RapidEdwin08/dazi/main/lzdoom-dazi.png -P ~/RetroPie/retropiemenu/icons

0R Run Manually from any directory:

cd ~
git clone --depth 1 https://github.com/RapidEdwin08/dazi.git
sudo chmod 755 ~/dazi/lzdoom-dazi.sh
cd ~/dazi && ./lzdoom-dazi.sh

Screenshots here:

Videos of Install and how to Load M0Ds here:

ExarKunIv · 28 Mar 2022, 20:01

@RapidEdwin08 very cool. i will have to give this a try. i was hoping someone who knows more at programming might come up with something, just like this

RapidEdwin08 · 28 Mar 2022, 20:30

@ExarKunIv Thanks.
And THANKs for the all the great work you do maintaining extras/P0RTS.

I forgot to mention the obvious, that lzdoom should be installed before using this...

ExarKunIv · 28 Mar 2022, 21:11

@RapidEdwin08 said in Doom Addon ZIP Integration (DAZI) for RetroPie:

And THANKs for the all the great work you do maintaining extras/P0RTS.

Thank you im trying my best to keep up with everything and getting them up to the current format, but things have changed from when i learned how to make scripts to what RP uses now. So i have to reteach myself again how to do it. lol

RapidEdwin08 · 29 Mar 2022, 03:34

Some last minute changes have been applied to the lzdoom-dazi.sh installer script:
Changed [home/pi] references to [home/$USER]
Accommodated for multiple addon- entries

NIGHTKILLER05 · 29 Mar 2022, 09:44

I dreamed with something like this, thank you !!! just one question, ¿is it possible to modify the runcommand menu to 1) launch a game 2) Press A to enter runcommand menu 3)select one or more mods in a list 3)Exit the runcommand menu launching the game with that mods activated?

Thank you again man, this is great !!!

RapidEdwin08 · 11 May 2022, 18:54

@NIGHTKILLER05 said in Doom Addon ZIP Integration (DAZI) for RetroPie:

¿is it possible to modify the runcommand menu to 1) launch a game 2) Press A to enter runcommand menu 3)select one or more mods in a list 3)Exit the runcommand menu launching the game with that mods activated?

I'm not sure about modifying the actual runcommand script maintained by RetroPie, but a Menu to select M0Ds is a Great Idea.

I'm currently working on a Menu driven script to Load M0D.ZIPs.
At the moment I have it set to always Run before the runcommand Menu is Launched IF the $Emulator is lzdoom.

Still need some more testing and tweaking, but here are some screenshots of the what I have so far:

Due to the Space Limitation on some HW with tmpfs, I plan on accommodating for multiple zdoom AddOn Locations:
~/RetroPie/roms/ports/doom/addon
/dev/shm/addons

Subject to change and open to suggestions and recommendations...

RapidEdwin08 · 13 May 2022, 02:45

DAZI v2022.05 Released.

[dazi-mod-loader] Menu is the New Feature worth mentioning.
Brings easy method to Add and Remove M0Ds.
Extracts ZIP/zip Files, and Supports Loading other pk3/pk7 files.

First crack at the Mod Menu here...
The scripts could use some cleaning up, but the functionality is there.

Feel free to report any issues here.

NIGHTKILLER05 · 18 May 2022, 01:24

@RapidEdwin08 Amazing, let me test (and enjoy!) it, thank you man, this is my dream came true!!!!

RapidEdwin08 · 20 May 2022, 13:05

Last minute cleaning and changes to script made after the 202205 release mentioned above.
dazi-template now supports loading any number of mods.
ZIPs still get extracted, but all other file types now get symbolic links
Automated Numeric 0rder for M0Ds in templates + mod-loader menu
Traversing Sub-Directories now supported in mod-loader menu
Mod-loader is now independent; no need to install dazi unless you want it to load @runncommand.

You can identify the latest version inside the menu/template by 2022.05 instead of 202205.

RapidEdwin08 · 1 Jun 2022, 23:03

DAZI v2022.06 Released.
Added [srb2] AddOns Manager.
Documentation updates.

The [srb2] AddOns Manager Simply applies CUSTOM AddOns Directory to the srb2.cfg files.
[srb2] AddOns Are Technically D00M M0Ds After All...

NIGHTKILLER05 · 6 Jul 2022, 01:58

Hey, I already try it DAZI and it's amazing!! great, really really great work, thank you.

I have 2 suggestions, if that's possible:

-When you create a zip file, it would bea good option if I can include one or more .txt files to know the details of the mod/mapset (I would read the file from WinSCP for example, without the need to search for it at the internet, in case I want to know more from the mod itself, there are many "DOOM/HEXEN/HERETIC" RPG mods that need those files to learn the basis, or weapon mods in what we need to know hot to use them), and DAZI could ommit that file extension from the list of files to load. Another workaround could be put those .txt or .rtf or .mhtml in a folder inside the .zip and DAZI would ommit folders as if they don't exist or something like that.

-You could add and optional (I repetat, optional) way to automatically delete the loaded/used mods located at "/dev/shm/addon" after I exit the game in order to have a clean list in the next game to load, currently I have to select a game, wait for the [dazi-mod-loader], and then check if there are any mods already loaded, erase them, and then select another set of mods and play the game.

I hope you'll find that suggestions useful, and thank you again.

RapidEdwin08 · 6 Jul 2022, 14:30

@NIGHTKILLER05 Thanks for the Feedback!

Are you using the DAZI Template sh for your D00M.sh's? It removes and recreates the addon folder already after it's finished.

Edit: actually I might like the idea of moving the addon clean up out of the template.sh and into the runcommand_onEnd.sh. Will try it out...

The template.sh can also load as many M0Ds as you want.
I let the Template.sh do all the work because you don't need to create an emulators.cfg for each custom M0D anymore. Just modify each doom.sh as needed.

As for 0mitting TXT files, anything is possible, but is it really needed? I never encountered an issue with loading them using the wildcard * in LZDoom.

NIGHTKILLER05 · 9 Jun 2022, 15:50

@RapidEdwin08 I think it would be useful to offer the option (something that anyone can choose to on/off) to ommit certain extensions, like .txt/.rtf/.html/.doc files, to avoid the clutter in the list of mods/maps in [dazi-mod-loader] when someone is loading and sorting mods/maps order.

By the way, there are certain maps that replaces doom episodes, one good example is the mapset "Back to Basics" which replaces the second eposide of Ultimate Doom, ¿Would It be possible to add an option or file to choose the starting map? (like the "-map mapname" cli command, but with a feature built in DAZI.

Again, thank for such great program.

NIGHTKILLER05 · 9 Jun 2022, 15:51

@RapidEdwin08 Oh, the template.sh worked great, by the way, thank you.

NIGHTKILLER05 · 15 Jun 2022, 21:30

I have been downloading PWADs like crazy, and It's thanks to you man, hey could you add the option to let the user choose the "default MODs folder" in which DAZI will initially search, please please please? currently is "/home/pi/RetroPie/roms/ports/doom/mods", but I need to put mods, maps and addons from several games, not only Doom.

By the way, It is normal that I can't use folder names with spaces for my mod/maps/Pwads?

Thank you again for such great add to any RetroPie.

RapidEdwin08 · 15 Jun 2022, 22:06

@NIGHTKILLER05 said in Doom Addon ZIP Integration (DAZI) for RetroPie:

I have been downloading PWADs like crazy, and It's thanks to you man, hey could you add the option to let the user choose the "default MODs folder" in which DAZI will initially search, please please please? currently is "/home/pi/RetroPie/roms/ports/doom/mods", but I need to put mods, maps and addons from several games, not only Doom.

No need, subdirectories are supported. I sorted mine like you mentioned, maps, mods, tcs, ect...
Just make sure it's all in doom/mods
Are you sure you're using latest version? 2022.06
If you're not sure, just redownload and reinstall...

By the way, It is normal that I can't use folder names with spaces for my mod/maps/Pwads?

Yep, I'm pretty sure it's due to using the LZDoom wildcard * to load.
Best to avoid SPACES and Special characters if possible.

RapidEdwin08 · 7 Mar 2022, 15:37

DAZI v2022.07 Released.

M0D Loader Menu can now Read/Display [.TXT] [.txt] Files.
[DAZI-template.sh] now Dynamically Updates M0D#'s based on AddOn Directory content.
AddOn Directory Clean Up MOVED from [dazi-template.sh] to [runcommand-onend].
Added Config [runcommand-onstart/runcommand-onend] 0ptions to Script Menu.
Changed [runcommand] Settings to be Triggered by [doom] P0RT Instead of [lzdoom] Emulator.
Added [lzdoom-dazi+] for Loading M0Ds from BOTH AddOn Locations.
Added Select Alternate M0D Directory for Current Session Feature.
Added Configurable [alternateM0Ddir=] to 0verride DEFAULT M0D Directory (0ptional+Manual).
Documentation Updates and Cleaning.

NIGHTKILLER05 · 3 Jul 2022, 13:56

That updates sounds great man, THANK YOU !!!!! I'll update the script tonight !!!!!!!

NIGHTKILLER05 · 3 Jul 2022, 20:04

@RapidEdwin08 hey man I am checking the update, and I only have a couple of doubts:

-Where inside the Doom Loader menu can I read certain TXT files? my update menu looks like this:

-When you said "[DAZI-template.sh] now Dynamically Updates M0D#'s based on AddOn Directory content", do you mean that now I don't need to list in incremenal order the mods I want to apply or something?

And again, thank you.