Version 11 (zx64, 02/10/2012 19:42)

1 3 dslyecxi
h1. STHUD Wiki
2 11 zx64
3 1 dslyecxi
4 5 dslyecxi
h1. About the STHUD
5 3 dslyecxi
6 5 dslyecxi
h2. Design Intent
7 1 dslyecxi
8 5 dslyecxi
The ShackTac Fireteam HUD was designed to do the following:
9 5 dslyecxi
* Provide situational awareness on where your fireteam members are and what their orientation is. This is intended to represent both peripheral vision, as well as the extended awareness one has in reality. You only see your fireteam members relative to you - no terrain, no other players/units.
10 5 dslyecxi
* Give you an always-visible way of seeing who your team members are
11 5 dslyecxi
12 6 dslyecxi
> !!
13 5 dslyecxi
14 5 dslyecxi
15 5 dslyecxi
h2. How it Works
16 5 dslyecxi
17 5 dslyecxi
The current incarnation works as follows. As long as you are in a group, and not inside of a vehicle, you will see the Fireteam HUD displaying at the bottom-center of your screen. There are three circles - the first one indicates a range of 15m, next is 30m, last is 45m. We've tried a few different scaling sizes, and have settled on this one for the present time. 
18 5 dslyecxi
19 5 dslyecxi
The current group leader will display as a white icon. If you are not the group leader, you will display as a yellow icon. Other team members will show as green icons. Medics/Corpsmen and leaders will show with special icons. 
20 5 dslyecxi
21 5 dslyecxi
Note that the appearance of someone's marker, or their name, does not necessarily mean that they are alive - it works off of the same logic used in normal ArmA group handling, so if you have a dead team member, you will need to "know" about them (ie, right-click while looking at their body) to have them removed from the list. When you die, the HUD will automatically close.
22 5 dslyecxi
23 5 dslyecxi
Note that this has been designed to work with a "Very Small" GUI size, so for best results, try it like that. The STHUD currently supports a max of twelve names displayed.
24 5 dslyecxi
25 6 dslyecxi
26 5 dslyecxi
27 6 dslyecxi
28 5 dslyecxi
29 7 dslyecxi
30 7 dslyecxi
31 7 dslyecxi
Note that as of 1.60 STHUD supports color-coded group members. To use, simply use the in-game team assignment feature - the changes will be made to the HUD after a few moments. 
32 7 dslyecxi
33 9 dslyecxi
Note also that the current STHUD has a default compass overlaid into it. You can disable this through the fthud_usermenu feature. This compass is tied to your in-game compass item, so if you do not have one, it will not show.
34 9 dslyecxi
35 9 dslyecxi
36 9 dslyecxi
37 8 dslyecxi
h2. fthud_UserMenu.pbo
38 8 dslyecxi
39 8 dslyecxi
The fthud_usermenu.pbo gives you the ability to interact with the HUD in a few ways in-mission. Current functionality is as follows. The menu is currently brought up by pressing *alt-shift-H* in-game. 
40 8 dslyecxi
41 8 dslyecxi
42 1 dslyecxi
* Allows you to restart the HUD. This is useful if you change into/out of window mode and the HUD distorts/disappears, but shouldn't need to be used otherwise.
43 9 dslyecxi
* Allows you to change to radar-only, names, names + radar, or turn the HUD off entirely.
44 9 dslyecxi
* Allows you to toggle the compass on/off
45 8 dslyecxi
46 5 dslyecxi
h1. Download and Install Info
47 5 dslyecxi
48 5 dslyecxi
h2. Download
49 5 dslyecxi
50 5 dslyecxi
Please do not mirror this file. You're welcome to add it to community addonsync servers for the purpose of distributing it to your own communities, but we would ask that the only 'normal' download method be directly from DevHeaven. Thanks for your cooperation in this! :)
51 5 dslyecxi
52 5 dslyecxi
You can download the ShackTac Fireteam HUD from DevHeaven here:
53 5 dslyecxi
54 6 dslyecxi
55 5 dslyecxi
56 5 dslyecxi
57 3 dslyecxi
h2. Installation
58 3 dslyecxi
59 3 dslyecxi
The STHUD is included as a standard addon folder. Simply place the @sthud folder into your ArmA2 directory and load it as you would any other mod. 
60 3 dslyecxi
61 3 dslyecxi
h2. Dependencies
62 3 dslyecxi
63 3 dslyecxi
CBA is required for the STHUD to function. More info about CBA can be found here:
64 1 dslyecxi
65 1 dslyecxi
66 1 dslyecxi
67 5 dslyecxi
h1. Islands & Island Support 
68 3 dslyecxi
69 5 dslyecxi
h2. Current Supported Islands
70 3 dslyecxi
71 5 dslyecxi
[[Supported Islands]]
72 1 dslyecxi
73 1 dslyecxi
74 5 dslyecxi
h2. Known Issues
75 1 dslyecxi
76 10 zx64
The current incarnation works off of preconfigured scaling settings for different islands in ArmA2. If an island is not already configured, it will default and warn you - at which point the HUD may not look ideal.
77 5 dslyecxi
78 5 dslyecxi
h2. How to adjust for other islands
79 5 dslyecxi
80 5 dslyecxi
The current implementation of the STHUD uses a map control to display the markers. Unfortunately, map controls can't seem to be configured to not have gridlines and the zoom needed to fit one grid square inside the map control varies from island to island.
81 5 dslyecxi
82 5 dslyecxi
There's probably a way to figure these values out from examining the island's config but until then, we hardcode the values for each island used by ShackTac in the config.
83 5 dslyecxi
84 5 dslyecxi
When you use an island that isn't hasn't been configured, you'll get a sideChat saying so. You can tweak the three values used in real time assuming you have some sort of debug console. Once you're happy with the values, post them up and we'll be happy to add them to the next version of the STHUD. 
85 5 dslyecxi
86 5 dslyecxi
First you need to ensure the markers are in the center of a grid square:
87 5 dslyecxi
88 5 dslyecxi
89 5 dslyecxi
ST_FTHud_Centre = [150,150];
90 5 dslyecxi
91 5 dslyecxi
92 5 dslyecxi
You will also need to adjust the zoom so the grid square fits inside the HUD without showing grid lines.
93 5 dslyecxi
94 5 dslyecxi
95 5 dslyecxi
ST_FTHud_Zoom = 0.5;
96 5 dslyecxi
97 5 dslyecxi
98 5 dslyecxi
If the markers are too big for the grid square, you'll need to change the scale value to shrink the markers:
99 5 dslyecxi
100 5 dslyecxi
101 5 dslyecxi
ST_FTHud_Scale = 1.0;
102 5 dslyecxi
103 1 dslyecxi
104 10 zx64
Note that with the latest versions of STHUD, you'll need to do a @call ST_FTHud_Debug;@ each time after changing the variables to see any changes (this was always the case on islands which have a config). This change was made to slightly optimise performance on unconfigured islands at the expense of being slightly more inconvenient the one time you're actually working on the settings.
105 10 zx64
106 5 dslyecxi
Adding to the island's config:
107 5 dslyecxi
108 5 dslyecxi
109 5 dslyecxi
class ST_FTHud_IslandSettings
110 5 dslyecxi
111 5 dslyecxi
    class NewIsland
112 5 dslyecxi
113 5 dslyecxi
        Zoom = 0.5;
114 5 dslyecxi
        Scale = 0.95;
115 5 dslyecxi
        Centre[] = {150, 100};
116 5 dslyecxi
117 5 dslyecxi
118 5 dslyecxi
119 5 dslyecxi
120 1 dslyecxi
(Similar story with the hud's own config)
121 5 dslyecxi
122 10 zx64
Remember, for those of you that run islands other than the ones listed, please feel free to find out good settings for them and we'll be happy to include those settings in future releases of the STHUD.
123 5 dslyecxi
124 5 dslyecxi
h1. Terms, Feedback, and Credits
125 5 dslyecxi
126 3 dslyecxi
h2. Questions, comments
127 3 dslyecxi
128 3 dslyecxi
Support and updates will be provided here on DevHeaven, while also crossposted to the Bohemia Interactive forum thread, here:
129 3 dslyecxi
130 3 dslyecxi
If you would like to know more about ShackTac, you can find us at
131 3 dslyecxi
132 3 dslyecxi
133 3 dslyecxi
134 3 dslyecxi
h2. Terms of Use
135 1 dslyecxi
136 1 dslyecxi
Usage of STHUD requires agreement with the following terms. The STHUD may NOT be modified, included in other mods in whole or part, used for military training or any commercial purposes whatsoever, without prior permission from the authors (zx64 and dslyecxi). Redistribution of the addon via YAS/6updater etc is permitted only if it is unmodified and free of charge. Modifications are forbidden without prior permission from the authors. 
137 1 dslyecxi
138 1 dslyecxi
You can reach the authors at
139 1 dslyecxi
140 3 dslyecxi
141 5 dslyecxi
h2. Credits & Thanks
142 5 dslyecxi
143 1 dslyecxi
144 5 dslyecxi
The ShackTac Fireteam HUD was conceptualized and prototyped by Dslyecxi, then vastly improved and made into a slick and polished addon package by zx64. Many thanks to zx64 for putting this into a format that could not only be used by all of ShackTac, but shared with the rest of the ArmA community as well. 
145 5 dslyecxi
146 10 zx64
Thanks also to ShackTac, of course! Also to the WGL team, ACE1 team, and ACE2 team for building upon the great foundation that BIS has laid down for us with their games and helping to take it to the next level.  Thanks to the community itself for the motivation they have instilled through their feedback on a variety of past ArmA-related works. Thanks, too, to both Yoma and Sickboy for creating tools that have redefined the way groups like mine maintain and distribute our addon sets.  And, of course, thanks to Bohemia Interactive for providing a truly one-of-a-kind series of games that has been keeping our interest for almost nine years and counting.