Idea: make the slow performance report from the Longshot Launcher, without editing longshot_env.txt by hand #1048
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#1048
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
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?
The idea
Let a player make the slow performance report from the Longshot Launcher: a Measure slow performance entry on a version starts the game with the page's four measurements on for that run only, and when the game closes shows what the run left and what to send.
Today the page (#730) asks the player to do it by hand:
longshot_env.txtin the game folder with four lines;Each step is a place where a report gets lost. The page itself warns about
longshot_env.txt.txton Windows and about replacing a file that already holds a workaround, and the measurements stay on for as long as the lines are forgotten.What the launcher would do
Measure slow performance on a version, beside Play. It opens a short wizard and starts nothing yet.
The checks, before anything starts. Each one shows as passed or not, with the reason and what to do about it, as the launcher's problem pages do. The run can't start while one fails:
GameFolder.IsBuilt);Saves.RunningFrom): the game reads its switches only when it starts, so a game left open would measure nothing;SystemRequirements.Check);A
longshot_env.txtalready in the folder is no failure. The page names the switches it sets, they stay on for the run, and they go in the report. The game takes the environment first, so the four measurements hold even where the file has a line of the same name.The confirmation page says exactly what is about to happen, and nothing happens until Start measuring:
The game starts with the four switches in its environment, for that run only:
HOS_FPS_LOG=1,HOS_THREAD_TIMES=5,RX_VK_PASS_TIMING=1,RX_VK_SLOW_LOG=50. The launcher already makes the game's environment at each start (Core/MakeGameCommand.cs,StartInfo), so no file is written:longshot_env.txtis neither made nor changed, and the next Play is a normal one.When the game closes: the run's bug report folder and
longshot_log.txt, with Open folder and Copy for the report (the version, the settings, the graphics card and driver filled in; where and what the player did left for them to write), and the issue form opened with those fields filled in, as the game's Bug report link does. A run with no Bug report says so and still offers the log.What it leaves out
Sending, as a second step
Once the launcher has a way to send that the team has agreed on, the page shown when the game closes gains Send to the team, as a failed build's page does in LongshotLauncher pull request 128:
~, as that pull request's build report does. No game file and no save.It needs two things this idea can't bring by itself:
The website's inbox (#251, with LongshotLauncher pull request 42) would carry it as well, as one issue a report.
To decide
Anything else
docs/performance-report.md).This is currently being worked on with performance reporting from @gab9281