fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games #1000
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1000
Loading…
Reference in a new issue
No description provided.
Delete branch "Xarishark/Longshot:fix/build-into-install-folder"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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/Longshotback to Easy Setup on their next Play (theprepare.versionbump below), so they build into the new folder. Saves follow through #232 (Beta 55). The launcher reads therecomplauncher.jsona release ships before the one onmain, so this reaches players with the first Longshot release after the merge. Hookshot's same change is already merged (Hookshot/Hookshot#2980).Related
Why
Players who install Longshot through RecompLauncher get the game built into
~/Games/Longshot(C:\Users\<name>\Games\Longshoton Windows), whatever drive they picked for their library.recomplauncher.jsonruns--cli --preparewithout--out, somake_game.pyfalls 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.argspasses--out {install}/Longshot, so the game is built in the launcher's install folder, next to LongshotBuilder.start,config,saves,folders.savesandfolders.gamemove from{home}/Games/Longshotto{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.versionis"2", so players who already set up are asked to build once more, this time into their library folder. Builds already in~/Games/Longshotstay where they are until the player deletes them.tests/test_recomplauncher_json.py:test_builds_into_the_launchers_game_folderchecks that the folder--outbuilds into is the onestartplays and the one the settings, saves and game folder point at, and that no{home}/Gamespath is left.How it was tested
main(ERROR: test_builds_into_the_launchers_game_folder) and passes with the change.python -I -B tests/run_all.pyon Linux (Bazzite): 535 passed, 23 failed, 93 skipped. Unchangedmainfails the same 23 on that machine (missing Python packages and tools there, and tests behind the source), so none come from this change.recomplauncher.com/schema/recomplauncher.jsonwith no errors.F:, the library onF:, the Builder's home set to a folder onF:withLONGSHOT_SETUP_BASE), from the supported.nup(builde0f3ccfa), with Longshotnightly-189-aa95d35f. The release's ownrecomplauncher.jsonwas swapped for this one. The Builder built intoF:\rl-test-215\library\longshot\Longshot, and Play startedLongshotBuilder.exe --play F:\rl-test-215\library\longshot/Longshot. The game ran from...\Longshot\bin\longshot.exewith its log,longshot_options.inianduserfolder in the same place. Nothing was written to~/Games.Not tested
~/Games/Longshotinstall 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 newuserfolder.Possibly related, for context:
fix(builder): RecompLauncher builds the game in its own install folder, not ~/Gamesto WIP: fix(builder): RecompLauncher builds the game in its own install folder, not ~/GamesWIP: fix(builder): RecompLauncher builds the game in its own install folder, not ~/Gamesto fix(builder): RecompLauncher builds the game in its own install folder, not ~/Games