============= YAFM-HL v0.907 ===============
** Yet Another Flashlight Mod - Headlight **
by CHaSE <chase@hotmail.ru> ***** 30.09.2004
        http://neherson.narod.ru/

**************
***FEATURES***
**************

- adds flashlight to all weapons in Doom 3 (update 1.1)
- flashlight can be turned on or off with an assigned key
- weapons do not lose the muzzleflash effect


****************
***PREHISTORY***
****************

First, a little history. Like many others, I was somewhat irritated by
the very, Very, *VERY* dark atmosphere of Doom 3. So initially I've
attempted to somehow merge the flashlight weapon with the other weapons.
I failed. Then I started searching the Net in a hope that someone already
did that for me. Soon enough I've found the Duct Tape mod and a lot of mods
that are, in essence, based on DT.

However, I was disappointed by them. Why? Because they either restrict the
flashlight, or make almost the entire level lit. Because they work only with
certain guns, and if they do work with them, you can't do anything about it -
you can't turn the light off. Because if there's a flashlight on a weapon,
then this weapon doesn't have muzzleflash effect. Why? Because those mods
are basically hacks. They replace the weapon's muzzleflash with a bigger
and directed one, thus emulating the flashlight beam (that's what the
original Doom 3 flashlight does too). It was obvious that this approach
is rather flawed. That's when I started to learn Doom 3 scripting. 

Now to the mod itself.


*****************
***DESCRIPTION***
*****************

YAFM-HL is my attempt to create a flashlight that would work simultaneously
with any given weapon. Initially this work started for my private use only,
but at the end I decided this could be of use to the others as well. In a
way YAFM-HL is more like a proof-of-concept than something designed to
actually change the gameplay. (However, YAFM-HL definitely works and does
change the gameplay).

The flashlight (or, rather, headlight) originate from the player's head.
Its properties are basically the same as of the flashlight weapon. The
player is able to turn the headlight on or off with an assigned key
(Main Menu - Options - Controls - Other - Headlight). Also when using
the headlight you don't lose the muzzleflash effect.

This is one of the first complete versions of the mod, that is the first
with all the intended functionality. However, not all that much testing
was performed, so there might be nasty bugs of any sort whatsoever.
Naturally, I'd be extremely happy to hear about them (or about their
absence, which is unlikely though).


******************
***INSTALLATION***
******************

Unzip and copy yafm-hl folder to your Doom 3 folder (where doom3.exe is
located). Launch Doom 3, and choose yafm-hl in the MODS menu.

Note: any non-YAFM-HL saved games will be loaded at the beginning of
the level. This behaviour is by Doom 3 design.


************
***THANKS***
************

zeh for his awesome GUI tutorials
Glen 'FrenZon' Murphy for his Duct Tape MOD
www.doom3world.org
www.doom3reference.com


**********************
***DISCLAIMER/LEGAL***
**********************

YAFM-HL - Yet Another Flashlight Mod - Headlight ("MOD") is provided
on "AS IS" basis without warranty of any kind. The author, CHaSE, can
not be held responisble for any damages arising out of or in any way
related to the use or inability to use the MOD. You are given the right
to use the MOD as a base for your own products provided that you add
significant and primary functionality to the MOD. You are given the
right to freely copy and distribute the MOD provided that you include
this file without modifications. You agree to be bound to the terms of
this agreement by installing, copying or otherwise using the MOD. If
you do not agree, do not install or use the MOD. 


****************
***CHANGELIST***
****************

v0.907   updated for Doom 3 version 1.1
         NOTE: probably incompatible now with 1.0, sowwy!

v0.906   bugfix: there seems to be an error with the processing of the
         console "script" command; doom 3 refuses ("ERROR: couldn't load
         console") to load games saved after issuing "script" command from
         the console; since the 0.905 relied on this command, it's sort of
         incompatible with the savegame feature ;)
         fixed with some perverted coding...

v0.905   headlight is now switched on or off with an assigned key

v0.904   bugifx: removed duplicate windowDef for headlight switch in
         pda.gui (ooops)

v0.903   headlight turns off when cinematic is played (did this after
         the cseq with that guy on the ceiling - ewwwwww, id people are sick!)

v0.902   homepage is up, and the readme is updated

v0.901   changelist and thanks are added to the readme, version numbers
         are removed from certain places

v0.9     first release, all the initially forethought functions are
         working (i hope)
