===========================================================================
Archive Maintainer      : This is intended to replace previous versions.
                          This is the final release.
Update to               : smm4doom.zip
Advanced engine needed  : ZDoom, GZDoom or Zandronum
Primary purpose         : Mirrored monster death animations
===========================================================================
Title                   : Simple Mirrored Monsters
Filename                : smm4doom.zip
Release date            : February 2017 (Updated: August 2017, March 2018)
Author                  : Coldiron
Email Address           : [redacted]
Other Files By Author   : Simple Pistol Starter (pstlstrt.zip)
Description             : Update: The supported Freedoom version has
                          been updated for Freedoom v0.11 and higher.  
                          (For more info, see "As for "colorized" blood:"
                          and "UPDATE:" below.)

                          New update: Support for "Commander Keen" and
                          "Wolfenstein SS" monsters in Doom and Freedoom
                          has been moved to separate ".pk3" files.
                          (See "NEW UPDATE:" below.)

                          This is a mod that provides mirrored death
                          animations for Doom and several other IWADs.

                          It also provides colorized blood for Doom,
                          Freedoom, Hacx, and several Doom megawads.

                          It makes no changes to gameplay at all in the
                          IWADs or megawads that the included files are
                          compatible with.

                          Usage is simple: Load only one of these files,
                          and load it after whatever WADs you want to use.

                          Files other than the one for Doom can be found in
                          the "extras" folder.

                          For Doom or Doom megawads use the "Doom" file,
                          unless a specific file is provided for that WAD.

                          Hacx, Heretic, Hexen and Strife have their own
                          files for mirrored death animations as well.

                          If a WAD includes custom monsters it will not
                          work as intended unless a compatible version
                          of one of these files is used with it.

                          This is a list of the included files:

                          (IWAD) Doom:                      smm4doom.pk3
                          (IWAD) Freedoom:                  smm4frdm.pk3
                          (IWAD) Hacx:                      smm4hacx.pk3
                          (IWAD) Heretic:                   smm4hrtc.pk3
                          (IWAD) Hexen:                     smm4hxen.pk3
                          (IWAD) Strife:                    smm4strf.pk3
                          (Mod)  Ancient Aliens:            smm4aans.pk3
                          (Mod)  Bloodstain:                smm4blds.pk3
                          (Mod)  Elf Gets Pissed:           smm4efgp.pk3
                          (Mod)  Resurgence:                smm4rsrg.pk3
                          (Mod)  Scythe 2:                  smm4scy2.pk3
                          (Mod)  Strange Aeons:             smm4stas.pk3
                          (Mod)  Valiant: (also Sawdust)    smm4valt.pk3

                          Death animations and corpses have a chance of
                          being flipped horizontally, or "mirrored".

                          This allows for visual variety after clearing
                          out a horde of monsters.

                          Additionally, in Hexen "Poison Mushrooms" can
                          flip after bursting, and in Strife both wooden
                          and explosive barrels can flip when destroyed.

                          Hexen's "Ice" deaths can flip, as can Strife's
                          "Fire" and "Disintegration" deaths.

                          All monsters can "flip", with a few exceptions:

                          In Doom: Pain Elementals
                          (to prevent changes to release of Lost Souls;
                          the monster and its death animation are too
                          symmetrical to need flipping, anyway)

                          In Heretic: D'Sparil
                          (final boss; mirroring unnecessary, potential
                          to break scripting)

                          In Hexen: All bosses

                          In Strife: All bosses, including the Inquisitor
                          (the Inquisitor drops an arm when destroyed,
                          this is done using a "Restricted Function" and
                          cannot be mirrored; to flip the corpse would only
                          highlight this, so it isn't flipped either)

                          In Elf Gets Pissed: The Annabis

                          In Strange Aeons: All bosses, and others
                          (the "Starspawn", the "Spidergods" and
                          Leng Spiderlings, due to issues with using
                          "A_SetScale" on them; A_SetScale is used in
                          DECORATE to change their visible sprite size
                          in-game, using it to "flip" them must also
                          reset their "size" so they cannot be shown as
                          the correct size AND be mirrored, sadly)

                          As for "colorized" blood:

                          In Doom: Cacodemons have blue blood,
                          Hell Knights and Barons have green blood,
                          Spectres have matching "fuzzy" red blood,
                          and Lost Souls don't bleed.

                          In Freedoom: All monsters bleed red, except for
                          "Deadflares" and "Summoners", which don't bleed.
                          The "Stealth Worms" have fuzzy blood.

                          In Hacx: Thorn Things have green blood.

                          In Ancient Aliens: "Stealth Alien Troopers"
                          have purple blood.

                          In Valiant: Cacodemons bleed blue, Spectres have
                          fuzzy blood, and Lost Souls have no blood, but
                          all other monsters bleed red.

                          (Note: Crushed corpses will automatically match
                          their new blood colors, but that is actually
                          a feature of the ZDoom engine, not this mod.)

                          As for other mods, these are not intended for use
                          with mods like Brutal Doom, Beautiful Doom, etc.

                          Those mods provide more extensive alternatives
                          to the functions of this mod, which is intended
                          only to provide a light enhancement to the game.

                          This mod is fully compatible with Revenant100's
                          "Doom 2 Minor Sprite Fixing Project" and
                          "Heretic Minor Sprite Fixing Project":

                          Load the files for either of those, then a
                          megawad if desired, then this mod's matched file.
                          (if you also want to use NightFright's
                          "gzd_brightmaps142.pk3" put it after the sprite fix)

                          A suggested loading order:

                          "Optional megawad of your choosing"
                          D1SPFX19.WAD  or  D2SPFX19.WAD  or  HRSPFX10.WAD
                          D1DEHFIX.DEH  or  D2DEHFIX.DEH (not with Heretic)
                          gzd_brightmaps142.pk3
                          "A matching file from this mod"
                          "Only with Heretic sprite fix: HRWIDE10.WAD"

                          BONUS:

                          Also included in the "bonus" folder is an
                          alternative to the main versions of this mod:

                          "Simple Colored Blood" which only includes the
                          changes to blood colors in Doom, Freedoom, Hacx,
                          Ancient Aliens, and Valiant.

                          To use these, just load one of them instead of
                          their "main version" counterparts.

                          File list:

                          (IWAD) Doom:                      scb4doom.pk3
                          (IWAD) Freedoom:                  scb4frdm.pk3
                          (IWAD) Hacx:                      scb4hacx.pk3
                          (Mod)  Ancient Aliens:            scb4aans.pk3
                          (Mod)  Valiant: (also Sawdust)    scb4valt.pk3

                          UPDATE:

                          In the "old" folder the original .pk3 files for
                          versions of Freedoom before v0.11 are included.

                          With those: "Flesh Worms" bleed yellow,
                          and "Stealth Worms" bleed "fuzzy" yellow.

                          "Pain Bringers" have tan blood to match
                          their color-scheme while "Pain Lords" have white.

                          "Deadflares" and "Summoners" do not bleed.

                          NEW UPDATE: (March 2018)

                          Support for Keens and Nazis has been moved to
                          separate "-kn" files: "smm4doom-kn.pk3" and
                          "smm4frdm-kn.pk3" to improve compatibility.

                          Certain megawads such as Moonblood among others
                          replace one or both of these monsters with new
                          ones, which this mod would previously break.

                          For example: Moonblood's final boss replaces the
                          Wolfenstein SS, and since this mod did that also
                          the boss would become glitched.

                          This mod is now fully compatible with Moonblood,
                          so long as the "-kn" file is not used.

                          Also, in Freedoom the "Keen" replacement doesn't
                          bleed anymore.

Credits                 : This mod was inspired by some of the features of
                          the Doom source port "Crispy Doom", but was made
                          "from scratch" and not actually copied from it.

                          This mod couldn't have been made without info
                          from the ZDoom Wiki: https://zdoom.org/wiki/
===========================================================================
* What is included *

New levels              : None
Sounds                  : No
Music                   : No
Graphics                : No
Dehacked/BEX Patch      : No
Demos                   : No
Other                   : DECORATE
Other files required    : Depends on versions selected


* Play Information *

Game                    : Doom, Doom 2, Final Doom, Freedoom, Hacx,
                          Heretic, Hexen, and Strife
Single Player           : Designed for
Cooperative 2-4 Player  : Designed for
Deathmatch 2-4 Player   : Designed for
Difficulty Settings     : Yes


* Construction *

Base                    : New from scratch
Build Time              : ~3 months (on and off) with later updates
Editor(s) used          : SLADE
Known Bugs              : None
May Not Run With        : Any mod that alters monsters without a compatible
                          version of this one.
Tested With             : ZDoom, GZDoom and Zandronum


* Copyright / Permissions *

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
International License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/4.0/

You are free to copy and redistribute the material in any medium or format;
and remix, transform, and build upon the material for any purpose, even
commercially. If you do so, you must give appropriate credit, provide a link
to the license, and indicate if changes were made. You may do so in any
reasonable manner, but not in any way that suggests the licensor endorses you
or your use. If you remix, transform, or build upon the material, you must
distribute your contributions under the same license as the original.

* Where to get the file that this text file describes *

The Usual: ftp://archives.gamers.org/pub/idgames/ and mirrors
