Files
NX2navi/docs/releases/v0.7.2.md
epicmeme546 5a69bdc91f Add a debug menu for testing Ocarina of Time: the game's flags by name, the game's speed, and a memory search, on F9.
With debug_menu = 1 (off by default; the Game tab has the switch) F9 opens a panel on the left edge in the
performance overlay's look, with the game in view beside it. ui/menu.cpp lays it out in the settings menu's place,
so its input and the game's blocked pad are the menu's own. Typed characters now reach the menu for its text fields.

Flags: the game's 11,292 on/off flags are read from its game data manager, and a click changes one through the
game's own function on the game's thread at its pad read (runtime/debug_tools.c dbg_tick), so the game applies it
at its next update as it does its own changes. The game knows a flag by the hash of its name only; the names shown
are found in the player's own event flow files, hashed and matched when the panel first opens (2,250 of them from
915 files in 0.2 s), and none is kept in the code. World: Link's position, and a speed factor from 0.05 to 8 that
multiplies the step the runtime gives the game each frame (measured 0.50 at 0.5x). Memory: a search of the heap
for a value of 1, 2 or 4 bytes or a float (about 2 s), narrowed by equals, changed, unchanged, went up or went
down, with a value to set at a place or to hold there every frame.

Tested through the window's own messages: F9 opened it, a click on a flag set that flag in the game, text typed
into the filter narrowed the list, and F9 closed it; a scripted run set and held a value and put it back.

Teleporting, a free camera and starting cutscenes are not in it: writing Link's position, or every copy of it in
the heap, moved him back within three frames, so they need the game's own warp, scene-change and event functions.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-11 06:19:47 -05:00

73 lines
6.5 KiB
Markdown

Draft notes for the release after 0.7.1. The version number is not decided yet.
## Faster
- **AMD cards: about a fifth more frames in open areas, and more even frame times.** The game asks the video card
which objects are visible, about a hundred questions a frame in Hyrule Field, and waits for a frame to be finished
on the card before it lets the next one start. The answers were fetched one call at a time, on the thread that also
reports "finished", and on AMD's Windows driver each of those calls goes into the kernel: every frame was reported
finished about 4 ms late, with every thread of the game waiting. They are now fetched a few hundred at a time.
Standing in Hyrule Field on an RX 7900 XT (driver 26.10.1, 3440x1440, FSR): 53 fps instead of 45, and the longest
frame of a minute 46 ms instead of 55 (`oq_batch = 0` in `nx2navi.ini` brings the old readback back).
- **No more frames drawn one present late.** The game signals from the CPU when a frame's data is written, and its
render thread submits the frame's commands without waiting for that signal. When the signal came a millisecond or
two after the submit call, in about every other frame in Hyrule Field, the frame was set aside and drawn at its
present, and frames of 23 and 15 ms took turns. The submit call now waits for the signal, 10 ms at most
(`gate_wait_ms`): 54.5 fps instead of 53 in the same place and the longest frame 33 ms instead of 46; with
`vk_recorder = 1`, which AMD cards do not have on by default, 58.6 fps.
## New
- **AMD FSR 4 upscaling** on Radeon RX 6000, RX 7000 and RX 9000 cards (Windows, AMD's driver 26.10.1 or newer):
AMD's machine-learned upscaler, in the menu under Screen, Upscaling, as *AMD FSR 4 Native AA*, *Quality*,
*Balanced*, *Performance* and *Ultra Performance* (`fsr4 = 1` in `nx2navi.ini`). It keeps thin things whole that
FSR 3.1 breaks up or smears when the camera moves: grass and leaves, Navi's wings, the edges of Link's hat. It is
off until you choose it, because it costs more than FSR 3.1: standing in Hyrule Field on an RX 7900 XT at
3440x1440, 47 fps in Quality where FSR 3.1 gives 51, and 41 fps in Native AA; it takes about 220 MB of video
memory. The setup brings AMD's two libraries for it (FSR SDK 2.4, `amd_fidelityfx_loader_vk.dll` and
`amd_fidelityfx_upscaler_vk.dll`), which ask the driver whether the card can run FSR 4: the rows appear only
where it can, and the log names the version (`ffx4:`). It works together with FSR 3.1 frame generation, and you
can switch between FSR 3.1 and FSR 4 while playing.
- **Frame generation from AMD's newer library, to try**: in the menu under Screen, Frame generation, as *AMD FSR 4
library* with its version, a choice of its own after *AMD FSR 3.1* (`fsr4_fg = 1` in `nx2navi.ini`). Choosing it
sets Upscaling to FSR 4 as well, which it needs. The frames are then generated by the library FSR 4 comes with (FSR
SDK 2.4, `amd_fidelityfx_framegeneration_vk.dll`) instead of the FSR 3.1 library. It picks the version for your
card: on a Radeon RX 9000 with Windows 11 that is AMD's machine-learned FSR Frame Generation 4, **which nobody has
tested in this game yet**; on every other card it is version 3.1.6, which on an RX 7900 XT runs at the same frame
rate as before and showed clean frames in a fast camera turn. It is off unless you set it, and when it fails the FSR
3.1 library takes over. Please report how it looks on an RX 9000.
- **A debug menu for testing** (off by default: Game tab, *Debug menu (F9)*, or `debug_menu = 1` in `nx2navi.ini`). F9
opens a panel on the left edge, in the performance overlay's look, with the game in view beside it. It has three
tabs. *Flags*: the game's 11,292 on/off flags with a search box, about 2,250 of them by name (the names are found in
your own game's event files; the rest show their hash), each switched with a click through the game's own function,
with the last changes listed to put back. *World*: Link's position and the game's speed, from 0.05x to 8x. *Memory*:
a search of the game's memory for a number (1, 2 or 4 bytes, or a float), narrowed down by equals, changed,
unchanged, went up or went down, with a value to set at a place or to hold there. Teleporting, a free camera and
starting cutscenes are not in it yet: they need the game's own scene-change, warp and event functions. Changing
flags or memory can break a save, so keep a copy first.
- **Add to Steam** in Customize Launcher (Windows): adds the game to your Steam library as *The Legend of Zelda
Ocarina of Time*, with Navi as its icon and the title screen's artwork and logo. Starting it from Steam starts the
game. Steam restarts once while it is added.
- **Custom color scheme** in Customize Launcher: pick your own background, panel and button colors on a color
square with a hue bar, or type a hex code.
## Fixed
- A crash with frame generation (AMD FSR 3.1) set: switching Upscaling to a choice without FSR or DLSS and back, which
the Upscaling row does on its way through its choices, ended the game in AMD's driver. Frame generation was handed
the depth picture of the last frame before the switch, which the game had replaced by then.
- Frame generation never generates a frame from a picture with the HUD in it any more: a frame for which the picture
without the HUD is missing is shown as it is, so the HUD cannot be warped along with the scene behind it. On screen
the item button stayed pixel for pixel in place through a fast camera turn, with both frame generation libraries.
- Your own background picture in the launcher is no longer partly hidden under the top bar: it now starts right
below it, and keeps its shape.
- Black and white blocks on AMD RX 5000 and RX 6000 cards: on Navi and on Link next to her, on bright floors near her,
and on the bright outdoors seen through a door or window from inside a house. Every float colour a shader writes is
checked for NaN, so that one bad pixel cannot spread through the blur and bloom passes; those checks, and the
game's own NaN tests in nearly nine of ten shaders, are float comparisons that a shader compiler may decide can
never be true. The Windows driver for these cards uses AMD's older shader compiler (the log reads "AMD proprietary
shader compiler"); with it each NaN test is now made on the bits of the number instead, which no compiler can drop.
It is on by default only with that driver (`vk_nan_bits`); the first start after the update compiles the pipelines
again. Untested on those cards before this release: please report whether the blocks are gone.