Item Filter - jainafrost/MapAssist GitHub Wiki

Status: DETECTED

Do Not Use on B.net

Using this program on B.net will result in a permanent account suspension from D2R online.

MapAssist users reported being banned from D2R online services beginning June 14, 2022.

Item Filter

The item filter will apply to

  • unidentified items on the ground,
  • identified items in a vendor's store, and
  • identified items in your inventory or cube

The item filter is a yaml file with a specific format. Check out some basics for yaml, but you can look through this wiki and the default itemfilter.yaml file for examples on how to construct new filters to fit your needs.

If your item filter is not loading properly and giving an error, check to make sure your yaml formatting is valid here.

The default item filter file is meant to be a sample. You are free to edit it to your own liking.

Items on the ground

  • All rules will be tested for items on the ground.
  • If an item is unidentified, only some item attributes can properly be tested. For instance, a criterion for all resistance can only properly work on items that come unidentified with all resistance (like a Paladin shield) or once identified (like a rare ring). An example of how to properly handle this can be found below.
# This rule will work on all identified and unidentified Paladin shields
# that drop with all resistance stats
Paladin Shields:
  - All Resist: 1

# This ring rule will show all unidentified rare rings that drop on the ground
Ring:
  - Qualities: rare
  # The ring below tests stats that only possible on identified items, so this rule
  # will only trigger when the ring identified by you or picked up as identified
  - Qualities: rare
    All Resist: 1

Items in a vendor's store

  • All rules will be tested for items being sold by the vendor.
  • These rules will only be tested when trading with the vendor. Talking to them is insufficient, you must click on trade.
# This will show Barbarian Warcry sticks when you trade a town vendor that has them for sale
Glaive:
  - Qualities: magic
    Class Skill Tree:
      Barbarian Warcries: 3

Items identified in your inventory

  • Only rules that contain stats that can be rolled will be tested for identified items in your inventory.
  • Rules that are simple enough to apply to unidentified items will not work.
Gloves:
  # This will show elite magic gloves, but will not trigger if found in your inventory
  - Tiers: elite
    Qualities: magic
  # This will show elite 3/20 magic gloves and will work if found in your inventory
  - Tiers: elite
    Qualities: magic
    Increased Attack Speed: 20
    Class Skill Tree:
      Amazon Javelin And Spear: 3

Item Classes

Click to expand! 
Axes:
Wands:
Clubs:
Scepters:
Maces:
Hammers:
Swords:
Daggers:
Throwing Knifes:
Throwing Axes:
Javelins:
Spears:
Polearms:
Staves:
Bows:
Crossbows:
Helms:
Armors:
Shields:
Gloves:
Boots:
Belts:
Circlets:
Assassin Katars:
Sorceress Orbs:
Amazon Bows:
Amazon Spears:
Amazon Javelins:
Druid Helms:
Barbarian Helms:
Paladin Shields:
Necromancer Shields:

Item Tiers

Click to expand! 
Normal
Exceptional
Elite

Item Qualities

Click to expand! 
Inferior
Normal
Superior
Magic
Set
Rare
Unique
Crafted

Item Stats

Click to expand! 
   Ethereal: (true/false)
   Sockets: [0 - 6]
   Qualities: [inferior, normal, superior, magic, set, rare, unique, crafted]
   Defense: (number)
   Strength: (number)
   Dexterity: (number)
   Vitality: (number)
   Energy: (number)
   Max Life: (number)
   Max Mana: (number)
   Enhanced Damage: (number)
   Enhanced Defense: (number)
   Attack Rating: (number)
   Min Damage: (number)
   Max Damage: (number)
   Damage Reduced: (number)
   Life Steal: (number)
   Mana Steal: (number)
   Cold Skill Damage: (number)
   Lightning Skill Damage: (number)
   Fire Skill Damage: (number)
   Poison Skill Damage: (number)
   Increased Attack Speed: (number)
   Faster Run Walk: (number)
   Faster Hit Recovery: (number)
   Faster Cast Rate: (number)
   Faster Block Rate: (number)
   Magic Find: (number)
   Gold Find: (number)
   Deadly Strike: (number)
   Crushing Blow: (number)
   Open Wounds: (number)
   Cannot Be Frozen: (number)
   Slain Monsters Rest In Peace: (number)
   Prevent Monster Heal: (number)
   Max Life Percent: (number)
   Max Mana Percent: (number)
   Damage Taken Goes To Mana: (number)
   Absorb Cold Percent: (number)
   Absorb Fire Percent: (number)
   Absorb Lightning Percent: (number)
   Cold Resist: (number)
   Lightning Resist: (number)
   Fire Resist: (number)
   Poison Resist: (number)
   All Resist: (number)
   Sum Resist: (number)
   Max Cold Resist: (number)
   Max Lightning Resist: (number)
   Max Fire Resist: (number)
   Max Poison Resist: (number)
   Enemy Fire Resist: (negative number)
   Enemy Lightning Resist: (negative number)
   Enemy Cold Resist: (negative number)
   Enemy Poison Resist: (negative number)
   Skills:
      <Skill Name> or Any: (number)
   Skill Charges:
      <Skill Name>: (number)
   Class Skill Tree:
      <Class Tree> or Any: (number)
   Class Skills:
      <Class> or Any: (number)
   All Skills: (number)
   Min Area Level: (number)
   Max Area Level: (number)
   Min Player Level: (number)
   Max Player Level: (number)
   Min Quality Level: (number)
   Max Quality Level: (number)

💬 FAQ

Do I need to restart MapAssist when changing the itemfilter.yaml file?

Yes

Why doesn't the default item filter include <insert item you care about>?

Everyone plays the game differently and we're not going to be managing a list that pleases everyone. If we did, it would be as simple as including every item in the game.

# This rule will please everyone. Doesn't seem very helpful, does it?
Any:

How do skill filters work?

The item filter will properly add up skills between + all skills, + class skills, + class skill tree and + skills, as such:

Assassin Katars:
    # This will show all normal - rare katars where + all skills and + Assassin skills all add up to 3 or greater
  - Qualities: [Normal, Superior, Magic, Rare]
    Class Skills:
      Any: 3
    # This will show all normal - rare katars where + all skills, + Assassin skills and + to any assassin skill tree
    # all add up to 3 or greater
  - Qualities: [Normal, Superior, Magic, Rare]
    Class Skill Tree:
      Any: 3
    # This will show all normal - rare katars where + all skills, + Assassin skills, + to any assassin skill tree,
    # and + to any skill within the same skill tree all add up to 3 or greater
  - Qualities: [Normal, Superior, Magic, Rare]
    Skills:
      Any: 3

How do I search for any +skills?

Use Any: rules, as such:

# This will show all amulets that add +2 or more to any class skill (Sorceress, Paladin, etc...)
Amulet:
  - Class Skills:
      Any: 2

# This will show all gloves that add +2 or more to any class skill tree (Bow and Crossbow, Javelin and Spear, etc...)
Gloves:
  - Class Skill Tree:
      Any: 2

How do I turn off sounds for individual items?

Add PlaySoundOnDrop: false to the rule, as such:

# This will show all magic rings, but not play a sound
Ring:
  - Qualities: magic
    PlaySoundOnDrop: false

How do I prevent a rule from searching vendor items?

Add CheckVendor: false to the rule, as such:

# This will show dropped elite armors but not elite armors at the vendor
Armors:
  - Tiers: [elite]
    CheckVendor: false

How do I not show filtered items in the log?

Add ShowInLog: false to the rule, as such:

# This will only show dropped Rejuvenation Potion on the map but not in the log
Full Rejuvenation Potion:
  - ShowInLog: false

How do I use a different sound for individual items?

Add SoundFile: <name of sound file>.wav to the rule, as such:

# This will show all unique rings and play "omg.wav"
Ring:
  - Qualities: unique
    SoundFile: 'omg.wav'

How do I render specific items differently on the map?

Add Rendering: ... to the rule, as such:

# Items are rendered based on the details in the config.yaml file, but Rejuvenation Potion are shown in purple
Rejuvenation Potion:
 -  Rendering:
      IconColor: Purple
      IconShape: Ellipse
      IconSize: 8
      LabelFontSize: 10
      LabelFont: Microsoft Sans Serif
      LabelTextShadow: true

How do I see all items that match certain conditions?

Use Any: rules, as such:

# This will show all rare items
Any:
  - Qualities: rare

Can I search by item level?

No, item levels are not available and will not be. You can search by area level which is an okay proxy, as such:

# This will show all magic rings found in level 85 areas
Ring:
  - Qualities: magic
    Min Area Level: 85
⚠️ **GitHub.com Fallback** ⚠️