Skip to content

feat: game clients from Steam, version switching, and the Game client window - #32

Merged
evrydayjunglist merged 11 commits into
mainfrom
feat/own-client-folder
Nov 12, 2026
Merged

evrydayjunglist merged 11 commits into
mainfrom
feat/own-client-folder

Conversation

@evrydayjunglist

Copy link
Copy Markdown
Collaborator

Follows LocalExile v0.5.0-beta (allowed client builds, 3.29.3c and 3.29.3d, Steam installs, LocalExile.exe builds) and adds getting a game client from Steam. Read the branch as a whole: the first two commits (no link option at all, a forced copy before Play) are superseded by the third, which follows LocalExile PR 870.

What changes for a user

  • Client versions come from LocalExile. Waypoint asks each LocalExile folder which builds it runs (LocalExile.exe builds --json on a release from v0.5.0-beta, ClientBuilds.cs in a source copy). A client of any listed version fits, and a Steam-layout client in a release folder is recognised. Waypoint's own table gains 3.29.3d and prefers it for a new folder.
  • The client's version is shown in the sidebar folder box, the folder list and a release's Play page. In the Windows app the sidebar's path keeps its end, with dots only at the start.
  • Linking is for developers, as in LocalExile PR 870: a release always copies the client, and the setup guide's "use this folder itself" tick box shows only with Developer Mode. A release whose client is a link to a game folder outside LocalExile shows LocalExile's warning on Play. When that folder is a standalone client, "Make a copy…" copies it beside the link, checks it, and swaps it in; the link works until then. For a link to a Steam install there is the warning but no copy yet.
  • Game client window (a release's Play page, "Game client…", Windows x64 only): lists every game client in every LocalExile folder Waypoint knows, the one each folder uses and those it keeps, with version, Steam or standalone, and path. For the folder in use: put a kept version back in use, delete a kept copy, finish an interrupted switch.
  • Download a version from Steam: the builds LocalExile lists with Steam manifests that the folder does not hold yet (on v0.5.0-beta: the 3.29.3.5 hotfix of 3.29.3c, and 3.29.3d). A download signs in with the user's own Steam account when needed: a QR code for the Steam mobile app, or the tool's own password prompt in a console window.
  • Choosing how to switch: with a client already there the user chooses each time, among the ways the drive has room for. A Steam client: update in place (only what differs is downloaded; the old version is gone) or keep both. A standalone client: keep both, or Replace, which downloads the version whole and then deletes the standalone client for good. Settings can fix the choice for Steam clients; a standalone client is always asked about.
  • Finish setup offers the download for a release folder with no game client at all, on 64-bit Windows with a LocalExile from v0.5.0-beta: the newest listed build (3.29.3d today), or a client already on the PC through the setup guide as before. Anywhere else it opens the guide as before.
  • Linux gets the parts that are not the download: the client's version, the developer-only link box, the linked-client warning with "Make a copy…", and the "no game client" note. It has no Game client window and no Steam download.

How

  • DepotDownloader 3.4.0 (GPL-2.0) does the download. Its official Windows x64 release is carried unchanged inside Waypoint.exe: tools/Get-DepotDownloader.ps1 fetches it and holds it to a pinned SHA-256, the release workflow runs the script before publishing, and the project embeds the zip when it is there (a local build embeds it only after the script was run by hand; without it Waypoint fetches that release at first use). It is unpacked to %LOCALAPPDATA%\Waypoint\tools\DepotDownloader. This adds about 33 MB to Waypoint.exe, which every self-update then downloads.
  • Sign-in: Waypoint sees no password and no token and stores only the account name (Settings.SteamAccount). DepotDownloader itself remembers the sign-in on the PC (-remember-password, in the Windows user's isolated storage). "Forget the sign-in" drops Waypoint's name for it, not the tool's own sign-in.
  • Safety: except for an update in place, a working client is never removed before another is whole. Every other download goes into .waypoint-next-client, is checked (the executable's hash, and the Steam index hash when LocalExile lists one), and is swapped in by renames with rollback. An update in place changes the one client where it is: it carries a mark until it is whole, Play starts nothing on it meanwhile, and the version it was is gone. Enter and Esc are Cancel in every question that starts a download, a copy, a replacement or a deletion. Nothing changes while the game or a server runs.
  • After a download Waypoint removes Game.exe and Game.patched.exe from the new client, carries config.json over, and runs LocalExile.exe setup --no-update-check to make them again.
  • On disk, in a release folder: Clients\<version> (kept clients, each a whole game), .waypoint-next-client (a download being made ready), Client\.waypoint-switching (an update in place under way), and for the linked-client copy .waypoint-new-client, .waypoint-complete, .waypoint-old-link. LocalExile reads only Client.
  • When programs run: LocalExile.exe builds --json for the folder in use at start, and for each known release folder when the folder list or the Game client window opens. Each ask has ten seconds; an answer is kept until LocalExile.exe changes.
  • New code: LocalExileBuilds, ClientVersions, SteamDownload, OwnClient in Launcher.Core; ClientVersionsWindow, SteamSignInWindow, PathLine in Waypoint. New settings: SteamAccount, ClientSwitch. All text is translated (ru, zh-CN). README and docs/launcher.md are updated.

Needs your review

  • Release workflow: .github/workflows/release.yml now runs tools/Get-DepotDownloader.ps1 -Source between Test and Publish, attaches DepotDownloader-3.4.0-source.zip to the release and names it in the notes. A release now needs two downloads from github.com/SteamRE and fails without them. The tool's zip is held to its SHA-256; the source zip is GitHub's tag archive and has no pinned hash. This step has never run: it runs only on a v* tag, and CI builds a Waypoint without the embedded tool.
  • Licence: a GPL-2.0 program is carried inside the release exe as a separate, unmodified program. THIRD-PARTY-NOTICES.md and a README line say so, but the app itself shows no third-party notice; a user gets the GPL text as the LICENSE file unpacked beside the tool and through the release's source zip.
  • Two couplings: a source copy's build list is read by regular expressions over the server's src/GameServer.Core/Protocol/ClientBuilds.cs, which is not one of the hooks AGENTS.md names (AGENTS.md is not changed here). And the download is driven by matching DepotDownloader 3.4.0's English console lines, so another version of the tool needs those re-checked.

Tested

  • Both solutions build with 0 warnings; Waypoint.Tests 443 pass; Launcher.Checks 201 pass; translations complete. One of those tests is a real download and does nothing unless two environment variables are set, so CI never downloads; the two windows and the tool's unpacking were checked in the app only.
  • In the app against real Steam: QR sign-in; update in place in both directions on a full 67 GB Steam client with the real v0.5.0-beta launcher (hashes checked, LocalExile's own setup and check accept the result); keep both and back with a standalone client. On stand-in release folders with only Steam's small executables depot: a first download, the download from Finish setup, and finishing a half-way copy.
  • Not tested: a whole 71 GB download from zero (at full size only differences were downloaded); the password sign-in with a real password; a Waypoint built without the bundled zip fetching the tool at first use; a source copy in the running app; the Linux app beyond building; the release workflow's new step; the adapter's tests/*.Tests.ps1 (its scripts are untouched).

Not in this PR

  • The Steam download on Linux; a copy for a client linked to a Steam install; the setup guide copying from an installed Steam folder; source copies with a Steam-layout client.

evrydayjunglist and others added 11 commits November 11, 2026 13:10
The setup guide no longer offers "Use this folder itself instead of a copy":
a release is always given a copy (--client-mode copy).

A release that was set up that way runs from the user's own Path of Exile
folder, where LocalExile writes Game.exe, Game.patched.exe and the login list,
and where a game update leaves it without the client it needs. That is not
supported any more. Its Play page says so, and every Play asks for a copy of
its own (Copy now, Open folder, Play anyway). Nothing is refused, so a user
without the room for the copy can still play.

The move (OwnClient) never leaves the release without a client:
- the copy is made beside the link, which keeps working meanwhile;
- only a copy that is whole and still matches the user's folder takes the
  link's place, by renames that are undone if one fails;
- the user's folder is only read; removing the link removes nothing in it;
- a stop or a failure leaves the release as it was, and the next try goes on
  from what was copied; a move cut short at the swap is finished at startup.

A link to another LocalExile folder's client (a shared client) is left alone,
and a source copy is never asked.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…drive is too full

Running a release from the user's own Path of Exile folder is not supported,
so with the room for the copy there is no playing on without it: the question
is Copy now or Cancel, and Cancel starts nothing.

Only a user whose drive is too full may play on from the link, because a
refusal would leave them no way to play. That box says how much the copy
needs, and that a Path of Exile update in that folder can break this
LocalExile; it comes back on every Play.

A copy that fails is not the user's doing: the game starts from the link that
time, and the next Play tries again. Enter and Esc press Cancel in both boxes,
so a box that opens while its user types starts nothing.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
LocalExile v0.5.0-beta lists the client builds it runs, runs 3.29.3c and
3.29.3d side by side, always copies the client, and keeps linking for
developers with a warning. Waypoint follows it instead of keeping rules of its
own.

Client versions
- Which versions a LocalExile runs is asked of that LocalExile: a release's
  "LocalExile.exe builds --json", a source copy's ClientBuilds.cs
  (LocalExileBuilds). A folder that cannot say runs the one version it names.
- A client of any version the folder's LocalExile runs fits. A 3.29.3c client
  on v0.5.0-beta is no longer taken for an old one, and a 3.29.3d client on a
  release before it is told that LocalExile needs the update.
- The builds a list names are recognized by their executable's hash, so a
  build LocalExile comes to allow shows by its version without a new Waypoint.
- The sidebar's folder box and list, and a release's Play page, show the
  version of the folder's game client.

Linking
- The setup guide offers "use this folder itself" again, only with Developer
  Mode on, as LocalExile keeps --client-mode link for developers.
- A release whose client is a link to the user's game folder is no longer
  made to copy before it plays. The Play page shows LocalExile's own warning,
  told by LocalExile's own test, and "Make a copy..." does the safe copy on
  the user's word.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Not reachable from a screen yet.

- SteamDownload drives DepotDownloader for a build LocalExile lists
  (app, depots and manifests from "LocalExile.exe builds"): the tool's QR
  sign-in with its code handed over for Waypoint to draw, a build's size from
  its manifests, and the fetch with its progress. A log never gets the
  sign-in code or the account's name.
- ClientVersions holds the versions of a LocalExile folder: Client, which is
  all LocalExile looks at, and those set aside in Clients\. A build comes by
  updating the one client where it is, or beside it with both kept; a kept
  one comes back by two renames. A client being updated where it is carries
  a mark until it is whole.
- DepotTool fetches the pinned DepotDownloader 3.4.0 and holds it to its
  SHA-256. How the tool reaches a user (fetched, bundled, or built in) is
  still open.

Tried against Steam with DepotDownloader 3.4.0: the anonymous account is
refused, the QR sign-in works with its output captured, and a client moved
between 3.29.3d and 3.29.3c both ways on the depot of executables.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
A release's Play page has "Game client...": the client in use, those kept
beside it, and each version its LocalExile lists that Steam can deliver, with
LocalExile's own name for the build.

- The download tool, DepotDownloader 3.4.0, is carried in Waypoint.exe: the
  build fetches its official release once (tools/Get-DepotDownloader.ps1,
  held to its SHA-256), the project embeds the zip, and Waypoint unpacks it on
  first use. A user's Waypoint downloads no tool. The release workflow attaches
  the tool's source; THIRD-PARTY-NOTICES.md has its licence (GPL-2.0).
- Steam's anonymous account cannot fetch the game, so the user signs in once:
  by the tool's QR code, drawn in Waypoint's own window (with a new code when
  one runs out), or without the Steam mobile app by the tool's own password
  prompt in a console window. Waypoint sees no password and no token; it keeps
  and shows the account's name.
- With a client already there, the way is asked each time: update the one
  client in place, or keep both. Settings can make one the way every time.
- A kept version comes back by two renames. LocalExile's setup prepares a
  client that came in. Play starts nothing on a client half-way to another
  version.
- The setup guide takes a folder's own client in Steam's layout for a client.

Tried in the app against Steam on the depot of executables: sign-in by QR, a
first download, the other version with both kept, and back to the kept one.
Not tried: the 71 GB depot of game files, the password prompt with a real
password, Linux (the tool is pinned for Windows x64 only).

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
- A version Steam can deliver in more than one build (a release and its hotfix) has a line for each, named as LocalExile
  names it, and the folder moves between two builds of one version like between two versions. The mark of an unfinished
  update in place names the build by its executable hash, and a download counts as whole only with that build's executable.
- "Close the game and stop the servers" has its own line: LocalExile's setup starts its tools for a moment, and that no
  longer overwrites what the switch just said. The buttons follow what runs.
- A standalone client cannot come back from Steam: Keep both is the first button there.
- LocalExile's setup lines are logged as LocalExile's, not Steam's.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…part from it

The window listed the versions LocalExile allows as rows "from Steam", which read as clients that were there. Now:

- The list is every game client in every LocalExile folder Waypoint knows, drawn as the sidebar's folder list draws its
  folders: the version with LocalExile's name for the build, Steam version or Standalone version, the folder it belongs
  to, a kept copy's size, and where it is. "In use" marks the client of the folder in use, and only that folder's
  clients are changed here.
- "Download a version…" is apart from the list: it opens the builds the folder's LocalExile lists that Steam can deliver
  and the folder does not hold. Enter there is Cancel.
- A linked client is shown where it is used, with where it leads: another LocalExile folder's client, or a game folder
  outside LocalExile, with LocalExile's warning and "Make a copy…" (the Play page's copy) for the folder in use. A
  linked client is neither replaced nor downloaded over.
- A client half-way to another version says so in any folder. It is only ever made whole where it is: Keep both is
  refused for it, a copy never carries the mark on, and a kept copy in that state gets "Finish this copy"
  (ClientVersions.FinishKeptAsync) instead of "Use this version".
- "Always update in place" no longer applies to a standalone client, which it would delete for good.
- What a stopped version change left counts as room for the next one and is said, with what an update in place does to it.
- A kept copy whose deletion was cut short is not listed and is finished when the window opens.
- A LocalExile that failed to answer "builds" once is no longer taken to have no list for good: the window asks once more.
- Several counts every listed build of a version, so two builds of 3.29.3c are told apart in the questions.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The window explained itself in sentences, said the same facts in several places, and announced what would happen next.

- No intro text: the title and the list carry what the window is. This folder's clients come first, the rest under
  "Other folders". A line is the version (the build's name only where the version is several builds), what it is, and
  where it is.
- A button beside the list shows only for the line it applies to, and the one likely next step has the primary style.
  A sentence appears only where something is blocked or not safe, or when a thing happens.
- The sign-in buttons are gone from the window: a download signs in when it needs to, and the QR window offers the
  password prompt. The Steam line shows only once there is an account.
- The picker has no intro, and the questions give the size, the room and what each way costs, in short whole
  sentences that translate cleanly. 34 strings left the catalogs and 27 shorter ones came in.
- A path keeps its end and loses its start behind dots (PathLine): in the sidebar's folder box, which cut both ends,
  and on every client's line.
- A release folder with no game client: Finish setup asks where it should come from, and offers the newest version its
  LocalExile lists from Steam (3.29.3d for v0.5.0-beta), or the setup guide as before. The guide's note no longer names
  3.29.3c or says Waypoint cannot download the game.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
- A window closed while it still read the folders no longer starts the download Finish setup asked for.
- The setup guide says Finish setup can download the game only where it will (ClientVersions.FirstDownload, the same
  test the Play page uses): a release whose LocalExile lists a build Steam can deliver.
- A folder whose only clients are kept ones is not said to have none: Finish setup opens the Game client window, which
  puts one back.
- "Always update in place" asks when an unfinished keep-both left a download behind, which that way deletes.
- A LocalExile that did not answer is not said to be too old, a link that leads to no game names its target, and the
  step says itself again after a renewed sign-in.
- The sidebar's path is fitted again when the reading font or zoom changes, and never cuts a character in two.
- The Linux Play page says the same of a folder with no game client.
- The Finish setup question names the version in its sentence, so its buttons are short. Lines of the how-to-move
  question start with their buttons' own names in Russian and Chinese, and the Chinese names Finish setup as its
  button does. Three catalog entries with no source left are gone.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
LocalExile can list two builds of one version for Steam (the 3.29.3c release and its hotfix). A switch mark with no
build hash then resumed to the first listed, the release. It means the last listed, the hotfix, as Newest does.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
- The "drive is too full" box of Make a copy closes on Enter and Esc: they pressed Open folder, which brought it back.
- A client linked to a Steam install outside LocalExile gets LocalExile's warning on Play too (it had none, because
  Waypoint cannot make that copy yet).
- The README and the setup guide's first page no longer say Waypoint cannot download the game or name only 3.29.3c.
- docs/launcher.md "Releases and updates" names the release workflow's new step and asset.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@evrydayjunglist
evrydayjunglist merged commit 57e7a03 into main Nov 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant