Giter Club home page Giter Club logo

d4lf's Introduction

logo

Filter items in your inventory based on affixes, aspects and thresholds of their values. For questions, feature request or issue reports join the discord or use github issues.

Alt text for thumbnail

Features

  • Filter items in inventory and stash
  • Filter by item type and item power
  • Filter by affix and their values
  • Filter by aspects and their values
  • Filter uniques and their affix and aspect values
  • Supported resolutions: 1920x1080, 3840x1080, 2560x1080, 2560x1440, 3440x1440, 5120x1440, 3840x2160

How to Setup

Game Settings

  • Font size can be small or medium (better tested on small) in the Gameplay Settings
  • Game Language must be English
  • Advanced Tooltip Information (showing min and max values) is fine. But the Advanced Tooltip Compare has to be truned off!

Run

  • Download the latest version (.zip) from the releases: https://github.com/aeon0/d4lf/releases
  • Execute d4lf.exe and go to your D4 screen
  • There is a small overlay on the center bottom with buttons:
    • max/min: Show or hide the console output. Good for checking ingame if there are some errors.
    • start/stop: Turn filtering on/off
    • scripts/stop: In case there are any scripts attached, run them
  • Alternative use the hotkeys. e.g. f11 for filtering

Limitations

  • If you rerolled an affix, that affix (and the one above) will not be considered. So these items will most likely not show up with a green box
  • The tool does not play well with HDR as it makes everything super bright

Configs

The config folder contains:

  • profiles/*.yaml: These files determine what should be filtered.
  • params.ini: Different hotkey settings and number of chest stashes that should be looked at.
  • game.ini: Settings regarding color thresholds and image positions. You dont need to touch this.

params.ini

[general] Description
profiles A set of profiles seperated by comma. d4lf will look for these yaml files in config/profiles and in C:/Users/WINDOWS_USER/.d4lf/profiles.
run_vision_mode_on_startup If the vision mode should automatically start when starting d4lf. Otherwise has to be started manually with the vision button or the hotkey.
check_chest_tabs How many chest tabs will be checked and fitlered for items in case chest is open when starting the filter. E.g. 2 will check first two chest tabs
hidden_transparency The overlay will go more transparent after not hovering it for a while. This can be any value between [0, 1] with 0 being completely invisible and 1 completely visible. Note the default "visible" transparancy is 0.89
local_prefs_path In case your prefs file is not found in the Documents there will be a warning about it. You can remove this warning by providing the correct path to your LocalPrefs.txt file
[char] Description
inventory Hotkey for opening inventory
[advanced_options] Description
run_scripts Hotkey to start/stop vision mode
run_filter Hotkey to start/stop filtering items
exit_key Hotkey to exit d4lf.exe
log_level Logging level. Can be any of [debug, info, warning, error]
scripts Running different scripts

How to filter

Aspects

In your profile .yaml files any aspects can be added in the format of [ASPECT_KEY, THRESHOLD, CONDITION]. The condition can be any of [larger, smaller] and defaults to larger if no value is given. Smaller has to be used when the aspect go from high value to a lower value (eg. ‍Blood-bathed Aspect)

For example:

Aspects:
    # Filter for a perfect umbral
    - [aspect_of_the_umbral, 4]
    # Filter for any umbral
    - aspect_of_the_umbral

Aspect keys are lower case and spaces are replaced by underscore. You can find the full list of keys in assets/aspect.json. If Aspects is empty, all legendary items will be kept.

Affixes

Affixes have the same structure of [AFFIX_KEY, THRESHOLD, CONDITION] as described above. Additionally, it can be filtered by itemType, minPower and minAffixCount. See the list of affix keys in assets/affixes.json. Uniques are by default always kept while Magic and Common items are not.

Affixes:
  # Search for armor and pants that have at least 3 affixes of the affixPool
  - Armor:
      itemType: [armor, pants]
      minPower: 725
      affixPool:
        - [damage_reduction_from_close_enemies, 10]
        - [damage_reduction_from_distant_enemies, 12]
        - [damage_reduction, 5]
        - [total_armor, 9]
        - [maximum_life, 700]
      minAffixCount: 3

Uniques

Uniques look similar to affixes, but will need the full unique description of itemtype and affixes to be able to be matched:

# Take all Tibault's Will pants that have item power > 900 and dmg reduction from close > 12 as well as aspect value > 25. Note that the other affixes still must be specified to be able to match the unique item to the config!
Uniques:
  - aspect: [tibaults_will]
    minPower: 900
    affixPool:
      - [damage_reduction_from_close_enemies, 12]

Note: If an itemType is not included in your filters, all items of this type will be discarded as junk! So if you want to take all items of a certain type, add it and leave minPower, affixPool and minAffixCount empty.

Custom configs

D4LF will look for params.ini and for profiles/*.yaml also in C:/Users/WINDOWS_USER/.d4lf. All values in params.ini will overwrite the value from the param.ini in the D4LF folder. In the profiles folder additional custom profiles can be added and used.

This is helpful to make it easier to update to a new version as you dont need to copy around your config and profiles. In case there are breaking changes to the configuration there will be a major release. E.g. update from 2.x.x -> 3.x.x.

Develop

Python Setup

git clone https://github.com/aeon0/d4lf
cd d4lf
conda env create environment.yaml
conda activate d4lf
python src/main.py

Linting

The CI will fail if the linter would change any files. You can run linting with:

conda activate d4lf
black .

To ignore certain code parts from formatting

# fmt: off
# ...
# fmt: on

# fmt: skip
# ...

Setup VS Code by using the black formater extension. Also turn on "trim trailing whitespaces" is VS Code settings.

Credits

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.