Can I ask somebody with more english skills than me, to fix the errors in my beta manual?
Thank you very much! Beta release is comiiiiiiiiiiiiiiiiiing
Code:
----------------------
-- TurboHUD Manual --
----------------------
After this is released, you HAVE to ask Blizzard Support what they think about it.
If you don't ask them, you are not permitted to use this.
I'm not responsible for any damage if you are banned because you didn't asked the support.
This project is reading D3's memory, NOT writing it, and not injecting anything into it.
It is using a simple GDI+ transparent window for overlay, it's not a fancy DirectX modification.
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, build, etc.
This HUD is NOT made to give you advantage over other people, or 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 show_monsters flag is currently limited to the actual screen you can see in the game
- floor and item_quality_names tags are currently disabled, not used
----------------------
I. Basics
----------------------
...section is under construction...
----------------------
II. Installation
----------------------
First installation
------------------
- unzip the 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 will be created after you start the HUD first time
- IMPORTANT NOTE: SAVE YOUR CONFIG.XML before you do anything in that file. Your identification IDs will be important for you!
----------------------
III. Start
----------------------
- run the TurboHUD.exe as an administrator
- 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 file.
Before doing any change in that file, please backup it into a safe locations.
In case you mess up the config file and the HUD is unable to read it, the file will be automatically deleted and recreated with a new instance ID and all default values (like after a fresh installation).
Tags:
<identification> - DO NOT TOUCH THIS
<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