Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
!/docs/ps5-generator.md
!/docs/release-v0.8.0.md
!/docs/release-v0.9.0.md
!/docs/release-v0.9.1.md
!/docs/pr-review-2026-11.md
!/native/
!/profiles/
/profiles/*
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ is Windows-first. The fork adds a Linux build (also packaged for macOS), a Linux
(`sf3patch`), profiles for the Translation Project V25.1 discs, an optional accurate CD-drive timing mode, and a
large automated test harness. Upstream's Windows releases, artwork tools and documentation are kept below.

**Source updates after v0.9.0:** reviewed community fixes improve memory mirrors, non-local returns, save-file flushing, overlay snapshot dispatch, scene callback discovery and composition/lookup caching. Seven additional exact disc profiles are experimental registrations. See the [PR review and validation limits](docs/pr-review-2026-11.md). These source updates are not yet in the v0.9.0 downloads below.

> **Status: work in progress.** All three scenarios boot, play and save, and save transfer between scenarios works.
> End-to-end playthroughs of every scenario are still being tested. The Premium Disc (Translation V25.1) is
> **experimental**: it boots and its menus work in headless smoke tests.
> See [Status and known issues](#status-and-known-issues).

Upstream [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0) adds 2160-line rendering (**1× / 2× / 5× / 9×**) with optional four-sample SSAA, five display filters (Nearest, Bilinear, Integer smooth, Bicubic and Lanczos), guarded vertex precision for reviewed Scenario 1–3 BOOT families, sharper sampling for supported rotation backgrounds, smoother audio when presentation falls behind, fullscreen/VSync/toolbar controls, and an Apple Silicon Mac package alongside Windows and Linux. Widescreen still uses **original game graphics** — turn **AI graphics** to **Off** when using 16:9. See the [v0.9.0 release notes](docs/release-v0.9.0.md). Upstream [v0.8.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.8.0) added official widescreen support (16:9 with GPU rendering; Windows hybrid-GPU laptops request the high-performance GPU before SDL starts).
Upstream [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1) is a maintenance release that ships the community fixes reviewed in [docs/pr-review-2026-11.md](docs/pr-review-2026-11.md) (memory mirroring, non-local returns, save flushing, overlay snapshot dispatch, scene callback discovery, composition/lookup caching) and registers seven additional exact disc profiles as experimental. See the [v0.9.1 release notes](docs/release-v0.9.1.md).

Upstream [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0) added 2160-line rendering (**1× / 2× / 5× / 9×**) with optional four-sample SSAA, five display filters (Nearest, Bilinear, Integer smooth, Bicubic and Lanczos), guarded vertex precision for reviewed Scenario 1–3 BOOT families, sharper sampling for supported rotation backgrounds, smoother audio when presentation falls behind, fullscreen/VSync/toolbar controls, and an Apple Silicon Mac package alongside Windows and Linux. Widescreen still uses **original game graphics** — turn **AI graphics** to **Off** when using 16:9. See the [v0.9.0 release notes](docs/release-v0.9.0.md). Upstream [v0.8.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.8.0) added official widescreen support (16:9 with GPU rendering; Windows hybrid-GPU laptops request the high-performance GPU before SDL starts).

## Contents

Expand Down Expand Up @@ -102,25 +102,25 @@ To check a dump, `python3 -m tools.sf3patch identify DISC.cue --content-id` prin

The fork has no releases of its own yet. Upstream's published packages are:

- **Windows x64:** [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0).
- **Windows x64:** [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1).
1. Extract the whole ZIP and open **SFIII Native.exe**.
2. Choose the scenario, your CUE or CHD, and a data folder.
3. Click **Prepare game**, then **Play**.

There is also an optional
[offline AI graphics builder](https://github.com/mattkuhnQAAI/sfiii-native/releases/download/v0.9.0/SFIII-Offline-Graphics-Builder-0.9.0-Windows-x64.zip).
See [docs/DESKTOP.md](docs/DESKTOP.md).
- **Linux x64:** [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0). Upstream built and
- **Linux x64:** [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1). Upstream built and
synthetically tested the Linux package; real-disc gameplay, widescreen and AI graphics on Linux remain
unvalidated upstream. See [docs/POSIX.md](docs/POSIX.md) and [docs/release-v0.9.0.md](docs/release-v0.9.0.md).
- **Apple Silicon macOS:** [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0). Upstream
unvalidated upstream. See [docs/POSIX.md](docs/POSIX.md) and [docs/release-v0.9.1.md](docs/release-v0.9.1.md).
- **Apple Silicon macOS:** [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1). Upstream
built and synthetically tested an Apple Silicon package (ad-hoc signed, not notarized). Intel Mac packages are
not included in the upstream release. Real-disc gameplay, physical controllers and hardware audio on macOS
remain unvalidated upstream.

Upstream releases accept only upstream's six registered discs (Sc1 USA, Sc1 V25.1, Sc2 v24, the Sc2 v24-to-V25.1
migration, the supplied Sc2 V1.003 image whose header reports V24, and Sc3 V25.1), and they do not include the fork's
changes. To use the fork's other profiles (the V25+ add-on discs, the other Sc2 and Sc3 revisions and the Premium Disc)
Upstream v0.9.1 registers 13 exact-content profiles: its original six (Sc1 USA, Sc1 V25.1, Sc2 v24, the Sc2
v24-to-V25.1 migration, the supplied Sc2 V1.003 image whose header reports V24, and Sc3 V25.1) plus seven experimental
registrations contributed from this fork. Upstream releases do not include the fork's other changes. To use the fork's other profiles (the V25+ add-on discs, the other Sc2 and Sc3 revisions and the Premium Disc)
and the fork's fixes, build from source.

Upstream's earlier v0.6.1-preview1 included faster same-address module identification, reduced repeated GPU artwork uploads, larger demand-filled artwork caches on PCs with sufficient RAM, and an adaptive audio cushion (it starts at 100 ms and grows to 150 ms after repeated underruns, trading latency for fewer interruptions). Upstream tested these on selected Windows Scenario 2 routes. It also labels the artwork styles **Animated**, **Illustrated** and **General** (with **Off** in the game); older packs and saved settings keep their internal identifiers and stay compatible.
Expand Down
2 changes: 1 addition & 1 deletion desktop/dependencies.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.9.0",
"version": "0.9.1",
"licenses": [
{
"file": "ninja-LICENSE.txt",
Expand Down
2 changes: 1 addition & 1 deletion desktop/posix-dependencies.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.9.0",
"version": "0.9.1",
"git": {
"sdl": {
"url": "https://github.com/libsdl-org/SDL.git",
Expand Down
8 changes: 4 additions & 4 deletions docs/DESKTOP.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Automatic Windows preparation

## v0.9.0
## v0.9.1

Download [**SFIII-Native-0.9.0-win64.zip**](https://github.com/mattkuhnQAAI/sfiii-native/releases/download/v0.9.0/SFIII-Native-0.9.0-win64.zip), extract the complete ZIP to a new application folder and open **SFIII Native.exe**. Players do not install a compiler or enter build commands. Choose your supported disc and separate scenario data folder, then **Prepare game** and **Play**. If updating, prepare against your existing scenario data folder to retain ordinary saves; keep the old application and build for their build-specific quick states.
Download [**SFIII-Native-0.9.1-win64.zip**](https://github.com/mattkuhnQAAI/sfiii-native/releases/download/v0.9.1/SFIII-Native-0.9.1-win64.zip), extract the complete ZIP to a new application folder and open **SFIII Native.exe**. Players do not install a compiler or enter build commands. Choose your supported disc and separate scenario data folder, then **Prepare game** and **Play**. If updating, prepare against your existing scenario data folder to retain ordinary saves; keep the old application and build for their build-specific quick states.

This release adds **9×/2160-line rendering**, optional four-sample SSAA, five display filters including GPU Bicubic/Lanczos, vertex precision, sharper supported backgrounds, fullscreen/toolbar/VSync controls and smoother audio. It retains original-graphics 16:9, optional artwork, indexed pack loading, controller setup and save import/export. Rendering choices are **1× / 2× / 5× / 9×**. Use **AI graphics > Off** with 16:9 because optional artwork can misalign or pop in. See [release notes](release-v0.9.0.md) and [optional graphics setup](#optional-graphics-builder).
v0.9.1 improves loader and save reliability, caches overlay lookups, and adds experimental disc profiles. It includes **9×/2160-line rendering**, optional four-sample SSAA, five display filters including GPU Bicubic/Lanczos, vertex precision, and sharper supported backgrounds. It retains original-graphics 16:9, optional artwork, indexed pack loading, controller setup and save import/export. Rendering choices are **1× / 2× / 5× / 9×**. Use **AI graphics > Off** with 16:9 because optional artwork can misalign or pop in. See [release notes](release-v0.9.1.md) and [optional graphics setup](#optional-graphics-builder).

Linux x64 and Apple Silicon macOS archives are attached to [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0), subject to the validation limits in [portable setup](POSIX.md). Intel Mac is excluded. Windows gameplay checks do not establish Linux/macOS gameplay compatibility. The optional builder remains Windows x64 only.
Linux x64 and Apple Silicon macOS archives are attached to [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1), subject to the validation limits in [portable setup](POSIX.md). Intel Mac is excluded. Windows gameplay checks do not establish Linux/macOS gameplay compatibility. The optional builder remains Windows x64 only.

## v0.5.0-alpha additions

Expand Down
2 changes: 1 addition & 1 deletion docs/POSIX.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Linux and Apple Silicon macOS

v0.9.0 supplies **Linux x86-64** and **Apple Silicon ARM64** packages alongside Windows. Intel Mac is excluded. Download the appropriate archive from [v0.9.0](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0).
v0.9.1 supplies **Linux x86-64** and **Apple Silicon ARM64** packages alongside Windows. Intel Mac is excluded. Download the appropriate archive from [v0.9.1](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.1).

## Player setup

Expand Down
2 changes: 1 addition & 1 deletion docs/pr-review-2026-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The 17 open contributions were reviewed against v0.9.0. Changes from twelve were adapted into the current source, one was superseded, and four proposals were deferred as written. Adaptation preserves current renderer, save-identity and packaging behavior rather than replacing the runtime patch with an older snapshot. Credit: [damiantw](https://github.com/damiantw).

These are source updates after v0.9.0; existing published archives have not been replaced. New builds and new generated game programs are required to use them. Ordinary saves remain the cross-build progress path. Retain old applications/prepared builds for their native states and replay checkpoints.
These changes ship in [v0.9.1](release-v0.9.1.md). New builds and new generated game programs are required to use them. Ordinary saves remain the cross-build progress path. Retain old applications/prepared builds for their native states and replay checkpoints.

| PR | Disposition | Reason and retained work |
| --- | --- | --- |
Expand Down
21 changes: 21 additions & 0 deletions docs/release-v0.9.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# v0.9.1 — Loader, save and runtime fixes

- Fixes Saturn RAM and backup-memory mirroring, native returns across overlay calls, scene callback discovery, and a recompiler edge case involving stores in branch delay slots.
- Flushes backup memory before replacing the save file and restores native states saved between an overlay load and its first call.
- Caches overlay dispatch and balances background composition across CPU workers.
- Returns complete CD status replies and prevents reserved sound-register writes from overwriting DSP delay taps.
- Registers seven experimental exact disc profiles, including three additional v25.1 images and four default V25+ add-on combinations. See the [edition table](../README.md#registered-game-editions).

Thanks to [damiantw](https://github.com/damiantw) for the contributions behind these fixes. See the [PR review](pr-review-2026-11.md) for individual changes and deferred work.

## Download and update

Applications are available for Windows x64, Linux x86-64, and Apple Silicon macOS 13+. Extract the full archive and use **Prepare game** with your own supported CUE or CHD. The tools are bundled. No BIOS is required. The optional Windows graphics builder remains a separate download on the [v0.9.0 release](https://github.com/mattkuhnQAAI/sfiii-native/releases/tag/v0.9.0).

To update, extract into a new application folder and prepare against your existing scenario data folder. Ordinary in-game saves stay in that folder. Keep the previous application and prepared build for its build-specific native states and replay checkpoints. The launcher save manager imports and exports individual BIN and YSBAK saves.

Use **AI graphics Off** with 16:9. Optional artwork can misalign in widescreen.

## Validation

Windows checks cover fresh disc preparation, save import, runtime regressions, and 16 recorded routes across original and translated Scenario 1, the supplied Scenario 2 V1.003 edition, and translated Scenario 3. The seven new disc profiles lack local gameplay fixtures. Linux and Apple Silicon packages use hosted native builds and synthetic tests. Gameplay and physical-device behavior on those platforms remain unverified. The macOS app uses an ad-hoc signature.
2 changes: 1 addition & 1 deletion tools/check-source-package.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def main():
failures.append([name,'unreviewed generation profile'])
if path.parts[0] == 'desktop' and name not in {'desktop/dependencies.json','desktop/posix-dependencies.json'} and path.suffix not in {'.py','.cs'}:
failures.append([name,'not desktop application source'])
if path.parts[0] == 'docs' and name not in {'docs/BUILDING.md','docs/USAGE.md','docs/DEVELOPMENT.md','docs/DESKTOP.md','docs/POSIX.md','docs/linux-bringup.md','docs/testing-plan.md','docs/translation-patcher.md','docs/ps5-generator.md','docs/release-v0.8.0.md','docs/release-v0.9.0.md','docs/pr-review-2026-11.md'}:
if path.parts[0] == 'docs' and name not in {'docs/BUILDING.md','docs/USAGE.md','docs/DEVELOPMENT.md','docs/DESKTOP.md','docs/POSIX.md','docs/linux-bringup.md','docs/testing-plan.md','docs/translation-patcher.md','docs/ps5-generator.md','docs/release-v0.8.0.md','docs/release-v0.9.0.md','docs/release-v0.9.1.md','docs/pr-review-2026-11.md'}:
failures.append([name,'local history or unreviewed documentation'])
if path.suffix.lower() in FORBIDDEN or any(x in {'.local','research','sessions','captures','generated','build','data','extract'} for x in path.parts):
failures.append([name, 'game/build/debug artifact path'])
Expand Down
Loading
Loading