Idea: make the slow performance report from the Longshot Launcher, without editing longshot_env.txt by hand #1048

Open
opened 2026-11-16 04:51:46 +00:00 by Victor · 1 comment
Contributor

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:

  1. create longshot_env.txt in the game folder with four lines;
  2. start the game again, stay 60 to 90 seconds where it is slow and make a Bug report;
  3. find the bug report folder and the log, and send them with the settings and the graphics card;
  4. remove the lines again, because measuring costs speed.

Each step is a place where a report gets lost. The page itself warns about longshot_env.txt.txt on 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

  1. Measure slow performance on a version, beside Play. It opens a short wizard and starts nothing yet.

  2. 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:

    • the version is built and whole (GameFolder.IsBuilt);
    • Longshot is not running from that folder (Saves.RunningFrom): the game reads its switches only when it starts, so a game left open would measure nothing;
    • no build or update of that version is under way;
    • the PC still passes the launcher's own requirements check (SystemRequirements.Check);
    • the game folder can be written to, since the Bug report and the log are saved there;
    • the shaders are prepared, if the launcher can tell: a first start after an update prepares them, and that would be measured as stutter.

    A longshot_env.txt already 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.

  3. The confirmation page says exactly what is about to happen, and nothing happens until Start measuring:

    • which four measurements are turned on, in the page's words, for this run only, and that they cost a little speed;
    • that no file in the game folder is changed and nothing is sent;
    • what to do in the game: go where it is slow, stay 60 to 90 seconds doing one thing, then F1 → Gameplay → Bug report, and quit normally;
    • what comes after: the launcher shows what the run left and what to send.
  4. 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.txt is neither made nor changed, and the next Play is a normal one.

  5. 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

  • The launcher sends nothing in this first step. Collecting stays local and apart from sending, as #44 asks. Sending is the second step, below.
  • It is not the opt-in statistics (#206, #983): those count frames on every map to say where and on which hardware the game is slow. This is one detailed run that says why.
  • A game started without the launcher (a Steam Deck Gaming mode tile, the program itself) keeps the page.

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:

  1. The report is made when the game closes: the versions, the system, the graphics card and driver, the settings, what the player wrote (where, and what they did), and the measurements' lines of that run's log.
  2. The home folder is written as ~, as that pull request's build report does. No game file and no save.
  3. Show what is sent shows the report exactly as it goes. Nothing is sent until the player presses Send to the team.
  4. It is posted over https, and See it opens the link the answer gives.

It needs two things this idea can't bring by itself:

  • A route for it in Longshot-api. There is one for failed builds and one for the statistics, none for a report like this. The run's lines can be many and the picture is a file of its own, so how much a report may hold is the service's to set.
  • That pull request's sender and consent texts on main, to build on instead of writing a second sender.

The website's inbox (#251, with LongshotLauncher pull request 42) would carry it as well, as one issue a report.

To decide

  • Where the entry goes and what it is called.
  • Whether the list of switches is the launcher's own or comes with the game folder, so that a newer build can change it without a new launcher.
  • Which way the second step sends: Longshot-api or the website's inbox.

Anything else

  • The page: https://longshot.magicbean.dev/help/performance/ (docs/performance-report.md).
  • I searched the issues and pull requests of Longshot and LongshotLauncher and found nobody proposing this.
  • I can write it in the launcher if the idea is wanted.
### The idea Let a player make the [slow performance report](https://longshot.magicbean.dev/help/performance/) 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: 1. create `longshot_env.txt` in the game folder with four lines; 2. start the game again, stay 60 to 90 seconds where it is slow and make a Bug report; 3. find the bug report folder and the log, and send them with the settings and the graphics card; 4. remove the lines again, because measuring costs speed. Each step is a place where a report gets lost. The page itself warns about `longshot_env.txt.txt` on 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 1. **Measure slow performance** on a version, beside Play. It opens a short wizard and starts nothing yet. 2. **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: - the version is built and whole (`GameFolder.IsBuilt`); - Longshot is not running from that folder (`Saves.RunningFrom`): the game reads its switches only when it starts, so a game left open would measure nothing; - no build or update of that version is under way; - the PC still passes the launcher's own requirements check (`SystemRequirements.Check`); - the game folder can be written to, since the Bug report and the log are saved there; - the shaders are prepared, if the launcher can tell: a first start after an update prepares them, and that would be measured as stutter. A `longshot_env.txt` already 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. 3. **The confirmation page says exactly what is about to happen**, and nothing happens until **Start measuring**: - which four measurements are turned on, in the page's words, for this run only, and that they cost a little speed; - that no file in the game folder is changed and nothing is sent; - what to do in the game: go where it is slow, stay 60 to 90 seconds doing one thing, then F1 → Gameplay → Bug report, and quit normally; - what comes after: the launcher shows what the run left and what to send. 4. **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.txt` is neither made nor changed, and the next Play is a normal one. 5. **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 - **The launcher sends nothing in this first step.** Collecting stays local and apart from sending, as #44 asks. Sending is the second step, below. - **It is not the opt-in statistics** (#206, #983): those count frames on every map to say where and on which hardware the game is slow. This is one detailed run that says why. - **A game started without the launcher** (a Steam Deck Gaming mode tile, the program itself) keeps the page. #### 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](https://git.magicbean.dev/MagicBeanDev/LongshotLauncher/pulls/128): 1. **The report is made when the game closes:** the versions, the system, the graphics card and driver, the settings, what the player wrote (where, and what they did), and the measurements' lines of that run's log. 2. **The home folder is written as `~`**, as that pull request's build report does. No game file and no save. 3. **Show what is sent** shows the report exactly as it goes. Nothing is sent until the player presses **Send to the team**. 4. **It is posted over https**, and **See it** opens the link the answer gives. It needs two things this idea can't bring by itself: - **A route for it in Longshot-api.** There is one for failed builds and one for the statistics, none for a report like this. The run's lines can be many and the picture is a file of its own, so how much a report may hold is the service's to set. - **That pull request's sender and consent texts on main**, to build on instead of writing a second sender. The website's inbox (#251, with [LongshotLauncher pull request 42](https://git.magicbean.dev/MagicBeanDev/LongshotLauncher/pulls/42)) would carry it as well, as one issue a report. #### To decide - Where the entry goes and what it is called. - Whether the list of switches is the launcher's own or comes with the game folder, so that a newer build can change it without a new launcher. - Which way the second step sends: Longshot-api or the website's inbox. ### Anything else - The page: https://longshot.magicbean.dev/help/performance/ (`docs/performance-report.md`). - I searched the issues and pull requests of Longshot and LongshotLauncher and found nobody proposing this. - I can write it in the launcher if the idea is wanted.
Owner

This is currently being worked on with performance reporting from @gab9281

This is currently being worked on with performance reporting from @gab9281
Sign in to join this conversation.
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#1048
No description provided.