Item filter

From Path of Exile Wiki
Revision as of 21:42, 4 December 2021 by KickahaOta (talk | contribs) ({{merge}} with Guide:Item filter guide)
Jump to navigation Jump to search

It has been suggested that this article be merged with Guide:Item filter guide.

Proposed since December 4, 2021

This is a guide on the subject of using item filters.

Last updated on May 6, 2021‎.

Screenshot showing how item filters work in-game.

Grinding Gear Games implemented Item filters into the Path of Exile UI so players can customize how the game client displays items on the ground. This feature remedies the time it takes to find useful / valuable items in game. For those who don't have experience with programming or website development, the code for the item filters might seem complex. However, the information provided here will open the door so that you, the player, can understand how the item filters work.

Using an existing filter

Step 1
Go to: %USERPROFILE%/Documents/My Games/Path of Exile/
For example:
Step 2
Locate an existing filter, i.e. from List of item filters or elsewhere.
Step 2A - Copying file
If the item filter is supplied as downloadable file with the .filter extension, you can simply download it and save it in the folder.
Step 2B - Copying Contents
Create a text file with the name you want your Filter to have. When you Save this file, be sure to select 'Save As' and set the file type to "All Files (*.*)". Copy the contents of the filter into the file.
Then save the file as: filtername.filter
It should look like this if done correctly
If you cannot see your file extension, Show/Hide File extensions in Windows
Step 3
Go to the in-game Options menu and click on the UI tab. You should see this new option, located at the very bottom of the list:
If your Filter is not a .filter file, or it is not located in the same folder as your production_Config.ini file, you won't see this option.
Step 4
Clicking 'Reload' will display this message if the Filter is working correctly:

Syntax

See https://www.pathofexile.com/item-filter/about for the official page of filter rules.

Terminology

Please consider the following when reading this wiki page:

  • Replace the values in the brackets with a single value
  • x-y (i.e. 0-255) is used to show a range of valid values
  • Values enclosed with [] are optional; remove the []
  • Values enclosed with <> are required; remove the <>

Basic Syntax

The basic syntax of a script is a collection of Show and Hide blocks that each specify conditions. Anything matched by a Show block will be shown and anything matched by a Hide block will be hidden. If there are multiple conditions in a block then all of them must be matched for the block to match an item.

Every block must start with either Show or Hide, and any conditions in that block must start on the next line; indentation is optional. A line with only Show or Hide with no conditions is an "empty block," and matches ALL items, which means that a Hide at the end of the file effectively hides everything that wasn't specifically shown.

The blocks are prioritized in the order they come in the file, meaning that condition blocks that appear earlier in the file take precedence, applying their effects even if their conditions overlap with later blocks. Effectively, the script reads the filter file until it finds the first block that matches the item in question, follows that block's instructions, and then terminates. 

# For example, the following would hide all normal rarity items, but fail to show currencies:
Hide
    Rarity Normal
Show
    Class Currency

# To fix this, move more specific blocks earlier in the file, and save the most general for last. This would show currencies, but hide other normal rarity items:
Show
    Class Currency
Hide
    Rarity Normal

Comments

A line starting with # will be considered a comment and will be ignored.

Blocks

Name Notes
Show If all conditions are matched, show the item and do any actions specified.
Hide If all conditions are matched, hide the item and do any actions specified
Continue Continues block to other match.

This is a special flag that indicates that the filter rule matching should not stop when an item matches this block.

Note that if an item matches a Hide block that Continues, then later matches a Show block, it will use the most recently matched Show or Hide flag, and thus show. If an item matches and Continues and then never matches any further blocks, it will also show or hide based on the most recently matched block.

Values

Type Notes Range
Numeric Like: 20. No quotation marks. -1,[0-9]
String Text with quotation marks, but not in all condition, as example is Class or BaseType where values could be strings separated by space only [a-zA-Z]
None When argument is string None must be in quotation marks like "None" "None", None
Empty No value

Comparison operators

The following comparison operators are used to write conditions. Note that the equal operator (=) is always optional; if no operator is specified, the condition is assumed to be comparing equality.

Operator Description
= Equal
! Not equal
< Less than
<= Less than or equal to
> Greater than
>= Greater or equal to
== Exact match

Conditions

Notes:

  • Ranges in parentheses are plausible values, but not enforced.
  • Every condition can have multiple values separated by a space.
  • If a multi-word value contains whitespace, it must be encapsulated in quotation marks, or else it will be parsed as separate (and possibly invalid) values.
Name Valid Values Notes
AreaLevel [Operator] <Value> Numeric Level (0-100) Filters for items dropped in a particular Monster level of the current area. This is probably the most relevant of the filters, as it allows enabling/disabling filters dynamically depending on leveling.
ItemLevel [Operator] <Level> Numeric Level (0-100) The item level the item was generated at.
DropLevel [Operator] <Level> Numeric Level (0-100) The level that the item starts dropping at.
Quality [Operator] <Quality> Numeric Quality (0-20) The amount of quality on the item.
Rarity [Operator] <Rarity> Normal, Magic, Rare, Unique Rarity of the item.
Class <Class> Full or partial item class name The item class. Specifying part of a class name is allowed and will match any classes with that text in the name. So for example "One Hand" will match both "One Hand Sword" and "One Hand Axe"
BaseType <Type> Full or partial item name The base type of the item. Specifying a part of a base type name is allowed and will match any of the base types with that text in the name.
Prophecy <Type> Full or partial prophecy name The prophecy name. Specifying a part of a prophecy name is allowed and will match any of the prophecies with that text in the name. Prophecies have the Class type "Stackable Currency".
LinkedSockets [Operator] <Links> Numeric Number of Links (0-6) The size of the largest group of linked sockets that the item has.
SocketGroup [Operator] <GroupSyntax> Numeric Number of Linked Sockets followed by R, G, B, D, A, W Supports a list of groups that each one represents linked sockets containing a specific set of colors, at least one group must be matched for the condition to pass.

Each group is composed by an optional number and a sequence of letters. The number specifies the longest link which contains the following color sequence described by the letters. Each letter is short-hand for the colour ([R]ed, [G]reen, [B]lue, [W]hite) or Special ones ([D]elve Socket, [A]byss Socket). For example, 5RRG will match any group that contains two red sockets linked with a green socket in a 5-link group. Delve and Abyss cannot be in the same group as any other, as they cannot be linked.

If a comparison operator is used, it will apply to the numeric portion, so a ">= 5GGG" will match a 5 or more linked group with 3 green sockets.

SocketGroup with A and D socket has no effect. For example "SocketGroup RGBA" or "SocketGroup DD". As Abyss and Delve sockets are never linked.

Sockets [Operator] <GroupSyntax> Numeric Number of Sockets (0-6) followed by R, G, B, D, A, W Does the exact same thing as SocketGroup but does not require the sockets to be linked. So the same example ">= 5GGG" will match 5 or more sockets not necessarily linked, with at least 3 green sockets anywhere.

Unlike SocketGroup, this condition does allow for mixing and using Delve and Abyss sockets, for example, a Resonator with 3 sockets would be "DDD".

Height [Operator] <Value> Numeric number of slots (1-4) The number of slots the item takes on the Y-axis (verical axis), i.e. the height of the item.[1]
Width [Operator] <Value> Numeric number of slots (1-2) The number of slots the item takes on the X-axis (horizontal axis), i.e. the width of the item.
HasExplicitMod <Value> Full or partial item name Filter by mods on an item by name. For example: [HasExplicitMod "Tyrannical" ] (Tyrannical=Local Physical Damage 155 to 169%)
AnyEnchantment <Boolean> True or False If an item has any enchantment from the Labyrinth.
HasEnchantment <Value> Full or partial name of enchantment Filter by enchantments
EnchantmentPassiveNode <Value> Full or partial name of enchantment Filter Cluster Jewels by enchantment type.
EnchantmentPassiveNum [Operator] <Value> Numeric number of slots (0-n) Filter Cluster Jewels by the number of enchantments. Only checks the "Adds X passive skills" modifier.
StackSize [Operator] <Value> Numeric number of slots (1-n) Currency stack size
GemLevel [Operator] <Value> Numeric number of slots (1-21) Gem Level
GemQualityType <Value> Superior

Divergent

Anomalous

Phantasmal

Gem Quality Type
AlternateQuality <Boolean> True or False If an item has alternate quality or not. Note: This is applicable to Alternate Gems introduced in 3.12.
Replica <Boolean> True or False If an item is an Replica or not. Note: This is applicable to Replica Unique introduced in 3.12.
Identified <Boolean> True or False If an item is identified or not.
Corrupted <Boolean> True or False If an item is corrupted or not.
CorruptedMods [Operator] <Value> Numeric number of corrupted mods (0-n). How many corrupted mods are present.
Mirrored <Boolean> True or False If the item is a Mirrored item or not. Does not drop normally, except when opening a Strongbox with the "Contains Mirrored Items", or via the Prophecy Kalandra's Craft.
ElderItem <Boolean> True or False If an item is an Elder item or not.
ShaperItem <Boolean> True or False If an item is a Shaper item or not.
HasInfluence <Type> Shaper, Elder, Crusader,

Hunter, Redeemer, Warlord, None

If an item has Influence of a certain type. Note that this also affects Maps that are influenced.

If want item that has no Influence, choose value as None.

FracturedItem <Boolean> True or False If an item is fractured or not
SynthesisedItem <Boolean> True or False If an item is synthesised or not
ElderMap <Boolean> True or False If the map is elder or not.
ShapedMap <Boolean> True or False If the map is shaped or not.
BlightedMap <Boolean> True or False If the map is blighted or not.
MapTier [Operator] <Value> Numeric Tier (1-17) The map tier of the map.

Actions

Name Valid Values Notes
SetBorderColor <Red> <Green> <Blue> [Alpha] 0-255 Sets the border colour of the item box in RGB values from 0-255 with optional Alpha (opacity) value of 0-255
SetTextColor <Red> <Green> <Blue> [Alpha] 0-255 Sets the text colour of the item box in RGB values from 0-255 with optional Alpha (opacity) value of 0-255
SetBackgroundColor <Red> <Green> <Blue> [Alpha] 0-255 Sets the colour of the item box in RGB values from 0-255 with optional Alpha (opacity) value of 0-255
SetFontSize <FontSize> 18-45 (default: 32) Sets the font-size of item text.[2]
PlayAlertSound <Id> [Volume] Disable:
  • None

Id:

  • [1-16] Ingame Sounds

Volume:

  • [0-300]
 Plays the specified Alert Sound with optional volume when dropped. Only one sound can be played at a time.
PlayAlertSoundPositional <Id> [Volume] Disable:
  • None

Id:

  • [1-16] Ingame Sounds

Volume:

  • [0-300]
 Work as PlayAlertSound with Sound Volume relative to distance where Item dropped. Could be usable with low Tier Items to smooth Sounds.
DisableDropSound Disable the drop sound. This is a separate sound from PlayAlertSound.
EnableDropSound Enable the drop sound. This is a separate sound from PlayAlertSound.
CustomAlertSound <FileName | FileFullPath> local path to the file (with quotation marks):
  • "None" (disable)
  • [reative path]
  • [absolute path]
 Plays the specified custom sound when a specified item drops. (almost all of the common file extensions should be supported)
MinimapIcon <Size> <Color> <Shape> Disable:
  • -1

Size:

  • 0 (largest)
  • 1 (medium)
  • 2 (small)

Color:

  • Red
  • Green
  • Blue
  • Brown
  • White
  • Yellow
  • Cyan
  • Grey
  • Orange
  • Pink
  • Purple

Shape:

  • Circle
  • Diamond
  • Hexagon
  • Square
  • Star
  • Triangle
  • Cross
  • Moon
  • Raindrop
  • Kite
  • Pentagon
  • UpsideDownHouse
Displays an icon on the minimap for specified items.
PlayEffect <Color> [Temp] Disable:
  • None

Color:

  • Red
  • Green
  • Blue
  • Brown
  • White
  • Yellow
  • Cyan
  • Grey
  • Orange
  • Pink
  • Purple

Beam Visualization [Temp]:

  • Empty (no value, instantly)
  • Temp (temporary)
 Displays a coloured beam of light above an item highlighted by an item filter.

Use the Temp parameter to have a beam only appear as the item drops.
Otherwise, it will be permanently visible.

A list of the default RGB codes used in-game can be found in the corresponding item filter guide section.

Examples

Example 1

  • Shows all items with a red, green and blue linked socket
  • Changes the text color to a light blue one
Show
    SocketGroup RGB
    SetTextColor 127 127 255

Example 2

  • Shows all items that match the following conditions
    • Item class is either Ring or Amulet
    • Item basename contains "Gold"
    • Item has the "Rare" rarity level
    • Item level is 75 or higher
  • Effectively, this means rare Gold Rings and Gold Amulets with item level 75 or higher will be shown
  • Changes the border to a yellow border
Show
    Class Ring Amulet
    BaseType Gold
    Rarity Rare
    ItemLevel >= 75
    SetBorderColor 255 255 0

Known issues

Known issues with workaround. Use at your own risk.

Item filters not found

Solution A

  • Check that the filter has the correct ending (.filter )
  • Check whether the item filter is placed in the correct folder

Solution B

Currently (beta) item filters may not load for users who use a non-ASCII userpath. As a work around you can move your documents folder to a location which does not contain non-ASCII letters. To do so: 

 Go to your user folder (%USERPROFILE%) -> right click on My Documents -> properties -> path -> move... -> select a new location to move to -> apply

List of item filters

Main page: list of item filters

Note: For sorting by multiple columns hold SHIFT.

General purpose filters

NameAuthorReleaseIngame FeaturesOther FeaturesFiltration Support
ColoursBordersFont
Size		BackgroundItem
Hiding		LevelingEndgameVendor
recipes		CraftingCustomizableGeneralThemes
Ajido's Aesthetically Pleasing Loot FilterAjido (Twitch YouTube)2015-07-17majormajoryesyesyesyesyespartialyesyesyesno
EpicFail42's Loot FilterEpicFail422015-06-25minormajorpartialminorpartialmajoryesyesminornoyesno
Highwind's Lootfilterffhighwind2015-12-10majormajormajormajoryesyesyesyesyesyesyesyes
Ment's Item FilterMent20082015-04-11partialmajormajorminoryesyesyesyesyesyesnono
NeverSink's LootfilterNeverSink2015-04-15partialpartialmajormajoryesyesyesyesyesyesyesyes
One Filter to rule them allMuldini2015-05-03minorminorminorminoryesyesyesyesyesyesyesno
SimplefilterKoszmarnica2020-12-31yesyesyesyesyesyesyesyesyespartialpartialno
StupidFatHobbit's SovereignStupidFatHobbit2016-03-02partialyesmajormajoryesyesyesyesyesyesnono

Specialized filters

Filters that are intended for a specialized purpose, such as leveling a specific class or otherwise.

NameAuthorReleaseIngame FeaturesOther FeaturesFiltration SupportDescription
ColoursBordersFont
Size		BackgroundItem
Hiding		LevelingEndgameVendor
recipes		CraftingCustomizableGeneralThemes


Version history

Version Changes
3.16.0b
  • Fixed a bug where Item Filters would incorrectly assign Weapons and Jewellery a BaseDefencePercentile value of 0 rather than 100.
3.15.0d
  • Rapier One Hand Swords are once again classified as Thrusting One Hand Swords. Their Weapon Range is again 14 (instead of 11). Please update your item filters!
3.15.0
3.14.0
3.13.0
3.12.0
3.11.0
3.10.2b
  • You can now filter for items without being required to use special alphanumeric characters, such as "Maelstrom Staff" rather than "Maelström Staff".
3.10.1d
  • Fixed a rare bug where the client would repeatedly download an item filter.
  • Added an EnableDropSound parameter that can be used in Item Filters.
  • Added a chat output upon logging into a character which contains information about the currently loaded item filter if that filter is one that you are subscribed to through your account page.
3.10.1
  • Fixed an issue with the PlayAlertSound parameter in Item Filters not handling the Continue command correctly.
3.10.0
  • Added new item filter drop effect colour options.
  • Delve areas are now considered to be the level of the monsters in the shallowest part of the Delve, meaning players will not be downscaled below the level of the shallowest part of the Delve. It also means that item filters which filter by area level will work correctly in the Azurite Mine.
3.9.2f
3.9.2e
  • Fixed a bug where declining the save option when changing your Item Filter caused the most recently selected Item Filter to be used.
3.9.2
  • Fixed the item filter settings not saving when using languages other than English.
  • Fixed a bug where updating an item filter on the website would de-select it in-game.
3.9.0
  • You can now add Item Filters to your account through the Path of Exile website. When you then log into your game client, no matter where you are logging in from, you will then have access to all of the Item Filters tied to your account (even if you're playing on Console!).
3.8.1d
  • You can now use an "Exact Match" parameter in Item Filters. Simply use == to filter for exact matches. For example, BaseType == "The Demon" will show The Demon Divination Card but will not show The Demoness.
3.8.0d
  • Updated the default item filter.
3.7.2
  • Increased the volume levels of all item filter sounds as they were quieter than intended.
3.6.0
  • Item filters can now filter out Shaper and Elder items, if that's something you want to do for some reason.
3.4.1
  • Fixed a bug where quest items could be hidden on the minimap when using item filters.
3.4.0
  • Items filters are now capable of displaying minimap icons and lightbeams for specific categories of items, making them much harder to miss.
  • Added the capacity to use custom local sound files in your item filter.
3.3.1b
  • Fixed an issue introduced by patch 3.3.1b which caused the default loot filter to be unable to load. If you were having this issue, please close and re-open your client in order to download the fix.
3.3.1
  • The default loot filter now plays audio when an item with 5 linked sockets drops.
3.3.0c
  • Tweaked various alert sounds in the Default Loot Filter.
3.3.0
  • The item filter now supports sorting by gem levels, stack sizes and explicit item mods.
3.2.1
  • Added a keyword that item filters can use to disable default drop sounds. The keyword is "DisableDropSound".
3.1.0b
  • Fixed a bug where some items were not being filtered correctly when using the default loot filter.
3.0.0
  • In item filters, you can now use PlayAlertSoundPositional rather than PlayAlertSound to play a positional version (the sound comes from where the item dropped).
  • Item filters can now play a much larger array of sounds when items drop.
2.5.0d
  • Various improvements have been made to the default Item Filter.
2.5.0
  • Items filters can now see whether an item is corrupted with "corrupted true".
2.4.2
  • There’s now an item filter bundled with Path of Exile that you can select in the User Interface options.
2.3.2
  • Added "Identified" as a filter option for Item Filters. Valid values for this filter are "True" or "False".
2.2.1d
  • Fixed a bug where Labyrinth Items could be displayed incorrectly when modifying how they are shown using Item Filters.
2.0.1
  • Sound events triggered by item filters can now have a maximum volume of 300 (up from 100).
2.0.0b
  • Fixed a bug with Item Filters where some item types would not load if they were included in a type that was already loaded. For example, "Thrusting" when "Swords" was already loaded.
2.0.0
  • We’ve added Item Filter functionality. You can now filter what types of items you want to see, cause sounds to play, change the font colour, size, and other options. For more information about item filters, check out www.pathofexile.com/itemfilters

See also

References

  1. ↑ (12 May 2015). "Item Filter Suggestions; Identified items, corrupted items, and grid sizes.". Reddit. Retrieved 12 May 2015.
  2. ↑ (2 May 2015). "PSA: You can change the font size in item filters.". Reddit. Retrieved 2 May 2015.

External links

ru:Фильтр предметов

Retrieved from "https://www.poewiki.net/index.php?title=Item_filter&oldid=1133924"