docs(virtual_jaguar): update Virtual Jaguar page for core v3.0.0 - #1173
docs(virtual_jaguar): update Virtual Jaguar page for core v3.0.0#1173JoeMatt wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Virtual Jaguar core documentation to reflect the current libretro Virtual Jaguar core v3.0.0 behavior, especially around Jaguar CD support, BIOS handling, features, and the expanded core options set.
Changes:
- Refreshes background/author info and adds Jaguar CD extensions plus an
.isoload-time limitation note. - Adds a new BIOS section documenting optional Jaguar CD BIOS override filenames and MD5 hashes.
- Rewrites the core options section into categories (Video, BIOS & Boot, CD-ROM, Network Link, Input, Diagnostics, Timing) and updates compatibility notes.
Suppressed comments (1)
docs/library/virtual_jaguar.md:203
- This line reads like a single core option named "Port 1/2 > RetroPad (button)", but the core exposes one option per port and per RetroPad input (e.g.,
Port 1 > RetroPad Up,Port 2 > RetroPad Up, etc.). Rewording this bullet as a grouped/patterned set of options makes it clear there isn't a single option/key users can look up.
- **Port 1/2 > RetroPad (button)** [virtualjaguar_p1_retropad_*] [virtualjaguar_p2_retropad_*]
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Input Port 1 / Input Port 2 | ||
|
|
||
| - **Port 1/2 > Numpad Buttons to Keyboard Keys** [virtualjaguar_p1_numpad_to_kb] [virtualjaguar_p2_numpad_to_kb] (**disabled**|Number Row Keys|Keypad Keys) |
There was a problem hiding this comment.
Good catch — fixed. The page now has separate Input Port 1 and Input Port 2 sections listing the real option keys (virtualjaguar_p1_numpad_to_kb / virtualjaguar_p2_numpad_to_kb, and virtualjaguar_p1_retropad_* / virtualjaguar_p2_retropad_*), with a concrete example key for each so the names are searchable. Port 2's entries point back at Port 1 for the value list rather than duplicating it.
3f47b99 to
3468872
Compare
c53c5c8 to
d4733d2
Compare
- Author list now leads with Joseph Mattiello, matching the core's .info file (authors = "Joseph Mattiello|David Raingeard|Shamus"). - Background rewritten from the .info description: the core is the actively maintained Jaguar / Jaguar CD emulator, no BIOS required. - Extensions: add .cue and .cdi (Jaguar CD); note that bare .iso is refused at load time (a 2048-byte-sector ISO cannot represent a Jaguar CD's multi-session layout). - New BIOS section listing both Jaguar CD BIOS images with md5sums, flagged clearly as OPTIONAL overrides -- the core embeds them. The console boot ROM is deliberately not listed: it is never loaded from the system directory. - Features table: States, Rewind, Netplay, RetroArch Cheats and Native Cheats flip to supported. The core reports zero serialization quirks (deterministic states) and implements the libretro netpacket interface and retro_cheat_set. - Directories: the separate *.cdrom.srm no longer exists; all EEPROM and Memory Track NVRAM data round-trips through one frontend .srm. - Core options rewritten and grouped into the core's 9 categories. Removed 'Doom Res Hack' (option deleted upstream once the underlying resolution handling was fixed) along with its two screenshot admonitions. Added CD boot mode / CD BIOS type / CD read speed / Memory Track, the four Network Link options, crash detect, CD trace, DRAM timing, and the input remap options. - Compatibility split into Jaguar CD and cartridge tables and re-measured against the core's own triage docs. Fixed since the last update: Doom, Wolfenstein 3D, Iron Soldier 2, Alien vs Predator, Tempest 2000, Brutal Sports Football. Documents core v3.0.0; the post-3.0 options currently on develop (Jaguar GameDrive, M68K/RISC clock scale) are intentionally omitted.
d4733d2 to
173f7c1
Compare
The Virtual Jaguar page had drifted a long way from the core. This brings it in line with the shipped v3.0.0 release (the
master/buildbot core).Author
Leads with Joseph Mattiello, matching the core's own
.infofile (authors = "Joseph Mattiello|David Raingeard|Shamus").Extensions
Added
.cueand.cdifor Jaguar CD, and a note that bare.isoimages are refused at load time — a 2048-byte-sector ISO can't represent a Jaguar CD's multi-session layout, so no retail disc boots from one.New BIOS section
Both Jaguar CD BIOS images with md5sums, flagged clearly as optional overrides — the core embeds them and no BIOS file is required:
[BIOS] Atari Jaguar CD (World).j64(retail)77cd95c7ad06a39f4c59995094aa10f9[BIOS] Atari Jaguar Developer CD (World).j64(developer)578de34498cb9a40c5368b6f5ca80484The console boot ROM is deliberately not listed — it's never loaded from the system directory, so listing it would send people hunting for a file the core ignores.
Features table
States,Rewind,Netplay,RetroArch CheatsandNative Cheatsflip from ✕ to ✔. The core reports zero serialization quirks, implementsRETRO_ENVIRONMENT_SET_NETPACKET_INTERFACE, and implementsretro_cheat_set/retro_cheat_reset.Directories
The separate
*.cdrom.srmno longer exists — cartridge EEPROM, CD EEPROM and the 128 KB Memory Track NVRAM all round-trip through one frontend-managed.srm.Core options
Rewritten and grouped into the core's nine categories.
Doom Res Hackis removed — the option was deleted upstream once the underlying resolution handling was fixed — along with its two screenshot admonitions, which would otherwise be orphaned.Added: CD Boot Mode, CD BIOS Type, CD Read Speed, Memory Track, the four Network Link (JagLink/CatBox) options, Crash Detect, CD Trace and DRAM Timing, plus the per-port input remapping options. No new image references were added, since those files don't exist in this repo.
Compatibility
The per-game issue tables are removed. The full commercial cartridge library and every Jaguar CD title now boot and run, so the old table was mostly stale entries (Wolfenstein 3D, Iron Soldier, Iron Soldier 2, Pitfall, Doom's resolution hack…). Per-game issues are tracked on the core's issue tracker, and keeping a second copy here just guarantees one of them is wrong. The section now points there, plus at the CD boot matrix in the core repo.
This also drops the two orphaned screenshot admonitions (
cyber.png,ninja.png) that only the removed table referenced.This documents v3.0.0 specifically. The options currently only on
develop(Jaguar GameDrive, M68K/RISC clock scale) are intentionally left out until they ship.