----------------------------------------
         G'day... aJynks here...
----------------------------------------

This is a small WAD file to place in your
DSDA or Nyan AUTOLOAD directory. All it
does is change the way the Extended HUD
works. This WAD only contains a modified
DSDAHUD and DSDATC, and the corresponding
Nyan versions.

 - DSDATC / NYANTC control the colours of
   the Extended HUD.

 - DSDAHUD / NYANHUD control the look of
   the HUD.

----------------------------------------
           : Nyan Doom :
----------------------------------------

As of Nyan-Doom 1.3.1, Nyan now uses its
own uniquely named lumps for DSDATC and
DSDAHUD. This allows you to have a single
Extended HUD mod that can be run on both
DSDA and Nyan without them interfering
with each other. So I can now combine two
mods into one.

----------------------------------------
               : Usage :
----------------------------------------

Simply add the HUD of your choice to your
load order, or place the WAD in the
autoload directory inside the root of
your source port:

  ./autoload/all-all/

----------------------------------------
        : DSDA-DOOM Usage :
----------------------------------------

To display your name or any text:

 - Open the console  
 - Type: free_text.update <textString>  
   (You can use spaces; omit the <>)

 Example:  
   free_text.update aJynksed Doomer

To open the console, go to the keybinding
options. Press left until you get to the
DSDA-DOOM page (near the end). Then set a
key to open the console.

I would recommend using the ` key.

----------------------------------------
        : Nyan-DOOM Usage :
----------------------------------------

To set the custom text in Nyan, there is
an option in the settings menu. Simply
use that to set the text:

  options > display > exhud >  
  exhud Free text

----------------------------------------
       : WAD File Description :
----------------------------------------

This mod makes the Extended HUD **always**
on.

The "OFF" state will hide level stat
totals, meaning that kills, items and
secrets will display as "5" instead of
"5/25".

The "ON" state will switch all values to
show the totals.

The automap will always show the map name
and the level stats, but not the totals.

The idea is you can play with level stats
on but not spoil the map by knowing how
many monsters, items or secrets there are
in the map. Once you find all of a given
type, even if totals are hidden, it will
switch to showing the totals.

If you set a keybind to toggle the EXHUD
ON and OFF, you can reveal or hide totals
via a keyboard press.

There are three versions of each EXHUD:

 - MAPNAME: always shows the map name on
   the main game screen.

 - NO MAPNAME: never shows the map name on
   the main game screen.

 - REVEAL MAPNAME: hides the map name when
   totals are also hidden. Revealing
   totals also reveals the map name.

----------------------------------------
         : File Options :
            Horizontal
----------------------------------------

These will display the level stat widgets
above the status bar in a horizontal
layout.

----------------------------------------
         : File Options :
       Vertical (Time on Bar)
----------------------------------------

These will display the game time and stats
vertically, placed on the left of the
status bar in the "empty" section next to
the ammo display.

----------------------------------------
         : File Options :
     Vertical (Time on Screen)
----------------------------------------

This is a vertical layout like the above,
but the time is placed above the status
bar on the left, as in the horizontal
versions.

This is because, in continuous play across
multiple levels, the total game time is
added to the timer. This makes the time
readout too wide to fit within the side
of the status bar.

----------------------------------------

Have fun and SLAUGHTER DEMONS!  
--aJynks