WIP: docs(website): add an experimental multiplayer guide #962

Draft
bibiburl wants to merge 4 commits from bibiburl/Longshot:docs/multiplayer-guide into main
Member

Type: docs · Risk: medium · Tested on: Linux, Chromium (website only) · Needs: #68 merged, final build/UI and publication checks

Why

Players currently have to piece together the co-op discussion, technical reference and tester guide to start a session. They need a clear route through temporary saves, room setup and consent before trying the experimental features. See #463, #355 and #68.

Keep this PR WIP until #68 is merged and the publication checks below are complete. Merging this PR publishes the Multiplayer section and header link automatically through website.yml; there is no separate deployment approval afterwards. The header link is retained for that publication point. Multiplayer is experimental, off by default and targeting 3.1.0 through #68; a target is not a release promise.

Mooki reviewed every page and confirmed the consent, save-safety and networking distinctions. The requested settings-file and link corrections are applied in c525656d. This was a comment review, not an approval.

What changed

Added a Multiplayer section to the main navigation and documentation sidebar, with five player-facing guides:

  1. Overview — availability, eight-player room capacity versus the two-player testing recorded so far, and a first-session route.
  2. Protect your save — create and verify a temporary copy, return without importing progress, and what happens after a crash or manual restart.
  3. Make or join a room — relay address, private room secret, room rules, fingerprints and acceptance.
  4. Playing together — friend information, chat, Go to friend and the separately confirmed sword-practice kit.
  5. Connections & help — hosting from a game or the small relay script, optional direct connections, troubleshooting and reporting.

Temporary-copy acceptance is see and talk only: it does not authorize progress sharing, pools, transfers or Go to friend. Normal-save sharing can persist changes; a backup is not temporary-session isolation. These distinctions stay explicit throughout the guide.

The canonical pages live in docs/multiplayer/, registered through website/src/content-pages.ts. The unpublished docs/multiplayer/README.md records pinned sources and the remaining content checks. Website workflow path filters include this directory so later documentation-only changes build the site. Settings-file guidance links the README’s Where the files go, covering OS and launcher differences; player-facing playtest/build/reporting links point to #68. The backup and relay references are pinned to the reviewed commit until #68 is merged. Relay setup requires a matching checkout containing multiplayer support, without assuming every release has it.

Sources: plan #463, behaviour, networking, technical reference at 25746346, historical playtest #355, base #68, and the draft tester guide, revision 03ca1a12.

Menu positions, exact build-mismatch messages, invite codes, UPnP, shared time, shared enemies and an official relay are not documented as settled features. In-game pictures will follow once the layout is stable and the agreed build can be captioned accurately. The screenshots below show the website itself.

Measurements

Nothing to measure in the game: documentation, website navigation and guide styling only. No gameplay or networking performance claim.

Flags and settings

None. Existing playtest settings are explained; this PR changes no game default or runtime switch.

Testing

Tested:

  • Current head 23144a3a has an identical tracked source tree to the tested c525656d (git diff c525656d HEAD is empty). The checks and guide screenshots below are from that identical source tree.
  • npm run build: passed at c525656d; the previously tested baseline is main @ a8a30c22, with 23 pages versus 18.
  • Built-site audit: 23 pages and 1,383 local links/assets, including anchors and source edit links, pass.
  • npm run check: run on c525656d; the site audit passes; website tests are 101 passed / 1 failed on both revisions. The existing failure is graphics-settings.test.ts: “HDR Native condition accepts current prose but remains required”.
  • python -I -B tests/run_all.py: rerun on c525656d, 551 passed / 18 failed / 76 skipped, matching the previously tested baseline a8a30c22; identical failing test files, no branch-only failures (listed below).
  • Initial-draft guide image integrity passes (no guide image assets changed in this follow-up). --review-sources reports the same 19 existing Graphics source-review mismatches on both revisions; Launcher source review was not performed. Review hashes were not reset.
  • Rendered all five new pages at 1440, 390 and 320 px without horizontal page overflow; also checked the overview/header at 1280, 1130, 1120 and 768 px. Inspected desktop/phone layouts and light/dark themes.
  • Search for “temporary save” finds the new pages and follows the save-guide result. Mobile navigation reaches the new section. Tab/Enter follows the overview cards with a visible focus outline.
  • Initial-draft axe-core check: zero reported violations on the overview in light and dark, and on the save guide. This is an automated check, not a complete accessibility certification.
  • git diff --check: passes. No additional test run was needed for the exact restoration of the tested source tree.
Existing game-free failures on both main and this PR
  • tests/test_appimage_player_build.py
  • tests/test_bake_portability.py
  • tests/test_crash_dialog.py
  • tests/test_crt_options.py
  • tests/test_env_on.py
  • tests/test_lift_cleanup_error.py
  • tests/test_linux_preflight.py
  • tests/test_linux_update.py
  • tests/test_make_game_cache.py
  • tests/test_missing_nup.py
  • tests/test_mods_size_table.py
  • tests/test_options_budget_once.py
  • tests/test_pipeline_tour.py
  • tests/test_readback_late.py
  • tests/test_run_all_changed.py
  • tests/test_vk_occlusion_queries.py
  • tests/test_vk_pgo.py
  • tests/test_walk_key.py

Not tested: no game was built or launched, and no multiplayer, save recovery, relay or direct connection was exercised in this task. Behaviour is documented from the linked sources. No live deployment or hosted PR preview has been requested.

Must be tested:

  • By hand, documentation owner before ready/merge: confirm #68 is merged, rebase onto the current main and check its actual playtest/release availability, expecting every public build link and availability statement to match what players can obtain. Then verify and switch the two pinned technical references to main’s docs/coop.md. A merge into main alone does not prove a Release or Nightly is available.

  • By hand, co-op author on the agreed Linux/Windows candidate builds: walk through copy → room → acceptance → return, checking the action labels, normal-save/copy distinction, Friend information and host setup against these pages. Expect the documented restrictions and recovery behaviour; correct the prose before marking this PR ready.

  • By hand, documentation owner before publication: confirm the available playtest/release entry point, then add version-captioned UI pictures with secrets hidden when the layout settles, expecting the linked build and its controls to match the guide. Keep future features and an official relay unpromised until confirmed.

Risks

What could break: experimental behaviour and menu wording can outpace the guide; incorrect save instructions would matter to players. The draft is explicitly marked experimental, starts with temporary copies, and records its source revisions for review. The extra navigation entry also needs to remain usable at narrow widths.

Turning it off: revert this documentation commit.

Compatibility: no changes to saves, options, caches, renderer ABI, game builds or launcher behaviour.

Issues

See #463 — plan and availability.

See #355 — playtest and behaviour evidence.

See #68 — multiplayer integration target; this documentation PR does not implement or close it.

Screenshots

Local builds: Before: main @ a8a30c22; After: this PR @ c525656d for the overview and connection-guide captures. Current head 23144a3a restores that identical source tree. Desktop viewport 1440 × 1000; phone viewport 390 × 844. Full-page captures show the current wording. The unchanged navigation comparisons and mobile-menu capture retain their original d23583a7 captions.

After: this PR @ c525656d — Multiplayer overview, light, 1440 px, full page

After: this PR @ c525656d — Multiplayer overview, dark, 1440 px, full page

Phone: light, dark and the new navigation section

After: this PR @ c525656d — Multiplayer overview, light, 390 px, full page

After: this PR @ c525656d — Multiplayer overview, dark, 390 px, full page

After: this PR @ d23583a7 — Multiplayer navigation, light, 390 × 844

Navigation comparison on Install: same viewport and page, both themes

The local Astro preview does not serve the download Worker endpoint, so both Install captures show the existing version-metadata fallback. This PR does not change that feature.

Before: main @ a8a30c22 — Install navigation, light, 1440 × 1000

After: this PR @ d23583a7 — Install navigation, light, 1440 × 1000

Before: main @ a8a30c22 — Install navigation, dark, 1440 × 1000

After: this PR @ d23583a7 — Install navigation, dark, 1440 × 1000

Connections & help: hosting and reporting

After: this PR @ c525656d — Connections & help, 1440 px, light, full page

After: this PR @ c525656d — Connections & help, 1440 px, dark, full page

After: this PR @ c525656d — Connections & help, 390 px, light, full page

After: this PR @ c525656d — Connections & help, 390 px, dark, full page

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main: the tested base remains a8a30c22; refresh after #68 merges, before marking ready.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
  • Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen.
  • Docs updated.
**Type:** docs · **Risk:** medium · **Tested on:** Linux, Chromium (website only) · **Needs:** #68 merged, final build/UI and publication checks ## Why Players currently have to piece together the co-op discussion, technical reference and tester guide to start a session. They need a clear route through temporary saves, room setup and consent before trying the experimental features. See #463, #355 and #68. **Keep this PR WIP until #68 is merged and the publication checks below are complete. Merging this PR publishes the Multiplayer section and header link automatically through `website.yml`; there is no separate deployment approval afterwards.** The header link is retained for that publication point. Multiplayer is experimental, off by default and targeting 3.1.0 through #68; a target is not a release promise. [Mooki reviewed every page](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/962#issuecomment-30826) and confirmed the consent, save-safety and networking distinctions. The requested settings-file and link corrections are applied in `c525656d`. This was a comment review, not an approval. ## What changed Added a **Multiplayer** section to the main navigation and documentation sidebar, with five player-facing guides: 1. **Overview** — availability, eight-player room capacity versus the two-player testing recorded so far, and a first-session route. 2. **Protect your save** — create and verify a temporary copy, return without importing progress, and what happens after a crash or manual restart. 3. **Make or join a room** — relay address, private room secret, room rules, fingerprints and acceptance. 4. **Playing together** — friend information, chat, Go to friend and the separately confirmed sword-practice kit. 5. **Connections & help** — hosting from a game or the small relay script, optional direct connections, troubleshooting and reporting. Temporary-copy acceptance is **see and talk only**: it does not authorize progress sharing, pools, transfers or Go to friend. Normal-save sharing can persist changes; a backup is not temporary-session isolation. These distinctions stay explicit throughout the guide. The canonical pages live in `docs/multiplayer/`, registered through `website/src/content-pages.ts`. The unpublished `docs/multiplayer/README.md` records pinned sources and the remaining content checks. Website workflow path filters include this directory so later documentation-only changes build the site. Settings-file guidance links the README’s **Where the files go**, covering OS and launcher differences; player-facing playtest/build/reporting links point to #68. The backup and relay references are pinned to the reviewed commit until #68 is merged. Relay setup requires a matching checkout containing multiplayer support, without assuming every release has it. Sources: [plan #463](https://git.magicbean.dev/MagicBeanDev/Longshot/issues/463), [behaviour](https://git.magicbean.dev/MagicBeanDev/Longshot/issues/463#issuecomment-21261), [networking](https://git.magicbean.dev/MagicBeanDev/Longshot/issues/463#issuecomment-21264), [technical reference at 25746346](https://git.magicbean.dev/mooki/Longshot/src/commit/2574634645ea0d7380171dd53c7ca6e410a9f7d8/docs/coop.md), [historical playtest #355](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/355), [base #68](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/68), and the [draft tester guide, revision 03ca1a12](https://gist.github.com/mooki000/b2563cd3445cc78542c1f4f9bc05cd8e/03ca1a12333a832fdb5254364b7127c94da33814). Menu positions, exact build-mismatch messages, invite codes, UPnP, shared time, shared enemies and an official relay are not documented as settled features. In-game pictures will follow once the layout is stable and the agreed build can be captioned accurately. The screenshots below show the website itself. ## Measurements Nothing to measure in the game: documentation, website navigation and guide styling only. No gameplay or networking performance claim. ### Flags and settings None. Existing playtest settings are explained; this PR changes no game default or runtime switch. ## Testing **Tested:** - Current head `23144a3a` has an identical tracked source tree to the tested `c525656d` (`git diff c525656d HEAD` is empty). The checks and guide screenshots below are from that identical source tree. - `npm run build`: passed at `c525656d`; the previously tested baseline is `main @ a8a30c22`, with 23 pages versus 18. - Built-site audit: **23 pages and 1,383 local links/assets**, including anchors and source edit links, pass. - `npm run check`: run on `c525656d`; the site audit passes; website tests are **101 passed / 1 failed** on both revisions. The existing failure is `graphics-settings.test.ts`: “HDR Native condition accepts current prose but remains required”. - `python -I -B tests/run_all.py`: rerun on `c525656d`, **551 passed / 18 failed / 76 skipped**, matching the previously tested baseline `a8a30c22`; identical failing test files, no branch-only failures (listed below). - Initial-draft guide image integrity passes (no guide image assets changed in this follow-up). `--review-sources` reports the same **19 existing Graphics source-review mismatches** on both revisions; Launcher source review was not performed. Review hashes were not reset. - Rendered all five new pages at 1440, 390 and 320 px without horizontal page overflow; also checked the overview/header at 1280, 1130, 1120 and 768 px. Inspected desktop/phone layouts and light/dark themes. - Search for “temporary save” finds the new pages and follows the save-guide result. Mobile navigation reaches the new section. Tab/Enter follows the overview cards with a visible focus outline. - Initial-draft axe-core check: zero reported violations on the overview in light and dark, and on the save guide. This is an automated check, not a complete accessibility certification. - `git diff --check`: passes. No additional test run was needed for the exact restoration of the tested source tree. <details> <summary>Existing game-free failures on both main and this PR</summary> - `tests/test_appimage_player_build.py` - `tests/test_bake_portability.py` - `tests/test_crash_dialog.py` - `tests/test_crt_options.py` - `tests/test_env_on.py` - `tests/test_lift_cleanup_error.py` - `tests/test_linux_preflight.py` - `tests/test_linux_update.py` - `tests/test_make_game_cache.py` - `tests/test_missing_nup.py` - `tests/test_mods_size_table.py` - `tests/test_options_budget_once.py` - `tests/test_pipeline_tour.py` - `tests/test_readback_late.py` - `tests/test_run_all_changed.py` - `tests/test_vk_occlusion_queries.py` - `tests/test_vk_pgo.py` - `tests/test_walk_key.py` </details> **Not tested:** no game was built or launched, and no multiplayer, save recovery, relay or direct connection was exercised in this task. Behaviour is documented from the linked sources. No live deployment or hosted PR preview has been requested. **Must be tested:** - By hand, documentation owner before ready/merge: confirm #68 is merged, rebase onto the current main and check its actual playtest/release availability, expecting every public build link and availability statement to match what players can obtain. Then verify and switch the two pinned technical references to main’s `docs/coop.md`. A merge into main alone does not prove a Release or Nightly is available. - By hand, co-op author on the agreed Linux/Windows candidate builds: walk through copy → room → acceptance → return, checking the action labels, normal-save/copy distinction, Friend information and host setup against these pages. Expect the documented restrictions and recovery behaviour; correct the prose before marking this PR ready. - By hand, documentation owner before publication: confirm the available playtest/release entry point, then add version-captioned UI pictures with secrets hidden when the layout settles, expecting the linked build and its controls to match the guide. Keep future features and an official relay unpromised until confirmed. ## Risks **What could break:** experimental behaviour and menu wording can outpace the guide; incorrect save instructions would matter to players. The draft is explicitly marked experimental, starts with temporary copies, and records its source revisions for review. The extra navigation entry also needs to remain usable at narrow widths. **Turning it off:** revert this documentation commit. **Compatibility:** no changes to saves, options, caches, renderer ABI, game builds or launcher behaviour. ## Issues See #463 — plan and availability. See #355 — playtest and behaviour evidence. See #68 — multiplayer integration target; this documentation PR does not implement or close it. ## Screenshots Local builds: **Before: main @ a8a30c22**; **After: this PR @ c525656d** for the overview and connection-guide captures. Current head `23144a3a` restores that identical source tree. Desktop viewport 1440 × 1000; phone viewport 390 × 844. Full-page captures show the current wording. The unchanged navigation comparisons and mobile-menu capture retain their original `d23583a7` captions. ![After: this PR @ c525656d — Multiplayer overview, light, 1440 px, full page](https://git.magicbean.dev/attachments/69a48895-ea12-488f-a658-eaa495fb86b4) ![After: this PR @ c525656d — Multiplayer overview, dark, 1440 px, full page](https://git.magicbean.dev/attachments/e4feff1e-ba37-4353-9fb4-59bdd958baa9) <details> <summary>Phone: light, dark and the new navigation section</summary> ![After: this PR @ c525656d — Multiplayer overview, light, 390 px, full page](https://git.magicbean.dev/attachments/9ea96182-1225-4d45-a9a5-b3e268b3c1da) ![After: this PR @ c525656d — Multiplayer overview, dark, 390 px, full page](https://git.magicbean.dev/attachments/9aba0e88-d070-4746-86fe-0d3c4f15218b) ![After: this PR @ d23583a7 — Multiplayer navigation, light, 390 × 844](https://git.magicbean.dev/attachments/82a99901-b6b3-42b0-94f0-5c56333d3826) </details> <details> <summary>Navigation comparison on Install: same viewport and page, both themes</summary> The local Astro preview does not serve the download Worker endpoint, so both Install captures show the existing version-metadata fallback. This PR does not change that feature. ![Before: main @ a8a30c22 — Install navigation, light, 1440 × 1000](https://git.magicbean.dev/attachments/bb277b59-4e06-43d8-b776-d8077bf176b0) ![After: this PR @ d23583a7 — Install navigation, light, 1440 × 1000](https://git.magicbean.dev/attachments/fafdf7d9-2acc-4990-a2c7-ea0e155ecd15) ![Before: main @ a8a30c22 — Install navigation, dark, 1440 × 1000](https://git.magicbean.dev/attachments/c8e6bb8e-f5b0-445c-81af-531db3fb5fac) ![After: this PR @ d23583a7 — Install navigation, dark, 1440 × 1000](https://git.magicbean.dev/attachments/a507d266-4230-4404-a04e-6c8ff1583a94) </details> <details> <summary>Connections & help: hosting and reporting</summary> ![After: this PR @ c525656d — Connections & help, 1440 px, light, full page](https://git.magicbean.dev/attachments/64152910-0680-4294-acc6-da59f33f6d2c) ![After: this PR @ c525656d — Connections & help, 1440 px, dark, full page](https://git.magicbean.dev/attachments/9bba2fef-d0c4-4a13-83b9-a16af01900d3) ![After: this PR @ c525656d — Connections & help, 390 px, light, full page](https://git.magicbean.dev/attachments/dcbd4dc3-80b8-4f56-a22d-b0734ebfeeda) ![After: this PR @ c525656d — Connections & help, 390 px, dark, full page](https://git.magicbean.dev/attachments/662d5c5c-0e0f-46df-8ee5-8dbe85b80135) </details> ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [ ] Rebased on current `main`: the tested base remains `a8a30c22`; refresh after #68 merges, before marking ready. - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. - [x] Docs updated.
docs(website): add an experimental multiplayer guide
Some checks failed
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 5s
Third-party parts / As their notes say (pull_request) Successful in 8s
Website / Website on Cloudflare (pull_request_target) Has been skipped
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
CI / Conventional Commit title (pull_request) Successful in 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 5s
PR description / Description follows the template (pull_request_target) Successful in 4s
d23583a7c0
Assisted-by: Codex (OpenAI)
Author
Member

Added the built-site screenshots to the main description: full-page Multiplayer overview in light and dark, 390 px phone views, and matching before/after navigation captures. The final draft is d23583a7 on main a8a30c22. Builds and link checks pass; existing website and game-free failures are named with matching baseline results. Keeping this PR WIP as requested, pending co-op content confirmation.

Added the built-site screenshots to the main description: full-page Multiplayer overview in light and dark, 390 px phone views, and matching before/after navigation captures. The final draft is d23583a7 on main a8a30c22. Builds and link checks pass; existing website and game-free failures are named with matching baseline results. Keeping this PR WIP as requested, pending co-op content confirmation.
mooki left a comment

Thanks, this is a really good first pass. I checked every page against the co-op technical reference on the current co-op line and against main. Almost all of it is right, including the parts that are easy to blur: see-and-talk on a copy versus progress on a normal save, a backup not being isolation, direct connections still needing a relay, and acceptance repeating when rules change.

To fix

  1. Where longshot_options.ini is (connections.md, "Host from your game"). "In the game folder" is only right on Linux and for a game started by itself. On Windows, when the launcher starts the game, the file is in %APPDATA%\Longshot (a portable launcher's in LongshotLauncher-data\user), since #729. Rather than naming a folder, I'd link the README's "Where the files go": https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/README.md#where-the-files-go. The draft tester guide had the same mistake; I'm fixing it there too.
  2. 355 becomes 68. Co-op now lands as one pull request, and #355 will be closed into #68 in the next few days. The "agreed build" and "playtest instructions" links, and "post an agreed playtest result on the playtest PR" in connections.md, should all point to 68.
  3. Links to the technical reference. saves.md (backup recovery) and connections.md (relay reference) link docs/coop.md on the branch coop-playtest-r9, which stops moving when 355 closes. Pin them to a commit, as your README already does, until 68 is merged, then use main's docs/coop.md.

Before this leaves WIP

  1. Merging publishes it. website.yml deploys on every push to main, so merging puts a Multiplayer section and a header link live while co-op is in no release or Nightly yet. I'd merge after 68 is on main, or keep the sidebar section and leave the header link out until then.
  2. connections.md's "do not assume it is in a normal release checkout" (the relay script) stops being true once 68 is merged: a one-line change then.

Checked and correct, so you don't have to re-check them: Friend information starts at 0 and 3 shows both ages; Friend labels is the player's own Off, Names, Names and arrows; the copy's button is Accept to see and talk; Temporary save works outside a room only; coop-backup sits beside save and nothing from the room is applied until it is made; Go to friend is normal saves only; the kit flow, including that accepting again is not a refill; what the relay can and cannot see; direct connections off by default, the address warning and the relay fallback; and the two cross-links (../updates-and-saves.md, ../reporting-and-contributing.md) resolve on main.

CI: the red "Guide screenshots" check fails the same way on main (the 19 Graphics mismatches you named), and "not mergeable" is only the WIP: title; a trial merge into current main a8a30c22 is clean.

Coming up that you already mark as not settled: the Direct connections row moves under an Advanced heading, refusals get a next step, the build-mismatch message, invite codes and UPnP. Co-op tab pictures at Small, Medium and Large from a demo room are being made now; I'll send them when the layout settles.

Thanks, this is a really good first pass. I checked every page against the co-op technical reference on the current co-op line and against main. Almost all of it is right, including the parts that are easy to blur: see-and-talk on a copy versus progress on a normal save, a backup not being isolation, direct connections still needing a relay, and acceptance repeating when rules change. **To fix** 1. **Where `longshot_options.ini` is** (connections.md, "Host from your game"). "In the game folder" is only right on Linux and for a game started by itself. On Windows, when the launcher starts the game, the file is in `%APPDATA%\Longshot` (a portable launcher's in `LongshotLauncher-data\user`), since https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/729. Rather than naming a folder, I'd link the README's "Where the files go": https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/README.md#where-the-files-go. The draft tester guide had the same mistake; I'm fixing it there too. 2. **355 becomes 68.** Co-op now lands as one pull request, and https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/355 will be closed into https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/68 in the next few days. The "agreed build" and "playtest instructions" links, and "post an agreed playtest result on the playtest PR" in connections.md, should all point to 68. 3. **Links to the technical reference.** saves.md (backup recovery) and connections.md (relay reference) link `docs/coop.md` on the branch `coop-playtest-r9`, which stops moving when 355 closes. Pin them to a commit, as your README already does, until 68 is merged, then use main's `docs/coop.md`. **Before this leaves WIP** 4. **Merging publishes it.** `website.yml` deploys on every push to main, so merging puts a Multiplayer section and a header link live while co-op is in no release or Nightly yet. I'd merge after 68 is on main, or keep the sidebar section and leave the header link out until then. 5. connections.md's "do not assume it is in a normal release checkout" (the relay script) stops being true once 68 is merged: a one-line change then. **Checked and correct**, so you don't have to re-check them: Friend information starts at 0 and 3 shows both ages; Friend labels is the player's own Off, Names, Names and arrows; the copy's button is Accept to see and talk; Temporary save works outside a room only; `coop-backup` sits beside `save` and nothing from the room is applied until it is made; Go to friend is normal saves only; the kit flow, including that accepting again is not a refill; what the relay can and cannot see; direct connections off by default, the address warning and the relay fallback; and the two cross-links (`../updates-and-saves.md`, `../reporting-and-contributing.md`) resolve on main. **CI:** the red "Guide screenshots" check fails the same way on main (the 19 Graphics mismatches you named), and "not mergeable" is only the `WIP:` title; a trial merge into current main `a8a30c22` is clean. Coming up that you already mark as not settled: the Direct connections row moves under an Advanced heading, refusals get a next step, the build-mismatch message, invite codes and UPnP. Co-op tab pictures at Small, Medium and Large from a demo room are being made now; I'll send them when the layout settles.
docs(website): address multiplayer guide review
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 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 6s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 5s
Third-party parts / As their notes say (pull_request) Successful in 9s
PR description / Description follows the template (pull_request_target) Successful in 3s
c525656de9
Correct settings-file guidance, route playtest links to PR 68, pin technical references, and record the publication prerequisites.

Assisted-by: Codex (OpenAI)
Author
Member

Addressed the review in c525656d: settings-file guidance now links the canonical platform/launcher locations; all player-facing playtest, build and results links point to #68; backup and relay references are commit-pinned. Relay instructions now require a matching checkout containing multiplayer support. The description and maintenance ledger explicitly keep this WIP until #68 merges, with final availability checks and a warning that merging publishes the website. Refreshed overview and connection-guide screenshots are in the main post. Build and link audit pass; website tests remain 101/1 and game-free checks 551/18/76, matching the documented baseline failures.

Addressed the review in c525656d: settings-file guidance now links the canonical platform/launcher locations; all player-facing playtest, build and results links point to #68; backup and relay references are commit-pinned. Relay instructions now require a matching checkout containing multiplayer support. The description and maintenance ledger explicitly keep this WIP until #68 merges, with final availability checks and a warning that merging publishes the website. Refreshed overview and connection-guide screenshots are in the main post. Build and link audit pass; website tests remain 101/1 and game-free checks 551/18/76, matching the documented baseline failures.
docs(website): add nightly multiplayer feedback guidance
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 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 5s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 4s
Third-party parts / As their notes say (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 3s
5c19b93ce6
Assisted-by: Codex (OpenAI)
Author
Member

Added Nightly feedback guidance under Connections & help in 5c19b93c. It asks for both players’ exact build versions, what worked, regressions and connection/save setup, and links to individual bug reports or the multiplayer PR for session summaries. It explicitly asks players to confirm that their agreed Nightly contains multiplayer. The current full-page connection-guide screenshots are in the main description. Build and all 1,387 local links/assets pass; website tests retain the single documented baseline HDR-condition failure. Still WIP until #68 merges and publication checks are complete.

Added Nightly feedback guidance under Connections & help in 5c19b93c. It asks for both players’ exact build versions, what worked, regressions and connection/save setup, and links to individual bug reports or the multiplayer PR for session summaries. It explicitly asks players to confirm that their agreed Nightly contains multiplayer. The current full-page connection-guide screenshots are in the main description. Build and all 1,387 local links/assets pass; website tests retain the single documented baseline HDR-condition failure. Still WIP until #68 merges and publication checks are complete.
docs(website): remove nightly feedback from multiplayer guide
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 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 5s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 5s
Third-party parts / As their notes say (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 4s
23144a3a85
Assisted-by: Codex (OpenAI)
Author
Member

Removed the Nightly feedback addition in 23144a3a as requested. The PR now contains only the multiplayer guide and the corrections from mooki’s review. Restored the matching connection-guide screenshots and removed the feedback section from the main description. The tracked source tree is identical to the previously tested c525656d. Keeping this PR WIP.

Removed the Nightly feedback addition in 23144a3a as requested. The PR now contains only the multiplayer guide and the corrections from mooki’s review. Restored the matching connection-guide screenshots and removed the feedback section from the main description. The tracked source tree is identical to the previously tested c525656d. Keeping this PR WIP.
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 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 5s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 5s
Third-party parts / As their notes say (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 4s
This pull request has changes conflicting with the target branch.
  • .forgejo/workflows/website.yml
View command line instructions

Manual merge helper

Use this merge commit message when completing the merge manually.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'docs/multiplayer-guide:bibiburl-docs/multiplayer-guide'
git switch 'bibiburl-docs/multiplayer-guide'
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!962
No description provided.