vanilla-wow-addons – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 --------------------------------------------------------------------------------
2 S M A R T A S S I S T
3 --------------------------------------------------------------------------------
4  
5 SmartAssist is an addon which improves default assisting and targetting system in groups.
6  
7 Main features
8  
9 * Primary puller.
10 * Assist all party members trough single key. No need to bind multiple assist keys!
11 * Priorize low health players.
12 * Assist from party members emotes (helpme/attacktarget)
13 * Visual warning if acquired target is passive (not yet aggroed).
14 * List of all available targets. See detailed explanation below.
15 * Audio warning if you acquire aggro from known target.
16 * Does not offer stunned or polymorphed targets for you
17 * Selecting unit while holding shift will assist him. This works from anywhere where you can select unit. Example party icons, ct raidassist and even from player character.
18 * Configurable spell slot which will be cast if the acquired target is in combat. For hunters this is Auto Shot by default.
19 * SmartActions, See detailed explanation below.
20 * Supports CT RaidAssist tanks automaticly.
21 * Supports myAddons.
22 * Supports Scrolling Combat Text
23 * Does not use any chat channels to operate
24  
25 Installation and configuration?
26 -------------------------------
27  
28 Extract SmartAssist folder to <your-wow-install-dir>\Interface\Addons\. Ingame
29 go to the key binding options using esc key and bind key for assisting and
30 optionally for setting puller.
31  
32 SmartAssist configuration window can be opened by typing /sa or /smartassist
33 command.
34  
35 How to use it?
36 --------------
37  
38 If you are in group you may wish to set a puller. Decide who it is going to
39 be and set him as puller by targetting player/pet and either press 'set puller'
40 key or select 'set as puller' from player portrait menu.
41  
42 This is not mandatory and SmartAssist does excellent job even without assigned
43 puller. This is because the assist lookup order is based on character class.
44  
45 If you have not set someone to be a puller, SmartAssist will automatically use
46 your pet as one.
47  
48 When hitting 'SmartAssist'-key it will try to find who to assist starting from
49 your assigned puller. If it doesn't have good target it continues to look if
50 someone in your group is in need of assistance. If there isn't anyone to assist
51 in your group can be configured to fallback to basic target nearest enemy.
52 This should select good target in almost any situation.
53  
54 You can skip current assist by pressing 'SmartAssist'-key again, it should jump
55 to next available party memeber. So you can cycle trough all targets of your
56 group easily.
57  
58  
59 Available targets/assists
60 -------------------------
61  
62 Display floating list that has all hostile targets listed that your group is
63 currently engaging. Displays the name and health of the target and targets
64 target. Name of the targets target is color coded: white=normal, green = MT,
65 Red = You. Border of box is also color coded: Red = Hunters mark,
66 Black = Target is under crowd control (sheep, trap etc). Currently targetted
67 unit background is displayed in green and pullers target in yellow. There's
68 also small text at the bottom of box that tells who is targetting the mob.
69 If theres more than one targetting that enemy you'll see counter.
70  
71 Once you get used to reading this list you get very good overall idea
72 what's going on.
73  
74 So what exactly are smart actions?
75 ----------------------------------
76  
77 Consider following situation, you have some ally unit selected and you wish to
78 assist him. Normally without any addon you first press assist key and then
79 start casting the spells. Smart actions improve this scenario so that you
80 don't need to change target manually or press any assist key. With smart
81 actions you can just cast the attack on your ally and SmartAssist will detect
82 the situation and switch to ally target.
83  
84 Another scenario which we can make smarter is when you don't have any target
85 selected. Instead of getting 'You have no target' SmartActions can do SmartAssist
86 and try to acquire some target before casting the spell.
87  
88 To accomplish these features SmartAssist will need to know what actions are
89 considered as attacks. This is done by dragging the spells to configuration
90 dialog.
91  
92 SmartAssist also provides built in spell lists for some classes. Once you
93 startup SmartAssist first time it will ask if you wish to use auto configure.
94  
95 Other
96 -----
97  
98 This is my first released addon. As a beginner addon writer I've had to look
99 other addons for source of inspiration. There are some bits and pieces from
100 various addons and I've done my best effort to comment and credit every one
101 of them.
102  
103  
104 --------------------------------------------------------------------------------
105 Problems
106 --------------------------------------------------------------------------------
107  
108 KNOWN:
109  
110 - Current version works only with english client
111  
112 AND FOR REST:
113  
114 - First try to reset addon settings by command /sa reset
115  
116 - If problem persist you may get more information about what is going on by
117 entering command /sa debug. Additional information will be printed in General.
118 You can turn debug off by typing command again. These messages might be
119 helpfull to determine what's going on.
120  
121 You can reach me trough email: paranoidi@gmx.net altough it is not my main email
122 account.
123  
124 --------------------------------------------------------------------------------
125 Other
126 --------------------------------------------------------------------------------
127  
128 This is my first released addon. As a beginner addon writer I've had to look
129 other addons for source of inspiration. There are some bits and pieces from
130 various addons and I've done my best effort to comment and credit every one of
131 them.
132  
133 --------------------------------------------------------------------------------
134 Is this addon against blizzard policy ?
135 --------------------------------------------------------------------------------
136  
137 Moderator has stated in interface customization forums that:
138  
139 "Just so you know, the designers are against mods doing automated spell choosing
140 and target choosing for players, there just isn't a good way to prevent it at
141 the moment. If you do add such a feature, it's pretty likely to either not work
142 or not be allowed at some point in the future.
143  
144 Note that this does not mean that such mods are illegal at this time, just that
145 they are not encouraged."
146  
147 SmartAssist shouldn't be one of the unwanted addons due following reasons:
148  
149 - This addon does not do any automated spell choosing.
150  
151 - Automated target choosing I believe refers to addons that would select target
152 that has least HP or are otherwise ideal targets. SmartAssist doesn't do work
153 this way, it doesn't go trough all available enemies and select the one with
154 lowest health. Instead we assist group / raid members one by one and stop
155 when we have target.
156  
157 Only questionable feature that I can even think about is that SmartAssist
158 skips stunned mobs. However that is not the main idea of this addon and if
159 it is ever found to be something that addons should not do I will remove it.
160 Also note that this skipping is not as definite as sheepdefender which is
161 somewhat commonly disputed. You CAN still attack stunned mobs accidentally,
162 forexample if someone sheeps your target.
163  
164 --------------------------------------------------------------------------------
165 Readme is updated to version 1.2.1
166 --------------------------------------------------------------------------------