A library for interacting with Path of Exile game and economy data, and a unique loot filter generation framework.

Overview

wraeblast

Discord

A library for interfacing with Path of Exile game and economy data, and a set of item filters geared towards trade league players.

Filter Generation

Wraeblast provides an experimental, feature-rich item filter development framework and toolkit, as well as a dogfooded trade league filter.

⚠️ DISCLAIMER: ⚠️ This is an experimental, proof-of-concept project, and the author is not responsible for any loss of currency or efficiency as a result of using this project's filters. Please use FilterBlade for regular gameplay unless you're brave enough to deal with a pre-alpha filter.

Framework Features

  • Economy insights API powered by poe.ninja
    • Integration with pandas for data normalization and analysis
    • Local caching and rate limiting
  • Powerful extended item filter framework
    • Internally uses single API to express both standard and extended filter rules
    • Jinja2-templated YAML filter format
    • Some extended filter features include:
      • Rule tagging
      • Presets (i.e. feature flags)
      • Styles
      • Template environment helpers for 🌈 color manipulation, πŸ“ˆ economy data quantization and grouping, πŸ”Š filter alert sound generation (TTS), and more
  • Matplotlib colormap integration, enabling procedural generation of item-based (not just tier-based like many popular community filters) filter colors.
  • ...and many other technical features under the hood.

Filter Features

  • πŸ“Š Quantile based variants for efficient farming.†

    Currently provides two variants: D2 (2nd decile) and QU4 (4th quintile). Additional quantiles will probably be included in nightly releases, depending on feedback and experimentation.

  • 🌌 54 colormaps (108 if you include reversed colormaps, indicated by an _r prefix) included per quantile variant.

    There are even more colormap palettes available, it would just be too cost prohibitive to include them all at present. See the Palettable documentation for colormap previews (only sequential colormaps are used).

    Some form of item filter preview may be added as a feature in the future, but for now either refer to the documentation or just try them out in game.

  • πŸ”Š AWS Polly Neural Text-To-Speech (NTTS) powered synthesized alert sounds for ✨ all ✨ valuable filter rules (quantile dependent).

    Get instant, aural feedback for currency, fragments, skill gems, cluster jewels, and more. Anything tracked by poe.ninja can be supported by TTS.

    Filter sounds for relevant items are also generated for varying stack sizes, for more accurate chaos value approximations.

    The Aria (New Zealand English, appropriately) voice is currently the default for the trade league filters included with this project, but any voice supported by AWS Polly can be used when developing new filters.

† TLDR: think of quantiles like strictness, with an arguably better ranking of item and currency value in a trade league than hard-coded tiers.

Demos

Installation

Download the filter variant(s) of your choice from the releases, as well as the latest, compressed TTS filter sounds. Extract both the .filter and the FilterSounds directory to your Path of Exile directory.

Filter syncing is currently not supported, and would be largely useless regardless without a way to sync filter sound files.

Note that updating the filter also requires updating the TTS files, and you can simply choose to overwrite existing files every time, or delete the entire TTS folder before installing the latest version.

Rationale Development Manifesto

  • Path of Exile's current loot system requires complex filters for efficient gameplay 🀦
  • Complex filters require a πŸ”¨ filter generation/templating layer πŸ”¨ (this is exactly what NeverSink has done)
  • Many community maintained filters (including NeverSink's) are ✨ awesome ✨ and work well for the majority of the playerbase, but have some shortcomings:
    • πŸš€ Über strict isn't always ΓΌber enough for softcore juiced map blasters (filter "strictness" in general is a trap)
    • 🌈 Filter customization is somewhat limiting and tedious to do through a web interface (loot filters are code)
    • πŸ“ˆ Economy-based presets and filters leverage a small subset of the available data from poe.ninja
    • πŸ› Filter rules take the kitchen sink approach and include a large amount of rules for low-value recipes and items
    • πŸ”Š Default alert sounds and sound rules are usually sparse, and adding custom sounds is a time-consuming process

Architecture

  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
  β”‚                        β”‚
  β”‚ .yaml.j2 filter source β”œβ”€β”€β”€β”€β”
  β”‚                        β”‚    β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β”‚  β”‚                     β”‚  β”‚          β”‚
                                β”œβ”€β”€β”€    rendered .yaml   β”œβ”€β”€β”€  final   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚  β”‚ intermediate filter β”‚  β”‚ .filter  β”‚
β”‚                             β”‚ β”‚  β”‚                     β”‚  β”‚          β”‚
β”‚ .config.json filter options β”œβ”€β”˜  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
β”‚                             β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
  1. Economy insights data (currently just poe.ninja) is fetched and cached
  2. The .yaml.j2 is rendered with the economy data, colormaps, and filter option overrides from the .config.json file as context, if provided.
  3. The resulting intermediate .yaml is then parsed by the extended filter parser, and outputs a final .filter file, and any associated sounds.

Usage

See wraeblast --help and wraeblast render_filter --help for detailed command line usage.

❯ wraeblast render_filter \
    -l Expedition \
    -d output \
    -O filters/softcore.config.json \
    -o softcore.filter -i -vvv filters/softcore.yaml.j2

For detailed library installation instructions and usage, see the technical documentation.

Roadmap

  • Base filter generation functionality that nobody cares about
  • Basic filters for different play styles: HC SSF, SC SSF, casual, deli farming, harby farming, legion farming, and all-around blasting πŸš€
  • Features for league launches: shimming new item classes without relying on poe.ninja data, early league specific colormaps, thresholds, etc.
  • Performance improvements
  • Unit tests and documentation
  • Filter preview image generation
  • Filter compression/deduping of rules
  • Investigate auto-updating, but yet another downloadable tool to do it is out of the question (probably)
  • Integration with poeprofit (i.e. dedicated styles and sounds for profitable strategies)
  • Web frontend for downloading up-to-date filters (sans the complex configuration menus full of knobs and sliders and color pickers)
  • Become obsolete when PoE 2 comes out πŸ‘»

[REDACTED]

Additional features and tools are planned and will be incorporated into this project in the near future.

Comments
  • Error on Loading

    Error on Loading

    So Ive installed it exactly like the installation guide said, when loading it up on POE, I didnt see the filter except a filter called new filter. So I used that and I got line 4906: Unable to parse parameter for BaseType rule: No base types found matching "Blood Magic Support"

    opened by HelloMikko 5
  • Question regarding 6sockets

    Question regarding 6sockets

    The filter is currently showing 6Sockets even on Q5, even though they're practically worthless. Is this by choice or is it an oversight?

    on Q4+, an awakened sextant being 1.7-2c is hidden, while the 6socket is shown.

    opened by Cloudslapper 3
  • Conda environment compatability.

    Conda environment compatability.

    Background:

    As this seems to be a mix of data science and software development project, there are some things to think about. Conda as a package and python virtual environment manager is ubiquitous in data science, sometimes to the consternation of Python programmers. Conda will just work with traditional (and admittedly janky) setuptools based package requirements. It can also use an environment.yml file specifically for conda, or even just a simple pip requirements file.

    Description of the problem:

    I went down a rabbit hole chasing down getting poetry to work using my conda based python installation, and setting up poetry inside of a conda based (python) virtual environment. The official docs of poetry recommend a base installation separate of package managers like conda (https://python-poetry.org/docs/#alternative-installation-methods-not-recommended). Documentation is lacking in how poetry interacts with conda virtual environments (https://github.com/python-poetry/poetry/issues/1724). Poetry devs decided to reject even considering conda compatibility and closed the issue (https://github.com/python-poetry/poetry/issues/105). There are some scripts for taking a poetry based pyproject file and converting it to a conda one (https://github.com/dojeda/poetry2conda), however, they are unmaintained, and require individually reviewing packages, knowing whether their Pypi or conda names are used, and editing the pyproject.toml file to point to the correct package manager, source, names, etc, possibly for many dependencies. Poetry also requires a workaround to install a package in editable mode, which is sometimes used for development work.

    As a result of this, I spent more than half an hour trying to simply create a virtual environment that I could work on wraeblast with.

    Issue:

    Wraeblast is difficult to get running for people using conda, without possibly messing up your development environment (as several documented issues on poetry's github page shows). There are issues with poetry's own dependencies bleeding into the virtual environment or even your root/base python environment. This is caused by a lack of providing "the old way" of packaging python software, as existing workflows were configured to work from this (admittedly somewhat flawed) system.

    Suggestion:

    Provide and maintain either a traditional setup.py, an alternative requirements.txt, or even better, a conda environment.yml file for easily starting to work on wraeblast. It would have taken me about 20 seconds instead of more than half an hour, and especially as you said on reddit, if you want some data scientist type people taking a look at the package, it would make the process of contributing much more accessible for that community.

    Conclusion:

    Please add a non-poetry way of dependency tracking that works with existing workflows prevalent in other communities, or at least a guide on how to get this running using poetry and the recent PEP suggested pyproject.toml files.

    enhancement 
    opened by emirkmo 2
  • Line 3088: Unable to parse parameter for BaseType

    Line 3088: Unable to parse parameter for BaseType

    Line 3088: Unable to parse parameter for BaseType rule: No base types found matching "Scourged Bone Crypt Map"

    newest nightly

    Edit: every entry with Scourged 'map' as its basetype, makes the filter fail to load.

    bug 
    opened by Cloudslapper 0
  • Line 22274: Unable to parse parameter for BaseType rule: No base types found for exactly matching

    Line 22274: Unable to parse parameter for BaseType rule: No base types found for exactly matching "Maven's Orb"

    As of March 2022 I am getting this error: Line 22274: Unable to parse parameter for BaseType rule: No base types found for exactly matching "Maven's Orb"

    opened by joyzer 0
  • Some T1 Item Bases might not get displayed

    Some T1 Item Bases might not get displayed

    Just ran some Abysses and noticed ilvl86 Stygian Vises not showing up on strictness D2

    Since the Base is worth 12-16c, the filter might be missing that:

    https://poe.ninja/challenge/base-types?name=stygian&level=86%2B

    opened by kxc0re 8
Releases(v0.3.0)
Owner
David Gidwani
David Gidwani
Python based utilities for interacting with digital multimeters that are built on the FS9721-LP3 chipset.

Python based utilities for interacting with digital multimeters that are built on the FS9721-LP3 chipset.

Fergus 1 Feb 2, 2022
Simple web index to use bloom filter for Pwned Passwords

pwbloom Simple web index to use bloom filter for Pwned Passwords The index.py runs a simple CGI web service checking passwords with a bloom filter for

Hanno BΓΆck 4 Nov 23, 2021
Raganarok X: Next Generation Data Dump

Raganarok X Data Dump Raganarok X: Next Generation Data Dump More interesting Files File Name Contains en_langs All the variables you need in English

null 14 Jul 15, 2022
Python program to do with percentages and chances, random generation.

Chances and Percentages Python program to do with percentages and chances, random generation. What is this? This small program will generate a list wi

n0 3 Jul 15, 2021
Experimental python optimistic rollup fraud-proof generation

Macula Experimental python optimistic rollup fraud-proof generation tech by @protolambda. Working on a python version for brevity and simplicity. See

Diederik Loerakker 30 Sep 1, 2022
Collection of code auto-generation utility scripts for the Horizon `Boot` system module

boot-scripts This is a collection of code auto-generation utility scripts for the Horizon Boot system module, intended for use in Atmosphère. Usage Us

null 4 Oct 11, 2022
Let's renew the puzzle collection. We'll produce a collection of new puzzles out of the lichess game database.

Let's renew the puzzle collection. We'll produce a collection of new puzzles out of the lichess game database.

Thibault Duplessis 96 Jan 3, 2023
Simple RGB to HEX game made in python

Simple RGB to HEX game made in python

null 5 Aug 26, 2022
A collection of resources/tools and analyses for the angr binary analysis framework.

Awesome angr A collection of resources/tools and analyses for the angr binary analysis framework. This page does not only collect links and external r

null 105 Jan 2, 2023
Modest utility collection for development with AIOHTTP framework.

aiohttp-things Modest utility collection for development with AIOHTTP framework. Documentation https://aiohttp-things.readthedocs.io Installation Inst

Ruslan Ilyasovich Gilfanov 0 Dec 11, 2022
Dependency Injector is a dependency injection framework for Python.

What is Dependency Injector? Dependency Injector is a dependency injection framework for Python. It helps implementing the dependency injection princi

ETS Labs 2.6k Jan 4, 2023
πŸ”© Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

Boltons boltons should be builtins. Boltons is a set of over 230 BSD-licensed, pure-Python utilities in the same spirit as β€” and yet conspicuously mis

Mahmoud Hashemi 6k Jan 4, 2023
isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type.

isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type. It provides a command line utility, Python library and plugins for various editors to quickly sort all your imports.

Python Code Quality Authority 5.5k Jan 8, 2023
A Python library for reading, writing and visualizing the OMEGA Format

A Python library for reading, writing and visualizing the OMEGA Format, targeted towards storing reference and perception data in the automotive context on an object list basis with a focus on an urban use case.

Institut fΓΌr Kraftfahrzeuge, RWTH Aachen, ika 12 Sep 1, 2022
RapidFuzz is a fast string matching library for Python and C++

RapidFuzz is a fast string matching library for Python and C++, which is using the string similarity calculations from FuzzyWuzzy

Max Bachmann 1.7k Jan 4, 2023
pydsinternals - A Python native library containing necessary classes, functions and structures to interact with Windows Active Directory.

pydsinternals - Directory Services Internals Library A Python native library containing necessary classes, functions and structures to interact with W

Podalirius 36 Dec 14, 2022
Library for processing molecules and reactions in python way

Chython [ˈkʌΙͺΞΈ(Ι™)n] Library for processing molecules and reactions in python way. Features: Read/write/convert formats: MDL .RDF (.RXN) and .SDF (.MOL

null 16 Dec 1, 2022
A simple gpsd client and python library.

gpsdclient A small and simple gpsd client and library Installation Needs Python 3 (no other dependencies). If you want to use the library, use pip: pi

Thomas Feldmann 33 Nov 24, 2022
Python library to decorate and beautify strings

outputformat Python library to decorate and beautify your standard output ?? Ins

Felipe Delestro Matos 259 Dec 13, 2022