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
26 changes: 26 additions & 0 deletions .github/release-notes/v2.1.10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# RustyNES v2.1.10 — Fathom (creator tools and web parity — Loom)

The **creator-tools-and-web-parity** step of the v2.1.5 → v2.2.0 "deepen the existing project" run. It deepens the content-creation surface (TAStudio + Lua) and closes the deferred browser gaps (RetroAchievements + Vs. `DualSystem` libretro present). The deterministic core is untouched — greenzone snapshots and Lua reads/writes preserve the TAS/replay contract — so **AccuracyCoin 141/141 (100.00%)**, `visual_regression` byte-identical, and save-state / TAS / netplay replay stay bit-identical. Two PRs (#287, #288).

## Added

### Creator tools — TAStudio depth + Lua API breadth (B8/B9) — #288

- **TAStudio greenzone** — per-frame cached save-states with a **force-greenzone** range so piano-roll seeking / rewinding is instant (bounded, `MAX_FORCED_GREENZONE_FRAMES` ≈ 3 min; forced frames pinned as non-evictable anchors). Named markers and richer branch slots (the `.rnmproj` model already carried these) round out the surface.
- **Lua API breadth** — the full lifecycle-callback surface (`startFrame` / `endFrame` / `nmi` / `irq` / `reset` / `inputPolled` / `spriteZeroHit` / `codeBreak` / `stateLoaded` / `stateSaved`), CPU / PPU / palette / OAM / CHR read-write (reads are the side-effect-free debug-peek path — no open-bus / mapper side effects; writes stay gated / deferred), `emu.drawLine` HUD drawing (mlua + piccolo + both render sites), a bundled example-script library (`hud_graph.lua`, `palette_viewer.lua`, `lifecycle_events.lua`), and a **wasm `piccolo` parity uplift** (read-parity memory table + `drawLine`, the deferred-but-lands write contract preserved, ADR 0012).

### Web parity — browser RetroAchievements + Vs. `DualSystem` libretro (ADR 0015) — #287

- **Browser RetroAchievements** — completes the wasm trampoline marshalling and adds the **deployable auth-proxy** the browser client needs (`deploy/Dockerfile.raproxy` + an `ra-proxy` compose service behind Caddy; RA credentials via env only, never committed). The full code path is in place with marshalling-contract tests; the live login + unlock is a documented deploy-to-verify step (`docs/cheevos-browser.md`).
- **Vs. `DualSystem` presentation in the libretro core** — detects the cabinet, steps both consoles, and composes a 512×240 side-by-side XRGB8888 image with the correct port mapping + audio + save-state — delivering the dual-console view for the mainstream RetroArch target.

## Deferred (documented honestly)

- **Vs. `DualSystem` on the wasm desktop-style present** — the core compositor and the libretro path are done, but un-gating the browser GPU present for the four Vs. arcade boards is a niche, CI-unverifiable (no headless-browser GPU) change to the common wasm present hot-path; kept deferred with the rationale in `docs/frontend.md`.

## Notes

- Version: workspace `2.1.9 → 2.1.10` (Cargo.lock refreshed). No dependency or mobile changes (the mobile apps re-release at v2.3.0).
- **No default-build behavior change.** TAStudio greenzone is pure frontend anchor bookkeeping; Lua writes stay gated/deferred; the web-parity work is browser/libretro/deploy. AccuracyCoin stays **141/141 (100.00%)**, `visual_regression` byte-identical, and save-state / TAS / netplay replay stay bit-identical (verified by the greenzone bit-identity + TAS-replay gates). Two review-surfaced fixes landed alongside: a real `rustynes-libretro::push_audio` hot-path realloc (capacity 4096 vs stereo-interleave 8192) and two TAStudio greenzone anchor-bookkeeping bugs (each with a new regression test).
- Docs updated in-change: `docs/scripting.md`, `docs/frontend.md`, `docs/cheevos-browser.md`, `deploy/README.md`, `CHANGELOG.md`.
- Full host gate green: fmt · clippy (native all-targets + `scripting` / `scripting,hd-pack` / `retroachievements` + all wasm32 targets incl. `browser-cheevos` / `script-wasm`) · `cargo build -p rustynes-libretro` · rustdoc (`-D warnings`) · markdownlint (pinned v0.39.0) · AccuracyCoin 141/141 + `visual_regression` byte-identical + the greenzone / TAS bit-identity suites + `rustynes-script` (mlua + piccolo) tests · version consistency.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ cycle-accurate core later replaced.

## [Unreleased]

## [2.1.10] - 2026-07-12 - "Fathom" (creator tools and web parity — TAStudio greenzone + Lua API breadth + browser-RA auth-proxy deploy stack + Vs. DualSystem libretro presentation — "Loom")

### Added

- **Vs. `DualSystem` presentation in the libretro core (v2.1.10 "Web Parity").**
Expand Down
36 changes: 18 additions & 18 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ members = [
]

[workspace.package]
version = "2.1.9"
version = "2.1.10"
edition = "2024"
rust-version = "1.96"
license = "MIT OR Apache-2.0"
Expand Down
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>

<p align="center">
<a href="https://github.com/doublegate/RustyNES/actions"><img src="https://github.com/doublegate/RustyNES/workflows/CI/badge.svg" alt="Build Status"></a> <a href="#license"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg" alt="License: MIT OR Apache-2.0"></a> <a href="https://github.com/doublegate/RustyNES/releases"><img src="https://img.shields.io/badge/version-v2.1.9-blue.svg" alt="Version"></a> <a href="rust-toolchain.toml"><img src="https://img.shields.io/badge/rust-1.96-orange.svg" alt="Rust: 1.96"></a><br>
<a href="https://github.com/doublegate/RustyNES/actions"><img src="https://github.com/doublegate/RustyNES/workflows/CI/badge.svg" alt="Build Status"></a> <a href="#license"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg" alt="License: MIT OR Apache-2.0"></a> <a href="https://github.com/doublegate/RustyNES/releases"><img src="https://img.shields.io/badge/version-v2.1.10-blue.svg" alt="Version"></a> <a href="rust-toolchain.toml"><img src="https://img.shields.io/badge/rust-1.96-orange.svg" alt="Rust: 1.96"></a><br>
<a href="#compatibility-and-accuracy"><img src="https://img.shields.io/badge/AccuracyCoin-100%25%20(141%2F141)-brightgreen.svg" alt="AccuracyCoin"></a> <a href="#compatibility-and-accuracy"><img src="https://img.shields.io/badge/nestest-0--diff-brightgreen.svg" alt="nestest"></a> <a href="https://doublegate.github.io/RustyNES/"><img src="https://img.shields.io/badge/play-in%20browser-success.svg" alt="Try in browser"></a><br>
Comment thread
doublegate marked this conversation as resolved.
<a href="#platform-support"><img src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS%20%7C%20Web%20%7C%20Android%20%7C%20iOS-lightgrey.svg" alt="Platform"></a>
</p>
Expand Down Expand Up @@ -775,16 +775,19 @@ and the Material-for-MkDocs documentation handbook at

## Current Release

RustyNES's current release is **v2.1.9 "Fathom" ("Aperture")**, the presentation-and-signal
step of the v2.1.5 → v2.2.0 "deepen the project" run — it adds a **marquee CRT shader stack**
(WGSL ports of **CRT-Royale**, **crt-guest-advanced**, and **Sony Megatron** HDR, selectable
in Settings → Shaders with mask/scanline/curvature controls and per-game presets), a
**raw NTSC composite signal-decode path** (a new `rustynes-ppu::raw_signal` un-decoded 2C02
composite model plus a `signal_decode.wgsl` pass that reconstructs and demodulates the real
signal for artifact-accurate color), **GIF + WAV capture** (extending `av-record`), and a
**generated-NTSC palette editor** with a live preview. Every shader / signal / capture path
is **opt-in and default-off**, so the shipped default presentation stays byte-identical:
**AccuracyCoin stays 141/141 (100.00%)**, nestest 0-diff, `visual_regression` byte-identical.
RustyNES's current release is **v2.1.10 "Fathom" ("Loom")**, the creator-tools-and-web-parity
step of the v2.1.5 → v2.2.0 "deepen the project" run — on the **creator** side it deepens
**TAStudio** (greenzone / force-greenzone caching so piano-roll seeking is instant, named
markers, richer branch slots) and broadens the **Lua API** (the full lifecycle-callback surface,
CPU/PPU/palette/OAM/CHR read-write with side-effect-free `*Debug` variants, HUD drawing, an
example-script library, and wasm-`piccolo` parity uplift); on the **web-parity** side it
completes the **browser RetroAchievements** path (wasm trampoline marshalling + a deployable
auth-proxy stack, ADR 0015) and brings **Vs. `DualSystem`** presentation to the **libretro**
core. The deterministic core is untouched — greenzone snapshots + Lua reads/writes preserve
Comment thread
doublegate marked this conversation as resolved.
the TAS/replay contract — so **AccuracyCoin stays 141/141 (100.00%)**, `visual_regression` is
byte-identical, and save-state / TAS / netplay replay stay bit-identical. (Vs. `DualSystem` on
the wasm present path is honestly deferred, and the browser-RA live login is a documented
deploy-to-verify step — see the CHANGELOG.)

The v2.1.x line opened with **v2.1.0**, the accuracy-remediation release (a display-only
PPU palette-backdrop-override fix, 86 mapper families promoted BestEffort → Curated, and
Expand Down Expand Up @@ -910,7 +913,7 @@ If you use RustyNES in academic research, please cite:
author = {RustyNES Contributors},
title = {RustyNES: A Cycle-Accurate NES Emulator in Rust},
year = {2026},
version = {2.1.9},
version = {2.1.10},
url = {https://github.com/doublegate/RustyNES},
Comment thread
doublegate marked this conversation as resolved.
note = {Cycle-accurate NES emulator on a master-clock-precise scheduler;
AccuracyCoin 100\% (141/141), nestest 0-diff; 172 mapper families,
Expand Down
Loading