fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games #1000

Merged
HumanBean merged 1 commit from Xarishark/Longshot:fix/build-into-install-folder into main 2026-11-16 04:24:53 +00:00
Contributor

Ready for review. This needs RecompLauncher 0.90 Beta 56, which has elripalda/RecompLauncher#244: that's what sends players who already built into ~/Games/Longshot back to Easy Setup on their next Play (the prepare.version bump below), so they build into the new folder. Saves follow through #232 (Beta 55). The launcher reads the recomplauncher.json a release ships before the one on main, so this reaches players with the first Longshot release after the merge. Hookshot's same change is already merged (Hookshot/Hookshot#2980).

Why

Players who install Longshot through RecompLauncher get the game built into ~/Games/Longshot (C:\Users\<name>\Games\Longshot on Windows), whatever drive they picked for their library. recomplauncher.json runs --cli --prepare without --out, so make_game.py falls back to its default. LongshotBuilder is on the drive they chose, but the build goes to the system drive without asking. Reported for Hookshot, which has the same setup, in RecompLauncher issue 215.

What changed

  • prepare.args passes --out {install}/Longshot, so the game is built in the launcher's install folder, next to LongshotBuilder.
  • start, config, saves, folders.saves and folders.game move from {home}/Games/Longshot to {install}/Longshot. The save list keeps the same number of entries in the same order, so RecompLauncher's restore (with #232) puts a copy made from the old folder into the new one.
  • prepare.version is "2", so players who already set up are asked to build once more, this time into their library folder. Builds already in ~/Games/Longshot stay where they are until the player deletes them.
  • tests/test_recomplauncher_json.py: test_builds_into_the_launchers_game_folder checks that the folder --out builds into is the one start plays and the one the settings, saves and game folder point at, and that no {home}/Games path is left.

How it was tested

  • The new test fails on main (ERROR: test_builds_into_the_launchers_game_folder) and passes with the change.
  • python -I -B tests/run_all.py on Linux (Bazzite): 535 passed, 23 failed, 93 skipped. Unchanged main fails the same 23 on that machine (missing Python packages and tools there, and tests behind the source), so none come from this change.
  • The manifest validates against recomplauncher.com/schema/recomplauncher.json with no errors.
  • A real build on Windows 11 with an RTX card, through RecompLauncher's Easy Setup (a portable launcher on F:, the library on F:, the Builder's home set to a folder on F: with LONGSHOT_SETUP_BASE), from the supported .nup (build e0f3ccfa), with Longshot nightly-189-aa95d35f. The release's own recomplauncher.json was swapped for this one. The Builder built into F:\rl-test-215\library\longshot\Longshot, and Play started LongshotBuilder.exe --play F:\rl-test-215\library\longshot/Longshot. The game ran from ...\Longshot\bin\longshot.exe with its log, longshot_options.ini and user folder in the same place. Nothing was written to ~/Games.

Not tested

  • Linux and the AppImage with a real build (only the game-free suite ran there).
  • An existing ~/Games/Longshot install moving over. The same move was tested end to end with Hookshot, whose manifest is the same apart from the names (see Hookshot/Hookshot#2980): Easy Setup opened on Play, the rebuild went into the install folder, and the save copy restored into the new user folder.
  • DLSS and XeSS ticked during the build.
**Ready for review.** This needs RecompLauncher 0.90 Beta 56, which has [elripalda/RecompLauncher#244](https://github.com/elripalda/RecompLauncher/pull/244): that's what sends players who already built into `~/Games/Longshot` back to Easy Setup on their next Play (the `prepare.version` bump below), so they build into the new folder. Saves follow through [#232](https://github.com/elripalda/RecompLauncher/pull/232) (Beta 55). The launcher reads the `recomplauncher.json` a release ships before the one on `main`, so this reaches players with the first Longshot release after the merge. Hookshot's same change is already merged ([Hookshot/Hookshot#2980](https://git.notrexed.dev/Hookshot/Hookshot/pulls/2980)). ## Related - RecompLauncher issue: [elripalda/RecompLauncher#215](https://github.com/elripalda/RecompLauncher/issues/215) - Launcher, rebuild when the setup step changes or the build folder is gone: [elripalda/RecompLauncher#244](https://github.com/elripalda/RecompLauncher/pull/244) (needed before this merges) - Launcher, saves follow a moved save folder: [elripalda/RecompLauncher#232](https://github.com/elripalda/RecompLauncher/pull/232) (in Beta 55) - The same change for Hookshot: [Hookshot/Hookshot#2980](https://git.notrexed.dev/Hookshot/Hookshot/pulls/2980) ## Why Players who install Longshot through RecompLauncher get the game built into `~/Games/Longshot` (`C:\Users\<name>\Games\Longshot` on Windows), whatever drive they picked for their library. `recomplauncher.json` runs `--cli --prepare` without `--out`, so `make_game.py` falls back to its default. LongshotBuilder is on the drive they chose, but the build goes to the system drive without asking. Reported for Hookshot, which has the same setup, in [RecompLauncher issue 215](https://github.com/elripalda/RecompLauncher/issues/215). ## What changed - `prepare.args` passes `--out {install}/Longshot`, so the game is built in the launcher's install folder, next to LongshotBuilder. - `start`, `config`, `saves`, `folders.saves` and `folders.game` move from `{home}/Games/Longshot` to `{install}/Longshot`. The save list keeps the same number of entries in the same order, so RecompLauncher's restore (with #232) puts a copy made from the old folder into the new one. - `prepare.version` is `"2"`, so players who already set up are asked to build once more, this time into their library folder. Builds already in `~/Games/Longshot` stay where they are until the player deletes them. - `tests/test_recomplauncher_json.py`: `test_builds_into_the_launchers_game_folder` checks that the folder `--out` builds into is the one `start` plays and the one the settings, saves and game folder point at, and that no `{home}/Games` path is left. ## How it was tested - The new test fails on `main` (`ERROR: test_builds_into_the_launchers_game_folder`) and passes with the change. - `python -I -B tests/run_all.py` on Linux (Bazzite): 535 passed, 23 failed, 93 skipped. Unchanged `main` fails the same 23 on that machine (missing Python packages and tools there, and tests behind the source), so none come from this change. - The manifest validates against `recomplauncher.com/schema/recomplauncher.json` with no errors. - A real build on Windows 11 with an RTX card, through RecompLauncher's Easy Setup (a portable launcher on `F:`, the library on `F:`, the Builder's home set to a folder on `F:` with `LONGSHOT_SETUP_BASE`), from the supported `.nup` (build `e0f3ccfa`), with Longshot `nightly-189-aa95d35f`. The release's own `recomplauncher.json` was swapped for this one. The Builder built into `F:\rl-test-215\library\longshot\Longshot`, and Play started `LongshotBuilder.exe --play F:\rl-test-215\library\longshot/Longshot`. The game ran from `...\Longshot\bin\longshot.exe` with its log, `longshot_options.ini` and `user` folder in the same place. Nothing was written to `~/Games`. ## Not tested - Linux and the AppImage with a real build (only the game-free suite ran there). - An existing `~/Games/Longshot` install moving over. The same move was tested end to end with Hookshot, whose manifest is the same apart from the names (see Hookshot/Hookshot#2980): Easy Setup opened on Play, the rebuild went into the install folder, and the save copy restored into the new `user` folder. - DLSS and XeSS ticked during the build.
fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games
Some checks failed
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Failing after 4s
37ccc7a26a
Member

Possibly related, for context:

  • issue #720 Idea: choose the install drive for the launcher and everything it downloads, not just the game folder — Related install-drive concern, but broader launcher/home-folder scope
Possibly related, for context: - issue #720 Idea: choose the install drive for the launcher and everything it downloads, not just the game folder — Related install-drive concern, but broader launcher/home-folder scope
Xarishark changed title from fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games to WIP: fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games 2026-11-16 02:50:03 +00:00
Xarishark changed title from WIP: fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games to fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games 2026-11-16 04:15:49 +00:00
HumanBean deleted branch fix/build-into-install-folder 2026-11-16 04:24:54 +00:00
Some checks failed
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Failing after 4s
Some workflows are waiting to be reviewed.
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!1000
No description provided.