SZ-Doom engine

----------------------------------------
* SZ-Doom: a Custom GZ Doom Experience
----------------------------------------
[Aims]
* improve first time user experience.
* include, and often create, documentation, examples, etc
* Provide variety using official content only. (vanilla+ sprinkles)
* To be able to run doom as close to original as a playthrough
* To also be able to run a modern doom experience.
* provide instructions on creating a DOOM -PERFECT wad experience {WiP}.
^^ those things every users wants/ does, needs etc.

[INSTRUCTIONS]:
* This is a pre-installed setup for benefit of mainly new users
^^ it can help everyone though or intermediate-advanced users could contribute...

[STEP 1]
* Place folder where you want and edit any .bat files needed:
"\SZ-Doom\Help\bat\...."

[STEP 2]
* Navigate to this FOLDER:
.\SZ-Doom\Apps\bsdiff_v4.3

* Place doom.wad in this folder
* Apply Patches 1-3 In order using bsdiff/patch to Doom.wad version 1.9 Ultimate:
* Doing this (in the correct order- with the correct wad) allows users to use the Doom Adlib Audio Project Music (.mp3) and have the perfect doom.wad (almost - maybe not perfect yet)

It will do the foolowing:
* Clean wad
* RMBv3 -PERFECT Nodes
* GLNodes
* Sprite Fixes
* Extra Maps
* Sw#sBack
* Map Fixes
* Add .mp3 Music from The Doom Addlib Audio Project

[STEP 3]
* WHEN YOU HAVE THE FILE COMPLETE
* ADD IT TO THE FILE HERE:
.\SZ-Doom\Mods\TKBS \"TKBS_DOOM1.pk3"

[Note]:
* THIS is as close as you can get to legal distribution of these types of files, not that people care, based on MODDb contents and various, if not all doom related forums.

[The Music]
* IF users only want the music (no other .wad changes) simply extract the files using slade from the final result. Put them in a wad (D1MUSMP3.wad) and add it to the launch options (the "-file D1MUSMP3.wad" commands)
* .wav versions are too big to create a single patch, it would require approximately 10 more stages of patching 1-2 files at a time to convert the contents from .mp3 to .wav
// There is not enough interest in my stuff for me to do it- i spent a disgusting amount of time and money i don't have (hours and hours) just putting the files in a folder (this pack) to release SZ-Doom in a legit pro way - and that doesn't even consider making the actual contents.

----------------------------
Example; doom".bat" file:
----------------------------
.\SZ-Doom\szdoom.exe -iwad DOOM.wad -file TKBS_Doom1.pk3 TKBS_AmbientCreatures.pk3 TKBS_Bridges.pk3 TKBS_Commands.pk3 TKBS_LevelFX.pk3 TKBS_Monsters.pk3 TKBS_DoomMusic-mp3.pk3 TKBS_PCS_Sound.pk3 TKBS_Pickups.pk3 TKBS_SkyPack.pk3 TKBS_Weapons.pk3 TKBS_MENU.pk3 COMPAT01.wad -deh ALL999.DEH

---------
//note
---------
"TKBS_DoomMusic-mp3.pk3" can be removed if you have made the wad from the patches and merged it into "TKBS_Doom1.pk3"

----------------------------------------
* How to Make a Custom GZ Doom Experience
----------------------------------------
0. The Doom.wad
1. The engine Settings
2. Mods
3. Distribution

* The easiest way to run Doom with Multiple mods is;
a) Reference Folders in the gzdoom.ini
- you may have to add several folder/ file paths.
b) use a ".Bat" script to load them using the command "-file ".
c) then create shortcut to the ".bat"

[create your perfect Doom 1 (doom.wad) and Doom 2 doom2.wad]:
- see \SZ-Doom\Help\HOW TO\ - "Doom -PERFECT.txt" notes.

[Create mini-mods as .wad or .pk3 files]
- can reduce and nmerge as much as possible in a .pk3
- new code, commands, menu system etc
- new sky textures pack
- new items, pickups, add monster variety etc
- add variety using official content and maps

------------------------------------
Setup: A new version
------------------------------------

0. Install gzdoom whatever version
// If compiling from source- see the "SRC"/ "Source" folder.

1. Create a BLANK ini file : "gzdoom_portable.ini"
- (see help\ini folder for example)
* Run GZ-Doom and it will auto-populate the default config settings into the blank ini.
..i usually just run it and it generates an ini

2. edit ini file
* add wads directory (doom.wad)
* add files directory (-file stuff.pk3)
* add sounds directory (audio .cfg)
// if you have an exisiting one- it may be portable between versions, new options should auto generate if they exist...but i would not recommend it: do it manually -

3. run gz doom
configure In-Game settings & save.

4. Create batch script to load wads and mods etc
*then Create shortcut to run the bat script
*add to the doom-launcher.xml

5. add an autoexec.cfg to run common settings on startup.
* see example included here.

Startup:
* When using GZ-Doom with extra files they load from left to right.
* With each file over-riding the one before
* Using -warp command will break mods. especially menu systems.

NOTE:
* By Default Config is stored; (unless Config present in the GZ-Doom dir.)
"C:\Users\****\Documents\My Games\GZDoom"
or saved games folder....

----------------------------
Shortcut Examples:
----------------------------
Use directory:
zdoom -iwad doom2.wad -file mydirectory
e.g;
# C:\Games\Doom\Doom_GZ\gzdoom.exe -file Data
# C:\Games\Doom\Doom_GZ\gzdoom.exe -file ./Data
# C:\Games\GZ-Doom\gzdoom.exe -iwad doom2.wad -FILE MYCUSTOMDATAFOLDER
# x:\...\gzdoom.exe Doom -file .\WADs\JPTR_V40.WAD JPTR_FIX.WAD MyINVULN.pk3 DDogs.pk3

Use File: e.g;
# C:\Games\GZ-Doom\gzdoom.exe -iwad doom2.wad -DEH InfiniteAmmo.DEH
# C:\Games\GZ-Doom\gzdoom.exe -iwad doom2.wad -file NERVE.wad shotgunsound.wav

----------------------------
Shortcut Examples: using -dmflags
----------------------------
* Make a shortcut of gzdoom.exe, right click on it, then click on properties.

In the target field, add the following:
"+set dmflags 131072" to enable jumping,
"+set dmflags 8388608" to enable crouching
"+set dmflags 8519680" to enable jumping AND crouching.

* dmflags can also be changed in the settings menu also.

[Notes]:
* Some mods may require specific builds of gzdoom for compatibility (zscript etc)
* This Mini Kit needs work, but it is much better than the default experience.
* users need several versions of gzdoom if they want to play mods, for compatibility.
* normal users will not be able to compile source code - so don't bother, none of the versions i tried compile, it is a fucking waste of time and money.
* gzdoom will never improve - the authors seem to only care that it works ontheir pc, and doesn;t give a shit about documentation, or releasing source code that actually works. The are little to no benefits to many of the versions, just random unneeded shit - hence why so may other sourceports pop up every year becuase their code base actually works and compiles an users can use it..
* i see people trying to automate too much.
* users should learn to be happy with typing xxx.pk3 and getting the order correct, it is a pain in the ass but it ensures compatibility and helps users learn the content