Skip to content

Latest commit

 

History

History
164 lines (115 loc) · 6.2 KB

README.md

File metadata and controls

164 lines (115 loc) · 6.2 KB
Raw

Filter Spirit

Advanced item filter generator for Path of Exile that uses it's own DSL and online item price APIs. Basically an enhanced filter language that lets you write item filters with more convenience and using item price data from poe.ninja or poe.watch available at generation time. Create multiple filter variants and refresh whenever you want to always be up to date with market prices.

If you ever worked with web stuff - a perfect analogy is that Filter Spirit is the same for real filters as are LESS and Sass for CSS.

news

Crucible (3.21) update released - DOWNLOAD HERE. No update needed for Trial of the Ancestors (3.22) - no changes in the program, only within filter templates.

As of now, the tool supports all possible conditions and actions except few corner cases which are described in doc/known_issues.

Message me (/u/Xeverous on reddit or Xeverous#2151 on Discord) if you are interested in it or have any questions/suggestions/whatever. You can also open an issue.

I'm currently focused on a different project so generally FS has low priority. This can change if you contact me though.

poe.watch is dead - only poe.ninja generation will work. Original author passed the project to someone else and the website is being revived on stats.mrk.xyz.

Plans for the future:

  • poe.watch support
  • support for cluster jewel pricing in filter template code
  • Visual Studio Code plugin that uses FS in the background
  • UI overhaul
  • WASM-compiled build, hosted on a static GitHub Pages website (some work already in progress, JavaScript help needed)

Please contact me if you are familiar with web-related technologies and would like to help in making these.

overview

Core features:

  • Generation-time error checking. FS has own parser and compiler that performs semantic analysis - it is not a blind text-copy-paste script.
  • Language features dedicated to elimination of filter code duplication:
    • named constants: $red = 255 0 0
    • named style groups: $x = { SetFontSize 42 SetTextColor $black }
    • nesting of filter blocks to inherit conditions and override actions
  • querying item prices: Autogen cards Price > 50 pulls data from API to list div cards worth 50+ chaos at generation time. Refresh whenever you want - your filter is always up-to-date with market prices.
  • Support for filter variants - selectively enable/disable certain blocks based on a variable to generate multiple filters with different flavours from a single source file.
  • Filter debugger & loot preview - find matching blocks and preview randomly generated loot from specific game encounters. You can debug both real filters and FS filter templates.

UI screens (might be slightly dated):

image image

Planned features:

  • Live edit mode - see generared code as you write.

example filter template code

There is a full example filter template source in the repository. You can also browse src/test/compiler/filter_generation_tests.cpp for even more examples.

$color_white  = 255 255 255 255
$color_hammer = 162  85   0 # (will use default opacity)

BaseType "Gavel" "Stone Hammer" "Rock Breaker" {
	SetTextColor $color_white
	SetBackgroundColor $color_hammer
	# above BaseType conditon will be inherited by all nested blocks
	# above actions will be inherited and can be overriden by nested blocks

	Rarity Normal {
		Show # show normal hammers
	}

	Rarity Magic
	Quality >= 12 {
		Show # show magic hammers with 12+ quality
	}

	Rarity Rare
	Quality >= 16 {
		Show # show rare hammers with 16+ quality
	}

	# hide any other hammers (actually discouraged as you might lose
	# RGB recipe material for later blocks - better don't write this Hide)
	Hide
}

Class "Divination Card" {
	SetTextColor $color_divination

	# cards that you always want to pickup
	BaseType "The Void" "The Cartographer" "Chaotic Disposition" {
		SetAlertSound $alert_divination_stack_1
		PlayEffect $effect_divination
		Show
	}

	Autogen cards {
		Price >= 100 {
			SetTextColor $color_black
			SetBorderColor $color_divination
			SetBackgroundColor $color_divination
			SetFontSize $font_max
			SetAlertSound $alert_divination_best
			PlayEffect $effect_divination
			MinimapIcon 0 Blue Square
			Show
		}

		Price < 100
		Price >= 10 {
			SetBorderColor $color_divination
			SetFontSize $font_mid_divinaton
			SetAlertSound $alert_divination_mid
			PlayEffect $effect_divination
			MinimapIcon 1 Blue Square
			Show
		}
	}

	# if you really hate these cards
	BaseType "Rain of Chaos" "Carrion Crow" {
		Hide
	}

	# any other cards
	Show
}

documentation and tutorial

Browse doc directory. Files are in Markdown so you can read them online on GitHub.

program interface

Graphic interface - just run filter_spirit_gui.

Command-line interface: on Windows, you can quickly open command line in desired directory by typing "cmd" in the file explorer's path - see https://stackoverflow.com/a/10135218/4818802. Do this in FS directory (where filter_spirit_cli.exe is) and you can instantly use the program, eg filter_spirit_cli --help.

runtime dependencies

FS does not need to install anything (it's fully portable). You can download latest release and immediately use the program. The program never writes anything to system directories.

building and dependencies

See documentation directory.

Modern CMake build script. All dependencies are exposed as targets. See comments inside the build recipe for more information.

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release [your_options...]
make -j

If you are using make don't forget to add -j (parallel jobs) to add 100% increased build speed per additional core.

licensing

LICENSE file in the main directory of the repository applies to any file, unless otherwise specified.

Contact me if you are interested in work on or using this project but got any concerns in regards to usage or licensing.