Mapping tracker - Lailloken/Lailloken-UI GitHub Wiki

Feature Overview

  • collect and record mapping-related statistics (maps per day, net run-time, effective exp, kills, side-content, etc.)

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

  • optional statistics to collect:

    • side-areas: lab trials, vaal side areas, abyssal depths

    • optional content/mechanics: bestiary, betrayal, blight, delirium, delve, expedition, harvest, incursion, legion, metamorph, ritual

    • dropped loot & kill-count in individual map-runs

    • effective exp gained in a map

    • map mods rolled on a map

    • custom notes, and map-device stats (scarabs, sextants, Kirac mods)


User Interface & Settings

  • this feature has its own section in the settings menu, with customization and sub-feature options
main UI-elements & user interaction screenshot
toggle button on the main toolbar:
- click to open the log-viewer, right-click to pause tracking
img
tracker panel
- hidden while mapping, hold TAB to view

1. in hideout: drag to move the panel, right-click to reset position to default

2. map-name (tier) run-time
- click when it flashes red to update kill-tracker (optional)
- long-click when in hideout to manually log the run and "clear" the panel

3. side-content encountered in the map (optional)

4. custom notes (optional)
- click to add notes for the map runs
image

Requirements

  • optional loot tracking: stash image-check has to be set up correctly in the screen-checks section of the settings menu

  • optional mechanic tracking:

    • some mechanics can be tracked via voice-lines in the client.txt, which requires the in-game option output dialogue to chat to be enabled (bottom of the UI tab)

    • other mechanics can only be tracked visually via screen-reading, which requires manual calibration for each of those mechanics


Initial Setup

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

  • the toggle button will appear in the main toolbar, and the tracker panel on the bottom edge of the client


General Usage

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

  • 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

  • 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

  • you can manually log the map-run and "clear" the panel by long-clicking the map-name while in a hideout

    • this can be used after finishing a map, knowing you will do something else, so there's no "pending" map in the tracker
  • you can temporarily pause/disable the tracker by right-clicking the toggle-button (the button and the panel-text will turn gray)

    • 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

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

    • the stash is on screen and the plaque at the top is clearly visible

    • 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

    • ctrl + right-click to undo the previous steps (like ctrl-Z in a text-editor, 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

  • if enabled, a tooltip will follow the cursor prompting you to press the omni-key upon entering a new map

    • don't press it during the loading-screen, wait for your character to be visible
  • pressing it will trigger the /kill command in game and use the returned value as the starting kill-count

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

    • clicking the map-name will trigger the /kill command again and calculate the kill-count difference

    • refreshing the kill-count is only required when you leave the map for the last time and know you won't enter it again: if you leave the map for trading or stashing only, you can ignore the flashing (it will stop once you re-enter)

  • entering a new map will save the logged data as usual, and the tooltip will prompt you to press the omni-key again


League-mechanics Tracking

  • if enabled, optional content/mechanics you encounter while mapping will also be tracked

    • the tracker panel will show icons of league content you found during this map run
      image

    • the log-viewer will list all the content you found during each map run
      image

  • you can toggle tracking for each mechanic individually by clicking their buttons in the settings menu

  • some mechanics can only be tracked via screen-reading, which requires manual calibration

    • find the specific content/mechanic in a map and open the mapping tracker section of the settings menu

    • right-click the button of said mechanic to open the snipping tool, then screen-cap a unique ui-element
      image
      image

    • left-click the button to enable tracking for it (it will be highlighted green)

    • whenever you encounter this mechanic while mapping, hold TAB to activate screen-reading

    • if the script finds the ui-element, the mapping tracker panel will show a small icon to indicate successful tracking of the content/mechanic
      image

    • do not use the buttons in some mechanics for calibration because they don't render correctly and are hard to track
      image

    • some examples of alternative ui-elements:
      image
      image

  • there's also an option to show a reminder whenever you activate portal scrolls in the map

    • requires the inventory pixel-check to be set up correctly in the screen-checks section of the script settings
      image image

Accessing Logged Data

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

  • click the button next to logs: in the top left to open the date selector which shows dates and league periods with available runs
    image

  • you can export logged data into csv-files: long-click export to save the runs that are currently loaded into the log-viewer

    • the csv-files will be stored in the export folder within the script's install folder
  • some columns don't have text but simply highlighted cells to indicate stored data: click these cells to view it in a tooltip

⚠️ **GitHub.com Fallback** ⚠️