docs(perf): the player guide says the game sends the performance batches, not the launcher #1775
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!1775
Loading…
Reference in a new issue
No description provided.
Delete branch "mooki/Longshot:docs/readme-game-sends-perf"
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?
Summary
Since #1530 the game sends the five-minute performance batches itself, and the performance statistics reference (
docs/dev/reference/profiling.md) says so, but the player guide's "what Longshot connects to" list (docs/user/updates-and-saves.md) still had the launcher send them at its next start. It now says the game sends them in five-minute batches to the team with the GPU, driver, CPU, OS and renderer, but no paths, user name or ID. This is the sentence #1502's last review suggested. The README row this change was opened against moved with the docs revamp (the README is a landing page now), so the title now names the player guide.Testing
Tested: Rebased onto main @
068fb8ebe2(the docs revamp, #1802; this head8be546f776, one commit, docs only). The earlier heade0a69cba3on main @3653c9c57changed one README sentence and the checks that read the README gave the same results as on main there. On this head,test_doc_anchorsandtest_fs_linkspass; the documentation links of the page resolve. The whole suite was not run and nothing was started: a sentence in a Markdown file cannot reach a game or a check that does not read it. Not tested: how the page looks rendered on the website.Still to test:
None
Measurements
Nothing to measure: a documentation sentence.
Risks
Nothing the game or a build reads. A revert is enough; players see the corrected sentence.
Checklist
Ready for review
main; the title is a Conventional Commit.mise run testpasses (any failure that also fails onmainis named): the focused checks named in Tested ran; docs only, the whole suite was not run (the checks that read the page ran)main, or Measurements says why there is nothing to measure.third_party/untouched; nothing GPL-incompatible.When it applies
Assisted-by:/Co-Authored-By:trailers.Ready to merge
main, measured again or a comment says why the numbers still hold.New on this forge; not opened on GitHub.
WIP: docs(perf): the README says the game sends the performance batches, not the launcherto docs(perf): the README says the game sends the performance batches, not the launcher@Beanstalk
Beanstalk test farm · an earlier run: commit
e0a69cb(the newer results are in a comment below)Commit
e0a69cb· tier reviewed · approved by mooki · dashboardWhat will be tested · AI plan (
gpt-6.1-terra)This is a README-only correction, so gameplay cannot verify the changed wording or who sends performance batches. A brief title-screen smoke test compares startup and rendering with main, taking about 10 minutes per tester. A crash, a startup slowdown over 20%, or a substantial screenshot difference fails the plan; the documentation claim itself remains outside the farm's checks.
Done (started 18:52 UTC, last report 19:24 UTC). Comment
@Beanstalkto run it again.NVIDIA GeForce RTX 3050 Ti Laptop GPU, 621.24.0; 2: windows+nvidia+nvidia-proprietary+dgpuNVIDIA GeForce RTX 3070, 621.24.0Measurements · any
Verdict: pass on any (2/1 report): no rule failed and no PR run crashed.
Hardware: 1: windows+nvidia+nvidia-proprietary+dgpu
NVIDIA GeForce RTX 3050 Ti Laptop GPU, 621.24.0AMD Ryzen 7 5800H with Radeon Graphics, 16 GB RAM; 2: windows+nvidia+nvidia-proprietary+dgpuNVIDIA GeForce RTX 3070, 621.24.0AMD Ryzen 5 5600X3D 6-Core Processor, 32 GB RAMScene: title-smoke, from the title screen; each cell's settings and switches as the table names them
Method: the Beanstalk test farm: main and this PR built and run on the same PC in one session, game starts alternating (ABBA); title-smoke: 1 game start a side; each number the median of the runs, then of 2 reports
How to reproduce: the farm's plan above (
@Beanstalkon this PR runs it again)3653c9ce0a69cbFlags and settings
None: the plan varied no setting, switch or build option.
Markdown for the PR description
Rebased onto main
068fb8ebe2(the docs revamp, #1802): head8be546f776.Conflict:
README.md, which is a landing page now. The sentence about who sends the performance batches lives in the player guide,docs/user/updates-and-saves.md, where it still said the launcher sends them; the change is there, and the title now says the player guide.Ran:
test_doc_anchorsandtest_fs_linkspass.e0a69cba348be546f776Beanstalk test farm
Commit
8be546f· tier reviewed · approved by mooki · dashboardWhat will be tested · AI plan (
gpt-6.1-terra)This documentation-only change cannot be verified by a gameplay test. A short title-screen smoke test compares startup time and appearance with main, taking about 10 minutes per tester. A crash, a startup-time increase over 20%, or a substantial screenshot difference fails the plan; it does not check the corrected documentation or telemetry behavior.
Done (started 01:46 UTC, last report 02:44 UTC). Comment
@Beanstalkto run it again.NVIDIA GeForce RTX 3050 Ti Laptop GPU, 621.24.0; 2: windows+nvidia+nvidia-proprietary+dgpuNVIDIA GeForce RTX 3080 Ti, 621.24.0Measurements · any
Verdict: pass on any (2/1 report): no rule failed and no PR run crashed.
Hardware: 1: windows+nvidia+nvidia-proprietary+dgpu
NVIDIA GeForce RTX 3050 Ti Laptop GPU, 621.24.0AMD Ryzen 7 5800H with Radeon Graphics, 16 GB RAM; 2: windows+nvidia+nvidia-proprietary+dgpuNVIDIA GeForce RTX 3080 Ti, 621.24.0AMD Ryzen 9 5900X 12-Core Processor, 64 GB RAMScene: title-smoke, from the title screen; each cell's settings and switches as the table names them
Method: the Beanstalk test farm: main and this PR built and run on the same PC in one session, game starts alternating (ABBA); title-smoke: 1 game start a side; each number the median of the runs, then of 2 reports
How to reproduce: the farm's plan above (
@Beanstalkon this PR runs it again)068fb8e8be546fFlags and settings
None: the plan varied no setting, switch or build option.
Markdown for the PR description
@Beanstalk
docs(perf): the README says the game sends the performance batches, not the launcherto docs(perf): the player guide says the game sends the performance batches, not the launcherView command line instructions
Checkout
From your project repository, check out a new branch and test the changes.