Documentation
Readme
View as plain text
Name: HUD Improved
Version: 1.05
Date: 14/09/2010 19:07:41
Author(s): Forli
Description
========
"HUD improved" is a simple and configurable mod that change the appearance of the HUD.
It has been created for DarNified UI, so others UI mod are not compatibles.
MIn the future I will make different versions for the most popular UI mods.
This is the DarNified UI version
These are the features:
- Added a charge bar, to show the current charge of your weapon. It only show for enchanted weapons.
- Added the shield and torch icons, to show your current equipped shield and torch.
- Added new HUD elements to show your gold, encumberance and game time, (They can be Pop-ups, always visilble, or auto hide when in combat)
- Autohide your health, magicka, fatigue, durability and charge bars (Indipendently) when at maximum and force show them in combat.
- Autohide the compass: You can hide it when combat and/or when in interior or exterior cells.
- Autohide your weapon and spell icons. They will only show when:
WEAPON ICON:
- you draw the weapon/fists
- you equip another weapon
SPELL ICON:
- you change the current spell
- you cast the current spell
(OPTIONAL) BOTH ICONS:
- you are in combat
When no one of these condition is met, the icons will hide in 5 seconds.
You can decide to consider both icons as one. They will show/hide together with all the above conditions.
- Durability and Charge bars automatically hide when no weapon is equipped.
- Shield icon, Durability and Charge bars will hide when weapon icon does (No way to change this).
- The aspect of your Durability bar change if your armorer skill is above 75 (Because you can repair your equipment up to 125).
- The 4 icons (weapon, spell, shield and torch) will be positioned automatically, if any of them is hidden.
- You can show all the hidden HUD elements (Only if hidden by this mod) with a single key.
- You can enable/disable/configure every single feature in the file "HUDImproved.ini" and during the game.
NOTE: You will always need to change the DarNfied settings in the page 5.
This mod will never interfere with these settings.
Requirements
==========
Oblivion Patch 1.2.0.214 (Official 1.2 Patch)
Oblivion Script Extender v19 - http://obse.silverlock.org/
DarNifiedUI - http://www.tesnexus.com/downloads/file.php?id=10763
Installation Instructions
=================
Just extract the archive in your "Oblivion\Data" folder.
Files:
HUDImproved.esp
HUDImproved.ini
HUDImproved Readme.txt
Textures\Menus\Darn\hud_ribbon_charge_empty.dds
Textures\Menus\Darn\hud_ribbon_weapon_empty100.dds
Textures\Menus\Darn\hud_ribbon_weapon_empty125.dds
Textures\Menus\HUD\hud_ribbon_durability_full.dds
Textures\Menus\HUD\hud_back_popup.dds
Textures\Menus\Icons\HUDI\HUDISettingsToken.dds
Textures\Menus\Icons\HUDI\HUDI_Default_Shield.dds
Menus\Main\hud_main_menu.xml
Menus\Prefabs\Darn\hudmainmenu_config.xml
Menus\Prefabs\HUDI\HUDI_extra_elements.xml
For now it's near-impossible to import all the changes to your "hud_main_menu.xml"
In the future I will try to increase XML compatibility
Uninstallation Instructions
===================
Load the game, open your inventory, find and activate the token "+HUDI Settings". The settings menu will apppear: click on "Disable", close the menu, save and exit.
Delete the files and restore the original DarNifiedUI files.
Configuration
==========
All the features of this mod are configurable.
SETTINGS MENU
I suggest you to change all the settings in game, using the HUDI Settings menu.
An item called "+HUDI Settings" will be added to your inventory in the "Misc" section.
Activate it to show the settings menu.
INI FILE
If you want to configure the mod while not in game, open and edit "HUDImproved.ini".
If you change a settings to an invalid values, the mod will use the default value.
After you change the ini, reload it in game using the settings menu.
You don't need to reload the ini if this is your first installation.
These are all the settings you will find in the ini:
set HUDI.fQuestDelayTime to 0.05 (DEFAULT: 0.05)
If your FPS drop, try raise this value. Don't set it to high
You can set this to any positive value up to 0.25
Set HUDI.autoHideHealth to 1 (DEFAULT: 1)
Auto hide the health bar when at maximum
0 - Always show
1 - Autohide
Set HUDI.autoHideMagicka to 1 (DEFAULT: 1)
Auto hide the magicka bar when at maximum
0 - Always show
1 - Autohide
Set HUDI.autoHideFatigue to 1 (DEFAULT: 1)
Auto hide the fatigue bar when at maximum
0 - Always show
1 - Autohide
Set HUDI.statusMode to 1 (DEFAULT: 1)
Force show the status bars in combat
Ineffective if all the status bar can't autohide
0 - Don't force show in combat
1 - Force show in combat
Set HUDI.autoHideCompass to 1 (DEFAULT: 1)
Auto hide the compass
0 - Always visible
1 - Hide in interior cells
2 - Hide in exterior cells
Set HUDI.compassMode to 1 (DEFAULT: 1)
Auto hide the compass in combat
0 - Force hide in combat
1 - Don't force hide in combat
Set HUDI.iconsTogether to 0 (DEFAULT: 1)
If set this setting to 1, the weapon and spell icons will be considered as one
All the weapon settings will be used for both icons, while all the spell settings will not be used
The weapon and spell icons will show/hide together
0 - Icons indipendent
1 - Icons together
Set HUDI.autoHideWeapon to 1 (DEFAULT: 1)
Auto hide the weapon icon. See "HUDI Readme.txt"
When the weapon icon hide, the shield icon and the durability and charge bars will hide as well
If "HUDI.iconsTogether" is 1, this setting will be used also for spell icons
0 - Always visible
1 - Autohide
Set HUDI.autoHideSpell to 1 (DEFAULT: 1)
Auto hide the spell icon. See "HUDI Readme.txt"
Ineffective if HUDI.iconsTogether is 1
0 - Always visible
1 - Autohide
Set HUDI.weaponMode to 1 (DEFAULT: 1)
Force show the spell icon during combat
If "HUDI.iconsTogether" is 1, this setting will be used also for spell icons
Ineffective if "HUDI.autoHideWeapon" is disabled
0 - Don't force show during combat
1 - Force show during combat
Set HUDI.spellMode to 1 (DEFAULT: 1)
Force show the spell icon during combat
Ineffective if "HUDI.autoHideSpell" is disabled
Ineffective if "HUDI.iconsTogether" is 1
0 - Don't force show during combat
1 - Force show during combat
Set HUDI.weaponTimer to 5 (DEFAULT: 5)
The weapon icon will hide when this time (seconds) has passed
Ineffective if "HUDI.autoHideWeapon" is disabled
If "HUDI.iconsTogether" is 1, this setting will be used also for spell icon
You can set this to any positive value (also 0)
Set HUDI.spellTimer to 5 (DEFAULT: 5)
The spell icon timer (seconds)
Ineffective if "HUDI.autoHidesSpell" is disabled
Ineffective if "HUDI.iconsTogether" is 1
You can set this to any positive value (also 0)
Set HUDI.autoHideDurability to 1 (DEFAULT: 1)
Auto hide the durability bar when at maximum
0 - Always visible
1 - Autohide
Set HUDI.durabilMode to 1 (DEFAULT: 1)
Force show the durability bar in combat
Ineffective if "HUDI.autoHideDurability" is disabled
0 - Don't force show in combat
1 - Force show in combat
Set HUDI.showCharge to 1 (DEFAULT: 1)
Enable/disable the charge bar (Only with enchanted weapons)
0 - Disable
1 - Enable
Set HUDI.autoHideCharge to 1 (DEFAULT: 1)
Auto hide the charge bar when at maximum
Ineffective if "HUDI.showCharge" is disabled
0 - Always visible
1 - Autohide
Set HUDI.chargeMode to 1 (DEFAULT: 1)
Force show the charge bar in combat
Ineffective if "HUDI.autoHideCharge" is disabled
0 - Don't force show in combat
1 - Force show in combat
Set HUDI.showDayTime to 1 (DEFAULT: 1)
Show the current game time
0 - Hide
1 - Always visible
2 - Always visible but in combat
Set HUDI.showGold to 1 (DEFAULT: 1)
Show the current gold amount
0 - Hide
1 - Pop-up (only show when gold amount change)
2 - Always visible
3 - Always visible but in combat
Set HUDI.goldTimer to 5 (DEFAULT: 5)
The gold pop-up will hide when this time (seconds) has passed
Only effective if "HUDI.showGold" is 1 (Pop-up)
You can set this to any positive value
Set HUDI.showEncum to 1 (DEFAULT: 1)
Show the current/max encumberance
0 - Hide
1 - Pop-up (only show when encumberance change)
2 - Always visible
3 - Always visible but in combat
Set HUDI.encumTimer to 5 (DEFAULT: 5)
The encumberance pop-up will hide when this time (seconds) has passed
Only effective if "HUDI.showEncum" is 1 (Pop-up)
You can set this to any positive value
Set HUDI.showShield to 1 (DEFAULT: 1)
Show the current equipped shield
It will use the shield icon
Compatible with new shield added by mods
If the shield has no icon, the mod will use a generic one from HUDI
0 - Hide
1 - Always visible
2 - Show only in combat
Set HUDI.showTorch to 1 (DEFAULT: 1)
Show the torch icon when you equip a torch
It will use the torch icon
Compatible with new torchs added by mods
If the torch has no icon, the mod will use the icon from the vanilla torch
0 - Hide
1 - Always visible
2 - Always visible but in combat
Set HUDI.showKey to 56 (DEFAULT: 56 - LeftAlt)
This is the key to show all the hidden HUD elements:
- They must be enabled in the DarNified settings
- The durability bar will remains hide without a weapon
- The charge bar will remains hide without an enchanted weapon
http://cs.elderscrolls.com/constwiki/index.php/IsKeyPressed2
I suggest you to change it from the HUDI settings menu in game
Set HUDI.showMode to 1 (DEFAULT: 1)
Here you can set how the showKey shows the HUD
1 - (Timer) Tap to show temporarily; keep pressed for ~1 second to show indefinitely (Until you tap the key again)
2 - (Press) The HUD will show as long as you keep pressed the key
3 - (Toggle) Tap to show indefinitely, Tap again to hide
Set HUDI.showTimer to 5 (DEFAULT: 5)
This is the time (seconds) the HUD will be fully visible
Only effectives with showMode 1 (Timer)
You can set this to any positive value
Incompatibility
===========
You can use this mod with only DarNified UI. You can try to use it with other UI mods, but I'll take no responsibility.
If you have edited the DarNified Xml files, try to export all the changes you made to the HUDI Xml files
(I suggest you don't try the opposite way: It's very hard to export all the changes I made to "hud_main_menu.xml" and, again, I'll take no responsibility).
It SHOULD be compatible with DarkUI. (Tell me if not)
There shouldn't be other incompatibilities (The mod works entirely through scripts).
Known Issues
===========
None. Tell me about every bug you found.
Change Log
=========
1.05 - Fixed the time bug for minutes from 0 to 9.
Fixed a little glitch in the settings menu
1.0 - Initial Release.
Credits
======
Darn for his mod DarNified UI
kyoma, TheNiceOne and LogicDragon for their help with the scripts
The OBSE team for OBSE
Bethesda for game Oblivion
..... (Tell me if I forgot somebody....)
Legal
=======
You have to ask me to redistribuite any part of this mod.