From cd204fb07542ae564d2b7e5be0f5900023d8eebb Mon Sep 17 00:00:00 2001 From: Valiantsin Dzerakh Date: Tue, 3 Nov 2026 10:50:13 +0300 Subject: [PATCH] Issue templates: a Performance template and per-area steps for the logs and files to attach Performance gets its own template: kind of problem, machine, place, overlay numbers, and the steps for a log with the performance trace and flight recorder dumps. Other bug says what to attach per area: trace = audio in totk.ini for the audio underrun lines, an input recording and the save for repeatable bugs, the installer's install log. Every bug template asks for the last version that worked and the mods in use, and takes Copy system info as a multi-line field. Co-Authored-By: Claude Opus 5.5 --- .github/ISSUE_TEMPLATE/1-crash.yml | 28 ++++- .github/ISSUE_TEMPLATE/2-graphics.yml | 25 +++- .github/ISSUE_TEMPLATE/3-bug.yml | 65 ----------- .github/ISSUE_TEMPLATE/3-performance.yml | 108 ++++++++++++++++++ .github/ISSUE_TEMPLATE/4-bug.yml | 94 +++++++++++++++ .../{4-feature.yml => 5-feature.yml} | 0 6 files changed, 247 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/3-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/3-performance.yml create mode 100644 .github/ISSUE_TEMPLATE/4-bug.yml rename .github/ISSUE_TEMPLATE/{4-feature.yml => 5-feature.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/1-crash.yml b/.github/ISSUE_TEMPLATE/1-crash.yml index adb68726..05366944 100644 --- a/.github/ISSUE_TEMPLATE/1-crash.yml +++ b/.github/ISSUE_TEMPLATE/1-crash.yml @@ -23,10 +23,23 @@ body: validations: required: true - type: input + id: last-good + attributes: + label: Last version that worked + description: If an earlier version did not crash at this point, which one. + - type: textarea id: system attributes: - label: GPU, driver and Windows version - description: Copy system info in the menu's Advanced tab puts them on the clipboard. + label: System info + description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. On a Steam Deck, add LCD or OLED. + render: text + validations: + required: true + - type: textarea + id: mods + attributes: + label: Mods and cheats + description: The folders in mods/ with their download links, or "none". Say whether it also crashes without them. validations: required: true - type: dropdown @@ -56,10 +69,19 @@ body: label: What you did before the crash validations: required: true + - type: markdown + attributes: + value: | + ### The log + + - The log of the run that crashed is `logs\totk.log` in the folder of `totk.exe` (F1, Advanced tab, Open log folder). Copy it before you start the game again: the next start renames it to `totk.1.log`, and after five starts it is gone. + - Attach the whole file. Do not cut or edit it: the crash report is at the end, the GPU and driver lines are at the start. + - The log says `device lost` or `VK_ERROR_DEVICE_LOST` and the GPU is an NVIDIA one: set GPU pass marks to On (F1, Advanced tab, Diagnostics), restart the game, make it crash again and attach that log. The `vk: pass marks` lines then name what the GPU was drawing. + - The crash happens at the same point every time: also attach the input recording and the save described in the Other bug template. - type: textarea id: log attributes: label: Log - description: Attach logs\totk.log from the folder of totk.exe. Copy it before you start the game again, because the next start overwrites it. + description: Drag totk.log into this field. validations: required: true diff --git a/.github/ISSUE_TEMPLATE/2-graphics.yml b/.github/ISSUE_TEMPLATE/2-graphics.yml index bf297032..bce2b3f5 100644 --- a/.github/ISSUE_TEMPLATE/2-graphics.yml +++ b/.github/ISSUE_TEMPLATE/2-graphics.yml @@ -23,24 +23,37 @@ body: validations: required: true - type: input + id: last-good + attributes: + label: Last version that worked + description: If an earlier version drew this correctly, which one. + - type: textarea id: system attributes: - label: GPU, driver and Windows version - description: Copy system info in the menu's Advanced tab puts them on the clipboard. + label: System info + description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. It lists the settings you changed too. On a Steam Deck, add LCD or OLED. + render: text + validations: + required: true + - type: textarea + id: mods + attributes: + label: Mods and cheats + description: The folders in mods/ with their download links, or "none". Say whether the glitch also shows without them. Turn off ReShade and other overlays that draw into the game before you report. validations: required: true - type: textarea id: screenshot attributes: label: Screenshot or video - description: Drag the file into this field. Say where in the game it was taken. + description: Drag the file into this field. Say where in the game it was taken. Flicker needs a video. validations: required: true - type: textarea id: details attributes: label: What looks wrong and when - description: Does it show all the time, in one place, or after some time in play? Which settings did you change from the defaults? + description: Does it show all the time, in one place, or after some time in play? Does it go away after a restart, or when you change a setting? validations: required: true - type: dropdown @@ -56,4 +69,6 @@ body: id: log attributes: label: Log - description: Attach logs\totk.log from the folder of totk.exe. + description: Drag logs\totk.log from the folder of totk.exe into this field, from the run that showed the glitch. Copy it before you start the game again. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-bug.yml b/.github/ISSUE_TEMPLATE/3-bug.yml deleted file mode 100644 index 20d7087f..00000000 --- a/.github/ISSUE_TEMPLATE/3-bug.yml +++ /dev/null @@ -1,65 +0,0 @@ -name: Other bug -description: Sound, controls, performance, the settings menu, the installer, or game logic. -labels: [bug] -body: - - type: markdown - attributes: - value: | - Check the pinned issues at the top of the issue list first. - - Do not attach or link game files, keys, firmware or builds. Issues that do are closed. - - type: checkboxes - id: duplicates - attributes: - label: Existing issues - options: - - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this bug. - required: true - - type: dropdown - id: area - attributes: - label: Area - options: - - Audio - - Controls and input - - Performance and stutter - - Settings menu and overlay - - Installer - - Game logic and physics - - Something else - validations: - required: true - - type: input - id: version - attributes: - label: Version - description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". - validations: - required: true - - type: input - id: system - attributes: - label: GPU, driver and Windows version - description: Copy system info in the menu's Advanced tab puts them on the clipboard. - validations: - required: true - - type: dropdown - id: blocker - attributes: - label: Can you keep playing? - options: - - "Yes" - - "No, it stops the game or a quest" - validations: - required: true - - type: textarea - id: steps - attributes: - label: What happened and how to reproduce it - validations: - required: true - - type: textarea - id: log - attributes: - label: Log - description: Attach logs\totk.log from the folder of totk.exe. diff --git a/.github/ISSUE_TEMPLATE/3-performance.yml b/.github/ISSUE_TEMPLATE/3-performance.yml new file mode 100644 index 00000000..bb5d134b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-performance.yml @@ -0,0 +1,108 @@ +name: Performance +description: Low frame rate, freezes, hitches, stutter or long loading. +labels: [performance] +body: + - type: markdown + attributes: + value: | + Check the pinned issues at the top of the issue list first. + + Shaders the setup did not prepare are built the first time they are needed, so a short hitch the first time an area or effect shows is expected. Report it when it happens again in the same place. + + Do not attach or link game files, keys, firmware or builds. Issues that do are closed. + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this problem. + required: true + - type: input + id: version + attributes: + label: Version + description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". + validations: + required: true + - type: input + id: last-good + attributes: + label: Last version that ran better + description: If an earlier version was faster in the same place, which one. + - type: textarea + id: system + attributes: + label: System info + description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. It lists the settings you changed too. On a Steam Deck, add LCD or OLED. + render: text + validations: + required: true + - type: dropdown + id: machine + attributes: + label: Machine + options: + - Desktop PC + - Laptop, on mains power + - Laptop, on battery + - Steam Deck + - Other handheld PC + validations: + required: true + - type: textarea + id: mods + attributes: + label: Mods and cheats + description: The folders in mods/ with their download links, or "none". + validations: + required: true + - type: dropdown + id: kind + attributes: + label: What kind of problem? + options: + - The frame rate is low all the time + - Short freezes or hitches that come back in the same place + - The frame rate is fine, but motion is not smooth + - It gets slower the longer I play + - Loading takes long + validations: + required: true + - type: textarea + id: where + attributes: + label: Where and what you were doing + description: For example "Lookout Landing, walking to the tower", "the Depths below Hyrule Castle", "fighting a Talus in the Sky". How long into the session it started. + validations: + required: true + - type: textarea + id: overlay + attributes: + label: Performance overlay + description: Press F10 twice (or both stick clicks) for the full panel. Stay a minute in the place and write down the frame rate, the mean and the longest frame time, or attach a screenshot of the panel. + validations: + required: true + - type: markdown + attributes: + value: | + ### Recording the log + + 1. In the settings menu (F1), Advanced tab, Diagnostics: turn on Performance log. For freezes and hitches, also turn on Flight recorder. Restart the game: both take effect at the next start. + 2. Play at least three minutes in the place where it happens. The log gets a frame-time summary every 60 s, and a line for every frame over 50 ms that names what the frame waited for. + 3. With the flight recorder on, press F8 right after a hitch. It also saves on its own after every frame longer than the freeze threshold (100 ms), at most once per 10 s. + 4. Close the game with Quit game in the menu or the window's close button. Do not end it from Task Manager: the last summary is written when the game exits. + 5. Copy `logs\totk.log` from the folder of `totk.exe` before you start the game again. + 6. Each flight recorder save is a folder; the log line `flight: dump` names it. Zip the folders and attach them. + 7. Turn both off again afterwards: they cost a little frame time. + - type: textarea + id: log + attributes: + label: Log + description: Drag totk.log into this field. + validations: + required: true + - type: textarea + id: flight + attributes: + label: Flight recorder saves + description: Drag the zipped folders into this field, for freezes and hitches. diff --git a/.github/ISSUE_TEMPLATE/4-bug.yml b/.github/ISSUE_TEMPLATE/4-bug.yml new file mode 100644 index 00000000..fe63bd26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-bug.yml @@ -0,0 +1,94 @@ +name: Other bug +description: Sound, controls, the settings menu, the installer, or game logic. +labels: [bug] +body: + - type: markdown + attributes: + value: | + Check the pinned issues at the top of the issue list first. Crashes, graphics glitches and performance have their own templates. + + Do not attach or link game files, keys, firmware or builds. Issues that do are closed. + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this bug. + required: true + - type: dropdown + id: area + attributes: + label: Area + options: + - Audio + - Controls and input + - Settings menu and overlay + - Installer + - Game logic and physics + - Something else + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". For the installer, the version of TotK-Setup. + validations: + required: true + - type: input + id: last-good + attributes: + label: Last version that worked + description: If an earlier version did this correctly, which one. + - type: textarea + id: system + attributes: + label: System info + description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. On a Steam Deck, add LCD or OLED. For the installer, write your OS and the install disk. + render: text + validations: + required: true + - type: textarea + id: mods + attributes: + label: Mods and cheats + description: The folders in mods/ with their download links, or "none". Say whether it also happens without them. + validations: + required: true + - type: dropdown + id: blocker + attributes: + label: Can you keep playing? + options: + - "Yes" + - "No, it stops the game or a quest" + validations: + required: true + - type: textarea + id: steps + attributes: + label: What happened and how to reproduce it + description: What you expected, what happened instead, and the steps that lead there. + validations: + required: true + - type: markdown + attributes: + value: | + ### What to attach for your area + + Close the game with Quit game in the menu or the window's close button, then copy `logs\totk.log` from the folder of `totk.exe` before you start the game again. + + **Audio.** Open `totk.ini` in the folder of `totk.exe` and add the line `trace = audio`; when the file already has `trace = perf` (Performance log on), change it to `trace = perf,audio`. Start the game, play at least two minutes where the sound goes wrong and close the game. The log then has an `audio:` line every 5 s with the buffer underruns. Name the output device and how it is connected (speakers, headphones, USB, Bluetooth, HDMI), and attach a short video with sound if you can. Remove the line afterwards. + + **Controls and input.** Name the controller and how it is connected (USB, Bluetooth, Steam Input). Does it also happen with keyboard and mouse? + + **Controls, game logic, anything you can trigger again.** Turn on Input recording (F1, Advanced tab, Diagnostics), restart the game, load a save, make the bug happen and close the game. Attach `input-record.txt` from the logs folder and a zip of the save you loaded: the `profile` folder next to `totk.exe`. The recording replays what you did, so we can see the bug on our machine. + + **Installer.** Attach the newest `install-*.log` from `temp\logs` in the folder of `TotK-Setup.exe` (on Linux: `.setup-temp/logs` in the install folder), and the log file the error message names. + - type: textarea + id: log + attributes: + label: Log and other files + description: Drag totk.log and the files your area asks for into this field. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/4-feature.yml b/.github/ISSUE_TEMPLATE/5-feature.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/4-feature.yml rename to .github/ISSUE_TEMPLATE/5-feature.yml