Mapping tracker - Lailloken/Exile-UI-Legacy GitHub Wiki

Feature Overview

  • collect and save mapping-related statistics (maps per day, net run-time, etc.)

  • the collected data can be viewed via the log viewer while playing, or be exported as .csv files

  • optional statistics to collect:

    • side-content: lab trials, vaal side areas, abyss, etc.
    • loot dropped in individual map-runs
    • kill-count for individual map-runs

User Interface & Settings

  • main UI-elements:

    • tracker button image that can be placed anywhere within the client-window by dragging

    • tracker panel (in the corner between exp-bar and inventory) & log viewer

  • this feature has its own section in the settings menu, with UI and sub-feature options

Requirements

  • the game-client has to be set to English (if there's enough demand, I may implement support for other languages)

  • optional loot tracking: 'stash' image-check has to be set up

Initial Setup

  • go the 'mapping tracker' section of the settings menu and enable the feature

  • after enabling this feature, the tracker button and panel will show at the bottom edge of the screen

    • button and font sizes are adjustable

    • the panel should be positioned in the corner between inventory and exp-bar, but there are pixel-offsets in the settings to correct it for certain resolutions and/or aspect ratios
      image

General Usage

  • in its default state, the panel will read 'not tracking 00:00'

  • once you enter an instance in your map device, the panel will show the name and tier of the instance, and the timer will start

  • timer behavior:

    • leaving the instance will pause the timer, re-entering will resume it

    • the timer will also pause when the game-client is out of focus, so you can tab out or press the Windows key once to avoid logging AFK time (if you don't want to TP out, or need leave quickly)

  • entering a new instance will save the logged data of the previous one, and the panel will be updated with the new name, tier, and timer

    • note: this also works if the new instance is using the same map-type as before (e.g. when running the same map-type over and over for target-farming)

    • this means the tracker runs passively in the background and doesn't require user input

  • the logged data will also be saved automatically when the script closes, e.g. when you close the client at the end of a session

  • the instance can be marked as complete (and logged data saved) manually by long-clicking the name on the panel (a green progress-bar will fill underneath while holding)

    • this should be used after finishing a map, knowing you will do something other than mapping afterwards (since only map-changes and closing the script trigger the auto-save)

  • you can temporarily disable the tracker by right-clicking the tracker-button (the button will turn gray, and the panel will hide)

    • use this if you want to run something in-between without tracking, or when you need to enter someone else's map device and cannot finish your current map

    • NOTE: always use this in the same location, e.g. disable it in your hideout, do whatever has to be done, return to your hideout and enable it again there; toggling it in one location, then again in another will desync the timer slightly and lead to bad data

Loot Tracking

  • if loot tracking is enabled, ctrl-clicked items will be listed in the tracker panel when stashing items
    image

  • ctrl-clicking will track loot if these criteria are met:

    • the panel is active, i.e. not showing 'not tracking 00:00'

    • the stash is on screen and the plaque at the top is clearly visible (the image-check has to be set up and positive)

    • the clicked item is on the right side of the screen, i.e. it is transferred from inventory to stash and not the other way around

  • this list can be used to double-check whether data logging is working correctly

    • clicking items will remove them from the list (in case something was added accidentally)

  • pressing ESC will restore the panel to the smaller size (the list will only be hidden, not deleted), adding more items will show the list again

Kill Tracking

  • NOTE: this feature cannot be automated since it would violate GGG's terms of service (TOS), so it is as streamlined as possible right now

  • when enabled, the map-tracker panel (the one with the map name and timer) will flash green after entering a new map

  • clicking the timer will trigger the /kill command in game and use the returned value as the starting value; a tooltip will say "kill-tracker activated" and the panel will stop flashing

  • if the current map is completed and you want to start a new one, you'll have to click the timer again to refresh the kill-count; a tooltip will pop up and display a confirmation message

    • whenever you leave the map device, the panel will turn green as a reminder that the kill-count needs to be refreshed

  • entering a new map will save the logged data as usual, and the panel will start flashing again

Accessing Logged Data

  • clicking the tracker button will open an interface to view logged data (pressing ESC will close it)
    image

  • the drop-down menu lists all dates with available logged data, and selecting a date will display all runs from that day underneath

  • long-clicking the 'del'-button will delete the selected day (a red progress-bar will fill while holding)

  • you can export logged data into csv-files: click 'day' to export the selected day, and 'all' to export the complete data

    • the csv-files will be stored in the main Lailloken UI folder, either as 'mapping tracker year-month-day.csv' or 'mapping tracker.csv'

    • NOTE: if files are already present, they will be overwritten without warning, so move the files somewhere else if you want to keep old data

  • the entries on the list show when you first entered the instance, its tier, the run-time, portals used, deaths, and name

  • color highlighting indicates that an entry has additional information (e.g. loot, game content, etc.) which can be displayed in a tooltip by long-clicking the entry
    image

  • holding right-click will delete an entry (a red progress-bar will fill while holding)

Remarks

  • based on suggestions/requests by antoniocmf in #50, and GrimDawn-max in #105

  • the general map-tracker suggestion came in quite a while ago, but I hesitated because I didn't have enough ideas to make it a worthwhile feature

  • having implemented a few features that use the client.txt-log as well as getting the loot-tracker request justified implementing this kind of tracker

  • I'm aware that there are established tools that do similar things, but the people who submitted the requests either couldn't use them anymore or found them lacking for their personal use-case; these tools also only use the client.txt and are therefore limited

  • for the time being, it tracks a limited set of extra game-content (abyss, lab trials, vaal areas), but I could implement ways of tracking every kind of content in the future if there's demand for that