==========================================================================
 Stealth Boy Reworked
==========================================================================

Author:		schlangster
Version:	1.0
Date:		18-02-2010

Download
@ http://fallout3nexus.com/downloads/file.php?id=11025

==========================================================================
 Requirements
==========================================================================

FOSE, tested with version v1.2 b2 and later
@ http://fose.silverlock.org/

(!OPTIONAL!)
DarN UI, tested with version 0.11.0 and 0.11.1
@ http://www.bethsoft.com/bgsforums/index.php?showtopic=1063937

==========================================================================
 What this mod does
==========================================================================

This mod reworks the Stealth Boys found in Fallout 3. Instead of adding a
permanent stealth field for a longer duration, the player can switch it
on/off once the Stealth Boy has been used. To keep it balanced, the
stealth field is only stable for a short duration, after which it needs
time to regenerate.

As a result, the player can now freely decide when/how to use the
stealth field, however, only short continuous stealth periods are
possible, resulting in a more dynamic and suspenseful gameplay experience.

==========================================================================
 Features
==========================================================================

o Stealth Boys are now switched on/off by hotkey after they are used

o The stealth field is influenced by its stability

o When unstable, the stealth field can collapse and cause damage to the
  Stealth Boy

o HUD display elements for stability, charges and Stealth Boy condition

o All parameters configurable via menu.

==========================================================================
 Installation - FOMM (recommended)
==========================================================================

	1. Open FOMM.
	
	2. Open the Package Manager.
	
	3. Click on "Add new" and select the Stealth Boy Reworked zip file.
	
	4. Select "Stealth Boy Reworked" from the list and click on activate.
	
	5. Adjust your load order so StealthBoyReworked.esp loads after any
		other mods which make modifications to the Stealth Boy ingestible.
	  
==========================================================================
 Installation - Manual
==========================================================================

	!!! Important: Read this completely before you start !!!

	1. Extract the contents of the Stealth Boy Reworked zip archive to
		your Fallout 3 Data/ directory.
	
	2. If you're asked to overwrite hud_main_menu.xml, _DON'T_ do it.
		This means you already have a modified version and you
		will have to edit that one instead of overwriting it.
		
	3. Activate the StealthBoyReworked.esp plugin and adjust your
		load order so it loads after any other mods which make
		modifications to the Stealth Boy ingestible.

		
The next steps only apply if you already had modified version of
hud_main_menu.xml (see step 2) _AND_ if you want to use the HUD
status display. If not, you can skip this.
	
	4. Open Data/menus/main/hud_main_menu.xml in a text editor.
	
	5. Scroll to the end of the file.

-------------------------
(A. For the default HUD:)
-------------------------
	
	6a. Before </menu>, insert the following lines so it looks like this:
	
			<!-- BEGIN Added by Stealth Boy Reworked -->
			<include src="schlang\stealthmeter_vanilla.xml"/>
			<!-- END Added by Stealth Boy Reworked -->
		</menu>
	
	7a. Save your changes.

-----------------
(B. For Darn UI:)
-----------------

	6b. Before </menu>, insert the following lines so it looks like this:
	
			<!-- BEGIN Added by Stealth Boy Reworked -->
			<include src="schlang\stealthmeter_dui.xml"/>
			<!-- END Added by Stealth Boy Reworked -->
		</menu>
	
	7b. Save your changes.

==========================================================================
 Upgrading from previous versions
==========================================================================

From 0.2 to 1.0 I changed a couple of things, so to be safe you should
completely remove the old version, save your game, and then install the
current one.

In particular, to deinstall it you have to do the following:
	- Remove the StealthBoyReworked.esp file
	- If you used the DarN UI HUD, remove the line you added to
		hud_main_menu.xml
	- If you used the Default HUD, delete (or rename to be safe)
		Data/menus/main/hud_main_menu.xml


==========================================================================
 How to Use
==========================================================================

When activated for the first time, the configuration menu will pop up.
Default values should be reasonable, but feel free to change them.

Use a stealth boy like before to enable the stealth field.
Activate/Deactivate it by pressing X (default hotkey).

In your inventory under the category Aid you will find an item called
"< Stealth Boy Config >" you can use to re-open the configuration menu.

==========================================================================
 Known Issues
==========================================================================

120 seconds after using a Stealth Boy, you will get a message
"Stealth Boy has worn off.". This is caused by an alternative set of
effects for NPCs so they still can use the original Stealth Boy
functionality. For the player, these alternative effects are never active,
however, the game still displays a message once they would have worn off.
This can be ignored.

==========================================================================
 Compatibility
==========================================================================

- This mod changes the stealth boy ingestible, so load it after any mods
  which modify it.

- The HUD meter will probably overlap with FOOK2's NVG meter.

==========================================================================
 Changelog
==========================================================================

v1.0.:
- Script optimizations
- Hotkey now configurable per menu
- Added inventory item to bring up the configuration menu
- HUD position can now be adjusted ingame with the configuration menu
- FOMM support with installation script

v0.2.:
- Added HUD files that don't require DarN UI

v0.1.:
- Initial beta release