annotate verbage.lua @ 70:cdee65c1bd8c

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