Code:
----------------------
-- TurboHUD Manual --
----------------------
I'm not responsible for any damage in case you get banned because you are using TurboHUD.
TurboHUD clearly violates the TOS and EULA of Diablo 3!
What TurboHUD does:
- paints on a simple always-on-top GDI+ transparent window
- reads Diablo 3's memory:
- actor, acd information (the monsters, items, objects, etc in game)
- your stats, experience, gold amount, etc
- some selected UI objects (BattleTag label on top of the friend list panel, inventory panel, stash panel, etc)
- note: technically this HUD is able to read the login email and password UI objects too, but it doesn't do that.
- your BattleTag through an UI object
What TurboHUD doesn't do, and will never do:
- write Diablo 3's memory
- change any of Diablo 3's files
- inject something into Diablo 3's code
- modify the DirectX surface of Diablo 3
- collect/log your keystrokes and/or mouse events
- emulate keystrokes and/or mouse events
- show other players in game
The primary goal of this HUD is to give you detailed information about your farming statistics,
drops, and help you to optimize your paths, habits, builds, etc.
This HUD is NOT made to give you advantage over other people, nor to automatize anything you are doing.
----------------------
TABLE OF CONTENTS
----------------------
0. Release Notes
I. Basics
II. Installation
III. Start
IV. Hotkeys
V. Features
VI. Configuration
----------------------
0. Release Notes
----------------------
- the <minimap><show>/"normal_monster" and "strong_monster" flags, the <ping>/"strong monster" flag
and the <ping>/"goblin" flags are currently limited to the actual area you can see in the game.
With other words: you can't see anything on the minimap over your screen, except legendary pings.
- <floor> and <item_quality_names> tags are currently disabled, not used
- this beta release will stop working after 2013. january 01.
----------------------
I. Basics
----------------------
...section is under construction...
----------------------
II. Installation
----------------------
First installation
------------------
-install .NET 4.0 framework from here: http://www.microsoft.com/en-us/download/details.aspx?id=17851
- unzip the TurboHUD_vXXXXX.zip file into any folder
- after the first start the HUD will create some required additional folders (data_packets, logs, runs, saved_paths, config)
- the config.xml and identification.xml will be created after you start the HUD for the first time
- IMPORTANT NOTE: SAVE YOUR IDENTIFICATION.XML before you do anything in that file. Your identification IDs will be important for you!
If you would like to buy me a beer then let me tell you: I love beer. You can do it here:
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YJ44N6UXXB94G
Please do not forget to leave your Instance Private ID and BattleTag.
----------------------
III. Start
----------------------
- run the TurboHUD.exe as an administrator
- after you started the HUD and Diablo 3 not yet preloaded your Friend List Panel, you have to "teach" your BattleTag to the HUD.
You can do this with opening your friends panel for a second.
If you don't do this, the HUD's statistics and logging features will not work.
- enjoy
----------------------
IV. Hotkeys
----------------------
F1 - Show/Hide the HUD
F2 - Reload config files (you don't need this because it's automatic)
F8 - Save the current position into the saved_paths folder, into the file named after your current area
End - Terminate the HUD
----------------------
V. Features
----------------------
Some of the following features are only available in the donator-edition (look for the [donator] tag, but there are no donator-only features yet)
...section is under construction...
// SAVED PATHS //
You can save your paths in every area by pressing the F8 hotkey.
The file will be saved into the saved_paths folder - the filename is your current area's internal name.
Every time you are in that area, the HUD will display the saved path on the floor.
Please note that this feature is - obviously - working only in static areas.
For advanced users:
After you saved a node, you can open the path file with notepad, and give a name for any node by changing the "noname" text to something you want to see there.
----------------------
VI. Configuration
----------------------
All configuration options are stored in the .\config\config.xml and identification.xml files.
Before doing any changes in these files, please backup them into a safe locations.
Please note that after a version update the HUD will TRY to migrate your old config.xml to the new format (if it is changed),
but there is no guarantee that it'll work. So before any version update, please backup your config.xml.
Damaged config files
--------------------
In case you mess up a config file and the HUD is unable to read it,
the file will be automatically renamed to config_damaged_{timestamp}.xml or identification_damaged_{timestamp}.xml.
All content in that file will be restored to default values!
Configuration tags
------------------
<identification>
<instance_ids> - DO NOT TOUCH THIS
<instance_keys> - If you get a key from me, put it into the <key1 key="" /> or <key2 key="" />, between the "" marks.
Please note that keys are based on your Instance Private ID and BattleTag, so people can't exchange keys - it will not work.
<floor> - unused
<graph> - you can change the EXP, GOLD and DPS graphs here
enabled - you can turn on/off individual graphs
x,y,h - the graph's location and height in pixels
collection - for advanced users: you can define in milliseconds how often the graph will average the corresponding values
colors - the colors of the graph
<gain_panel> - the settings of the GAIN panel
x,y - the panel's location (size is automatic)
font - the font of the panel
background - you can turn off/on the panel and set up it's color
border - the border. you can't turn it off but you can set up it's color
*enabled - you can turn off/on values to display
<item_quality_name> - unused
<custom_radius_circles> - you can define circles showing custom radius values
count - you have to put the number of circles you want there
<idxN> - every entry here has to be in the format "idxN" where N is the index of it, starting with 1 (idx1, idx2, etc)
range - yards. simple.
thickness, color - line with and color
enabled - guess one.
<utility>
<pickup_range> - the HUD can display your actual pickup range.
<world_directions> - HUD can show the game's internal direction vectors (X and Y)
<monsters>
<strong> - HUD can't determine if a monster is elite, or not (yet). You can set up a health limit and every monster above that limit will be considered "strong".
<minimap>
use_default - the HUD will place the minimap drawings right onto the D3's minimap when this is true ("1")
x,y,size - you can define the HUD's location and size when use_default is turned off
show_monsters - the HUD will show the monsters on the minimap
ping - you can request pings on the minimap if the HUD detects any legendary/set item, strong monster, or goblin
<saved_paths> - you can disable/enabled the display of the current area's saved path file
line_floor - the line's settings which will show the path on the ground
line_minimap - the line's settings which will show the path on the minimap
font - the font definition of the text you can display on individual path nodes