Skip to content

Commit

Permalink
readme work
Browse files Browse the repository at this point in the history
  • Loading branch information
mculig committed Feb 25, 2020
1 parent 5065764 commit 9299658
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The tracker:
* **DOES NOT** intercept any Client-Server communication.
* **DOES NOT** send any requests of its own to any server.

The application relies on several dots to identify in-combat and out-of-combat situations. These dots can be seen on the following 2 images:
The application relies on several dots to identify in-combat and out-of-combat situations, and 2 Frames to identify Temtem names using OCR. These dots and frames can be seen on the following 2 images:

![OCR Frames and Sampling dots](https://github.com/mculig/TemtemTracker/blob/master/Images/OCR%20Frames%20and%20Sampling%20Dots.png)

Expand All @@ -26,6 +26,28 @@ The ARGB values the application tests for can also be found in the config file:

The application has been tested to work at 3840x2160, 1920x1080 and 1600x900 resolutions without the need to modify the spot locations in the config file.

The OCR Frames location and dimensions are determined by the values:

* frameXPercentageLeft
* frameXPercentageTop
* frameWidthPercentage
* frameHeightPercentage

The application interface can be seen on the following image:

![Application Interface](https://github.com/mculig/TemtemTracker/blob/master/Images/window.png)

The application tracks Temtem encountered, the number of encounters, the chance of having encountered a Luma of that species and the % that species represents in the total number of Temtem encountered, as well as totals for these values.

The Luma chance is based on the lumaChance value in TemtemTracker/config/config.json

The Window dimensions are saved upon exiting the application and can be found in TemtemTracker/config/userSettings.json

Finally, in order to clean up any artifacts in the OCR output, a string comparison operation is executed using the Temtem names found in TemtemTracker/config/temtemSpecies.json. This will need to be updated with new species when their names are released in order to keep the application reliable.

** Controls

To exit the application simply press X on the Window
To reset the timer and table press F8


0 comments on commit 9299658

Please sign in to comment.