Item filter

Item filters can be used to customize how items on the ground are displayed.

Using an existing filter

• Download the filter you wish to use
• Place the filter in

   %USERPROFILE%/Documents/My Games/Path of Exile/

• Make sure it has the correct file extension .filter
• In game, go to Options -> UI -> Item Filter and select the filter

Creating a filter

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.

The blocks are matched in the order they come in the file which means that you need to have the block that hides the scrolls above before the line that shows the currency because scrolls would also match the currency block.

An empty block matches all items, which means that the Hide at the end of the file effectively hides everything that wasn't specifically shown.

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

Notes

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

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

Operators

The following Operators can be used with numeric conditions. Note that for equal operations there is no operator required.

Operator	Notes
<	Less than
<=	Less than or equal to
>	Greater than
>=	Greater or equal to

Conditions

Notes:

• Ranges in parentheses are plausible values, but not enforced
• Every condition can have multiple values
• If the value contains whitespace, it will count as two sperate values unless quoted

Name	Valid Values	Notes
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.
Sockets [Operator] <Sockets>	Numeric Number of Sockets (0-6)	Total number of sockets that the item has.
LinkedSockets [Operator] <Links>	Numeric Number of Links (0, 2-6)	The size of the largest group of linked sockets that the item has.
SocketGroup [Group]	R, G, B, W	A group of linked sockets that contains the specified combination. Each letter is short-hand for the colour (i.e. Red = R). For example, RRG will match any group that contains two red sockets linked with a green socket.
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.
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.

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
PlayAlertSound <Id>	1-9	Plays the specified Alert Sound when dropped. Only one sound can be played at a time.
SetFontSize <FontSize>	17-42	Sets the font-size of item text.

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
• Effectively, this means rare Gold Rings and Gold Amulets with item level 75 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

Version history

Version	Changes
2.0.0	Introduced to the game.

See also

• Item Filters Annoucement