Item filter



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:
 * [[File:browserlocation.jpg]]


 * 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
 * [[File:Files.jpg]]
 * 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:
 * [[File:Highlight.jpg]]
 * 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:
 * [[File:Confirmation.png]]

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.

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

Show Class Currency Hide Rarity Normal
 * 1) 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:

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

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.

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.

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

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

Example 2
Show Class Ring Amulet BaseType Gold Rarity Rare ItemLevel >= 75 SetBorderColor 255 255 0
 * 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

Known issues
Known issues with workaround. Use at your own risk.

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

Version history

 * Added new functionality and made improvements to Item Filters. You can read more about them here: https://www.pathofexile.com/forum/view-thread/3079980


 * Added new functionality and made improvements to Item Filters. You can read more about them here: https://www.pathofexile.com/forum/view-thread/3009221


 * Added new functionality and made improvements to Item Filters. You can read more about them here: https://www.pathofexile.com/forum/view-thread/2935826


 * Added new functionality and made improvements to Item Filters. You can read more about them here: https://www.pathofexile.com/forum/view-thread/2873743


 * You can now filter for items without being required to use special alphanumeric characters, such as "Maelstrom Staff" rather than "Maelström Staff".


 * 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.


 * Fixed an issue with the PlayAlertSound parameter in Item Filters not handling the Continue command correctly.


 * 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.


 * Added new functionality and made improvements to Item Filters. You can read more about them here: https://www.pathofexile.com/forum/view-thread/2771031


 * Fixed a bug where declining the save option when changing your Item Filter caused the most recently selected Item Filter to be used.


 * 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.


 * 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!).


 * 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.


 * Updated the default item filter.


 * Increased the volume levels of all item filter sounds as they were quieter than intended.


 * Item filters can now filter out Shaper and Elder items, if that's something you want to do for some reason.


 * Fixed a bug where quest items could be hidden on the minimap when using item filters.


 * 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.


 * 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.


 * The default loot filter now plays audio when an item with 5 linked sockets drops.


 * Tweaked various alert sounds in the Default Loot Filter.


 * The item filter now supports sorting by gem levels, stack sizes and explicit item mods.


 * Added a keyword that item filters can use to disable default drop sounds. The keyword is "DisableDropSound".


 * Fixed a bug where some items were not being filtered correctly when using the default loot filter.


 * 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.


 * Various improvements have been made to the default Item Filter.


 * Items filters can now see whether an item is corrupted with "corrupted true".


 * There’s now an item filter bundled with Path of Exile that you can select in the User Interface options.


 * Added "Identified" as a filter option for Item Filters. Valid values for this filter are "True" or "False".


 * Fixed a bug where Labyrinth Items could be displayed incorrectly when modifying how they are shown using Item Filters.


 * Sound events triggered by item filters can now have a maximum volume of 300 (up from 100).


 * 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.


 * 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


 * }