Dungeon Helper 5 release notes

Scooper release notes

Scooper was rebuilt for Dungeon Helper 5. It picks up the same kinds of loot as before, but what it takes is now decided by a table of rules you can tune one by one. For how to use each feature, see the Scooper guide and Scooper settings.

The window

• The window has tabs. Status and Config are the two you use. The rest show what Scooper is tracking.
• Start / Stop, Loot from Chests, Loot Bindable Items, Only Chests and Show Pickup Range sit above the tabs, so you can reach them from any tab.
• The line beside Start / Stop names the character and server whose settings are loaded.
• The Status tab has a running log of what Scooper matched, tried, picked up and skipped, with the reason. Scooper 1.x kept its log hidden.
• Items picked up counts this session’s confirmed pickups, and Quest CR / Reaper shows the values the Lost Souls rule works from.

See The main window.

What gets picked up

Rules replace the category checkboxes

Scooper 1.x had one checkbox per category. Scooper 2.0 has a rule table instead, with 27 built-in rules in three groups (Common Loot, Equipment and Special) and a Custom group for your own. Every old category is there as a rule. See The built-in rules.

• Rules are tried from the top, and the first enabled rule that fully matches an object decides. Order now matters. See How Scooper decides.
• Breakables is an ordinary rule in Special. In Scooper 1.x the Breakables checkbox was hidden.
• XP Stones is a rule again. Scooper 1.3.6 had removed the option.
• Built-in rules can be switched off and given conditions, but not renamed or deleted.

Conditions on every rule

Each rule has a C button that opens its conditions. Scooper 1.x had none of these apart from a mythic level. See Conditions.

• Where you are: In Town, Out of Town, In Quest and In Explorer. A rule works if you are in any ticked place.
• Where the item is: From Ground and From Reward.
• What the item has: Has Reaper Effect, Has Mythic Effect with Excluded Mythic Levels, Has Dual-Slot Augments and Has Single-Slot Augment with Excluded Slot Colors, Is Named and Is Random Gen.
• Only When Low Mana, which the Lost Souls rule uses.
• Max range (m), covered under Range and the circles on the ground.

Two of these go further than Scooper 1.x could:

• Augment slots. The old Dual-Augments checkbox only looked for two slots. You can now ask for exactly one slot as well, and skip items by slot colour.
• Mythic levels. The old dropdown set a minimum level. You now tick the levels to skip, so any combination is possible.

Always, Chest and Bound are set per rule

• Always is a column on every rule. It lets that rule ignore the empty slot threshold and take from end-reward panels. In Scooper 1.x, Enable Always Loot was one switch that covered Guild XP and Remnants only.
• Chest and Bound are columns on every rule too. Each one either follows the switch above the tabs (Loot from Chests or Loot Bindable Items), or is set to Yes or No for that rule alone. In Scooper 1.x both were all or nothing.
• A rule set to No does not block the item. Scooper moves on to the next rule that matches.
• Always does not let a rule take from chests. That is what Chest is for.

See Pickup rules.

Your own rules

• Create Rule from Selection replaces Add Selected Item. It makes a rule for exactly the item you have selected, in every stack size. The old button stored the item’s name.
• Add Rule makes an empty custom rule. Click its name to open the rule editor.
• A custom rule can match on item type, item ID or name, or a combination. Scooper 1.x custom items matched an exact name only.
• Names can be matched with Exact, Contains, StartsWith or Wildcard, and one rule can hold several patterns separated by |.
• Custom rules get the same conditions and the same Always, Chest and Bound columns as built-in rules.

See Custom rules.

Lost Souls and explorer texts

• Outside reaper difficulty, the Lost Souls rule now takes a Lost Soul only when you are below 10% of your spell points. Scooper 1.x took one whenever you had 10% or more left, which was nearly always. In reaper the rule is unchanged: you must be missing at least as much as a Lost Soul restores.
• After reading an explorer text, Scooper closes the book window. Scooper 1.x did not.

Safer, confirmed pickups

• Your target is left alone. Scooper 1.x selected each object before using it. Dungeon Helper 5 lets plugins use an object directly, so Scooper no longer changes your target to pick something up. Breakables are the exception: Scooper still selects a crate or barrel to smash it.
• Mythic and reaper checks leave your selection alone too. Scooper 1.x selected each named item and pressed the examine key. Dungeon Helper 5 lets plugins ask for an item’s details directly, and Scooper only asks when an enabled rule needs the answer.
• Doors, levers and NPCs are off limits. Scooper works out what each object is before any rule may use it. One-use objects such as collection spots, treasure bags, Piles of Gold and crates can only be used by the built-in rules made for them, and only the Explorers rule reads texts. An object Scooper cannot identify is skipped and looked at again later.
• Every pickup is confirmed. Scooper waits for the sign that fits the item: your wallet going up, a gathering bag filling, the item reaching your inventory, or the object reporting it was used. Only then does it count. If an item simply vanishes because someone else took it, it is not counted.
• Retries are automatic. A pickup that does not take is retried after 2 seconds, plus 0.8 seconds for each failure in a row. The Timeout (ms) setting is gone.
• Pickups are paced. Scooper handles one pickup at a time and waits at least Min pickup spacing (ms) between them. The default is 250, about four a second. 0 removes the limit.
• The bind prompt is only confirmed when the winning rule allows bound items, through its Bound column or Loot Bindable Items.

See How Scooper decides.

Range and the circles on the ground

Scooper 1.x had no range setting. Scooper 2.0 has two, plus a way to see the result.

• Default pickup range (m) sets how far Scooper reaches for loose items. It starts at 3.7 and cannot go below 0.5.
• Max range (m) in a rule’s conditions gives that rule its own reach, longer or shorter than normal. -1 means use the normal range.
• Chests, doors and NPCs keep their own shorter reach unless a rule sets one.
• Items in the chest you have open are not range-checked.

See How far Scooper reaches.

Show Pickup Range is new. Dungeon Helper 5 lets plugins draw in the game world, so Scooper can draw a circle on the ground around every nearby item a rule matches and around every chest, sized to its real reach.

• Items are amber and turn green when you are close enough. Chests are violet and turn cyan.
• The circles are part of the scene. Walls and terrain hide them, and a faint copy shows through so you can still find one around a corner.
• They work while Scooper is stopped and while its window is closed, so you can use them just to see how close you need to be.
• Range circle fill opacity sets how solid they are. The outline always shows fully.

Limits to know about:

• At most 48 circles are drawn, nearest first, and nothing further than 40 m away is drawn.
• The circles are flat. On slopes, or for things up on a ledge, they are approximate.
• A chest is circled whether or not it holds anything you want.
• The circles ignore Only Chests, and loot reserved for another party member is still circled.

See Why didn’t it pick that up?.

Settings, files and rule profiles

• Settings are kept per character, one file each, in a ScooperConfigs folder inside Scooper’s plugin folder. Scooper 1.x kept every character in a single Scooper.json.
• Rule profiles are new. Save Rules stores a character’s whole rule table under a name, and Load puts it on any other character. Profiles are shared by all characters and live in a ScooperProfiles folder.
• A profile holds rules only. Loading one never changes the switches above the tabs or the numbers under Global Settings.
• Load replaces the character’s rule table. Custom rules that are not in the profile are lost, so Scooper asks first. It also asks before replacing or deleting a profile.
• Profile names can be up to 64 characters.
• A profile saved before a built-in rule existed still works. Loading it adds the missing built-in rule.

New settings on the Config tab, all per character:

See Where your settings are kept and Add Rule, hotkeys and rule profiles.

Hotkeys and chat commands

• Scooper has one hotkey, Toggle, which starts and stops it. Set it at the bottom of the Config tab. Esc cancels. It is shared by all characters.
• Scooper has no chat commands.

Finding out why

• Evaluate Selected Item is new. Select anything in game and press it. The log gets a full report: what Scooper thinks the object is, how far away it is against its reach, where you are, and for each rule whether it matched and which condition failed. The report is also copied to your clipboard.
• The same report warns about rules that contradict themselves, such as Is Named together with Is Random Gen.
• The Timeout, Used, Unusable, Examination and Inventory tabs list the objects Scooper is waiting on, has finished with, or is ignoring.
• The Perf tab shows how long each part of Scooper’s work takes, in the same terms as Dungeon Helper’s own Performance tab.
• A Probe checkbox and tab record the pickups made near you to a file in a ScooperProbes folder, for troubleshooting. It is off by default and never changes what Scooper picks up.

See The other tabs.

If you used an earlier 2.0 beta

A few things changed during the beta. Scooper updates your saved rules by itself.

• Chest and Bound used to be tick boxes. They now cycle between following the switch above the tabs, Yes and No. Boxes you had ticked become Yes.
• The four place conditions used to all have to be true. A rule now works if you are in any ticked place.
• In Explorer now works. A rule with only In Quest ticked no longer works in wilderness areas, so tick In Explorer as well if you want both.
• Guild renown items are taken by the Guild XP rule. Currency and other broad rules no longer catch them first.
• Create Rule from Selection used to make a rule that also matched everything of the same type. It now matches that item only. Rules it made earlier are narrowed the same way, unless you renamed or extended them.
• Mysterious Remnants are picked up from the ground. In earlier betas the rule never fired there.
• Piles of Gold and Mysterious Remnants are used once per character. Scooper no longer skips one because another party member used it first.

Coming from Dungeon Helper 4

What carries over

The first time a character logs in, Scooper looks for a Scooper 1.x Scooper.json in its plugin folder and converts that character’s settings. It does this only if the character has no Scooper 2.0 settings yet.

• Each category checkbox becomes the matching rule, switched on or off as you had it.
• Inventory Space to keep Empty, Loot Chests, Loot Bind on Acquire Items, Loot Only Chests and Start on Load keep their values.
• Enable Always Loot becomes Always on the Guild XP and Mysterious Remnants rules.
• A minimum mythic level becomes Excluded Mythic Levels on the Mythic Bonus rule.

What does not carry over

• Your custom item list. Items added with Add Selected Item are not turned into rules. Recreate them with Create Rule from Selection, or with a custom rule that matches on name.
• Your hotkey. Set Toggle again on the Config tab.
• Timeout (ms). The setting no longer exists.

Renamed

What may surprise you

• Rules are set up for outside town. Every rule starts with Out of Town, In Quest and In Explorer ticked and In Town unticked. That includes converted rules and new custom rules. Scooper 1.x had no place setting. Tick In Town in a rule’s conditions if you want it to work in towns and public areas.
• XP Stones may be switched on. Scooper 1.3.6 removed the XP Stone option but kept its saved value, which was on unless you had unticked it. The conversion reads that value, so the XP Stones rule can come across switched on. On a character with no old settings it is off.
• Lost Souls are taken far less often outside reaper, as described above.
• Rule order decides. If two rules match an item, the first one wins, and its Always setting is the one used.
• Always is not a chest setting. A rule with Always still needs Chest or Loot from Chests to take items from a chest you open.
• Your target no longer jumps to each item as it is picked up.
• A failed pickup is retried for as long as the object is there. There is no limit on the number of tries yet.
• Dungeon Helper 4 and 5 keep separate settings. Changes you make in Scooper 2.0 do not go back to Scooper 1.x.

Scooper guide and download · ← Dungeon Helper 5 release notes