Docs: credit ported work and cover today's merged changes

Add CREDITS.md, listing the projects the fork is built on and every
change ported from upstream WiiCompiled and other forks, with author and
source commit, taken from the commit messages. Link it from the README,
THIRD-PARTY-NOTICES.md and a new porting note in CONTRIBUTING.md.

Document adaptive_resolution in OPENXR.md, the 4 KiB page constant and
NEON mixing in the README, the Mozilla CA bundle in the notices, and draft
the frame-beta-3 release notes for what PRs #5 to #10 merged.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Axv1Y43Lu5a5rSSLUyU5BB
This commit is contained in:
Claude committed 2026-10-05 16:22:20 +00:00
1 parent 58b6d81ed1
commit 6a3441b616
7 files changed
+205 -7

No files matched your search

+70
View File
@@ -0,0 +1,70 @@
The third beta of WiiCompiled VR for the Steam Frame: Mario Kart Wii, statically recompiled to
native ARM64 code, running in VR on SteamOS through SteamVR. This one brings in fixes from upstream
WiiCompiled and from other WiiCompiled forks, Retro Rewind in the installer, and a diagnostics
script. Thanks to everyone whose work is in it; [`CREDITS.md`](https://github.com/mitch030504/Wiicompiled_VR_Frame/blob/openxr-work/CREDITS.md) lists who wrote
what.
**This release is source only.** The game is always built from your own clean PAL `RMCP01` disc,
and nothing built from it may be distributed, so there is no ready-built game here.
## New
- **Retro Rewind in the installer.** `steam-frame-install.sh --retro-rewind` downloads the Retro
Rewind pack from its own update server, builds Retro Rewind beside the base game and adds it to
your Steam library. `--retro-rewind-pack DIR` uses a pack you already have. Online play works on
Linux now that TLS does (below). From heurazy's Wiicompiled_VR-PLUS.
- **Adaptive resolution** (`[vr] adaptive_resolution`, off by default): lowers the race's eye
resolution down to 70% while frames fall behind, and raises it again once they keep up.
Experimental and not yet tried in a race on the Frame. From Wiicompiled_VR-PLUS.
- **`Launcher/frame-diagnostics.sh`** gathers the logs, crash files, settings, SteamVR logs and
system state from the Frame into one archive, with a summary of how far startup got. Attach it
to bug reports.
## Fixed
- A crash while a scene loads (`GXClearVtxDesc`). From Wiicompiled_VR-PLUS.
- TLS on Linux, through Mbed TLS, so online services can connect at all (upstream #144), and a
timed-out TLS write no longer frees a session the game still holds (DarthMDev).
- Saves on a different drive or the SD card can be moved (upstream #212); the game keeps its local
Wii identity services while offline, and emptied WiiConnect24 files are refilled, so it no longer
reports a save error for them (upstream #244, nx-mod).
- `Config.toml` is saved through a temporary file, so a crash mid-save can't empty it
(BlackAndBlue95).
- Renderer fixes from upstream's KartPad batch (#244): draws no longer read past their own vertices,
three-byte vertex attributes, GEN_MODE, EFB copies and readback, pipeline cache rows and pipeline
compile wake-ups. Waiting on the GPU now sleeps instead of holding a CPU core busy.
- Effects no longer vanish while the world is darkened, such as Stormship's lightning
(BlackAndBlue95).
- Controller player indices and socket errors (upstream #251), and a `bltl` translation (#254).
## Faster
- Disc reads and SZS decompression take bulk copies and keep file handles open per thread
(KartPad).
- Audio mixing uses NEON (rooklz).
- Translated memory accesses no longer check the page size each time, since the Frame uses 4 KiB
pages; the game checks once at startup (from nx-mod's finding).
## Updating from frame-beta-2
Run the install command again; you can leave out `--disc`. Dawn's patches did not change, so it is
not rebuilt. Most of the game is, since the translator changed as well as the runtime and renderer,
so expect a longer update than usual. The build now also downloads Mbed TLS. Add `--retro-rewind` to get Retro Rewind too.
## Known issues
Unchanged from frame-beta-2:
- Images double in races and on the HUD, sometimes in the right eye only. Foveation is the main
suspect; try foveation Off if it bothers you, and report the result.
- Foveation follows the right eye less well than the left.
- VR frame interpolation is not recommended on the Frame.
- The Android (`steamFrame`) flavour cannot show a picture in Lepton; use the native build.
## Recommended settings
`render_scale = 1.25`, `foveation = "medium"`, `repeat_frames = true`, `frame_interpolation_fps = 0`
under `[vr]`, and `resolution_multiplier = 2` under `[video]`. SteamVR at 120 Hz.
Reports with the run log from `~/.local/share/WiiCompiled/Logs/`, or the archive
`frame-diagnostics.sh` makes, are welcome as issues.