add docs

Author: aeon0

README.md

@@ -1,7 +1,77 @@
-# D4 Loot Filter
+# ![logo](assets/logo.png)
 
-## Linting
-The CI will fail if the linter would change any files. You can run linting by with:
+Filter items in your inventory based on affixes, aspects and thresholds of their values. For questions join the [discord]() or use github issues.
+
+@Blizzard, please dont take this away from us. I can not bear to look at another affix...
+
+## Getting Started
+
+### Game Settings
+- Supported resolutions: 1920x1080
+- Font size must be set to small in the Gameplay Settings
+
+### Run
+- Execute d4lf.exe
+- When ingame and you want to filter items in your inventory. Press F11
+- All items that do not match any of your filter configs will be marked as junk
+
+Note: If the item description doesnt show while hovering and is very laggy, try to move to another area without any events and less people around.
+
+### Configs
+The config folder contains:
+- __filter_aspect.yaml__: Filter settings for aspects.
+- __filter_affix.yaml__: Filter settings for affixes.
+- __params.ini__: Different hotkey settings. Mainly you want to adjust your hotkey to open the inventory.
+- __game.ini__: Settings regarding color thresholds and image positions. You dont need to touch this.
+
+## How to filter
+### Aspects
+In [config/filter_aspect.yaml](config/filter_aspect.yaml) any aspects can be added in the format of `[ASPECT_KEY, THERSHOLD, CONDITON]`. The condition can be any of `[larger, smaller]` and defaults to `larger` if no value is given.
+
+For example:
+```yaml
+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](assets/aspects.json). If Aspects is empty, all legendary items will be kept.
+
+### Affixes
+Affixes have the same structure of `[AFFIX_KEY, THERSHOLD, CONDITON]` as described above. Aditionally it can be filtered by `itemType`, `minPower` and `minAffixCount`. See the list of affix keys in [assets/affixes.json](assets/affixes.json)
+
+```yaml
+Filters:
+  # 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
+```
+
+Note: If an itemType is not included in your filters, it will keep all of the items of that type. Thus, if you do not specify anything for itemType=gloves, all gloves will be kept.
+
+## Develop
+
+### Python Setup
+- Install [miniconda](https://docs.conda.io/projects/miniconda/en/latest/)
+```bash
+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:
 ```bash
 conda activate d4lf
 black .