poe2hud — self-contained folder
===============================

Everything the program uses lives in this folder. Move or copy the whole
folder anywhere and it keeps working.

  start.sh      the launcher, and the easiest way in: it checks what the
                program needs, says what is missing, and offers the few
                options that can only be set before it starts. Double-click
                it, or run ./start.sh in a terminal.
  poe2hud       the program itself: overlay HUD, radar, tactical view,
                auto-potion, plugins. Run it with Path of Exile 2 running.
  poe2lua       offline plugin runner: develop and test .lua plugins in a
                terminal, no game needed (see docs/PLUGINS.md).
  poe2read      finds the game's memory offsets. Run it after a Path of
                Exile 2 patch, when something that used to work stops: it
                prints numbers to paste into data/offsets.json.
  data/         files YOU own and poe2hud never overwrites - the downloaded
                attack data, and offsets.json if you make one.
  plugins/      the plugins poe2hud loads, plus a .config beside each one
                once you tune it in the menu.
  config/       poe2hud.conf (your settings; written by "Save settings" on
                the F11 menu's Config tab) and imgui.ini (window positions).
  logs/         poe2hud.log — when something misbehaves, this file is how
                it gets diagnosed; bring it when reporting a problem.
  docs/         the full README, the plugin API reference, the changelog, and
                THIRD-PARTY.md — everything in the program someone else wrote.
  LICENSE       poe2hud is Apache-2.0. The plugins are MIT-0 instead, so an
  NOTICE        example you copy carries nothing with it: see plugins/LICENSE.
                Keep these two with the folder if you pass it on.

Something wrong?  https://discord.gg/apRdQWAfjn
Bring logs/poe2hud.log, what you expected, and what happened instead. The
log's first line says which build produced it, which is usually the first
question. docs/README.md has the longer version.

On first run poe2hud downloads its attack data (about 14 MB) into data/. Until
that finishes the attack indicator, telegraphs and cast names have nothing to
draw from; the log and the Config tab both say so while it runs.

Quickstart: start the game, run ./start.sh, then press F11 in game for the
settings menu, z for the tactical view. Every key is rebindable: click it
in the menu, then press the new key. Settings are saved and loaded with
"Save All" / "Load All" on the Config tab.

To close poe2hud: the Quit button on the F11 menu's Config tab, or ctrl-c in
the terminal the launcher opened. ./start.sh --install-desktop puts poe2hud
in your application menu.

Fresh copies start with safe defaults: every plugin loads switched OFF —
running one is a box you tick — and even a running plugin cannot press keys,
move the mouse or override your input until you also grant that permission,
in the menu, on this machine.

Upgrading: unpack the new folder, then copy across from your old one the
things that are yours — config/, data/, and each plugins/*.config you tuned
(they carry the permissions you granted, so only ever copy your own). The
log's first line names the version, which is how you confirm the swap took.
