Skip to content

Commit

Permalink
Update README according to the latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
4rtzel committed Feb 11, 2022
1 parent 646e699 commit 18761eb
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ When you start the program three small buttons will pop up in the top left corne
* 'Settings' button open settings window (see below).
* 'Scan' button does all the magic. Once you press it, the program will enter the scanning mode and the button will change to 'Scanning...'. It will scan your screen according to the scanning window area and will create a list of all possible recipes. After the scan completes, the button will change again to 'Hide'. Once you examine the scan result, click the 'Hide' button to hide them.

You could also hold the right mouse button to drag the controls around.

### Settings

The setting window allows you to adjust some parameters to improve the searching efficiency or change the display settings:
Expand All @@ -30,6 +32,8 @@ The setting window allows you to adjust some parameters to improve the searching

* 'Display inventory items' checkbox turns additional display setting for scan window. The scan results will also include a list of all of your archnemesis items in the inventory.

* 'Display unavailable recipes' checkbox turns the display of all possible recipes even if you can't currently build them. The unavailable recipes will be indicated by the white color (light green if you already have it in your inventory).

The settings are persistent and will be saved/loaded from settings.ini file.

### Scan results
Expand All @@ -49,6 +53,16 @@ If you checked 'Display inventory items' box, then your scan results will also i

Again, hover over any items to display them in your inventory.

If you checked 'Display unavailable recipes' box, then your scan results will also include the recipes that you cannot complete right now. This is useful for planning the next step especially with the next feature.

If you click at any recipe icon, then the recipe tree will open:

![docs/scan_results_recipe_tree](docs/scan_results_recipe_tree.png)

If the icon is highlighted in green, then that means you have this item in your inventory. You could hover of highlighted items to display them in your inventory. The tree is also interactable. You could click at other nodes to zoom in.

Both recipe list and recipe tree could be also moved with the right mouse button held.

## Installation

### Standalone
Expand Down

0 comments on commit 18761eb

Please sign in to comment.