annotate verbage.lua @ 51:857aea8ae33d

Also detect LFR happening and load then, before they zone in and potentially get into combat. Detect combat and avoid secure button creation in that case anyhow.
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Wed, 01 Feb 2012 02:34:10 +0000
parents 1070a14cfee4
children fcc0d0ff5832
rev   line source
farmbuyer@1 1
farmbuyer@1 2 local todo = [[
farmbuyer@1 3 - broadcasted entries triggering auto-shard don't have "shard" text
farmbuyer@1 4
farmbuyer@1 5 - [DONE,TEST,comm] releasing before DBM signals wipe results in outdoor location
farmbuyer@1 6
farmbuyer@1 7 - implement ack, then fallback to recording if not ack'd
farmbuyer@1 8
farmbuyer@1 9 - special treatment for recipes / BoE items? default to guild vault?
farmbuyer@1 10
farmbuyer@29 11 - [DONE,TEST,comm] rebroadcasting entire boss sections, entire days. (TODO: maybe only whisper
farmbuyer@29 12 to specific people rather than broadcast.)
farmbuyer@1 13
farmbuyer@16 14 - [DONE] signpost a potential boss kill, pipeline loot until the cache clears
farmbuyer@1 15
farmbuyer@1 16 - Being able to drag rows up and down the main loot grid would be awesome. Coding
farmbuyer@1 17 that would be likely to drive me batshiat insane.
farmbuyer@1 18 ]]
farmbuyer@1 19
farmbuyer@1 20 local addon = select(2,...)
farmbuyer@1 21
farmbuyer@1 22 addon.helptree = {
farmbuyer@1 23 {
farmbuyer@1 24 value = "about",
farmbuyer@1 25 text = "About",
farmbuyer@1 26 },
farmbuyer@1 27 {
farmbuyer@1 28 value = "basic",
farmbuyer@1 29 text = "Basics",
farmbuyer@1 30 children = {
farmbuyer@1 31 {
farmbuyer@1 32 value = "loot",
farmbuyer@1 33 text = "Loot Entries",
farmbuyer@1 34 },
farmbuyer@1 35 {
farmbuyer@1 36 value = "boss",
farmbuyer@1 37 text = "Boss Entries",
farmbuyer@1 38 },
farmbuyer@1 39 },
farmbuyer@1 40 },
farmbuyer@1 41 {
farmbuyer@1 42 value = "tracking",
farmbuyer@1 43 text = "Tracking Loot",
farmbuyer@1 44 children = {
farmbuyer@1 45 {
farmbuyer@1 46 value = "enabled",
farmbuyer@1 47 text = "Full Tracking",
farmbuyer@1 48 },
farmbuyer@1 49 {
farmbuyer@1 50 value = "bcast",
farmbuyer@1 51 text = "Rebroadcasting",
farmbuyer@1 52 },
farmbuyer@1 53 },
farmbuyer@1 54 },
farmbuyer@1 55 {
farmbuyer@1 56 value = "texts",
farmbuyer@1 57 text = "Generated Texts",
farmbuyer@1 58 children = {
farmbuyer@1 59 {
farmbuyer@1 60 value = "forum",
farmbuyer@1 61 text = "Forum Markup",
farmbuyer@1 62 },
farmbuyer@1 63 {
farmbuyer@1 64 value = "other",
farmbuyer@1 65 text = "Other Texts",
farmbuyer@1 66 },
farmbuyer@1 67 {
farmbuyer@1 68 value = "saved",
farmbuyer@1 69 text = "Saved Texts",
farmbuyer@1 70 },
farmbuyer@1 71 },
farmbuyer@1 72 },
farmbuyer@1 73 {
farmbuyer@7 74 value = "history",
farmbuyer@7 75 text = "History Tab",
farmbuyer@7 76 },
farmbuyer@7 77 {
farmbuyer@1 78 value = "tips",
farmbuyer@1 79 text = "Handy Tips",
farmbuyer@1 80 children = {
farmbuyer@1 81 {
farmbuyer@1 82 value = "slashies",
farmbuyer@1 83 text = "Slash Commands",
farmbuyer@1 84 },
farmbuyer@1 85 },
farmbuyer@1 86 },
farmbuyer@1 87 {
farmbuyer@1 88 value = "todo",
farmbuyer@1 89 text = "TODOs, Bugs, etc",
farmbuyer@1 90 children = {
farmbuyer@1 91 {
farmbuyer@1 92 value = "gotchas",
farmbuyer@1 93 text = "Gotchas",
farmbuyer@1 94 },
farmbuyer@1 95 {
farmbuyer@1 96 value = "todolist",
farmbuyer@1 97 text = "TODO/knownbugs",
farmbuyer@1 98 },
farmbuyer@1 99 },
farmbuyer@1 100 },
farmbuyer@1 101 }
farmbuyer@1 102
farmbuyer@1 103 -- Help text. Formatting doesn't matter, but use a blank line to split
farmbuyer@1 104 -- paragraphs. This file needs to be edited with a text editor that doesn't
farmbuyer@1 105 -- do anything stupid by placing extra spaces at the end of lines.
farmbuyer@1 106 do
farmbuyer@1 107 local replacement_colors = { ["+"]="|cff30adff", ["<"]="|cff00ff00", [">"]="|r" }
farmbuyer@1 108 local T={}
farmbuyer@1 109 T.about = [[
farmbuyer@1 110 Ouro Loot is the fault of Farmbuyer of Ouroboros on US-Kilrogg. Bug reports,
farmbuyer@1 111 comments, and suggestions are welcome at the project page at curse.com or send
farmbuyer@1 112 them to <farmbuyer@gmail.com>.
farmbuyer@1 113 ]]
farmbuyer@1 114
farmbuyer@1 115 T.basic = [[
farmbuyer@1 116 The </ouroloot> (and </loot> by default) command opens this display. The buttons
farmbuyer@1 117 on the right side control operation and are mostly self-explanatory. Hovering over
farmbuyer@1 118 things will usually display some additional text in the gray line at the bottom.
farmbuyer@1 119
farmbuyer@47 120 Each tab on the left side can additionally create extra contols in the lower right
farmbuyer@47 121 section (with the same name as the tab).
farmbuyer@1 122
farmbuyer@1 123 The first tab on the left side, <Loot>, is where everything goes to and comes
farmbuyer@1 124 from. Looting events and Deadly Boss Mods notifications go to the <Loot> tab; the
farmbuyer@1 125 other tabs are all generated from the information in the <Loot> tab.
farmbuyer@16 126
farmbuyer@16 127 |cffff335dNote about these Help pages:|r The category "titles" on the left side
farmbuyer@16 128 have their own help text, in addition to the more specific entries in the expanded
farmbuyer@16 129 list. Read those first before expanding the categories or you'll miss stuff.
farmbuyer@1 130 ]]
farmbuyer@1 131
farmbuyer@1 132 T.basic_loot = [[
farmbuyer@1 133 A "loot row" in the first tab has three columns: the item, the recipient, and any
farmbuyer@1 134 extra notes. The recipient's class icon is displayed by their names, if class
farmbuyer@1 135 information is available at the time.
farmbuyer@1 136
farmbuyer@1 137 <Mouse Hover>
farmbuyer@1 138
farmbuyer@1 139 Hovering the mouse over the first column will display the item in a tooltip.
farmbuyer@1 140
farmbuyer@1 141 Hovering over the second column will display a tooltip with the loot that person
farmbuyer@1 142 has received. If they've won more than 10 items, the list is cut off with '...'
farmbuyer@1 143 at the end; to see the full list, use the right-click +Show only this player> option
farmbuyer@1 144 instead.
farmbuyer@1 145
farmbuyer@1 146 <Right-Click>
farmbuyer@1 147
farmbuyer@1 148 Right-clicking a loot row shows a dropdown menu.
farmbuyer@1 149
farmbuyer@1 150 Right-clicking in the first or third columns will display options for special
farmbuyer@1 151 treatment of that loot entry (marking as offspec, etcetera). Using any of those
farmbuyer@1 152 options will change the text in the third column (which will then affect the text
farmbuyer@1 153 in the generated tabs, such as forum markup).
farmbuyer@1 154
farmbuyer@1 155 Right-clicking in the second column allows you to temporarily remove all other
farmbuyer@1 156 players from the loot display. Use the reset button in the lower-right corner to
farmbuyer@1 157 restore the display to normal. The menu also allows you to +reassign> loot from
farmbuyer@1 158 one player to another; if the new recipient is not in the raid group at the time,
farmbuyer@1 159 use the +Enter name...> option at the bottom of the list of names to type the
farmbuyer@47 160 name into a text box. If your raid takes advantage of the ability to trade
farmbuyer@1 161 soulbound items, you will need to reassign the item here for the generated text
farmbuyer@1 162 to be factually correct.
farmbuyer@1 163
farmbuyer@1 164 See the help screen on "Boss Entries" for the +Insert new boss kill event> option.
farmbuyer@1 165
farmbuyer@1 166 <Double-Click>
farmbuyer@1 167
farmbuyer@1 168 Double-clicking a loot row in the third ("Notes") column allows you to edit that
farmbuyer@1 169 field directly. The color of the text will still depend on any +Mark as ___>
farmbuyer@1 170 actions done to that loot row, whether automatically or by hand.
farmbuyer@1 171 ]]
farmbuyer@1 172
farmbuyer@1 173 T.basic_boss = [[
farmbuyer@1 174 Boss wipe/kill entries are entirely dependant on Deadly Boss Mods being enabled and
farmbuyer@1 175 up-to-date. The typical sequence of events for our usual raids goes like this:
farmbuyer@1 176
farmbuyer@1 177 We make four or five attempts on Baron Steamroller. As DBM registers that combat
farmbuyer@1 178 ends, a <wipe> event is entered on the loot display along with the duration of the
farmbuyer@1 179 fight. If the loot display is opened, the wipes will be visible with a light gray
farmbuyer@1 180 background.
farmbuyer@1 181
farmbuyer@47 182 After reminding the melee dps to move out of fire, we manage to kill
farmbuyer@1 183 Steamroller. When DBM registers the win, a <kill> event is entered on the display
farmbuyer@1 184 with a dark gray background.
farmbuyer@1 185 All previous <wipe>s are removed and collapsed into the <kill> event. The final
farmbuyer@1 186 <kill> event shows the duration of the successful fight and the number of attempts
farmbuyer@47 187 needed (or "one-shot" if we're competent).
farmbuyer@1 188
farmbuyer@1 189 Sometimes this goes wrong, when DBM misses its own triggers. If DBM does not catch
farmbuyer@1 190 the start of the boss fight, it can't register the end, so nothing at all is
farmbuyer@1 191 recorded. If the fight was a win but DBM does not catch the victory conditions,
farmbuyer@1 192 then DBM will (after several seconds) decide that it was a wipe instead. And
farmbuyer@1 193 sometimes useful loot will drop from trash mobs, which DBM knows nothing about.
farmbuyer@1 194
farmbuyer@1 195 For all those reasons, right-clicking on a "boss row" will display options for
farmbuyer@1 196 +Insert new boss kill event>, and for toggling a <wipe> into a <kill>. We often
farmbuyer@1 197 insert bosses named "trash" to break up the display and correct the forum markup
farmbuyer@1 198 listing.
farmbuyer@1 199 ]]
farmbuyer@1 200
farmbuyer@1 201 T.tracking = [[
farmbuyer@1 202 The first button underneath +Main> in the right-hand column displays the current
farmbuyer@1 203 status of the addon. If it is disabled, then no recording, rebroadcasting, or
farmbuyer@1 204 listening for rebroadcasts is performed. Any loot already recorded will be restored
farmbuyer@1 205 across login sessions no matter the status.
farmbuyer@1 206
farmbuyer@1 207 You can turn on tracking/broadcasting before joining a raid. If you join a raid
farmbuyer@47 208 and the addon has not been turned on, then a popup dialog will ask for
farmbuyer@1 209 instructions. (This can be turned off in the advanced <Options>.)
farmbuyer@1 210
farmbuyer@1 211 The addon tries to be smart about logging on during a raid (due to a disconnect or
farmbuyer@1 212 relog). If you log in, are already in a raid group, and loot has already been
farmbuyer@16 213 stored from tracking, it will re-enable itself automatically.
farmbuyer@1 214
farmbuyer@1 215 The intent of the addon design is that, after the end of a raid, all the generated
farmbuyer@1 216 markup text is done, optionally saved (see "Generated Texts - Saved Texts"), and
farmbuyer@1 217 then cleared from
farmbuyer@1 218 storage altogether. As a result, if you login with restored loot information but
farmbuyer@1 219 are not in a raid, the addon will do nothing on its own -- but will assume that
farmbuyer@1 220 you've forgotten to finish those steps and will yammer about it in the chat window
farmbuyer@1 221 as a reminder.
farmbuyer@1 222
farmbuyer@1 223 The +Threshold> drop-down has no connection at all with any current loot threshold
farmbuyer@1 224 set by you or a master looter.
farmbuyer@1 225 ]]
farmbuyer@1 226
farmbuyer@1 227 T.tracking_enabled = [[
farmbuyer@1 228 Full tracking records all loot events that fulfill these criteria:
farmbuyer@1 229
farmbuyer@1 230 1) The loot quality is equal to or better than what you have selected in the
farmbuyer@1 231 +Threshold> drop-down.
farmbuyer@1 232
farmbuyer@47 233 2) The loot is not in the list of items to filter out (see the <Options> tab).
farmbuyer@47 234 These are things like shards from disenchanting and Darkmoon Faire quest items.
farmbuyer@1 235
farmbuyer@1 236 3) <You can see the loot event.> More precisely, you need to be close enough
farmbuyer@1 237 to the recipient of the loot to be able to see "So-And-So receives loot: [Stuff]"
farmbuyer@1 238 in your chat window, even if you have those actual loot messages turned off.
farmbuyer@1 239
farmbuyer@1 240 It is (3) that causes complications. A master looter can assign loot to anybody
farmbuyer@1 241 anywhere in a raid instance, but the range on detecting loot events is much
farmbuyer@1 242 smaller. If your raid does not use master looting then you merely need to be
farmbuyer@1 243 close enough to the boss corpse, presuming that the winners will need to walk
farmbuyer@1 244 over to get their phat epix.
farmbuyer@1 245
farmbuyer@1 246 If you do use master looter, then you have two options: first, you can
farmbuyer@1 247 require players
farmbuyer@1 248 who might get loot to stay near the boss. You would then also need to stay near
farmbuyer@1 249 the boss to detect the loot event. (This can be less hassle if you are also
farmbuyer@1 250 the loot master.) The downside is that other players moving on to fight to the
farmbuyer@1 251 next boss are doing so without the help of their teammates.
farmbuyer@1 252
farmbuyer@1 253 The other option is to ask other players to also install Ouro Loot, and for
farmbuyer@1 254 them to turn on the "Rebroadcasting" feature. Any loot events which they can
farmbuyer@1 255 see will be communicated to you. Then it only becomes necessary for at least
farmbuyer@1 256 one person to be close enough to the loot recipient to see the item awarded,
farmbuyer@47 257 and you will record it no matter how far away you are -- even back in Orgrimmar.
farmbuyer@1 258
farmbuyer@1 259 If you have Full Tracking enabled, then you are also automatically rebroadcasting.
farmbuyer@1 260 Having more than one player with Full Tracking turned on is probably a good
farmbuyer@1 261 idea, in case one of the trackers experiences a game crash or is suddenly kidnapped
farmbuyer@1 262 by robot ninja monkeys.
farmbuyer@1 263 ]]
farmbuyer@1 264
farmbuyer@1 265 T.tracking_bcast = [[
farmbuyer@1 266 The simplest method of operation is only rebroadcasting the loot events that you
farmbuyer@1 267 see, as you see them. Nothing is recorded in your local copy of the addon.
farmbuyer@1 268
farmbuyer@1 269 If you logout for any reason, the addon will not reactivate when you log back in.
farmbuyer@1 270
farmbuyer@1 271 You can use </loot bcast> or </loot broadcast> to turn on rebroadcasting without
farmbuyer@1 272 opening the GUI.
farmbuyer@1 273 ]]
farmbuyer@1 274
farmbuyer@1 275 T.texts = [[
farmbuyer@47 276 The middle tabs are simply large editable text boxes. Their text is initially
farmbuyer@47 277 generated from
farmbuyer@1 278 the information stored on the main <Loot> tab, at the time you click on the tab.
farmbuyer@1 279 Not every bit of information that
farmbuyer@1 280 we want in the generated text is always available, or depends on things that the
farmbuyer@1 281 game itself can't know. So you can edit the text in the tabs and your edits will
farmbuyer@1 282 be preserved.
farmbuyer@1 283
farmbuyer@1 284 Each time you click one of the text tabs, every new entry on the <Loot> tab
farmbuyer@1 285 since the last time this tab was shown will be turned into text.
farmbuyer@1 286
farmbuyer@1 287 Clicking the +Regenerate> button will throw away all the text on that tab, including
farmbuyer@1 288 any edits you've made, and recreate all of it from scratch. If you've accidentally
farmbuyer@1 289 deleted the text from the editbox, or you've made manual changes to the <Loot> tab,
farmbuyer@1 290 you can use this button to start over.
farmbuyer@1 291
farmbuyer@1 292 You can click in an editbox and use Control-A to select all text, then Control-C
farmbuyer@1 293 to copy it to the system clipboard for subsequent pasting into a web browser or
farmbuyer@1 294 whatever. If you're on a Mac, you probably already know the equivalent keys.
farmbuyer@1 295 ]]
farmbuyer@1 296
farmbuyer@1 297 T.texts_forum = [[
farmbuyer@1 298 The <Forum Markup> tab creates text as used by the guild forums for Ouroboros
farmbuyer@31 299 of US-Kilrogg. By default this is fairly standard BBcode. The format of the
farmbuyer@1 300 individual loot items can be adjusted via the dropdown menu on the lower right
farmbuyer@1 301 of the tab.
farmbuyer@1 302
farmbuyer@1 303 The [url] choice defaults to using Wowhead. If you have the [item] extension
farmbuyer@1 304 for your BBcode installed, you can use either of those choices too. The "by ID"
farmbuyer@16 305 variant is good for heroic raid items that share names with nonheroic items,
farmbuyer@16 306 but the raw output is harder to read in the text tab.
farmbuyer@1 307
farmbuyer@1 308 You can also specify a custom string. Formatting is done with these replacements:
farmbuyer@1 309
farmbuyer@1 310 +$N>: item name|r
farmbuyer@1 311
farmbuyer@1 312 +$I>: (capital "eye", not "ell") numeric item ID|r
farmbuyer@1 313
farmbuyer@1 314 +$T>: loot recipient and any additional notes|r
farmbuyer@1 315
farmbuyer@1 316 +$X>: if more than one of the item was looted, this is the "x2", "x3", etc
farmbuyer@1 317
farmbuyer@1 318
farmbuyer@1 319 Pro tip #1: if something has happened on the main <Loot> tab which cannot be
farmbuyer@1 320 changed directly but would generate incorrect text, you can click this tab to
farmbuyer@1 321 generate the text right away. Then edit/move the text as needed. When you
farmbuyer@1 322 close the display or click back on the <Loot> tab, your edited text will be
farmbuyer@1 323 preserved for later.
farmbuyer@1 324
farmbuyer@47 325 Pro tip #2: Barring situations like pro tip #1, this addon author typically
farmbuyer@47 326 does not generate any text until the end of the raid, simplifying things
farmbuyer@47 327 considerably.
farmbuyer@1 328 ]]
farmbuyer@1 329
farmbuyer@1 330 T.texts_other = [[
farmbuyer@1 331 So far the only other generated text is the <Attendance> tab, an alphabetized list
farmbuyer@1 332 on a per-boss basis.
farmbuyer@1 333
farmbuyer@1 334 Other addons can register their own text tabs and corresponding generation
farmbuyer@1 335 functions. If you want to be able to feed text into an offline program (for
farmbuyer@1 336 example, a spreadsheet or DKP tracker), then this may be of use to you.
farmbuyer@1 337
farmbuyer@1 338 Ideas for more tabs? Tell me!
farmbuyer@1 339 ]]
farmbuyer@1 340
farmbuyer@1 341 T.texts_saved = [[
farmbuyer@16 342 The contents of the <Forum Markup>, <Attendance>, and other such tabs can be saved,
farmbuyer@16 343 so that they will not be lost when you use the +Clear> button.
farmbuyer@1 344
farmbuyer@1 345 Do any edits you want to the generated text tabs, then click the +Save Current As...>
farmbuyer@1 346 button on the right-hand side. Enter a short descriptive reminder (for example,
farmbuyer@1 347 "thursday hardmodes") in the popup dialog. The texts will remain in their tabs,
farmbuyer@1 348 but clearing loot information will not lose them now.
farmbuyer@1 349
farmbuyer@16 350 All saved texts are listed on the right-hand side. Clicking a saved text name
farmbuyer@16 351 lets you +Load> or +Delete> that saved set. The primary <Loot> tab is not saved
farmbuyer@16 352 and restored by this process, only the generated texts. This also means you cannot
farmbuyer@16 353 +Regenerate> the texts.
farmbuyer@1 354 ]]
farmbuyer@1 355
farmbuyer@7 356 T.history = [[
farmbuyer@7 357 The <History> tab maintains a list of all loot. It is intended to help answer
farmbuyer@7 358 questions such as "When was the last time PlayerX won something?" and "How much stuff
farmbuyer@7 359 has PlayerY gotten lately?" The history tab is, by design, not as configurable
farmbuyer@25 360 as the main <Loot> tab; entries cannot be manually edited and so forth.
farmbuyer@7 361
farmbuyer@25 362 This loot history is the only "live" data tab which persists across the +Clear Loot> command.
farmbuyer@7 363 For this reason, very little information is stored: only the recipient, the item,
farmbuyer@8 364 and a textual timestamp. Boss names, offspecs, and other notes are not preserved.
farmbuyer@7 365
farmbuyer@7 366 The default history window shows the most recent item received by each person. It
farmbuyer@7 367 is sorted with the most recent loot at the top, towards older loot at the bottom.
farmbuyer@7 368 You can click the column headers to rearrange the rows, but doing so repeatedly can
farmbuyer@7 369 lead to odd display issues.
farmbuyer@7 370
farmbuyer@7 371 Left-clicking a row will change the window to display all recorded loot for that
farmbuyer@25 372 player. While on that display, right-clicking any row will return to showing the
farmbuyer@25 373 most recent single item for all players.
farmbuyer@7 374
farmbuyer@7 375 Histories are maintained per-realm. This refers to the realm you are on when the
farmbuyer@7 376 loot drops, not the realm of the player receiving it (in the case of cross-realm
farmbuyer@7 377 groups). If you play multiple characters on the same realm, history will accumulate
farmbuyer@7 378 across all your raids. To change the displayed realm, use the dropdown menu in
farmbuyer@7 379 the lower right corner.
farmbuyer@7 380
farmbuyer@7 381 The +Regenerate> button permanently erases the history of the displayed realm, and
farmbuyer@7 382 creates fresh entries using whatever loot information is currently on the <Loot> tab.
farmbuyer@7 383 Be aware that the <Loot> tab does not track realms, so if you have gathered data
farmbuyer@7 384 for players on realm A, but are displaying realm B when you click the Regenerate button,
farmbuyer@7 385 then your history for realm B will be... very odd.
farmbuyer@7 386
farmbuyer@7 387 +Clear Realm History> and +Clear ALL History> are used to periodically wipe the
farmbuyer@7 388 slate clean. They do not generate any new entries from existing loot.
farmbuyer@7 389
farmbuyer@7 390 +Clear Older> deletes history information for all items not shown in the "most recent
farmbuyer@7 391 loot" display. It is another good periodic maintenance step, but does not discard
farmbuyer@7 392 as much data as the other actions.
farmbuyer@7 393
farmbuyer@25 394 Using +Reassign to...> will also move the item between player histories. The timestamp
farmbuyer@25 395 will not be changed; it will "always have been" received by the new recipient.
farmbuyer@25 396
farmbuyer@25 397 Using +Mark as disenchanted> or +Mark as guild vault> will remove the item from
farmbuyer@25 398 history altogether. Remarking such an item as +normal> or +offspec> will replace
farmbuyer@25 399 the item back into the player's history.
farmbuyer@25 400
farmbuyer@7 401 Note: the first time you display the histories during a game session, you will
farmbuyer@7 402 likely see several items listed as +UNKNOWN>. This is not a bug; these items are
farmbuyer@7 403 simply not in your local game cache. WoW will automatically retrieve the missing
farmbuyer@7 404 data after several seconds, but the display will not update until the next time
farmbuyer@7 405 the History tab is shown. Starting in WoW 4.0, the local game cache is not preserved
farmbuyer@7 406 across play sessions, so the +UNKNOWN> entries will pop up from time to time.
farmbuyer@7 407 ]]
farmbuyer@7 408
farmbuyer@1 409 T.tips = [[
farmbuyer@16 410 Shift-clicking an item in the <Loot> or <History> display will paste it into an
farmbuyer@16 411 open chat editbox.
farmbuyer@1 412
farmbuyer@16 413 The |cffff8000[Ouro Loot]|r "legendary item" displayed at the start of all
farmbuyer@1 414 chat messages is a clickable link. Clicking opens the main display. An option
farmbuyer@1 415 on the <Options> tab will cause a message to be printed after a boss kill,
farmbuyer@1 416 mostly for lazy loot trackers who don't like typing slash commands to open windows.
farmbuyer@1 417
farmbuyer@1 418 If you are broadcasting to somebody else who is tracking, you should probably be
farmbuyer@1 419 using the same threshold. If yours is lower, then some of the loot you broadcast
farmbuyer@1 420 to him will be ignored. If yours is higher, then you will not be sending information
farmbuyer@1 421 that he would have recorded. The "correct" setting depends on what your guild wants
farmbuyer@1 422 to track.
farmbuyer@1 423
farmbuyer@1 424 Ticking the "notraid" box in advanced debugging <Options>, before enabling tracking,
farmbuyer@1 425 will make the tracking work outside of a raid group. Communication functions
farmbuyer@1 426 will behave a little strangely when doing this. Be sure to check the threshold!
farmbuyer@1 427 You can also use <"/ouroloot debug notraid"> instead.
farmbuyer@1 428
farmbuyer@1 429 Using the "Saved Texts" feature plus the +Clear> button is a great way of putting
farmbuyer@1 430 off pasting loot into your guild's website until a more convenient time.
farmbuyer@1 431 ]]
farmbuyer@1 432
farmbuyer@1 433 T.tips_slashies = [[
farmbuyer@16 434 If you give an unrecognized argument to the </ouroloot> slash command, it will
farmbuyer@16 435 search the tab titles left to right for a title beginning with the same letters as
farmbuyer@16 436 the argument, and open the display to that tab. For example, <"/loot a"> would
farmbuyer@16 437 open the <Attendance> tab, and <"/loot ad"> would open the <Advanced> tab. If
farmbuyer@16 438 you had added a theoretical <EQDKP> tab, then <"/loot eq"> would be the fastest
farmbuyer@16 439 way to see it.
farmbuyer@16 440
farmbuyer@1 441 The </ouroloot> command can take arguments to do things without going through
farmbuyer@1 442 the UI. Parts given in *(angle brackets)* are required, parts in [square brackets]
farmbuyer@1 443 are optional:
farmbuyer@1 444
farmbuyer@1 445 +broadcast>/+bcast>: turns on rebroadcasting|r
farmbuyer@1 446
farmbuyer@1 447 +on [T]>: turns on full tracking, optionally setting threshold to T|r
farmbuyer@1 448
farmbuyer@1 449 +off>: turns off everything|r
farmbuyer@1 450
farmbuyer@1 451 +thre[shold] T>: sets tracking threshold to T|r
farmbuyer@1 452
farmbuyer@1 453 +list>: prints saved text names and numbers|r
farmbuyer@1 454
farmbuyer@1 455 +save *(your set name)*>: saves texts as "your set name"|r
farmbuyer@1 456
farmbuyer@1 457 +restore *(N)*>: restores set number N|r
farmbuyer@1 458
farmbuyer@1 459 +delete *(N)*>: deletes set number N|r
farmbuyer@1 460
farmbuyer@1 461 +help>: opens the UI to the help tab|r
farmbuyer@1 462
farmbuyer@1 463 +toggle>: opens or closes the UI (used mostly in automated wrappers)|r
farmbuyer@1 464
farmbuyer@1 465
farmbuyer@1 466 If you use the slash commands to enable tracking or set loot thresholds, you can
farmbuyer@1 467 give numbers or common names for the threshold. For example, "0", "poor", "trash",
farmbuyer@1 468 "gray"/"grey" are all the same, "4", "epic", "purple" are the same, and so on.
farmbuyer@1 469 ]]
farmbuyer@1 470
farmbuyer@1 471 T.todo = [[
farmbuyer@1 472 If you have ideas or complaints or bug reports, first check the Bugs subcategories
farmbuyer@1 473 to see if they're already being worked on. Bug reports are especially helpful
farmbuyer@1 474 if you can include a screenshot (in whatever image format you find convenient).
farmbuyer@1 475
farmbuyer@1 476 Click the "About" line on the left for contact information.
farmbuyer@1 477 ]]
farmbuyer@1 478
farmbuyer@1 479 T.todo_gotchas = [[
farmbuyer@1 480 <Things Which Might Surprise You> (and things I'm not sure I like in the
farmbuyer@1 481 current design):
farmbuyer@1 482
farmbuyer@1 483 If you relog (or get disconnected) while in a raid group, behavior when you log
farmbuyer@1 484 back in can be surprising. If you have already recorded loot (and therefore
farmbuyer@1 485 the loot list is restored), then OL assumes it's from the current raid and should
farmbuyer@1 486 reactivate automatically in full tracking mode. If you were tracking but no
farmbuyer@1 487 loot had dropped yet (and therefore there was nothing *to* restore), then OL
farmbuyer@1 488 will pop up its reminder and ask again. Either way, if you were only broadcasting
farmbuyer@1 489 then OL will *not* go back to only broadcasting. This is probably a bug.
farmbuyer@1 490
farmbuyer@1 491 The saved texts feature does exactly that: only saves the generated texts, not
farmbuyer@1 492 the full loot list. Restoring will get you a blank first tab and whatever you
farmbuyer@1 493 previously had in the various generated text tabs.
farmbuyer@1 494
farmbuyer@1 495 Using the right-click menu to change an item's treatment (shard, offspec, etc)
farmbuyer@1 496 does not broadcast that change to anyone else who is also tracking. Changing
farmbuyer@47 497 the item and then selecting "rebroadcast this item" <does> include that extra
farmbuyer@47 498 info. Automatically doing that on the initial "mark as xxx" action would
farmbuyer@47 499 be... tricky.
farmbuyer@1 500
farmbuyer@47 501 The generated forum text tries to only list the name of the instance if it has
farmbuyer@47 502 not already been listed, or if it is different than the instance of the previous
farmbuyer@1 503 boss. If you relog, the "last printed instance name" will be forgotten, and
farmbuyer@1 504 you'll see redundant raid instance names appearing in the text.
farmbuyer@1 505
farmbuyer@1 506 After a boss wipe, multiple broadcasting players releasing spirit more than
farmbuyer@1 507 several seconds apart can cause spurious "wipe" entries (of zero duration) on
farmbuyer@1 508 the loot grid. The surefire way to avoid this is to not release spirit until
farmbuyer@1 509 DBM announces the wipe, but the problem isn't serious enough to really worry
farmbuyer@1 510 about. (Right-click the spurious entries and delete them.)
farmbuyer@1 511 ]]
farmbuyer@1 512
farmbuyer@1 513 T.todo_todolist = todo
farmbuyer@1 514
farmbuyer@1 515
farmbuyer@1 516 -- Fill out the table that will actually be used. Join adjacent lines here so
farmbuyer@1 517 -- that they'll wrap properly.
farmbuyer@1 518 addon.helptext = {}
farmbuyer@1 519 for k,text in pairs(T) do
farmbuyer@1 520 local funkykey = k:gsub('_','\001') -- this is how TreeGroup makes unique keys
farmbuyer@1 521 local wrapped = text
farmbuyer@1 522 wrapped = wrapped:gsub ("[%+<>]", replacement_colors)
farmbuyer@1 523 wrapped = wrapped:gsub ("([^\n])\n([^\n])", "%1 %2")
farmbuyer@1 524 wrapped = wrapped:gsub ("|r\n\n", "|r\n")
farmbuyer@1 525 wrapped = wrapped:gsub ("Ouroboros", "|cffa335ee<Ouroboros>|r")
farmbuyer@1 526 wrapped = wrapped:gsub ("%*%(", "<") :gsub("%)%*", ">")
farmbuyer@1 527 addon.helptext[funkykey] = wrapped
farmbuyer@1 528 end
farmbuyer@1 529 end -- do scope
farmbuyer@1 530 todo = nil
farmbuyer@1 531
farmbuyer@1 532
farmbuyer@1 533 -- Don't bother recording any of this loot:
farmbuyer@1 534 addon.default_itemfilter = {
farmbuyer@1 535 [29434] = true, -- Badge of Justice
farmbuyer@1 536 [40752] = true, -- Emblem of Heroism
farmbuyer@1 537 [40753] = true, -- Emblem of Valor
farmbuyer@1 538 [45624] = true, -- Emblem of Conquest
farmbuyer@47 539 -- could probably remove most of this now
farmbuyer@1 540 [43228] = true, -- Stone Keeper's Shard
farmbuyer@1 541 [47241] = true, -- Emblem of Triumph
farmbuyer@1 542 [49426] = true, -- Emblem of Frost
farmbuyer@1 543 }
farmbuyer@1 544
farmbuyer@1 545 -- vim:noet