docs(help): a page on reporting slow performance, with the switches that measure it #730
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
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!730
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:docs/performance-report"
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?
Type: docs · Risk: low · Tested on: none (docs only) · Needs: the site preview
Why
When a player says the game is slow or stutters, the team has to explain each time which switches to turn on and what to send back. This adds one page on the site to point them to: a few lines in
longshot_env.txtthat make the game measure itself, how to capture a run, and what to send.What changed
A new player page, Help → Report slow performance (
/help/performance/), made fromdocs/performance-report.md. It lists four switches the env file accepts (HOS_FPS_LOG,HOS_THREAD_TIMES,RX_VK_PASS_TIMING,RX_VK_SLOW_LOG), then gives the steps (stay in the slow spot for 60 to 90 s, then Gameplay → Bug report), what to send, and how to turn them off again.docs/performance-report.md(new);docs/reporting-and-contributing.mdlinks to it.src/content-pages.tspublishes it athelp/performance;astro.config.tsadds it to the Help sidebar.Switches that name a file (
RX_VK_FRAME_LOG,HOS_SAMPLE_ALL) are left out on purpose:longshot_env.txtrefuses them (env_line_allowedinhost/hos_main.c). The log's ownvi:lines already give the fps and the spread of frame times every 5 s.Measurements
Nothing to measure: a docs page.
Flags and settings
None
Testing
Tested: checked against the source that each switch on the page is accepted from
longshot_env.txt(env_line_allowed), and that the defaultvi:lines log the fps and frame-time spread every 5 s (host/nn_vi.c). No checks or site build were run locally: they are left to CI.Not tested: the site build and how the page looks, until CI runs or a maintainer adds the
previewlabel (this is from a fork).Must be tested:
previewlabel): open/help/performance/, expecting it in the Help sidebar under Report a problem, and its links to Discord, the report form and Common problems to open (by hand: open the preview).Risks
What could break: the website build, if the page's links or the new sidebar entry are wrong.
Turning it off: revert the commit.
Compatibility: Nothing changes for players after updating.
Checklist
Everyone
type(scope): description) of the status line's type.main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named). Left to CI: not run locally.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.🤖 Generated with Claude Code
The Must-be-tested item now says what result to expect, and the status line names the preview.
WIP: docs(help): a page on reporting slow performance, with the switches that measure itto docs(help): a page on reporting slow performance, with the switches that measure ittheguyser referenced this pull request2026-11-16 13:51:42 +00:00