comparison verbage.lua @ 73:32eb24fb2ebf

- This code is not quite ready for prime time. Do not run it yet. - Loot events have associated unique IDs, enabling some new actions over the network. These IDs are preserved as part of realm history. As a result, the stored history format has completely changed (and requires less memory as a bonus). - "Prescan for faster handling" option, default off. - "Mark as <x>" now broadcast to other trackers. Older versions can't receive the message, of course. Future: Broadcast reassigning loot. - New options controlling whether (and where) to print a message when another player broadcasts those kinds of changes to existing loot. - Names colored by class when that data is available; CUSTOM_CLASS_COLORS supported. - Metric boatloads of minor tweaks and optimizations throughout.
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Tue, 29 May 2012 22:50:09 +0000
parents cdee65c1bd8c
children 124da015c4a2
comparison
equal deleted inserted replaced
72:bb19899c65a7 73:32eb24fb2ebf
2 local todo = [[ 2 local todo = [[
3 - [DONE,TEST,comm] releasing before DBM signals wipe results in outdoor location 3 - [DONE,TEST,comm] releasing before DBM signals wipe results in outdoor location
4 4
5 - implement ack, then fallback to recording if not ack'd 5 - implement ack, then fallback to recording if not ack'd
6 6
7 - special treatment for recipes / BoE items? default to guild vault? 7 - special treatment for recipes / BoE items? default to guild vault? (DONE for user-configurable list of items defaulting to crafting drops)
8 8
9 - [DONE,TEST,comm] rebroadcasting entire boss sections, entire days. (TODO: maybe only whisper 9 - [DONE,TEST,comm] rebroadcasting entire boss sections, entire days. (TODO: maybe only whisper
10 to specific people rather than broadcast.) 10 to specific people rather than broadcast.)
11 11
12 - [DONE] signpost a potential boss kill, pipeline loot until the cache clears 12 - [DONE] signpost a potential boss kill, pipeline loot until the cache clears
78 text = "Handy Tips", 78 text = "Handy Tips",
79 children = { 79 children = {
80 { 80 {
81 value = "slashies", 81 value = "slashies",
82 text = "Slash Commands", 82 text = "Slash Commands",
83 },
84 {
85 value = "prescan",
86 text = "Prescanning",
83 }, 87 },
84 }, 88 },
85 }, 89 },
86 { 90 {
87 value = "todo", 91 value = "todo",
101 105
102 -- Help text. Formatting doesn't matter, but use a blank line to split 106 -- Help text. Formatting doesn't matter, but use a blank line to split
103 -- paragraphs. This file needs to be edited with a text editor that doesn't 107 -- paragraphs. This file needs to be edited with a text editor that doesn't
104 -- do anything stupid by placing extra spaces at the end of lines. 108 -- do anything stupid by placing extra spaces at the end of lines.
105 do 109 do
106 local replacement_colors = { ["+"]="|cff30adff", ["<"]="|cff00ff00", [">"]="|r" } 110 local replacement_colors = {
111 ["+"]="|cff30adff", -- blue: right-click options, control panel names
112 ["<"]="|cff00ff00", -- light green, tab titles and generic highlighting
113 [">"]="|r" }
107 local T={} 114 local T={}
108 T.about = [[ 115 T.about = [[
109 Ouro Loot is the fault of Farmbuyer of Ouroboros on US-Kilrogg. Bug reports, 116 Ouro Loot is the fault of Farmbuyer of Ouroboros on US-Kilrogg. Bug reports,
110 comments, and suggestions are welcome at the project page at curse.com or send 117 comments, and suggestions are welcome at the project page at curse.com or send
111 them to <farmbuyer@gmail.com>. 118 them to <farmbuyer@gmail.com>.
468 If you use the slash commands to enable tracking or set loot thresholds, you can 475 If you use the slash commands to enable tracking or set loot thresholds, you can
469 give numbers or common names for the threshold. For example, "0", "poor", "trash", 476 give numbers or common names for the threshold. For example, "0", "poor", "trash",
470 "gray"/"grey" are all the same, "4", "epic", "purple" are the same, and so on. 477 "gray"/"grey" are all the same, "4", "epic", "purple" are the same, and so on.
471 ]] 478 ]]
472 479
480 T.tips_prescan = [[
481 When loot is manipulated, the history of previous loot entries must be scanned
482 to determine whether you already have any information for that loot. In this
483 case, "loot manipulation" includes things like receiving loot broadcasts from
484 other players, marking older loot as being disenchanted, and so on.
485
486 You can speed up these actions by turning on the +Prescan for faster handling>
487 toggle on the <Options> tab. This is a tradeoff: loot manipulation will
488 go faster, but data from the prescan will use up more memory. (If you end up
489 doing things to every single piece of loot, you would use up all that memory
490 eventually. But if you don't, then that memory is essentially wasted.)
491
492 This prescanning is only done for the specific realm on which you're playing.
493 Much depends on how far back you preserve history. The more history you keep
494 for a given realm, then...
495
496 [option on] ...the more memory this option uses...
497
498 [option off] ...the longer loot work takes...
499
500 ...while manipulating loot for that realm. See the tradeoff?
501
502 The prescan is only done once, during login. It will print out how much
503 additional memory is used, so you can better decide whether this option is
504 worth turning on. This also means that you need to relog or /reload to have
505 the option take effect once you enable it.
506 ]]
507
473 T.todo = [[ 508 T.todo = [[
474 If you have ideas or complaints or bug reports, first check the Bugs subcategories 509 If you have ideas or complaints or bug reports, first check the Bugs subcategories
475 to see if they're already being worked on. Bug reports are especially helpful 510 to see if they're already being worked on. Bug reports are especially helpful
476 if you can include a screenshot (in whatever image format you find convenient). 511 if you can include a screenshot (in whatever image format you find convenient),
512 and a copy of your SavedVariables file. This is found in your World of Warcraft
513 installation folder, named "WTF/Account/you/SavedVariables/Ouro_Loot.lua"
514 (where "you" is your account name). You may need to compress this file
515 before the ticket system will accept it.
477 516
478 Click the "About" line on the left for contact information. 517 Click the "About" line on the left for contact information.
479 ]] 518 ]]
480 519
481 T.todo_gotchas = [[ 520 T.todo_gotchas = [[
482 <Things Which Might Surprise You> (and things I'm not sure I like in the 521 <Things Which Might Surprise You> (and things I'm not sure I like in the
483 current design): 522 current design):
523
524 Manipulating existing information while logged into a realm other than the
525 realm represented by that same information can yield strange results, including
526 outright breakage.
484 527
485 If you relog (or get disconnected) while in a raid group, behavior when you log 528 If you relog (or get disconnected) while in a raid group, behavior when you log
486 back in can be surprising. If you have already recorded loot (and therefore 529 back in can be surprising. If you have already recorded loot (and therefore
487 the loot list is restored), then OL assumes it's from the current raid and should 530 the loot list is restored), then OL assumes it's from the current raid and should
488 reactivate automatically in full tracking mode. If you were tracking but no 531 reactivate automatically in full tracking mode. If you were tracking but no
491 then OL will *not* go back to only broadcasting. This is probably a bug. 534 then OL will *not* go back to only broadcasting. This is probably a bug.
492 535
493 The saved texts feature does exactly that: only saves the generated texts, not 536 The saved texts feature does exactly that: only saves the generated texts, not
494 the full loot list. Restoring will get you a blank first tab and whatever you 537 the full loot list. Restoring will get you a blank first tab and whatever you
495 previously had in the various generated text tabs. 538 previously had in the various generated text tabs.
496
497 Using the right-click menu to change an item's treatment (shard, offspec, etc)
498 does not broadcast that change to anyone else who is also tracking. Changing
499 the item and then selecting "rebroadcast this item" <does> include that extra
500 info. Automatically doing that on the initial "mark as xxx" action would
501 be... tricky.
502 539
503 The generated forum text tries to only list the name of the instance if it has 540 The generated forum text tries to only list the name of the instance if it has
504 not already been listed, or if it is different than the instance of the previous 541 not already been listed, or if it is different than the instance of the previous
505 boss. If you relog, the "last printed instance name" will be forgotten, and 542 boss. If you relog, the "last printed instance name" will be forgotten, and
506 you'll see redundant raid instance names appearing in the text. 543 you'll see redundant raid instance names appearing in the text.