Update README.md #114

Merged

HumanBean merged 1 commit from humanbean-patch-1 into main 2026-11-13 04:34:25 +00:00

Conversation 0 Commits 1 Files changed 1 +24 -33

HumanBean commented 2026-11-13 04:34:20 +00:00

Owner

• Copy link
• Copy Markdown

Why

What changed

• :

Flags and settings

Flag	What it does	Default now	Recommendation	Helps on	Doesn't help on	Untested on

Measurements

main: ()
this PR: @
Hardware: <GPU, driver, CPU, RAM, OS>
Scene: <area, time of day; resolution, upscaler, frame generation, frame rate cap>
Method: <duration, number of runs, and where the numbers come from: the FPS counter's Breakdown or Dev level, longshot_log.txt lines, RX_VK_DRAW_STATS, a test>
How to reproduce: <the save or spot, the settings and switches, the commands, so a tester can repeat the run>

	main @	this PR @

<the log lines or test output the numbers come from>

Testing

Tested: <what was run and checked, where and how>

Not tested: <what this PR could affect that nobody has run yet, and why>

Needs other testers:

• : , expecting (<test request, or "request to open">)

Screenshots

Risk and rollback

<what could break, and how to turn it off or revert>

Reviewer notes

Issues

Fixes #

Checklist

For everyone

• One topic.
• The title is a Conventional Commit (type(scope): description).
• Rebased on current main.
• python -I -B tests/run_all.py run and passing (any failure that also fails on main is named above).
• Tested in the game, or what wasn't is named under Testing.
• Testing filled in: what was tested, what wasn't, and what needs other testers (with test requests).
• Measured: main and this PR at named commits, on the same PC, scene and settings, at least 2 interleaved runs each, the median reported.
• No game files, dumps, build output or generated files.
• third_party/ untouched (a new folder with a PROVENANCE.md instead).
• The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

If applicable

• AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
• Flags noted, and the switch reference updated (docs/development.md, the README).
• Screenshots for a change that shows on screen.
• A row in docs/tested-configurations.md for each measured run.
• MKWVK_API_VERSION bumped (gpu/vk/vk_api.h's MkwVkHost or MkwVkRenderer changed).
• The SPIR-V headers regenerated with glslang (a shader changed).
• A game-free test added for the fix, failing on main and passing here.
• A check under tests/ that reads changed source updated in this PR, not weakened.
• Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths.
• Docs updated.

<!-- Open as work in progress (a "WIP: " title; forge.py pr create does it) and mark it ready (forge.py pr ready) once every section and every For everyone box is done. Keep this description current, and post a comment for each new commit, measurement or test run: CONTRIBUTING.md, "Commits and pull requests". --> ## Why <!-- The problem or goal a player would notice, not the implementation, in one or two sentences. E.g. "The menu's text is cut off at 4K." --> <why this PR is needed> ## What changed <!-- Bullets by area, naming the files and functions a reviewer should read. E.g. "- menu: `menu_font_scale()` in `gpu/vk/vk_menu.cpp` scales the font with the output". --> - <area>: <what changed> ## Flags and settings <!-- A note for reviewers and testers: what this PR adds or changes (an environment variable such as RX_VK_*, HOS_* or LONGSHOT_*, a menu row or option, an ini key, a build or command-line flag) and what you recommend: on by default / off by default / on after more testing, with a short reason. "None" when there is none. Document each one: docs/development.md, "Switches for testing and debugging" and "The options file"; the README's option table for a menu row. --> | Flag | What it does | Default now | Recommendation | Helps on | Doesn't help on | Untested on | |---|---|---|---|---|---|---| | <flag> | | | | | | | ## Measurements <!-- What counts for each kind of change, and what makes the two sides comparable: CONTRIBUTING.md, "Measurements". Name the columns "main @ <hash>" and "this PR @ <hash>", never a bare Before and After. Comparing something else (a flag off and on, a nightly)? Name each column exactly ("this PR @ <hash>, RX_VK_X=0"), add a line "Baseline: <its column>" and one on why main wasn't the comparison. A Δ column is optional: the change against the baseline. Rebased onto a newer main: measure again, or say why the numbers still hold. --> main: <commit> (<date>) this PR: <branch> @ <commit> Hardware: <GPU, driver, CPU, RAM, OS> Scene: <area, time of day; resolution, upscaler, frame generation, frame rate cap> Method: <duration, number of runs, and where the numbers come from: the FPS counter's Breakdown or Dev level, longshot_log.txt lines, RX_VK_DRAW_STATS, a test> How to reproduce: <the save or spot, the settings and switches, the commands, so a tester can repeat the run> | | main @ <commit> | this PR @ <commit> | |---|---|---| | <what was measured> | | | ``` <the log lines or test output the numbers come from> ``` ## Testing <!-- Tested: what you ran and checked, where (hardware, OS, driver) and how (the game-free checks; in the game, the area and steps; a test request's result), including what you checked but didn't measure. Not tested: what this PR could affect that nobody has run yet, and why. Needs other testers: one line per thing you can't test yourself (hardware, OS, driver, a handheld), with what to check, the result expected and its test request (scripts/test_requests.py request, docs/test-requests.md), or "request to open" while it is WIP; "None" if you covered everything. E.g. "- Steam Deck: Kokiri Forest loads without the hang, expecting no gfx timeout (T-7KQ2)". --> **Tested:** <what was run and checked, where and how> **Not tested:** <what this PR could affect that nobody has run yet, and why> **Needs other testers:** - <hardware or system>: <what to check>, expecting <the result> (<test request, or "request to open">) ## Screenshots <!-- If it shows on screen: the same spot on both, captioned "main @ <hash>" and "this PR @ <hash>". Otherwise: "Nothing on screen". --> ## Risk and rollback <!-- What could break, and where; how to turn it off (a flag), or that reverting the commit is enough. E.g. "Draws could go missing on AMD's RADV; RX_VK_X=0 turns it off." --> <what could break, and how to turn it off or revert> ## Reviewer notes <!-- Where to look first, and what is left for a follow-up on purpose. Optional. --> ## Issues <!-- Fixes #123 closes the issue when this merges (one line per issue); See #123 links it and keeps it open. --> Fixes # ## Checklist <!-- Keep the whole For everyone list, ticked. From If applicable, keep only the boxes that apply to this PR, and tick them; delete the rest. --> ### For everyone - [ ] One topic. - [ ] The title is a Conventional Commit (`type(scope): description`). - [ ] Rebased on current `main`. - [ ] `python -I -B tests/run_all.py` run and passing (any failure that also fails on `main` is named above). - [ ] Tested in the game, or what wasn't is named under Testing. - [ ] Testing filled in: what was tested, what wasn't, and what needs other testers (with test requests). - [ ] Measured: main and this PR at named commits, on the same PC, scene and settings, at least 2 interleaved runs each, the median reported. - [ ] No game files, dumps, build output or generated files. - [ ] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [ ] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### If applicable <!-- Keep only the boxes that apply to this PR, and tick them; delete the rest. Keep the whole For everyone list. --> - [ ] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [ ] Flags noted, and the switch reference updated (docs/development.md, the README). - [ ] Screenshots for a change that shows on screen. - [ ] A row in `docs/tested-configurations.md` for each measured run. - [ ] `MKWVK_API_VERSION` bumped (`gpu/vk/vk_api.h`'s `MkwVkHost` or `MkwVkRenderer` changed). - [ ] The SPIR-V headers regenerated with glslang (a shader changed). - [ ] A game-free test added for the fix, failing on `main` and passing here. - [ ] A check under `tests/` that reads changed source updated in this PR, not weakened. - [ ] Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths. - [ ] Docs updated.

HumanBean added 1 commit 2026-11-13 04:34:20 +00:00

Update README.md e5f81c31bf

HumanBean merged commit 769a06f338 into main 2026-11-13 04:34:25 +00:00

HumanBean deleted branch humanbean-patch-1 2026-11-13 04:34:25 +00:00

HumanBean referenced this pull request from a commit 2026-11-13 04:34:27 +00:00

Update README.md (#114)

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

area/accessibility

Barriers for people with disabilities

  

area/audio

Sound and music

  

area/input

Controllers, keyboard, mouse

  

area/install

Installing, updating, building from your game

  

area/menu

In-game menu and settings

  

area/renderer

Vulkan renderer, shaders, effects

  

area/saves

Save files

  

area/upscaling

DLSS, FSR, frame generation

  

good first issue

A good start for a new contributor

  

gpu/amd

AMD GPUs

  

gpu/igpu

Integrated GPUs

  

gpu/intel

Intel GPUs

  

gpu/nvidia

NVIDIA GPUs

  

help wanted

Extra hands or knowledge wanted

  

kind

bug

Something doesn't work as it should

  

kind

chore

Build, CI, dependencies, tidying

  

kind

docs

Documentation

  

kind

feature

A new feature or an improvement

  

kind

performance

Frame rate, frame time, loading, memory

  

kind

question

A question rather than a change

  

needs measurements

Waiting for before/after measurements

  

platform/linux

Linux only

  

platform/steam-deck

Steam Deck

  

platform/windows

Windows only

  

preview

Maintainers: deploy a preview of this PR's website (read its changes first). Removed after the run.

  

priority

critical

Crashes, data loss, or blocks most players

  

priority

high

Important: next in line

  

priority

low

Nice to have

  

status

blocked

Waits on something else first

  

status

confirmed

Reproduced or agreed on

  

status

duplicate

Already reported or proposed

  

status

invalid

Not a problem in this project

  

status

needs-info

Waiting for more information from the reporter

  

status

wontfix

Will not be worked on

  

testing wanted

Wanted: a test on other hardware (posts a test request in #test-requests)

No labels

area/accessibility

area/audio

area/input

area/install

area/menu

area/renderer

area/saves

area/upscaling

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/steam-deck

platform/windows

preview

priority

critical

priority

high

priority

low

status

blocked

status

confirmed

status

duplicate

status

invalid

status

needs-info

status

wontfix

testing wanted

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

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!114

No description provided.