Screen checks - Lailloken/Exile-UI-Legacy GitHub Wiki

Preface: why screen-checks?

  • Path of Exile doesn't have official addon/mod support, which means 3rd-party tools generally do not have information on what's happening inside the client, for example:

    • whether the inventory or stash is open

    • whether the player is accessing a full-screen interface

    • whether the player is interacting with an NPC

  • screen-checks provide this kind of information and expand the feature-set a tool can offer, while also improving user-experience

    • the 'gamescreen' pixel-check allows the tool to automatically toggle its overlays and UI elements by adapting to what's happening on screen, removing the need for manual toggling by the user

    • the integrated image-checks make a context-sensitive hotkey possible, i.e. accessing various features with a single hotkey (see omni-key)

  • NOTE: users of Windows versions older than 10 have to read BOTH 'usage' sections further below

User Interface

image

The screen-check configurator has its own section in the settings menu and contains the following settings/information:

  • help buttons (?) with information on how screen-checks work why they sometimes need to be recalibrated

  • lists of implemented pixel-checks and image-checks:

    • long-clicking an underlined name will show information and calibration-instructions

    • clicking the 'test' button will test a screen-check; this is for checking whether saved screen-data is still up to date

    • clicking the 'calibrate' button will (re)calibrate the specific screen-check

  • button to open the image folder

    • only needed on systems running a Windows version older than 10, where screen-capping has to be done manually

Usage

  • this is where screen-checks will be calibrated the first time

    • most features triggered by the omni-key require certain screen-checks to be set up

    • red highlighting indicates that setup by the user is required

    • calibrating the 'gamescreen' pixel-check is mandatory since most features depend on it

  • if you're certain you won't be using a specific feature, disable its screen-check by clicking the 'disable:' checkbox

    • this will remove the red highlighting and thus no longer bother you

    • this might also improve general screen-check and omni-key performance

  • each screen-check has a 'test' and 'calibrate' button, and information/instructions (accessed by long-clicking the check's name)

    • follow the instructions closely

    • then click the 'calibrate' button to (re)calibrate the check

    • when calibrating pixel-checks, clicking the button and making sure the required UI element is on screen is all that's needed (the script will do the rest)

    • when calibrating image-checks, the Windows snipping tool will open, and you need to screen-cap the required screen-area mentioned in the instructions

    • click the 'test' button afterwards to see if the screen-capped image is valid

    • it is important to follow the instructions closely and achieve repeatable positive tests

    • example video of calibrating an image-check

  • this is also a trouble-shooting feature which potentially enables the user to fix script-incompatibilities after game-updates on their own without having to wait for me to release an update

    • assuming the syndicate board gets updated in a mid-league patch, the betrayal screen-check will fail and its feature be unaccessible

    • instead of having to wait for me to release an update, the user can recalibrate the screen-check and continue using the tool

Usage: Windows-versions older than 10

  • older Windows versions don't have the snipping tool this feature is built around

  • instead, users will have to take a screenshot of the whole screen and crop out the required image manually

    • only image-checks are affected, pixel-checks can be calibrated in the settings menu itself

  • click the 'img folder' button in the settings menu to open the destination folder, and save the cropped image as a bitmap-file

    • the file has to be named after the image-check itself, e.g. bestiary.bmp, betrayal.bmp, gwennen.bmp, etc.

  • perform a test to see if the image-file is valid