docs(saves): clarify Windows Roaming save location #1269

Merged
llun merged 1 commit from bibiburl/Longshot:docs/clarify-roaming-save-location into main 2026-11-16 23:44:04 +00:00
Member

Type: docs · Risk: low · Tested on: source comparison only · Needs: website preview/checks during review

Why

A player found their saves in AppData\Roaming but could not connect that folder to the website's “Where Longshot keeps them” table. The existing %APPDATA%\Longshot\save\ path is correct for the installed nightly launcher; its Windows expansion was unexplained. The direct-launch row also omitted the --user exception.

What changed

Only docs/saves.md, the maintained source of /saves/transfer/:

  • Spell out the normal Roaming path beside %APPDATA%.
  • Add a File Explorer address-bar instruction and distinguish Roaming saves from Local backups.
  • Qualify the direct-launch row with “without --user”.

The existing table, page sections, portable/older-version guidance and screenshots remain in place.

Measurements

Verdict: Documentation wording only; no runtime or performance change to measure.

Flags and settings

None. --user is an existing argument, not a changed default.

Testing

Tested:

  • Compared the live page with Longshot main c9e3e542 and released game nightly-376-a413bf1c: host/hos_main.c accepts --user and otherwise retains the Windows build-local folder.
  • Checked Launcher nightly-100-5f30eea3: SaveEnvironment uses %APPDATA%\Longshot, with %USERPROFILE%\AppData\Roaming as the fallback. Launcher save documentation agrees; portable paths remain separate.
  • git diff --check passed. Only the original documentation source changed; generated website content was not edited.
    Not tested: Website build/checks and rendered screenshots were not run; builds remain paused in this workspace. No game run or save operation performed.

Must be tested: Linux, any GPU, by hand during review: run the website's documented build/check workflow and inspect /saves/transfer/#where-longshot-keeps-them at desktop and mobile widths, expecting the Roaming path to display correctly and the table to remain readable.

Risks

What could break: The longer explanatory cell could wrap differently; preview remains outstanding. “Normally” accounts for redirected Windows profile folders, and the copyable %APPDATA% path remains primary.

Turning it off: Revert the documentation commit.

Compatibility: No game, launcher, save-format or storage behavior changes.

Issues

Related: #760. This clarifies current behavior; it does not implement or close that feature request.

Checklist

Everyone

  • Changes are limited to the reported save-location wording.
  • Paths checked against current source and released launcher documentation.
  • No private paths, saves or game data included.
  • Website build/checks and rendered preview completed; outstanding for review.

When it applies

  • Docs updated.
  • AI assistance recorded in the commit.

Marked ready for review at the author's request; outstanding checks above are not claimed complete.

**Type:** docs · **Risk:** low · **Tested on:** source comparison only · **Needs:** website preview/checks during review ## Why A player found their saves in AppData\Roaming but could not connect that folder to the website's “Where Longshot keeps them” table. The existing `%APPDATA%\Longshot\save\` path is correct for the installed nightly launcher; its Windows expansion was unexplained. The direct-launch row also omitted the `--user` exception. ## What changed Only `docs/saves.md`, the maintained source of `/saves/transfer/`: - Spell out the normal Roaming path beside `%APPDATA%`. - Add a File Explorer address-bar instruction and distinguish Roaming saves from Local backups. - Qualify the direct-launch row with “without `--user`”. The existing table, page sections, portable/older-version guidance and screenshots remain in place. ## Measurements **Verdict:** Documentation wording only; no runtime or performance change to measure. ### Flags and settings None. `--user` is an existing argument, not a changed default. ## Testing **Tested:** - Compared the live page with Longshot main `c9e3e542` and released game `nightly-376-a413bf1c`: `host/hos_main.c` accepts `--user` and otherwise retains the Windows build-local folder. - Checked Launcher `nightly-100-5f30eea3`: [SaveEnvironment](https://git.magicbean.dev/MagicBeanDev/LongshotLauncher/src/tag/nightly-100-5f30eea3/Core/Saves.cs) uses `%APPDATA%\Longshot`, with `%USERPROFILE%\AppData\Roaming` as the fallback. [Launcher save documentation](https://git.magicbean.dev/MagicBeanDev/LongshotLauncher/src/tag/nightly-100-5f30eea3/docs/saves.md) agrees; portable paths remain separate. - `git diff --check` passed. Only the original documentation source changed; generated website content was not edited. **Not tested:** Website build/checks and rendered screenshots were not run; builds remain paused in this workspace. No game run or save operation performed. **Must be tested:** Linux, any GPU, by hand during review: run the website's documented build/check workflow and inspect `/saves/transfer/#where-longshot-keeps-them` at desktop and mobile widths, expecting the Roaming path to display correctly and the table to remain readable. ## Risks **What could break:** The longer explanatory cell could wrap differently; preview remains outstanding. “Normally” accounts for redirected Windows profile folders, and the copyable `%APPDATA%` path remains primary. **Turning it off:** Revert the documentation commit. **Compatibility:** No game, launcher, save-format or storage behavior changes. ## Issues Related: https://git.magicbean.dev/MagicBeanDev/Longshot/issues/760. This clarifies current behavior; it does not implement or close that feature request. ## Checklist ### Everyone - [x] Changes are limited to the reported save-location wording. - [x] Paths checked against current source and released launcher documentation. - [x] No private paths, saves or game data included. - [ ] Website build/checks and rendered preview completed; outstanding for review. ### When it applies - [x] Docs updated. - [x] AI assistance recorded in the commit. Marked ready for review at the author's request; outstanding checks above are not claimed complete.
docs(saves): clarify Windows Roaming save location
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 8s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 12s
CI / Workflow lint (actionlint) (pull_request) Successful in 13s
Website / Website on Cloudflare (pull_request_target) Has been skipped
Third-party parts / As their notes say (pull_request) Successful in 19s
PR description / Description follows the template (pull_request_target) Failing after 4s
3798d1d7d1
Assisted-by: OpenAI Codex
bibiburl changed title from WIP: docs(saves): clarify Windows Roaming save location to docs(saves): clarify Windows Roaming save location 2026-11-16 23:43:01 +00:00
llun approved these changes 2026-11-16 23:44:01 +00:00
llun merged commit 3afc90417b into main 2026-11-16 23:44:04 +00:00
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!1269
No description provided.