diff --git a/emulators/ace-dl.yml b/emulators/ace-dl.yml index 53fa25297..043c4a1eb 100644 --- a/emulators/ace-dl.yml +++ b/emulators/ace-dl.yml @@ -6,7 +6,7 @@ upstream: "http://ace.cpcscene.net" version_source: url: "https://roudoudou.com/ACE-DL/" pattern: 'New release [^<]* - (\d{4}/\d{2}/\d{2})' -profiled_date: "2026-10-20" +profiled_date: "2026-11-10" core_version: "2026/10/16" version_basis: kind: package @@ -23,21 +23,19 @@ mode: standalone notes: | SDL port of ACE, the Amstrad CPC/Plus emulator written by Philippe Rimauro (OffseT) for MorphOS. ACE-DL is built by Edouard Bergé (Roudoudou) from the - MorphOS sources and released for Windows, macOS, Linux and Raspberry Pi; - a third port targets Haiku. All three are closed source, the original author - keeps the sources private, so the entries below were established on the - official Linux x86-64 builds: file opens traced with strace and - required/optional decided by removing each file on the 2026-06-03 build, then - path constants, error strings and plugin keys read again from the 2026/10/16 - build (BNDGEN.tar.gz), which ships the same ROM files byte for byte. + MorphOS sources and released for Windows, macOS, Linux and Raspberry Pi. + The sources are private. Every entry below was read from the stripped + Linux x86-64 executable AceDL of the 2026/10/16 BNDGEN.tar.gz (tarball + sha256 4f3567bb2196e32f, AceDL sha256 0f159a705028e80e). The binary has no + symbols, so functions are named FUN_
(file offset = virtual + address in this PIE). Machines are CPC 464, 664 and 6128 plus the Plus range, which boots from a - cartridge and covers the GX-4000. An operating system is one 32 KB file - holding the 16 KB firmware ROM followed by the 16 KB BASIC ROM. The AMSDOS - disc ROM is a separate 16 KB file mapped in slot 7. The upstream MorphOS - release keeps the three ROMs apart under System/ and composes them at - startup, ACE-DL ships them pre-joined under private/firmware/ with one file - per machine and language. The pairs are exact: + cartridge and covers the GX-4000. An operating system is one file read by + FUN_248970 as two 16 KB halves, the firmware ROM then the BASIC ROM, each + fread having to return 0x4000 bytes. A shorter file is refused, bytes past + 32 KB are ignored. ACE-DL ships them pre-joined under private/firmware/, + one file per machine and language: OS464_UK.rom Firmware v1 + BASIC 1.00 OS464_FR.rom Firmware f1 + French BASIC 1.0 (md5 824f5213...) @@ -50,55 +48,55 @@ notes: | XMEM_FW_3_15_FR.rom XMEM 3.15 firmware + BASIC 1.23 Firmware versions run 1 to 4 for the 464, 664, 6128 and Plus, and the letter - is the country: v English, f French, s Spanish, d Danish. The BASIC revision - attached to a version 3 firmware follows the country, 1.23 for France, 1.21 - for Spain, 1.20 elsewhere, which is what the pairs above show. The XMEM files - replace the firmware half with the X-MEM expansion firmware and keep the - stock BASIC. + is the country: v English, f French, s Spanish, d Danish. - The nine operating systems are the entries of the Machine configuration - selector. OS6128_UK.rom is the built-in default and is opened at every - startup even when the config OS= key names another file. Command line -fuk, - -ffr, -fsp and -fdk switch to the UK, French, Spanish and Danish 6128 files. - A machine needs at least 32 KB in the file: truncated to 16384 bytes the - emulator prints "Error initializing ROMs!" and dies, padded to 40000 bytes it - boots, so the check is a lower bound rather than an exact length. The AMSDOS - ROM is checked for presence only, an 8 KB stub boots. Every ROM path is built - from the application directory. The -configDir option added in 2026/10/16 - only moves the directory holding config.cfg, while the firmware stays under - private/ beside the executable. + main (FUN_3a479) builds OS6128_UK.rom and Amsdos.rom from the application + directory and creates the machine with them before the config file is read. + If either load fails the machine constructor returns NULL, main prints + "Initialisation Error should not happend" and the next call dereferences + the NULL machine, so startup dies. Afterwards the OS= config key + (FUN_2a4840) loads the path it holds, the firmware requester (FUN_373ad0) + lists every *.rom under private/firmware/ and loads the pick, and -fuk, + -ffr, -fsp, -fdk (FUN_345230, applied by FUN_2989f0 after the config) load + one of the four 6128 files. These three paths keep the current firmware + when the load fails. The Machine configuration page (FUN_377790) names the + loaded firmware by comparing its basename with the nine names above. - Plus machines boot from a cartridge and no cartridge filename is compiled - into the binary, the three Amstrad_?4.cpr files are the system cartridges the - author ships in the same directory, which is also the default browse root of - the cartridge requester. The loader walks the RIFF chunk list and reports - "Cartridge Load Error (Header)" on a bad header and "truncated file!" when a - cb00..cb07 bank is short, each bank being 16 KB for 128 KB total. + Two older code paths switch firmware by RAM size, 64 KB for a 464 or 664, + more for a 6128, keeping the language through a strstr for "FR" in the + current path: the SNA loader (FUN_369ce0) opens ./private/firmware/OS464_FR, + OS464_UK, OS664_UK, OS6128_FR or OS6128_UK and the RAM selector + (FUN_377790) opens the same names under ./firmware/, both without + extension and relative to the working directory. When the open fails the + current firmware stays. - Plugins pull three more ROMs. Multiface II reads multiface2.rom, the Hacker - plugin reads hackit400uk.rom in its UK flavour and hacker481fr.rom in its - French one, and Play2CPC reads the YM2608 ADPCM rhythm ROM, warning with - "ym2608_adpcm_rom.bin not found!" and running without it. The Windows package - omits that ROM, the Linux and Raspberry Pi packages carry it. + Plus system cartridges are loaded by the CPR loader FUN_234870, reached + from the media loader FUN_2a30a0 on a .cpr extension (command line, + CARTRIDGE= config key, dropped file). No code names the three + Amstrad_?4.cpr files. + + Plugins pull three more ROMs, each from a path under the application + directory, loaded when the PLUGIN_ key is 1 in the config file (FUN_2a4840) + or from the plugin menu (FUN_375320). Multiface II and Play2CPC are also + reachable with -plugin multiface2 and -plugin play2cpc. A missing + Multiface II or Hacker ROM leaves the plugin uninstalled, a short one also + clears its PLUGIN_ flag. A missing YM2608 ROM is reported and Play2CPC runs + without the rhythm samples. The Windows x64 package omits that ROM, the + Linux packages carry it. Expansion ROMs are user business: config keys ROM0 to ROM255 hold whatever - the user picks through the requester rooted at media/rom/, and the release - seeds that directory with third-party ROMs (ParaDOS, Protext, Maxam, Utopia, - uniDOS, SymbOS, FutureOS, Orgams, Discology and others). Disc, tape, - snapshot, Dandanator and X-MASS images are user content the same way, and the - Nova plugin regenerates its 32 KB private/Nova/nova.nvram when the file is - absent. Outside emulation the binary loads its own payload: sixteen QOI - images (fatal with "Error loading QOI file please reinstall"), seventeen WAV - drive and monitor samples (each merely reported as not found), and the - private/messages catalog holding the French, English and Spanish - translations. private/sounds/hitachi_long_seek.wav and - private/images/acelogo.qoi ship with every package but appear in no path - constant. + the user picks through the requester rooted at media/rom/, loaded by + FUN_248ae0 with the ROM type check. Disc, tape, snapshot, Dandanator and + X-MASS images are user content the same way, and the Nova plugin + regenerates its 32 KB private/Nova/nova.nvram when the file is absent. + Outside emulation the binary loads its own payload: QOI images, WAV drive + and monitor samples, and the private/messages catalog. files: # -- Operating systems, firmware ROM + BASIC ROM joined in one 32 KB file -- - name: OS6128_UK.rom path: "private/firmware/OS6128_UK.rom" + aliases: [OS6128_UK] system: amstrad-cpc required: true bundled: true @@ -106,13 +104,15 @@ files: validation: [size] md5: b96280dc6c95a48857b4b8eb931533ae sha1: 5977adbad3f7c1e0e082cd02fe76a700d9860c30 - source_ref: "AceDL 2026/10/16: private/firmware/OS6128_UK.rom, default machine, opened at every startup" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_3a479 0x3a893-0x3a8ac (sprintf %sprivate/firmware/OS6128_UK.rom), 0x3a8fc FUN_26caf0, FUN_249ef0 0x249fc0 FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails), 0x249fda (Error initializing ROMs!), FUN_3a479 0x3a905-0x3a93e (NULL machine), FUN_247c50 0x247c54 (NULL dereference); FUN_2989f0 0x299450 (-fuk); FUN_372cb0 0x373077-0x3730a4 (reset to 6128 UK); FUN_369ce0 0x36b7f4 and FUN_377790 0x378298 (extensionless OS6128_UK)" note: >- CPC 6128 English. Firmware v3 followed by BASIC 1.20. Absence stops - startup with "Error initializing ROMs!". + startup with "Error initializing ROMs!". The SNA loader and the RAM + selector also try the extensionless name. - name: OS6128_FR.rom path: "private/firmware/OS6128_FR.rom" + aliases: [OS6128_FR] system: amstrad-cpc region: [france] required: false @@ -121,8 +121,10 @@ files: validation: [size] md5: 5ee871d5600eb9b5a22989c295f902a5 sha1: 200d59076dfef36db061d6d7d21d80021cab1237 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS6128_FR.rom, command line -ffr" - note: "CPC 6128 French. Firmware f3 followed by BASIC 1.23." + source_ref: "AceDL 2026/10/16 linux-x64 FUN_345230 0x345f26-0x345f36 (-ffr sets 2), FUN_2989f0 0x298a03, 0x2993d7-0x2993ff (sprintf %sprivate/firmware/OS6128_FR.rom), 0x29946b FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails), 0x299472 (failure keeps the current firmware); FUN_373ad0 0x374ea6-0x374ed7 (requester); FUN_369ce0 0x36b2ad and FUN_377790 0x377dc5 (extensionless OS6128_FR)" + note: >- + CPC 6128 French. Firmware f3 followed by BASIC 1.23. The SNA loader and + the RAM selector also try the extensionless name. - name: OS6128_S.rom path: "private/firmware/OS6128_S.rom" @@ -134,7 +136,7 @@ files: validation: [size] md5: 0246740371010333385665dfeb7cd0ec sha1: 1acd01c2c03424a78b32c9440f4d890fb1104815 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS6128_S.rom, command line -fsp" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_345230 0x345f6b-0x345f7b (-fsp sets 3), FUN_2989f0 0x2993c1-0x2993ff (sprintf %sprivate/firmware/OS6128_S.rom), 0x29946b FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails); FUN_373ad0 0x374ea6-0x374ed7 (requester)" note: "CPC 6128 Spanish. Firmware s3 followed by BASIC 1.21." - name: OS6128_DK.rom @@ -147,11 +149,12 @@ files: validation: [size] md5: ca1635fd992e2aa7a776b30da13467e5 sha1: a9e7ee6355730f319a37c95ca0a714212b88c3b1 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS6128_DK.rom, command line -fdk" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_345230 0x345fb0-0x345fc4 (-fdk sets 4), FUN_2989f0 0x299438-0x299449, 0x2993ff (sprintf %sprivate/firmware/OS6128_DK.rom), 0x29946b FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails); FUN_373ad0 0x374ea6-0x374ed7 (requester)" note: "CPC 6128 Danish. Firmware d3 followed by BASIC 1.20." - name: OS464_UK.rom path: "private/firmware/OS464_UK.rom" + aliases: [OS464_UK] system: amstrad-cpc required: false bundled: true @@ -159,11 +162,14 @@ files: validation: [size] md5: a993f85b88ac4350cf4d41554e87fe4f sha1: 56d39c463da60968d93e58b4ba0e675829412a20 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS464_UK.rom" - note: "CPC 464 English. Firmware v1 followed by BASIC 1.00." + source_ref: "AceDL 2026/10/16 linux-x64 FUN_373ad0 0x37407d-0x3740ad (firmware requester lists *.rom under %sprivate/firmware), 0x374ea6-0x374ed7 (sprintf %sprivate/firmware/ + pick, FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails)); FUN_2a4840 0x2a4bac-0x2a4c15 (OS= key); FUN_377790 0x3779fe (Machine configuration label); FUN_369ce0 0x36b918 and FUN_377790 0x378363 (extensionless OS464_UK)" + note: >- + CPC 464 English. Firmware v1 followed by BASIC 1.00. The SNA loader and + the RAM selector also try the extensionless name. - name: OS464_FR.rom path: "private/firmware/OS464_FR.rom" + aliases: [OS464_FR] system: amstrad-cpc required: false bundled: true @@ -171,13 +177,14 @@ files: validation: [size] md5: a588b7c9e1c142b5d8ebec65ac7713d8 sha1: c68d84f37ab9defbb19200598c24948c97c9a644 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS464_FR.rom" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_373ad0 0x37407d-0x3740ad (firmware requester lists *.rom under %sprivate/firmware), 0x374ea6-0x374ed7 (sprintf %sprivate/firmware/ + pick, FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails)); FUN_2a4840 0x2a4bac-0x2a4c15 (OS= key); FUN_377790 0x3779e7 (Machine configuration label); FUN_369ce0 0x36b8e1 and FUN_377790 0x3782f4 (extensionless OS464_FR)" note: >- - CPC 464 French. Firmware f1 followed by a French BASIC 1.0 that the - upstream MorphOS release does not carry. + CPC 464 French. Firmware f1 followed by a French BASIC 1.0. The SNA + loader and the RAM selector also try the extensionless name. - name: OS664_UK.rom path: "private/firmware/OS664_UK.rom" + aliases: [OS664_UK] system: amstrad-cpc required: false bundled: true @@ -185,8 +192,10 @@ files: validation: [size] md5: 5a384a2310f472c7857888371c00ed66 sha1: 073a7665527b5bd8a148747a3947dbd3328682c8 - source_ref: "AceDL 2026/10/16: Machine configuration entry OS664_UK.rom" - note: "CPC 664 English. Firmware v2 followed by BASIC 1.10." + source_ref: "AceDL 2026/10/16 linux-x64 FUN_373ad0 0x37407d-0x3740ad (firmware requester lists *.rom under %sprivate/firmware), 0x374ea6-0x374ed7 (sprintf %sprivate/firmware/ + pick, FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails)); FUN_2a4840 0x2a4bac-0x2a4c15 (OS= key); FUN_377790 0x377a15 (Machine configuration label); FUN_369ce0 0x36b881 and FUN_377790 0x378168 (extensionless OS664_UK)" + note: >- + CPC 664 English. Firmware v2 followed by BASIC 1.10. The SNA loader and + the RAM selector also try the extensionless name. - name: XMEM_FW_3_15_UK.rom path: "private/firmware/XMEM_FW_3_15_UK.rom" @@ -197,7 +206,7 @@ files: validation: [size] md5: 85accc17e98c79dbbdde826cbfaf4692 sha1: c7d7e5116665e4f21ae3b9bcdca2ce3685f00293 - source_ref: "AceDL 2026/10/16: Machine configuration entry XMEM_FW_3_15_UK.rom" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_373ad0 0x37407d-0x3740ad (firmware requester lists *.rom under %sprivate/firmware), 0x374ea6-0x374ed7 (sprintf %sprivate/firmware/ + pick, FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails)); FUN_2a4840 0x2a4bac-0x2a4c15 (OS= key); FUN_377790 0x377a9f (Machine configuration label)" note: "X-MEM firmware 3.15 English, followed by BASIC 1.20." - name: XMEM_FW_3_15_FR.rom @@ -209,7 +218,7 @@ files: validation: [size] md5: 046fa182f7574bde3ab97ee873f6e736 sha1: faa49a3aeb1d7e972437f6b77515455d14e2d680 - source_ref: "AceDL 2026/10/16: Machine configuration entry XMEM_FW_3_15_FR.rom" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_373ad0 0x37407d-0x3740ad (firmware requester lists *.rom under %sprivate/firmware), 0x374ea6-0x374ed7 (sprintf %sprivate/firmware/ + pick, FUN_248970 (fopen rb 0x248a0f, fread 0x4000 at 0x248a2c and 0x248aa1, a short read fails)); FUN_2a4840 0x2a4bac-0x2a4c15 (OS= key); FUN_377790 0x377a88 (Machine configuration label)" note: "X-MEM firmware 3.15 French, followed by BASIC 1.23." # -- Disc ROM, mapped in slot 7 -- @@ -221,10 +230,11 @@ files: size: 16384 md5: 25629dfe870d097469c217b95fdc1c95 sha1: 39102c8e9cb55fcc0b9b62098780ed4a3cb6a4bb - source_ref: "AceDL 2026/10/16: private/amsdos/Amsdos.rom, opened at every startup" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_3a479 0x3a8bb-0x3a8d4 (sprintf %sprivate/amsdos/Amsdos.rom), FUN_249ef0 0x24a037 FUN_248ae0 (fopen rb 0x248b42, %s is missing. 0x248c31, 128-byte AMSDOS header skipped when its checksum matches 0x248b63-0x248b99, ROM type byte 0-3 or 0x80 else not a CPC ROM file 0x248bd2-0x248bfd, fread 0x3f80 unchecked 0x248bb7), 0x24a098 (Error loading AMSDOS ROM), 0x249fda, FUN_3a479 0x3a905-0x3a93e, FUN_247c50 0x247c54 (NULL dereference)" note: >- AMSDOS disc ROM. Absence prints "Error loading AMSDOS ROM" then - "Error initializing ROMs!" and stops startup. Length is not checked. + "Error initializing ROMs!" and stops startup. Length is not checked, + the first byte must be a ROM type 0 to 3 or 0x80. # -- Plus system cartridges, 8 banks of 16 KB in RIFF chunks -- - name: Amstrad_v4.cpr @@ -235,7 +245,7 @@ files: size: 131156 md5: 39b565e648172980aa552293e667070f sha1: 405e341437fab8db477606238af0c20eca2e39ee - source_ref: "AceDL 2026/10/16: private/firmware, cartridge requester root, CPR loader" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a30a0 0x2a31ae (.cpr extension), FUN_234870 (fopen rb 0x2348b3, 12-byte RIFF header 0x234927, form AMS! or CXME 0x234937-0x23494b else Cartridge Load Error (Header) 0x2349a0, chunk loop 0x234bad with truncated file! 0x234d20, cbNN bank number 0x234eb0, 16 KB bank read 0x235010-0x235042)" note: "464plus/6128plus/GX-4000 system cartridge, English, firmware version 4." - name: Amstrad_f4.cpr @@ -246,7 +256,7 @@ files: size: 131156 md5: e7159fd674022ba05f9b347ae3cdafc6 sha1: e5aa80c501cfb435e2cba35ad92e427240394164 - source_ref: "AceDL 2026/10/16: private/firmware, cartridge requester root, CPR loader" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a30a0 0x2a31ae (.cpr extension), FUN_234870 (fopen rb 0x2348b3, 12-byte RIFF header 0x234927, form AMS! or CXME 0x234937-0x23494b else Cartridge Load Error (Header) 0x2349a0, chunk loop 0x234bad with truncated file! 0x234d20, cbNN bank number 0x234eb0, 16 KB bank read 0x235010-0x235042)" note: "464plus/6128plus/GX-4000 system cartridge, French, firmware version 4." - name: Amstrad_s4.cpr @@ -257,7 +267,7 @@ files: size: 131156 md5: 6eeed3fdd4abc98a2a932da810410128 sha1: 05fb14df24b2b504a3ae463a086f02f0adcc07b9 - source_ref: "AceDL 2026/10/16: private/firmware, cartridge requester root, CPR loader" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a30a0 0x2a31ae (.cpr extension), FUN_234870 (fopen rb 0x2348b3, 12-byte RIFF header 0x234927, form AMS! or CXME 0x234937-0x23494b else Cartridge Load Error (Header) 0x2349a0, chunk loop 0x234bad with truncated file! 0x234d20, cbNN bank number 0x234eb0, 16 KB bank read 0x235010-0x235042)" note: "464plus/6128plus/GX-4000 system cartridge, Spanish, firmware version 4." # -- Plugin ROMs -- @@ -266,36 +276,44 @@ files: system: amstrad-cpc required: false bundled: true - size: 8192 + min_size: 8192 + validation: [size] md5: 4c9f014e91d407cc6509fad0095ab909 sha1: 1431ec628d38f000715545dd2186b684c5fe5a6f - source_ref: "AceDL 2026/10/16: private/multiface2/multiface2.rom, read when PLUGIN_MULTIFACE2=1" - note: "Romantic Robot Multiface Two ROM. The plugin loads without it." + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a4840 0x2a735b-0x2a73c3 (PLUGIN_MULTIFACE2 into 0x50c410), 0x2a767b-0x2a7685, 0x2ac38a FUN_3aa850 (sprintf %sprivate/multiface2/multiface2.rom 0x3aa87b, fopen rb 0x3aa88c, missing returns uninstalled 0x3aa894, fread 0x2000 0x3aa8ad, short read clears the flag 0x3aa8ba, hooks installed 0x3aa8e0-0x3aa955); FUN_345230 0x346086 (-plugin multiface2), FUN_2989f0 0x29934c-0x299358" + note: >- + Romantic Robot Multiface Two ROM. Without it the plugin is not + installed, a file shorter than 8 KB also clears PLUGIN_MULTIFACE2. - name: hackit400uk.rom path: "private/hacker/hackit400uk.rom" system: amstrad-cpc required: false bundled: true - size: 16384 + min_size: 16384 + validation: [size] md5: 9a293eaaebca601f671070ad56cb81b6 sha1: 56306e7234bcffd14b4f977d42d237c4ad9c12d5 - source_ref: "AceDL 2026/10/16: private/hacker/hackit400uk.rom, read when PLUGIN_HACKER=1" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a4840 0x2a743d-0x2a74a5 (PLUGIN_HACKER into 0x50c40c), 0x2a74ae-0x2a7516 (PLUGIN_HACKERFR into 0x50c408), 0x2a769b-0x2a76a3, 0x2ac36c FUN_3adac0 (0x3adaf1 %sprivate/hacker/hackit400uk.rom when PLUGIN_HACKERFR=0, fopen rb 0x3adb1d, missing returns uninstalled 0x3adb28, fread 0x4000 0x3adb3e, short read clears PLUGIN_HACKER 0x3adb4b)" note: >- - HackIt 4.00 by Siren Software, English, UK flavour of the Hacker plugin. + HackIt 4.00 by Siren Software, English, read when PLUGIN_HACKERFR is 0. + Without it the plugin is not installed, a file shorter than 16 KB also + clears PLUGIN_HACKER. - name: hacker481fr.rom path: "private/hacker/hacker481fr.rom" system: amstrad-cpc required: false bundled: true - size: 16384 + min_size: 16384 + validation: [size] md5: dfdd9924295f491d54f30569874287f8 sha1: 0c15d6753cf0ae2a1737b6e857e8e82ee135a697 - source_ref: "AceDL 2026/10/16: private/hacker/hacker481fr.rom, read when PLUGIN_HACKER=1 and PLUGIN_HACKERFR=1" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a4840 0x2a74ae-0x2a7516 (PLUGIN_HACKERFR into 0x50c408), 0x2a769b-0x2a76a3, 0x2ac36c FUN_3adac0 (0x3adafb-0x3adaff %sprivate/hacker/hacker481fr.rom when PLUGIN_HACKERFR=1, fopen rb 0x3adb1d, missing returns uninstalled 0x3adb28, fread 0x4000 0x3adb3e, short read clears PLUGIN_HACKER 0x3adb4b)" note: >- Le Hackeur 4.81, the French edition of the same Siren Software ROM, - French flavour of the Hacker plugin. + read when PLUGIN_HACKERFR is 1. Without it the plugin is not + installed, a file shorter than 16 KB also clears PLUGIN_HACKER. - name: ym2608_adpcm_rom.bin path: "private/sounds/ym2608_adpcm_rom.bin" @@ -304,9 +322,9 @@ files: size: 8192 md5: 8740932cda05e518a9955f1d08d6786f sha1: 50b6c3e288eaa12ad275d4f323267bb72b0445df - source_ref: "AceDL 2026/10/16: private/sounds/ym2608_adpcm_rom.bin, read when PLUGIN_PLAY2CPC=1" + source_ref: "AceDL 2026/10/16 linux-x64 FUN_2a4840 0x2a7584-0x2a758c (PLUGIN_PLAY2CPC flag 0x50c46c), 0x2ac31a FUN_3a7820, 0x3a7849 FUN_3ae520, FUN_3ae340 (sprintf %sprivate/sounds/ym2608_adpcm_rom.bin 0x3ae3d1, fopen rb 0x3ae3f1, missing prints Warning not found 0x3ae4ed-0x3ae505 and continues, whole file read by ftell size 0x3ae402-0x3ae463); FUN_345230 0x345a29 (-plugin play2cpc)" note: >- YM2608 internal ADPCM rhythm ROM used by the Play2CPC cartridge sound. Missing file prints "Warning: ym2608_adpcm_rom.bin not found!" and the - plugin keeps running. Shipped in the Linux and Raspberry Pi packages, - absent from the Windows package. + plugin keeps running. The whole file is read, its length is not + checked. Absent from the Windows x64 package. diff --git a/emulators/advanced_drastic.yml b/emulators/advanced_drastic.yml index 0122152f0..8c673f0ab 100644 --- a/emulators/advanced_drastic.yml +++ b/emulators/advanced_drastic.yml @@ -29,14 +29,16 @@ systems: mode: standalone notes: | - trngaje's package around the closed-source 64-bit Linux DraStic, whose - screen output, input and settings menu it replaces through a hooked SDL2 - build (trngaje/SDL_drastic) and the drastic_layout library. The repository - carries the DraStic binary itself, md5 59a7711eff41c640b8861b4d869c747d, - which announces "Version r2.5.2.0", together with its system, config, - resources and microphone directories, game_database.xml and usrcheat.dat. - launch.sh changes to its own directory and runs ./drastic on the content. - ref: README.md:1-12, launch.sh:1-9, drastic r2.5.2.0 0x135990 + trngaje's package around the closed-source 64-bit Linux DraStic. The + repository carries the DraStic binary itself, md5 59a7711eff41c640b8861b4d869c747d + (sha256 6e11511907f21888), stripped, which draws "Version r2.5.2.0" in its + menu, together with its system, config, resources and microphone + directories, game_database.xml and usrcheat.dat. launch.sh puts libs/ under + its own directory on LD_LIBRARY_PATH, changes to that directory and runs + ./drastic on the content, so that directory is the root every path below is + joined to. + ref: launch.sh:1-9, + drastic r2.5.2.0 FUN_93140 0x931b4-0x931cc (draws the version string) KNULLI builds this revision, installs the whole tree under /usr/share/advanced_drastic, copies it to @@ -55,11 +57,20 @@ notes: | system files." It carries neither the firmware editor's nds_firmware_modified.bin nor game_database_user.xml. The root also serves game_database.xml, usrcheat.dat, microphone/.wav then - microphone/microphone.wav, drastic_dldi.img for homebrew and the - drastic_logo_.raw splash. - ref: drastic r2.5.2.0 0x131018-0x1310f8, drastic r2.5.2.0 0x12fa18, - drastic r2.5.2.0 0x12fce0, drastic r2.5.2.0 0x132128-0x132260, - drastic r2.5.2.0 0x132a90-0x132aa8, drastic r2.5.2.0 0x1359b8 + microphone/microphone.wav, scripts/.lua then scripts/default.lua, + cheats/.cht, slot2/.gba, drastic_dldi.img for homebrew and the + drastic_logo_.raw splash. The functions are unnamed and are matched to + their r2.5.2.2 names by the strings and calls they share: FUN_fbd0 is + load_system_file, FUN_1e7e0 initialize_memory, FUN_10920 initialize_system, + FUN_84640 initialize_gamecard, FUN_86cf0 initialize_game_database, FUN_94650 + load_cheat_directory, FUN_81720 reset_spu, FUN_839d0 load_nds, FUN_951e0 + load_custom_cheats, FUN_82c50 gamecard_load_gba, FUN_82480 + gamecard_initialize_homebrew and FUN_93360 load_logo. + ref: drastic r2.5.2.0 FUN_fbd0 0xfc18-0xfd04, drastic r2.5.2.0 FUN_1e7e0 0x1ed78-0x1ef6c, + drastic r2.5.2.0 FUN_10920 0x10ab8-0x10b84, drastic r2.5.2.0 FUN_84640 0x84678-0x846d0, + drastic r2.5.2.0 FUN_81720 0x819c8-0x81a78, drastic r2.5.2.0 FUN_839d0 0x83c30-0x83cd0, + drastic r2.5.2.0 FUN_951e0 0x952a4-0x952c4, drastic r2.5.2.0 FUN_82c50 0x82c98-0x82cdc, + drastic r2.5.2.0 FUN_82480 0x824f4-0x825ac, drastic r2.5.2.0 FUN_93360 0x933b8-0x93400 files: - name: nds_bios_arm9.bin @@ -73,7 +84,7 @@ files: validation: [size] description: "Nintendo DS ARM9 BIOS" note: "First candidate for the ARM9 slot, before the free replacement. The hashes are those of the copy the repository ships." - source_ref: "drastic r2.5.2.0 0x131018, drastic r2.5.2.0 0x12fa18, drastic r2.5.2.0 0x135a5a" + source_ref: "drastic r2.5.2.0 FUN_1e7e0 0x1ed78-0x1ed94 (FUN_fbd0 of nds_bios_arm9.bin for 0x1000 bytes, failure branches to 0x1eea4), FUN_fbd0 0xfc18-0xfca4 (sprintf %s%csystem%c%s, fopen rb, fseek and ftell length compared to the requested size, fread), 0xfcec-0xfd04 (wrong size message, returns -1), FUN_10920 0x10ab8-0x10b84 (a negative return from FUN_1e7e0 draws the missing BIOS screen through FUN_93ae0, prints FATAL: Could not load system files. and quits)" - name: drastic_bios_arm9.bin sha1: 4dc29a1560e1cbd7afef1998f7a6c25c5db1cc3a @@ -85,7 +96,7 @@ files: size: 4096 validation: [size] description: "DraStic free ARM9 BIOS replacement" - source_ref: "drastic r2.5.2.0 0x131070" + source_ref: "drastic r2.5.2.0 FUN_1e7e0 0x1eea4-0x1eec8 (logs Can't find Nintendo ARM9 BIOS, then FUN_fbd0 of drastic_bios_arm9.bin for 0x1000 bytes), 0x1eecc-0x1eeec (sets the free ARM9 bit), 0x1f160 (failure returns -1)" - name: nds_bios_arm7.bin path: system/nds_bios_arm7.bin @@ -98,7 +109,7 @@ files: validation: [size] description: "Nintendo DS ARM7 BIOS" note: "First candidate for the ARM7 slot. The hashes are those of the copy the repository ships." - source_ref: "drastic r2.5.2.0 0x131088, drastic r2.5.2.0 0x135a7b" + source_ref: "drastic r2.5.2.0 FUN_1e7e0 0x1ed9c-0x1edb8 (FUN_fbd0 of nds_bios_arm7.bin for 0x4000 bytes, failure branches to 0x1eefc), 0x1eed8-0x1eef8 (same load on the path that took the free ARM9 image)" - name: drastic_bios_arm7.bin sha1: 31ae916c85d012582c7cdf47de6943ac6778253b @@ -110,7 +121,7 @@ files: size: 16384 validation: [size] description: "DraStic free ARM7 BIOS replacement" - source_ref: "drastic r2.5.2.0 0x1310e0" + source_ref: "drastic r2.5.2.0 FUN_1e7e0 0x1eefc-0x1ef20 (logs the fallback message, then FUN_fbd0 of drastic_bios_arm7.bin for 0x4000 bytes), 0x1f160 (failure returns -1)" - name: nds_firmware.bin path: system/nds_firmware.bin @@ -124,7 +135,7 @@ files: validation: [size] description: "Nintendo DS firmware" note: "The hashes are those of the copy the repository ships." - source_ref: "drastic r2.5.2.0 0x1310f8" + source_ref: "drastic r2.5.2.0 FUN_1e7e0 0x1edc0-0x1eddc, 0x1ef30-0x1ef50 (FUN_fbd0 of nds_firmware.bin for 0x40000 bytes), 0x1ef54-0x1ef6c (on failure the region is zeroed and FUN_1e250 writes the firmware header, then the boot carries on)" - name: game_database.xml path: game_database.xml @@ -135,7 +146,7 @@ files: size: 1610336 sha1: 7b84fef16d1d461a49c197709d174eb1ccd8f88d description: "save type database, one entry per title" - source_ref: "drastic r2.5.2.0 0x132a90, drastic r2.5.2.0 0x133468" + source_ref: "drastic r2.5.2.0 FUN_84640 0x84678-0x846a0 (sprintf %s%cgame_database.xml, then FUN_86cf0), FUN_86cf0 0x86d18-0x86d30 (fopen rb), 0x87684-0x8769c (a failed open logs Error: could not load game database file and returns)" - name: usrcheat.dat path: usrcheat.dat @@ -146,7 +157,7 @@ files: size: 13739796 sha1: 6dd1a5399403f39620061556d61f5c6f6c704219 description: "Action Replay cheat library" - source_ref: "drastic r2.5.2.0 0x132aa8" + source_ref: "drastic r2.5.2.0 FUN_84640 0x846a8-0x846d0 (sprintf %s%cusrcheat.dat, then FUN_94650), FUN_94650 0x94680-0x9468c (fopen rb), 0x946cc-0x94704 (header read, Invalid cheat database header and close on a mismatch)" - name: microphone.wav path: microphone/microphone.wav @@ -158,4 +169,79 @@ files: sha1: ea9281c65ea39c9d1061a05b8b15d9a44f92918e description: "default fake microphone input" note: "Played when the game asks for the microphone and no microphone/.wav exists." - source_ref: "drastic r2.5.2.0 0x132128-0x132190" + source_ref: "drastic r2.5.2.0 FUN_81720 0x81a40-0x81a78 (sprintf %s%cmicrophone%cmicrophone.wav, FUN_7f220 loads it, Loaded default fake microphone audio file), FUN_7f220 0x7f250-0x7f28c (fopen rb, length by fseek and ftell)" + + - name: ".wav" + path: "microphone/.wav" + system: nintendo-ds + required: false + category: game_data + description: "per-title fake microphone input" + note: "Tried before microphone.wav and named after the running title." + source_ref: "drastic r2.5.2.0 FUN_81720 0x819c8-0x81a0c (sprintf %s%cmicrophone%c%s.wav, FUN_7f220 loads it, Loaded game specific fake microphone audio file)" + + - name: ".lua" + path: "scripts/.lua" + required: false + category: game_data + description: "per-title Lua script" + note: "Tried before default.lua and named after the running title." + source_ref: "drastic r2.5.2.0 FUN_839d0 0x83c30-0x83c8c (sprintf %s%c%s%c%s.%s with scripts and lua, Attempting to load lua script, FUN_99850), FUN_99850 0x99884 (luaL_loadfilex of the path), 0x998a4 (lua_pcallk)" + + - name: default.lua + path: scripts/default.lua + required: false + category: game_data + unsourceable: "script the user writes against the built-in Lua 5.3 interpreter" + description: "fallback Lua script" + note: "Loaded when no per-title script answers." + source_ref: "drastic r2.5.2.0 FUN_839d0 0x83ca4-0x83cd8 (sprintf %s%c%s%cdefault.%s, then FUN_99850, which hands it to luaL_loadfilex at 0x99884)" + + - name: ".cht" + path: "cheats/.cht" + system: nintendo-ds + required: false + category: game_data + description: "custom cheat file" + note: "Read on top of the entries usrcheat.dat holds and written back when a cheat is toggled. Absent, the message No custom cheat file is logged." + source_ref: "drastic r2.5.2.0 FUN_951e0 0x952a4-0x952e0 (sprintf %s%ccheats%c%s.cht, fopen rb, No custom cheat file at %s), FUN_957e0 0x95824-0x95850 (same path opened wb)" + + - name: ".gba" + path: "slot2/.gba" + system: nintendo-ds + required: false + category: game_data + unsourceable: "Game Boy Advance cartridge the title reads for bonus content" + description: "slot 2 cartridge image" + note: "Loaded into the slot 2 cart window, with its save read from slot2/.sav beside it." + source_ref: "drastic r2.5.2.0 FUN_82c50 0x82c98-0x82cdc (snprintf %s%cslot2%c%s.gba, fopen rb), 0x82d08-0x82d6c (length by fseek and ftell, read whole), 0x82dd0-0x82dec (slot2/.sav opened rb)" + + - name: drastic_dldi.img + path: drastic_dldi.img + system: nintendo-ds + required: false + category: game_data + unsourceable: "FAT image the user builds for the emulated flashcart" + description: "R4 flashcart disk image" + note: "Opened read-write when a homebrew title is recognised and mounted as the fat:/ device. Absent, the error is logged and the title runs without a card." + source_ref: "drastic r2.5.2.0 FUN_82480 0x824a4-0x824cc (Homebrew recognized), 0x824f4-0x82518 (sprintf %s%cdrastic_dldi.img, open O_RDWR), 0x825a4-0x825b0 (perror Couldn't load drastic_dldi.img, then carries on)" + + - name: drastic_logo_0.raw + path: drastic_logo_0.raw + required: false + category: game_data + size: 120000 + validation: [size] + description: "boot splash, first of two" + note: "Read from the root in one 120000 byte request, so a shorter file is rejected. The index is the low bit of the time and a missing file skips the splash. The repository ships neither." + source_ref: "drastic r2.5.2.0 FUN_93360 0x93398-0x933d8 (index time() & 1, sprintf %s%cdrastic_logo_%d.raw, fopen rb), 0x933e0-0x93410 (fread of 0x1d4c0 bytes as one item, buffer freed when the read falls short)" + + - name: drastic_logo_1.raw + path: drastic_logo_1.raw + required: false + category: game_data + size: 120000 + validation: [size] + description: "boot splash, second of two" + note: "Same read as index 0." + source_ref: "drastic r2.5.2.0 FUN_93360 0x93398-0x933d8, 0x933e0-0x93410" diff --git a/emulators/amiberry-5.6.5.yml b/emulators/amiberry-5.6.5.yml index 8671ce5eb..5db40d55e 100644 --- a/emulators/amiberry-5.6.5.yml +++ b/emulators/amiberry-5.6.5.yml @@ -32,6 +32,13 @@ systems: standalone_directories: - "getcwd" - "rom_path = kickstarts" +config_reads: + - file: "*.uae" + source_ref: "src/main.cpp:926-934" + keys: + - key: "kickstart_rom_file" + source_ref: "src/cfgfile.cpp:6050, src/memory.cpp:1907-1916" + notes: | Amiberry 5.6.5 (src/osdep/target.h:27). Every folder it reads is below its start path: $EXTERNAL_FILES_DIR or $XDG_DATA_HOME when either holds a diff --git a/emulators/amiberry-7.1.1.yml b/emulators/amiberry-7.1.1.yml index c617c4df7..fc433e525 100644 --- a/emulators/amiberry-7.1.1.yml +++ b/emulators/amiberry-7.1.1.yml @@ -43,6 +43,15 @@ standalone_directories: - "AMIBERRY_HOME_DIR/roms" - "~/Amiberry/roms" - "whdboot_path = whdboot" +config_reads: + - file: "*.uae" + source_ref: "src/main.cpp:986-994" + keys: + - key: "kickstart_rom_file" + source_ref: "src/cfgfile.cpp:6122, src/memory.cpp:1974-1983" + - key: "$(FILE_PATH)" + source_ref: "src/cfgfile.cpp:389" + notes: | Amiberry 7.1.1 (CMakeLists.txt:3-4). The ROM path is rom_path in amiberry.conf, else roms/ below the home directory: $AMIBERRY_HOME_DIR, diff --git a/emulators/arcadeflashweb.yml b/emulators/arcadeflashweb.yml index db394d5ad..9c5477947 100644 --- a/emulators/arcadeflashweb.yml +++ b/emulators/arcadeflashweb.yml @@ -181,8 +181,9 @@ files: bundled: true description: "Adobe Flash Access blob shipped with the runtime" note: >- - Named in the Flash library's own string table next to PepperFlashPlayer. + The Flash library joins its own directory and pepper.vch and hands the + path, with the name PepperFlashPlayer, to its Flash Access DRM callback. PKCS#7 over 446144 opaque bytes, signed through the Adobe Flash Access chain under subject CN AdobeIV-202002031156. It carries DRM material and no plain SWF needs it. - source_ref: "ArcadeFlashWeb v1.0.2 pepflashplayer.dll string table" + source_ref: "pepflashplayer.dll 32.0.0.371 (ArcadeFlashWeb v1.0.2, sha256 2b37e916199e1ef8) 0x104777be-0x104777d5 (plugin directory path joined with pepper.vch at 0x104777cb), 0x10477ca5-0x10477d3d (callback 0x10477c85 returns that path and PepperFlashPlayer), 0x104772a9 (callback stored in the DRM host table)" diff --git a/emulators/ares.yml b/emulators/ares.yml index 8f991ad13..35623cf00 100644 --- a/emulators/ares.yml +++ b/emulators/ares.yml @@ -56,6 +56,49 @@ systems: - zx-spectrum - zx-spectrum-128 +config_reads: + - file: "settings.bml" + source_ref: "desktop-ui/desktop-ui.cpp:9-35, 100-103, 114, desktop-ui/settings/settings.cpp:31-42, 263-286, nall/nall/path.cpp:123-142" + keys: + - key: "ColecoVision/Firmware/BIOS.World" + source_ref: "desktop-ui/emulator/colecovision.cpp:10-12, 42-50, mia/system/colecovision.cpp:7-9" + - key: "MSX/Firmware/BIOS.Japan" + source_ref: "desktop-ui/emulator/msx.cpp:16-19, 44-53" + - key: "FamicomDiskSystem/Firmware/BIOS.Japan" + source_ref: "desktop-ui/emulator/famicom-disk-system.cpp:17-19, 89-97" + - key: + - "Nintendo64DD/Firmware/BIOS.Japan" + - "Nintendo64DD/Firmware/BIOS.US" + - "Nintendo64DD/Firmware/BIOS.DEV" + source_ref: "desktop-ui/emulator/nintendo-64dd.cpp:15-19, 59-73" + condition: "the game's region" + - key: "GameBoyAdvance/Firmware/BIOS.World" + source_ref: "desktop-ui/emulator/game-boy-advance.cpp:12-14, 55-63" + - key: + - "MasterSystem/Firmware/BIOS.US" + - "MasterSystem/Firmware/BIOS.Japan" + - "MasterSystem/Firmware/BIOS.Europe" + source_ref: "desktop-ui/emulator/master-system.cpp:12-16, 93-107" + condition: "the game's region" + - key: "GameGear/Firmware/BIOS.World" + source_ref: "desktop-ui/emulator/game-gear.cpp:10-12, 30-40" + - key: + - "MegaCD/Firmware/BIOS.US" + - "MegaCD/Firmware/BIOS.Japan" + - "MegaCD/Firmware/BIOS.Europe" + source_ref: "desktop-ui/emulator/mega-cd.cpp:15-19, 63-77" + condition: "the disc's region" + - key: "NeoGeoPocket/Firmware/BIOS.World" + source_ref: "desktop-ui/emulator/neo-geo-pocket.cpp:10-12, 32-40" + - key: "NeoGeoPocketColor/Firmware/BIOS.World" + source_ref: "desktop-ui/emulator/neo-geo-pocket-color.cpp:10-12, 32-40" + - key: + - "PlayStation/Firmware/BIOS.US" + - "PlayStation/Firmware/BIOS.Japan" + - "PlayStation/Firmware/BIOS.Europe" + source_ref: "desktop-ui/emulator/playstation.cpp:19-23, 87-101" + condition: "the disc's region" + notes: | Multi-system emulator by Near (byuu), successor to higan/bsnes. Focuses on accuracy and preservation. 40 emulators registered at this pin diff --git a/emulators/armsx2.yml b/emulators/armsx2.yml index 5ee879e61..10de74fdc 100644 --- a/emulators/armsx2.yml +++ b/emulators/armsx2.yml @@ -48,6 +48,25 @@ data_root: source_ref: "source pcsx2/Pcsx2Config.cpp:2523-2530, pcsx2/Pcsx2Config.cpp:2540-2560, pcsx2/Pcsx2Config.cpp:2567-2589" note: "portable.ini or portable.txt beside the binary makes its folder the root" +pin_build: + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/armsx2-sa/package.mk" + variable: PKG_VERSION + value: "19c83bf065ed21a19d8c46a1f578e37d2dab8efd" +config_reads: + - file: "PCSX2.ini" + platforms: [rocknix] + source_ref: "pcsx2-qt/QtHost.cpp:1307, 1325-1331, pcsx2/Pcsx2Config.cpp:2398-2491, pcsx2/VMManager.cpp:630-641" + keys: + - key: "[Folders] Bios" + source_ref: "pcsx2/Pcsx2Config.cpp:2514-2524" + condition: "[UI] SettingsVersion 1, else the ini is reset (pcsx2-qt/QtHost.cpp:1331-1342)" + - key: "[Filenames] BIOS" + source_ref: "pcsx2/Pcsx2Config.cpp:1879-1881, 2258-2264, pcsx2/ps2/BiosTools.cpp:258-282, 333-348, pcsx2/VMManager.cpp:1638" + condition: "empty: the first PS2 BIOS of 4 to 8 MB found in [Folders] Bios" + notes: | PlayStation 2 emulator, a GPL-3.0 fork of PCSX2 that replaces the x86-64 only EE, IOP, VU and vtlb fast memory recompilers with native AArch64 ones. One tree diff --git a/emulators/capriceforever.yml b/emulators/capriceforever.yml index aa49293db..602f8b1b4 100644 --- a/emulators/capriceforever.yml +++ b/emulators/capriceforever.yml @@ -20,20 +20,40 @@ notes: | Closed source Amstrad CPC and PLUS emulator for Windows. The build read here is the one RetroBat installs, capriceforever.7z sha256 54c9f7f3df96011bdbd09e72413fed798a395c241e8c2d05eb6af075a15b79b4, release - 26.4 of 1 April 2026 (History.txt, version resource 26.4.0.0). Caprice.exe - md5 a33e841c80e9fd9067a1c373492cd53b is a 32-bit Delphi program, cited by - file offset. + 26.4 (version resource 26.4.0.0). Caprice.exe + md5 a33e841c80e9fd9067a1c373492cd53b is a 32-bit C++Builder (RAD Studio + 28.0) VCL program, cited by virtual address. Functions are named by their + address, or by the published method table entry for form event handlers. - The machine ROMs are compiled into the executable as named defaults. The - 464, 664 and 6128 OS and BASIC, AMSDOS and the Multiface Two ROM sit in the - data section byte for byte equal to the usual dumps (os464.rom at 0x7f5348, - basic464.rom at 0x7f9348, os6128.rom at 0x80d348, basic6128.rom at 0x811348, - os664.rom at 0x815348, basic664.rom at 0x819348, amsdos.rom at 0x7e1348, - the first 8 KiB of MF2.rom at 0x821348). A slot left blank in a device file - takes the built-in image, and the names "Default OS", "Default BASIC", - "Default AMSDOS", "Default Multiface Two", "Default Silicon Disc 1.3" and - "Default DK'Tronics Speech" select them explicitly. - ref: Caprice.exe 0x75d82c, 0x7314ad, 0x75d864, 0x75d884, 0x75d8a0 + The machine ROMs are RT_RCDATA resources of the executable. None of them + is read from disc, so none is a file entry below. Each resource, with the + sha1 of its bytes and the dump it equals: + + ROMCPC464_UK 32 KiB 56d39c463da6 cpc464.rom, os464.rom + basic464.rom + ROMCPC664_UK 32 KiB 073a7665527b cpc664.rom, os664.rom + basic664.rom + ROMCPC6128_UK 32 KiB 5977adbad3f7 cpc6128.rom, os6128.rom + basic6128.rom + ROMCPC464_FR 32 KiB c68d84f37ab9 OS464_FR.rom of ACE-DL + ROMCPC6128_FR 32 KiB 200d59076dfe OS6128_FR.rom of ACE-DL, CPC6128.ROM.FR of CPCemu + ROMCPC6128_SP 32 KiB 1acd01c2c034 OS6128_S.rom of ACE-DL, CPC6128.ROM.ES of CPCemu + ROMCPC464_SP 32 KiB 6291af67cb34 Spanish 464, same BASIC half as ROMCPC464_FR + ROMAmsdos 16 KiB 39102c8e9cb5 amsdos.rom + ROMMultiface2 8 KiB 1431ec628d38 multiface2.rom of ACE-DL and CPCemu + ROMDKSpeech 16 KiB bf28e07d5fad dkspeech.rom of MAME + ROMSiliconDisk13 16 KiB 932bc3bbe38a no other profile lists it + + A slot left blank in a device file takes the built-in image, + and the names "Default OS", "Default BASIC", "Default AMSDOS", "Default + Multiface Two", "Default Silicon Disc 1.3" and "Default DK'Tronics Speech" + select them explicitly. + ref: Caprice.exe 26.4.0.0 FUN_006fa870 0x6faff6-0x6fb036 (TResourceStream + of ROMCPC464_UK, type 0xa), 0x6fba6e-0x6fbaa9 (ROMAmsdos), + 0x6fc0fc-0x6fc109 (ROMSiliconDisk13), 0x6fc168-0x6fc18f (ROMDKSpeech), + FUN_006fd4c0 0x6feae9-0x6feb6a (LowerROM compared to Default OS), + 0x6fde23-0x6fde70 (Default Silicon Disc, DK'Tronics, Empty and + AMSDOS names taken for the upper slot loop), 0x6fe839-0x6fe8b7 and 0x6fef2f-0x6fef65 + (Default Multiface Two, TResourceStream of ROMMultiface2), + FUN_0074ebe4 0x74f95c-0x74fab5 (Default OS, BASIC and AMSDOS as the + initial slot values) RetroBat writes Device.ini on every launch: CPC_6128_UK, or PLUS_6128_UK for the gx4000 system, LowerROM and UpperROM0 blank, UpperROM7 "Default @@ -42,13 +62,24 @@ notes: | nothing outside the program is read for a RetroBat launch. ref: emulatorLauncher Generators/CapriceForever.Generator.cs:277-405 - Files in Roms\ (16512 bytes, a 128 byte AMSDOS header then the 16 KiB - image) are offered by name for the lower and upper ROM slots, and .cpr - files in Cartridges\ for the cartridge port. The package ships four ROMs + Files of 1 to 16512 bytes in RomsDirectory (Roms\ by default) are offered + by name for the lower and upper ROM slots. A slot file whose first 128 + bytes are an AMSDOS header with a valid checksum is read from offset 128 + for its declared length, at most 16 KiB, and any other file is used as is. + A missing file is skipped and nothing is copied into the slot. The cartridge is + chosen through an open dialog filtered on *.cpr, and a CartridgeFilename + without a directory is looked up in CartridgesDirectory (Cartridges\ by + default). A RIFF AMS! file is split by its cb chunks into 16 KiB banks, + any other file into consecutive 16 KiB banks. The package ships four ROMs and three PLUS system cartridges there. Only the bundled device template "PLUS 6128 UK.ini" names one of them (the UK cartridge), and RetroBat replaces that choice with the launched game. - ref: Caprice.exe 0x72fb01, 0x7332cb, 0x726d86 + ref: Caprice.exe 26.4.0.0 FUN_0074ebe4 0x74f621 (Roms\ default), + FUN_0072483c 0x740f0f-0x740f35 (Roms\ when the configured folder is + missing), 0x73e0b5 (RomsDirectory key), 0x73e481 (CartridgesDirectory + key), FUN_0059fc34 0x5a0e55-0x5a0ef5 (size filter), + FUN_007000f8 0x7001e6-0x700274 (AMSDOS header), + FUN_0071c58c 0x71ca9d-0x71cb48 (cartridge parsing) files: - name: "Burnin' Rubber + BASIC (UK).cpr" @@ -60,7 +91,7 @@ files: sha1: "405e341437fab8db477606238af0c20eca2e39ee" md5: "39b565e648172980aa552293e667070f" description: "Amstrad PLUS system cartridge, English" - source_ref: "Caprice.exe 0x7332cb, 0x726d86" + source_ref: "Caprice.exe 26.4.0.0 settings loader FUN_0072483c 0x73e829-0x73e858 (Roms section, CartridgeFilename key), FUN_006fd1a8 0x6fd1f1-0x6fd361 (a name without directory is prefixed with CartridgesDirectory), 0x6fd394 (cartridge loader called), FUN_0071c58c 0x71c956-0x71c9d0 (FileOpen, whole file read), 0x71ca9d-0x71cac5 (RIFF and AMS! test), 0x71cb85-0x71cc46 (cb chunks copied to 16 KiB banks), 0x71cacb-0x71cb48 (any other file split into 16 KiB banks), TFormEmulatorSettings.PanelButtonCartridgeFileClick 0x5aa26a-0x5aa2d1 (open dialog filtered on *.cpr)" note: "Named by the bundled Settings/PLUS 6128 UK.ini template." - name: "Burnin' Rubber + BASIC (FR).cpr" @@ -72,7 +103,7 @@ files: sha1: "958437ad6292ecd368e8c6c963cb3ae7d48b9406" md5: "2adf22a2046a18bd39de90ad01c15998" description: "Amstrad PLUS system cartridge, French" - source_ref: "Caprice.exe 0x7332cb, 0x726d86" + source_ref: "Caprice.exe 26.4.0.0 settings loader FUN_0072483c 0x73e829-0x73e858 (Roms section, CartridgeFilename key), FUN_006fd1a8 0x6fd1f1-0x6fd361 (a name without directory is prefixed with CartridgesDirectory), 0x6fd394 (cartridge loader called), FUN_0071c58c 0x71c956-0x71c9d0 (FileOpen, whole file read), 0x71ca9d-0x71cac5 (RIFF and AMS! test), 0x71cb85-0x71cc46 (cb chunks copied to 16 KiB banks), 0x71cacb-0x71cb48 (any other file split into 16 KiB banks), TFormEmulatorSettings.PanelButtonCartridgeFileClick 0x5aa26a-0x5aa2d1 (open dialog filtered on *.cpr)" - name: "Burnin' Rubber + BASIC (SP).cpr" path: "Cartridges/Burnin' Rubber + BASIC (SP).cpr" @@ -83,7 +114,7 @@ files: sha1: "076939a2cd7593b5e56c775d7a4752f2d138ff6c" md5: "75632137fcbe51eaec1f47a22e55d6a3" description: "Amstrad PLUS system cartridge, Spanish" - source_ref: "Caprice.exe 0x7332cb, 0x726d86" + source_ref: "Caprice.exe 26.4.0.0 settings loader FUN_0072483c 0x73e829-0x73e858 (Roms section, CartridgeFilename key), FUN_006fd1a8 0x6fd1f1-0x6fd361 (a name without directory is prefixed with CartridgesDirectory), 0x6fd394 (cartridge loader called), FUN_0071c58c 0x71c956-0x71c9d0 (FileOpen, whole file read), 0x71ca9d-0x71cac5 (RIFF and AMS! test), 0x71cb85-0x71cc46 (cb chunks copied to 16 KiB banks), 0x71cacb-0x71cb48 (any other file split into 16 KiB banks), TFormEmulatorSettings.PanelButtonCartridgeFileClick 0x5aa26a-0x5aa2d1 (open dialog filtered on *.cpr)" - name: "albireo.rom" path: "Roms/albireo.rom" @@ -94,7 +125,7 @@ files: sha1: "9dd652574638682876a55febe3dca7b5bb3ad222" md5: "9afe71e4c38040864576358a71474ab6" description: "Albireo ROM (AMSDOS header, title ALBIREO ROM)" - source_ref: "Caprice.exe 0x72fb01, 0x720ff1" + source_ref: "Caprice.exe 26.4.0.0 TFormEmulatorSettings.StringGridROMMappingSelectCell 0x5a386b (list builder FUN_0059fc34 called), FUN_0059fc34 0x5a08ab-0x5a0916 (FindFirst of RomsDirectory plus *.*), 0x5a0e55-0x5a0ef5 (FileOpen, FileSeek to the end, files of 1 to 16512 bytes added to ComboBoxAvailableROM), FUN_006fd4c0 0x6feae9-0x6febfa (LowerROM other than Default OS prefixed with RomsDirectory and loaded), 0x6fe3a7-0x6fe47b (UpperROM name prefixed with RomsDirectory, loaded, 0x4000 bytes copied to the bank), FUN_007000f8 0x700140-0x7001de (FileExists, FileOpen, whole file read), 0x7001e6-0x700274 (AMSDOS header: sum of bytes 0 to 0x42 against the word at 0x43, length at 0x40 capped at 0x4000, image taken from offset 0x80, any other file used as is)" - name: "unidos.rom" path: "Roms/unidos.rom" @@ -105,7 +136,7 @@ files: sha1: "e78a94ab8de917270179b80b071d3e90d98ea5dc" md5: "a9d1b46e49701c85d9a3a66ff725c6e6" description: "UniDOS ROM" - source_ref: "Caprice.exe 0x72fb01, 0x720ff1" + source_ref: "Caprice.exe 26.4.0.0 TFormEmulatorSettings.StringGridROMMappingSelectCell 0x5a386b (list builder FUN_0059fc34 called), FUN_0059fc34 0x5a08ab-0x5a0916 (FindFirst of RomsDirectory plus *.*), 0x5a0e55-0x5a0ef5 (FileOpen, FileSeek to the end, files of 1 to 16512 bytes added to ComboBoxAvailableROM), FUN_006fd4c0 0x6feae9-0x6febfa (LowerROM other than Default OS prefixed with RomsDirectory and loaded), 0x6fe3a7-0x6fe47b (UpperROM name prefixed with RomsDirectory, loaded, 0x4000 bytes copied to the bank), FUN_007000f8 0x700140-0x7001de (FileExists, FileOpen, whole file read), 0x7001e6-0x700274 (AMSDOS header: sum of bytes 0 to 0x42 against the word at 0x43, length at 0x40 capped at 0x4000, image taken from offset 0x80, any other file used as is)" - name: "unitools.rom" path: "Roms/unitools.rom" @@ -116,7 +147,7 @@ files: sha1: "982e523b2d5b5c9873526a7363fcac4cbc1b6dfd" md5: "83c6ecbf655b8f3c65e46a46c6bc7161" description: "UniTools ROM for UniDOS" - source_ref: "Caprice.exe 0x72fb01, 0x720ff1" + source_ref: "Caprice.exe 26.4.0.0 TFormEmulatorSettings.StringGridROMMappingSelectCell 0x5a386b (list builder FUN_0059fc34 called), FUN_0059fc34 0x5a08ab-0x5a0916 (FindFirst of RomsDirectory plus *.*), 0x5a0e55-0x5a0ef5 (FileOpen, FileSeek to the end, files of 1 to 16512 bytes added to ComboBoxAvailableROM), FUN_006fd4c0 0x6feae9-0x6febfa (LowerROM other than Default OS prefixed with RomsDirectory and loaded), 0x6fe3a7-0x6fe47b (UpperROM name prefixed with RomsDirectory, loaded, 0x4000 bytes copied to the bank), FUN_007000f8 0x700140-0x7001de (FileExists, FileOpen, whole file read), 0x7001e6-0x700274 (AMSDOS header: sum of bytes 0 to 0x42 against the word at 0x43, length at 0x40 capped at 0x4000, image taken from offset 0x80, any other file used as is)" - name: "fw-v3-u5.rom" path: "Roms/fw-v3-u5.rom" @@ -127,4 +158,4 @@ files: sha1: "bb9b4c487fa6e338d6b8f78b6fc10a3912263e22" md5: "96c5c16e8db2f5c7d6c3c160d686725a" description: "Firmware V3-U5 ROM (AMSDOS header title V3-U5 ROM)" - source_ref: "Caprice.exe 0x72fb01, 0x720fd8" + source_ref: "Caprice.exe 26.4.0.0 TFormEmulatorSettings.StringGridROMMappingSelectCell 0x5a386b (list builder FUN_0059fc34 called), FUN_0059fc34 0x5a08ab-0x5a0916 (FindFirst of RomsDirectory plus *.*), 0x5a0e55-0x5a0ef5 (FileOpen, FileSeek to the end, files of 1 to 16512 bytes added to ComboBoxAvailableROM), FUN_006fd4c0 0x6feae9-0x6febfa (LowerROM other than Default OS prefixed with RomsDirectory and loaded), 0x6fe3a7-0x6fe47b (UpperROM name prefixed with RomsDirectory, loaded, 0x4000 bytes copied to the bank), FUN_007000f8 0x700140-0x7001de (FileExists, FileOpen, whole file read), 0x7001e6-0x700274 (AMSDOS header: sum of bytes 0 to 0x42 against the word at 0x43, length at 0x40 capped at 0x4000, image taken from offset 0x80, any other file used as is)" diff --git a/emulators/chihiro-ds.yml b/emulators/chihiro-ds.yml index 138ffa88a..4ea1f9a9b 100644 --- a/emulators/chihiro-ds.yml +++ b/emulators/chihiro-ds.yml @@ -29,7 +29,10 @@ notes: | binaries carry "Chihiro-DS 1.0 (Mar 14 2025)". cxbxr-ldr.exe md5 d3675f7bb270072f33d9106497dd9bbc is the print DemulShooter lists for "Chihiro-DS 1.0". cxbxr-emu.dll (md5 62f492f14b2af4bef7329ef269355a78) is - cited by virtual address. + cited by virtual address. The package ships its cxbxr-emu.pdb (GUID + 7511A6DE-EA63-4F50-9FB8-AC9B37A49568, age 2, the values the DLL's debug + directory names), which gives the function names below. cxbx.exe is md5 + 7f59a0156a426fd4dfec6ee4e556648c with its matching cxbx.pdb. ref: emulatorLauncher Generators/Cxbx.Generator.cs:104-110, 202-214, emulatorLauncher Installer.cs:46 @@ -46,17 +49,26 @@ notes: | EmuDisk\Chihiro (this build predates the EmuMediaBoard folder). ref: CI-6f32d89 src/common/Settings.cpp:880-915, CI-6f32d89 src/common/FilePaths.cpp:82-109, - cxbxr-emu.dll 0x1061c648 + cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxrInitFilePaths 0x100cde5d-0x100cdf57 (data path + plus EmuDisk, filesystem::exists, created when absent), + JVS_Init 0x102c128a (data path plus EmuDisk Chihiro folder) A title is Chihiro when its XBE type says so or a boot.id sits beside it. - Launched directly, such a title needs the media board ROM: a missing file, - an unreadable one or one that is not 2 MB ends the run. When either SEGABOOT + Launched directly with a boot.id beside its XBE, a title needs the media + board ROM: a missing file, an unreadable one or one that is not 2 MB ends + the run. When either SEGABOOT file is missing both are rewritten from the two 1 MB halves of the ROM, then SEGABOOT_MBROM1.XBE is launched and boots the title. boot.id is read again by the media board for the region flags, and its absence ends the run. ref: CI-6f32d89 src/core/kernel/init/CxbxKrnl.cpp:517-586, CI-6f32d89 src/devices/chihiro/MediaBoard.cpp:46-57, - cxbxr-emu.dll 0x10623190, 0x1062b60c, 0x1062b618 + cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxrKrnlXbeSystemSelector 0x103e0fe9-0x103e105b (boot + flags zero and boot.id beside the XBE), 0x103e178f-0x103e1855 (XbeType + gives system 2, 4 or 8, filesystem::exists of xbeDirectory / boot.id + sets 8), 0x103e14c6-0x103e14cc + (CxbxLaunchNewXbe of SEGABOOT_MBROM1.XBE), MediaBoard::SetMountPath + 0x1041a468-0x1041a490 (fopen of the title path plus /boot.id), + 0x1041a56d (CxbxrAbortEx Could not open Chihiro boot.id) The four JVS base board images are memory mapped read/write when the system is Chihiro. Byte 0x1F00 of the QC firmware holds the board region and @@ -64,7 +76,11 @@ notes: | copy the package ships differs from the dump by that byte. ref: CI-6f32d89 src/core/hle/JVS/JVS.cpp:127-142, CI-6f32d89 src/core/hle/JVS/JVS.cpp:169-210, - CI-6f32d89 src/core/hle/JVS/JVS.cpp:246-262 + CI-6f32d89 src/core/hle/JVS/JVS.cpp:246-262, + cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxrKrnlInit 0x103e44cf-0x103e44d8 (JVS_Init called + when g_bIsChihiro is set), JVS_Init 0x102c2049-0x102c2081 (byte + 0x1F00 of the QC firmware tested against the boot.id region flags, + set to 2, 3 or 1) The package ships every file below except xboxdash.xbe and keys.bin. It also carries chihiro_xbox_bios.bin, ver1305.bin, 315-6215.bin, @@ -88,7 +104,7 @@ files: started, each failure ending the run. Read to write out the two SEGABOOT files when either is missing, and launched when a Chihiro title reboots with an empty launch path. - source_ref: "cxbxr-emu.dll 0x10624bb4, 0x10623190" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxrKrnlXbeSystemSelector 0x103e10bb-0x103e1139 (data path plus EmuDisk and MediaBoardRomFile, filesystem::exists), 0x103e1168-0x103e116f (CxbxrAbortEx could not be found), 0x103e1174-0x103e119e (fopen rb, abort on failure), 0x103e11ab-0x103e11da (fseek and ftell, abort unless 0x200000), HalReturnToFirmware 0x1030f09d-0x1030f0d7 (empty launch path with g_bIsChihiro set: Device prefix plus MediaBoardRomFile), 0x1030f15b (CxbxLaunchNewXbe)" - name: SEGABOOT_MBROM0.XBE path: "EmuDisk/Chihiro/SEGABOOT_MBROM0.XBE" @@ -103,7 +119,7 @@ files: Mounted as the mbrom0 device. Written from the first megabyte of the media board ROM when either SEGABOOT file is missing. The copy the package ships is that first megabyte. - source_ref: "cxbxr-emu.dll 0x10624b98" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) dynamic initializer for MediaBoardSegaBoot0 0x100c2457-0x100c246a, CxbxrKrnlXbeSystemSelector 0x103e11f0-0x103e122f (data path plus EmuDisk), 0x103e12ab-0x103e12cd (filesystem::exists, a miss starts the rewrite), 0x103e1363-0x103e137d (fopen wb), 0x103e13d8-0x103e13ff (fread then fwrite of the first 0x100000 bytes of the ROM), CxbxConvertFilePath 0x10408bdc-0x10408be1 (mbrom0 device mapped to this file)" - name: SEGABOOT_MBROM1.XBE path: "EmuDisk/Chihiro/SEGABOOT_MBROM1.XBE" @@ -120,7 +136,7 @@ files: SEGABOOT file is missing. The copy the package ships is not that half: it differs in 661005 bytes from the second megabyte of the ROM beside it. Hashes are those of the shipped copy. - source_ref: "cxbxr-emu.dll 0x10624b7c" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) dynamic initializer for MediaBoardSegaBoot1 0x100c24b7-0x100c24ca, CxbxrKrnlXbeSystemSelector 0x103e1246-0x103e1285 (data path plus EmuDisk), 0x103e12de-0x103e12f9 (filesystem::exists), 0x103e1380-0x103e139a (fopen wb), 0x103e1408-0x103e142f (fread then fwrite of the second 0x100000 bytes), 0x103e14c6-0x103e14cc (CxbxLaunchNewXbe), CxbxConvertFilePath 0x10408cc7-0x10408ccc (mbrom1 device mapped to this file)" - name: ic10_g24lc64.bin path: "EmuDisk/Chihiro/ic10_g24lc64.bin" @@ -136,7 +152,7 @@ files: opened. Byte 0x1F00 is dereferenced right after and rewritten to USA, export or Japan when the title's boot.id rejects the stored region. Hashes are those of the copy the package ships. - source_ref: "cxbxr-emu.dll 0x1061c648, 0x1061c620" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) JVS_Init 0x102c135d (name), 0x102c1576 (JVS_LoadFile), 0x102c15fa-0x102c15fe and 0x102c22a4-0x102c22b7 (CxbxrAbortEx Failed to load base board firmware), 0x102c2049-0x102c2081 (byte 0x1F00 read and rewritten), JVS_LoadFile 0x102c0ddd-0x102c0de7 (fopen rb), 0x102c0e14 (mio::make_mmap_sink, read/write mapping)" - name: pc20_g24lc64.bin path: "EmuDisk/Chihiro/pc20_g24lc64.bin" @@ -147,7 +163,7 @@ files: md5: "bf1cf24f8549137c0b1ad0fa61473c7e" description: "Base board SC microcontroller firmware" note: "Memory mapped read/write at JVS setup, the run ends when it cannot be opened." - source_ref: "cxbxr-emu.dll 0x1061c648, 0x1061c634" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) JVS_Init 0x102c13ae (name), 0x102c1706 (JVS_LoadFile), 0x102c178a-0x102c178e and 0x102c22c1-0x102c22d4 (CxbxrAbortEx Failed to load base board qc firmware), JVS_LoadFile 0x102c0ddd-0x102c0de7 (fopen rb), 0x102c0e14 (mio::make_mmap_sink, read/write mapping)" - name: ic11_24lc024.bin path: "EmuDisk/Chihiro/ic11_24lc024.bin" @@ -160,7 +176,7 @@ files: note: >- Memory mapped read/write at JVS setup, the run ends when it cannot be opened. Writes from JvsEEPROM_Write are synced to disk at once. - source_ref: "cxbxr-emu.dll 0x1061c648, 0x1061c688" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) JVS_Init 0x102c13ff (name), 0x102c189b (JVS_LoadFile), 0x102c191f-0x102c1923 and 0x102c22de-0x102c22f1 (CxbxrAbortEx Failed to load base board EEPROM), JVS_LoadFile 0x102c0ddd-0x102c0de7 (fopen rb), 0x102c0e14 (mio::make_mmap_sink, read/write mapping), EmuPatch_JvsEEPROM_Write 0x102c6275-0x102c629d (FlushViewOfFile and FlushFileBuffers after each write)" - name: backup_ram.bin path: "EmuDisk/Chihiro/backup_ram.bin" @@ -172,7 +188,7 @@ files: has_builtin: true size_note: "Created as 128 KB of zeros when absent, then memory mapped" description: "Base board backup memory" - source_ref: "cxbxr-emu.dll 0x1061c648, 0x1061c69c" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) JVS_Init 0x102c1439 (name), 0x102c1a1b (filesystem::exists), 0x102c1bee (fopen w when absent), 0x102c1ca4-0x102c1cbc (fseek 0x1ffff, fputc 0, fclose: a 128 KB file), 0x102c2300-0x102c2310 (CxbxrAbortEx Could not create Backup File), 0x102c1dba (JVS_LoadFile), 0x102c1e3e-0x102c1e42 and 0x102c231a-0x102c232a (CxbxrAbortEx Failed to load base board BACKUP RAM)" - name: xboxdash.xbe path: "EmuDisk/Partition2/xboxdash.xbe" @@ -183,7 +199,7 @@ files: Launched when an Xbox title reboots with an empty launch path and by the Open Dashboard menu entry. When it is missing the console's unrecoverable error screen is shown. - source_ref: "cxbxr-emu.dll 0x105f8c60" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) HalReturnToFirmware 0x1030f091-0x1030f103 (empty launch path with g_bIsChihiro clear: partition 2 path plus xboxdash.xbe), 0x1030f15b (CxbxLaunchNewXbe), Xbe::Xbe 0x1014d48a-0x1014d492 (fopen rb), 0x1014d5b4-0x1014d641 (on failure the file name is compared to xboxdash.xbe), 0x1014d6f2 (CxbxKrnlPrintUEM), and cxbx.exe Chihiro-DS 1.0 WndMain::OpenDashboard 0x4300fc (data location plus EmuDisk Partition2 xboxdash.xbe)" - name: EEPROM.bin path: "EEPROM.bin" @@ -194,14 +210,14 @@ files: md5: "6d497abbfb773a2e07f8ab71f2a2999d" has_builtin: true size: 256 - validation: [size] description: "Xbox EEPROM image" note: >- Opened at startup and mapped read/write, created with defaults when - absent, and a file that is not 256 bytes ends the run. Hashes are those of - the copy the package ships. RetroBat writes the language into it only for - the xbox system. - source_ref: "cxbxr-emu.dll 0x105f6084, 0x105f5d84" + absent. The file is cut or extended to 256 bytes before its size is read, + so the 256 byte check ends the run only when that resize fails. Hashes + are those of the copy the package ships. RetroBat writes the language + into it only for the xbox system. + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxrInitFilePaths 0x100ce4c4-0x100ce4f2 (snprintf of the data path and EEPROM.bin), CxbxKrnlEmulate 0x103e2b7c-0x103e2b81 (CxbxRestoreEEPROM), CxbxRestoreEEPROM 0x100c565b-0x100c5695 (CreateFileA OPEN_EXISTING, then OPEN_ALWAYS when absent), 0x100c56bb-0x100c56cc (SetFilePointer 0x100 and SetEndOfFile), 0x100c5704-0x100c5718 and 0x100c586f-0x100c587b (GetFileSizeEx, CxbxrAbortEx unless 0x100), 0x100c572a (MapViewOfFile read/write), 0x100c576e-0x100c5777 (EmuEEPROMReset for a new file), 0x100c5821 (checksum mismatch warning)" - name: keys.bin path: "keys.bin" @@ -211,7 +227,7 @@ files: validation: [size] description: "Xbox EEPROM and certificate keys" note: "Two 16 byte keys, the EEPROM key then the certificate key. Any other length is refused with a warning." - source_ref: "cxbxr-emu.dll 0x105f6094, 0x105f60a4" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxKrnlEmulate 0x103e2b77 (LoadXboxKeys), LoadXboxKeys 0x100ce5a7-0x100ce5d2 (data path plus keys.bin, fopen rb), 0x100ce5e7-0x100ce600 (fseek, ftell, size compared to 0x20), 0x100ce60f (fread of the two keys), 0x100ce63c-0x100ce645 (warning on any other size), 0x100ce659-0x100ce662 (warning when absent)" - name: wm2_loader.dll path: "wm2_loader.dll" @@ -224,7 +240,7 @@ files: Loaded with LoadLibraryW("./wm2_loader.dll") just before the XBE entry point is called, on every launch. A failure logs a warning and the title starts anyway. - source_ref: "cxbxr-emu.dll 0x103e0260, 0x10622b38" + source_ref: "cxbxr-emu.dll Chihiro-DS 1.0 (Mar 14 2025) CxbxLaunchXbe 0x103e0272-0x103e0277 (LoadLibraryW of ./wm2_loader.dll), 0x103e027d-0x103e0288 (warning on failure), 0x103e029c (XBE entry point called)" exclusion_note: > ntdll.dll and the XInput libraries tried in turn (xinput1_4, xinput1_3, diff --git a/emulators/cpcemu.yml b/emulators/cpcemu.yml index d98a99f02..8ca87824b 100644 --- a/emulators/cpcemu.yml +++ b/emulators/cpcemu.yml @@ -6,7 +6,7 @@ upstream: "https://www.cpc-emu.org/" version_source: url: "https://www.cpc-emu.org/" pattern: 'CPCemu (\d+(?:\.\d+)+) released' -profiled_date: "2026-08-08" +profiled_date: "2026-11-10" core_version: "3.0.2" version_basis: kind: package @@ -26,71 +26,64 @@ notes: | 6128. The firmware identifier and the message catalogue also know the 464+, the 6128+ and the KC compact. - Two packages were used. The 3.0.2 Windows portable and macOS builds of - 2025-04-24 carry the same fourteen ROM files and the same data files, and - provide the path constants, the message catalogue and the v3.0 help file. The - 2.5 Linux x86-64 build of 2022-08-13 is still the newest Linux release, the - 3.0.2 Linux archives listed on the download page being absent from the - server, and provides the runtime behaviour: - file opens traced with strace, required and optional decided by removing, - truncating and patching each file and reading the emulator's own messages. + Reversed from cpcemu_portable.exe of the 3.0.2 Windows portable package of + 2025-04-24 (zip sha256 fa2cde7da210b0db, exe sha256 3560e3a9c52095f1, Borland + C++ PE32). Addresses below are virtual addresses in that executable. The 3.0.2 + Linux archives listed on the download page are absent from the server. The + 2.5 Linux x86-64 package of 2022-08-13 ships the same ROM folder without + XDDOS210.ROM, and its binary has no National ROM selection. - ROMs live in ROM_PATH, "./ROM/" in the shipped configuration, resolved against - the working directory, while the macOS build reads them from the application bundle - Resources folder. Slots are filled by ROM_BLOCK lines naming a ROM number, a - file in ROM_PATH and a 16 KB block position inside that file: + Configuration comes from a file given on the command line, then the + cpcemu.cfg path assembled at 0x570a8c (FUN_00481bcc 0x481c96-0x481ca5) when + it exists, then the built-in name cpcemu0.cfg (pointer 0x570a84) in the + working directory, chosen at FUN_00481bcc 0x481d7a-0x481da2 and parsed by + FUN_00466680. ROM_PATH ("./ROM/" in the shipped cpcemu0.cfg) is stored by + FUN_00441008, which appends a backslash when the value does not end in one. + Each ROM_BLOCK line (FUN_004665d0: ROM number, file name, 16 KB block number) + becomes a node of the list at 0x5151a0. #IFCPC blocks are kept only when + their number equals the CPC type at 0x564590, set by -t or CPC_TYPE. The + shipped cpcemu0.cfg names CPC464.ROM for types 0 and 3, CPC664.ROM for type + 1, CPC6128.ROM for types 2, 4 and 5 (ROM 255 block 0, ROM 0 block 1), + CPCADOS.ROM as ROM 7 for every type, and M4.ROM as ROM 6 outside any #IFCPC. - ROM_BLOCK = 255, "CPC6128.ROM", 0 lower ROM - ROM_BLOCK = 0 , "CPC6128.ROM", 1 foreground ROM - ROM_BLOCK = 7 , "CPCADOS.ROM", 0 AMSDOS - ROM_BLOCK = 6 , "M4.ROM" , 0 M4 board + FUN_004407d0 loads every listed ROM from slot 0 to 255: ROM_PATH + file name, + an AMSDOS header skipped when its checksum matches (FUN_004721e4), a seek to + block * 0x4000 and a read of 0x4000 bytes with no length check + (FUN_0040a59c). A file that cannot be opened prints message 0xb8 "ROM: Cannot + open file" and counts one error. FUN_0046ac64 returns the count plus 2, and + FUN_00481bcc shows "CPCemu Error" and ends with that status for any value of + 3 or more, so a single missing file named by a ROM_BLOCK line stops startup + with status 3, whatever the slot and whatever device it serves. - The shipped cpcemu0.cfg repeats the first three for every CPC_TYPE from 0 to - 5, with CPC464.ROM for types 0 and 3, CPC664.ROM for type 1 and CPC6128.ROM - for types 2, 4 and 5, and adds the M4 line once for all types. A file named by - a ROM_BLOCK line that cannot be opened prints "ROM: Cannot open file" and ends - the process with status 3 before audio initialisation, whichever slot it fills - and whether or not the matching device is enabled. Deleting the line instead - lets the emulator start. + The machine is identified from ROM 0 by FUN_00440bfc: byte 0 has to be 0x80 + (else "ROM: No foreground ROM found.") and byte 2 selects 464 (0), 664 (1), + 6128 (2) or 6128+ (4), anything else giving "ROM: Unknown ROM version.". A + 6128 whose lower ROM has 0x21 at offset 0x5a1 is reported as a KC compact. + Without an identified machine startup ends on "CPC type not configured or + ROM for CPC type not available. Unable to continue." ROM 7 is accepted as + AMSDOS when its header is 01 00 05 or 01 00 07 (FUN_00440cc4), otherwise "ROM: + No AMSDOS ROM found." and disc support stays off. Types 3, 4 and 5 have no + dedicated ROM files: the shipped configuration loads the 464 and 6128 files + for them. There is no cartridge support. - The machine is identified from the foreground ROM, not from the lower half and - not from CPC_TYPE. CPCemu reads the four-byte CPC ROM header at the start of - block 1: byte 0 has to be 0x80, and byte 2 selects the machine, 0x00 for the - 464, 0x01 for the 664, 0x02 for the 6128. A random block 1 gives "ROM: No - foreground ROM found.", an unlisted version byte gives "ROM: Unknown ROM - version.", and both end on "CPC type not configured or ROM for CPC type not - available. Unable to continue." The modification byte is ignored, the lower - 16 KB half is never inspected, and padding past 32768 bytes is accepted, so - the length requirement is a lower bound: a block 1 has to exist. + The M4 board is set up at every startup by FUN_0044c6c4, called from + FUN_0046ac64 0x46ae76 without reading M4_ENABLED (0x516cd0). It looks for the + ROM_BLOCK entry whose file name is exactly "M4.ROM" and checks the ROM's name + table for "M4 BOARD". It then reads M4_SD_PATH + /NMIROM.BIN, and only when + that file is absent, ROM_PATH + /HACK.ROM, 0x4000 bytes each. The M4 firmware + updater (routine at 0x449c1c) downloads cpc/M4FIRM.BIN from spinpoint.org and + rewrites ROM_PATH + /M4.ROM and /HACK.ROM, 0x4000 bytes each. - Types 3, 4 and 5 need ROM images the packages do not carry. The help file - states they have to be supplied in CPCEMU.CFG first, and no filename for them - is compiled into the binary, the user names the file in the ROM_BLOCK line. - Left on the shipped configuration those types load the 464 and 6128 files and - report the machine those files describe. There is no cartridge support, the - file types handled on the command line are dsk, sna, cfg and zip. - - M4 board emulation is on by default. HACK.ROM, the board's lower ROM, is - opened at every startup whatever M4_ENABLED holds, after M4_SD_PATH + - NMIROM.BIN has been tried, so a NMIROM.BIN placed on the emulated SD card - replaces it. With neither present the emulator prints "Unable to load - HACK.ROM" and keeps running. M4.ROM contents are checked, a zeroed file boots - the CPC and reports "M4 ROM not valid." The firmware updater downloads - M4FIRM.BIN from spinpoint.org and rewrites M4.ROM and HACK.ROM in place. - - Alongside the ROMs the binary reads its own payload from the program - directory. cpcemu.msg is the message catalogue, and its absence leaves every - message unprinted. cpcemu.dat holds colours and key tables, cpcemu.hlp is the - online help opened on F1, cpcemu.dbf is the poke database opened from the poke - menu, and cpcemu0.cfg is the template used when no user configuration exists. - Configuration is looked up first in the user profile, ~/.CPCemu/cpcemu.cfg on - Linux, then cpcemu0.cfg in the working directory. With neither, startup stops - on "CPCEMU: Use INSTALL first". The disc, tape and snapshot folders and the - M4 SD card folder hold user content. + Alongside the ROMs the program reads the message catalogue cpcemu.msg (name + passed at FUN_00481bcc 0x481c86) and the colour and key tables cpcemu.dat + (built-in name at 0x570a88, passed to FUN_0045f734 at FUN_00481bcc 0x481dd9). The help file and the + poke database are named only by the HELP_FILE and POKE_DATABASE lines of + cpcemu0.cfg, "./cpcemu.hlp" and "./cpcemu.dbf". The disc, tape and snapshot folders and the M4 SD card folder hold + user content. files: - # The 3.0.2 Windows, macOS and Android packages ship every ROM below in ROM/ - # (assets/DATA/ROM/ in the APK). The 2.5 Linux archive ships all but XDDOS210.ROM. + # The 3.0.2 Windows package ships every ROM below in ROM/. The 2.5 Linux + # package ships all but XDDOS210.ROM. # -- Firmware, lower ROM in block 0 and foreground ROM in block 1 -- - name: CPC6128.ROM path: "ROM/CPC6128.ROM" @@ -98,13 +91,14 @@ files: required: true bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: b96280dc6c95a48857b4b8eb931533ae sha1: 5977adbad3f7c1e0e082cd02fe76a700d9860c30 - source_ref: "CPCemu 2.5/3.0.2: ROM/CPC6128.ROM, cpcemu0.cfg ROM_BLOCK 255 and 0 for CPC_TYPE 2, 4 and 5" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004407d0 0x440848-0x4408b6 (ROM_PATH + ROM_BLOCK file name per slot, ifstream open), 0x4408d1-0x44093f (open failure: message 0xb8, error count), 0x440959-0x440976 (seek block * 0x4000, FUN_0040a59c reads 0x4000, no length check), FUN_0046ac64 0x46ae22-0x46ae2d and FUN_00481bcc 0x481efa-0x481f54 (count + 2 >= 3 ends startup), FUN_00440bfc 0x440c03-0x440c47 (ROM 0 byte 0 = 0x80, byte 2 = machine), cpcemu0.cfg ROM_BLOCK 255 and 0 under #IFCPC 2, 4 and 5, kept by FUN_00466680 0x466871-0x466879" note: >- - CPC 6128 firmware and BASIC. Loaded for the shipped CPC_TYPE 2 and opened - twice, once per block. Foreground ROM header 80 01 02 00. + CPC 6128 firmware and BASIC, lower ROM in block 0 and foreground ROM in + block 1, opened once per block. Loaded for the shipped CPC_TYPE 2 and + for types 4 and 5. Foreground ROM header 80 01 02 00. - name: CPC464.ROM path: "ROM/CPC464.ROM" @@ -112,13 +106,13 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: a993f85b88ac4350cf4d41554e87fe4f sha1: 56d39c463da60968d93e58b4ba0e675829412a20 - source_ref: "CPCemu 2.5/3.0.2: ROM/CPC464.ROM, cpcemu0.cfg ROM_BLOCK 255 and 0 for CPC_TYPE 0 and 3" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004407d0 0x440848-0x4408b6 (ROM_PATH + ROM_BLOCK file name, ifstream open), 0x4408d1-0x44093f (open failure: message 0xb8, error count), 0x440959-0x440976 (seek block * 0x4000, read 0x4000), FUN_00440bfc 0x440c03-0x440c47 (ROM 0 header), cpcemu0.cfg ROM_BLOCK 255 and 0 under #IFCPC 0 and 3, kept by FUN_00466680 0x466871-0x466879 when the CPC type at 0x564590 matches" note: >- - CPC 464 firmware and BASIC, selected by CPC_TYPE 0 or the -t 0 command - line. Foreground ROM header 80 01 00 00. + CPC 464 firmware and BASIC, selected by CPC_TYPE 0 or 3 or the -t + command line. Foreground ROM header 80 01 00 00. - name: CPC664.ROM path: "ROM/CPC664.ROM" @@ -126,12 +120,12 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: 5a384a2310f472c7857888371c00ed66 sha1: 073a7665527b5bd8a148747a3947dbd3328682c8 - source_ref: "CPCemu 2.5/3.0.2: ROM/CPC664.ROM, cpcemu0.cfg ROM_BLOCK 255 and 0 for CPC_TYPE 1" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004407d0 0x440848-0x4408b6 (ROM_PATH + ROM_BLOCK file name, ifstream open), 0x4408d1-0x44093f (open failure: message 0xb8, error count), 0x440959-0x440976 (seek block * 0x4000, read 0x4000), FUN_00440bfc 0x440c03-0x440c47 (ROM 0 header), cpcemu0.cfg ROM_BLOCK 255 and 0 under #IFCPC 1, kept by FUN_00466680 0x466871-0x466879 when the CPC type at 0x564590 matches" note: >- - CPC 664 firmware and BASIC, selected by CPC_TYPE 1 or the -t 1 command + CPC 664 firmware and BASIC, selected by CPC_TYPE 1 or the -t command line. Foreground ROM header 80 01 01 00. # -- Disc ROM, slot 7 -- @@ -141,15 +135,15 @@ files: required: true bundled: true size: 16384 + validation: [signature] md5: aa2fb251814bd971b2b9874ab0971b3f sha1: 0e247123b9d3204784eeadb4629b9d35b9dfd984 - source_ref: "CPCemu 2.5/3.0.2: ROM/CPCADOS.ROM, cpcemu0.cfg ROM_BLOCK 7 for every CPC_TYPE" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004407d0 0x440848-0x4408b6 (ROM_PATH + ROM_BLOCK file name, ifstream open), 0x4408d1-0x44093f (open failure: message 0xb8, error count), 0x440959-0x440976 (read 0x4000, no length check), FUN_0046ac64 0x46ae22-0x46ae2d and FUN_00481bcc 0x481efa-0x481f54 (count + 2 >= 3 ends startup), FUN_00440f10 0x440fae-0x440fbf and FUN_00440cc4 (ROM 7 header 01 00 05 or 01 00 07, else message 0xbb), cpcemu0.cfg ROM_BLOCK 7 under every #IFCPC" note: >- - AMSDOS disc ROM, the 8 KB image zero-padded to 16 KB. Declared for every - machine by the shipped configuration, so startup ends on status 3 without - it. Dropping the ROM_BLOCK line instead boots with "ROM: No AMSDOS ROM - found." and no disc support. Length is not checked, an 8 KB file installs - the AMSDOS speedup all the same. + AMSDOS disc ROM, the 8 KB image zero-padded to 16 KB. Named for every + machine by the shipped configuration, so startup ends with status 3 + without it. Dropping the ROM_BLOCK line instead boots with "ROM: No + AMSDOS ROM found." and no disc support. # -- M4 board, ROM slot 6 plus the board's own lower ROM -- - name: M4.ROM @@ -161,11 +155,24 @@ files: validation: [signature] md5: 28a7e368badca8299ba24a15bb4ebe9b sha1: 05f9447d307ab17eae9e2100f91c36b0c9560d4b - source_ref: "CPCemu 2.5/3.0.2: ROM/M4.ROM, cpcemu0.cfg ROM_BLOCK 6, M4_ENABLED = 1" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004407d0 0x440848-0x44093f (ROM_PATH + ROM_BLOCK file name, ifstream open, open failure counted), FUN_0046ac64 0x46ae22-0x46ae2d (count + 2 >= 3 ends startup), FUN_0044c6c4 0x44c6fa-0x44c74c (FUN_00440570 finds the ROM_BLOCK entry named \"M4.ROM\", else \"M4 ROM not found.\"), 0x44c751-0x44c7be (8-byte compare with \"M4 BOARD\" at the name table address in ROM bytes 4-5, else \"M4 ROM not valid.\"), routine at 0x449c1c 0x44a4f4-0x44a548 (updater writes ROM_PATH + /M4.ROM, 0x4000 bytes), cpcemu0.cfg ROM_BLOCK 6 outside any #IFCPC" note: >- - M4 board firmware by Duke. Declared by the shipped configuration, so - startup ends on status 3 without it even when M4_ENABLED is 0. Contents - are checked, a zeroed file boots and reports "M4 ROM not valid." + M4 board firmware by Duke. Named by the shipped configuration for every + machine, so startup ends with status 3 without it, whatever M4_ENABLED + holds. The board is recognised only by the file name M4.ROM in the + ROM_BLOCK line. A failed lookup or name table check clears M4_ENABLED and + emulation goes on without the board. + + - name: NMIROM.BIN + path: "SDCARD/NMIROM.BIN" + system: amstrad-cpc + required: false + description: "M4 board NMI ROM on the emulated SD card" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_0044c6c4 0x44c966-0x44c9c4 (FUN_0044c238 builds M4_SD_PATH from 0x516cd8 + /NMIROM.BIN, fopen rb, fread 0x4000), called from FUN_0046ac64 0x46ae76" + note: >- + Read at every startup once M4.ROM has passed its check, in place of + HACK.ROM when present. The shipped cpcemu0.cfg sets M4_SD_PATH to + ./SDCARD/. Up to 0x4000 bytes are read, the length is not checked. - name: HACK.ROM path: "ROM/HACK.ROM" @@ -175,11 +182,13 @@ files: size: 7994 md5: ffcbcbce32223a152753d30766ad6215 sha1: 582dd1706391f6f0161ad3486ae75a04fb0f7d5b - source_ref: "CPCemu 2.5/3.0.2: ROM_PATH + /HACK.ROM, opened after M4_SD_PATH + NMIROM.BIN" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_0044c6c4 0x44c966-0x44c9c4 (FUN_0044c238 builds M4_SD_PATH from 0x516cd8 + /NMIROM.BIN, fopen rb, fread 0x4000), 0x44c9c9-0x44ca3f (ROM_PATH from FUN_00440a5c + /HACK.ROM, fopen rb, fread 0x4000 into the buffer at 0x516210), 0x44ca41-0x44ca6a (\"Unable to load HACK.ROM\", returns 0), called from FUN_0046ac64 0x46ae76, routine at 0x449c1c 0x44a5b7-0x44a60b (updater writes ROM_PATH + /HACK.ROM, 0x4000 bytes)" note: >- M4 hack ROM, the lower ROM behind the Shift+F1 menu. Opened at every - startup, and superseded by a NMIROM.BIN on the emulated SD card. Missing - prints "Unable to load HACK.ROM" and emulation continues. + startup once M4.ROM has passed its check, and only when M4_SD_PATH + + NMIROM.BIN is absent. Missing prints "Unable to load HACK.ROM" and + emulation continues. Up to 0x4000 bytes are read, the length is not + checked. # -- National firmware, configured by the 3.0.2 keyboard layout dialog -- - name: CPC6128.ROM.UK @@ -188,13 +197,13 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: b96280dc6c95a48857b4b8eb931533ae sha1: 5977adbad3f7c1e0e082cd02fe76a700d9860c30 - source_ref: "CPCemu 2.5/3.0.2: ROM/National/CPC6128.ROM.UK" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004866e0 0x486881-0x486908 (system ROM picker: file selector FUN_00462fe0 rooted at ROM_PATH, path made relative, FUN_004405f0 sets ROM 255 or 0), FUN_004407d0 0x440848-0x440976 (ROM_PATH + name, open, read 0x4000 per block), no path constant names this file, the English layout of FUN_0048202c keeps CPC6128.ROM" note: >- - English CPC 6128 firmware, the same image as CPC6128.ROM. Ships in the - National folder without being named by any path constant. + English CPC 6128 firmware, the same image as CPC6128.ROM. Loaded only when + the user names it in a ROM_BLOCK line or picks it in the setup menu. - name: CPC6128.ROM.FR path: "ROM/National/CPC6128.ROM.FR" @@ -202,11 +211,11 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: 5ee871d5600eb9b5a22989c295f902a5 sha1: 200d59076dfef36db061d6d7d21d80021cab1237 - source_ref: "CPCemu 3.0.2: National/CPC6128.ROM.FR, keyboard layout dialog on first start" - note: "French CPC 6128 firmware, configured when the French layout is picked." + source_ref: "cpcemu_portable.exe 3.0.2 FUN_0048202c 0x482045-0x48207d (layout dialog, keys 1, 3, 4, 5 give 0, 2, 3, 4), 0x4820c5 (layout 2: \"National/CPC6128.ROM.FR\"), 0x4820d8-0x4820f6 (FUN_004405f0 sets ROM 0 block 1 and ROM 255 block 0, reloaded by FUN_004407d0 through FUN_00440304 0x4403cc), called from FUN_00481bcc 0x481e23-0x481e5a when no keyboard layout is configured" + note: "French CPC 6128 firmware, configured when the French layout is picked on first start." - name: CPC6128.ROM.ES path: "ROM/National/CPC6128.ROM.ES" @@ -214,11 +223,11 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: 0246740371010333385665dfeb7cd0ec sha1: 1acd01c2c03424a78b32c9440f4d890fb1104815 - source_ref: "CPCemu 3.0.2: National/CPC6128.ROM.ES, keyboard layout dialog on first start" - note: "Spanish CPC 6128 firmware, configured when the Spanish layout is picked." + source_ref: "cpcemu_portable.exe 3.0.2 FUN_0048202c 0x482045-0x48207d (layout dialog), 0x4820cc (layout 3: \"National/CPC6128.ROM.ES\"), 0x4820d8-0x4820f6 (FUN_004405f0 sets ROM 0 block 1 and ROM 255 block 0, reloaded by FUN_004407d0 through FUN_00440304 0x4403cc), called from FUN_00481bcc 0x481e23-0x481e5a when no keyboard layout is configured" + note: "Spanish CPC 6128 firmware, configured when the Spanish layout is picked on first start." - name: CPC6128.ROM.DK path: "ROM/National/CPC6128.ROM.DK" @@ -226,11 +235,11 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: ca1635fd992e2aa7a776b30da13467e5 sha1: a9e7ee6355730f319a37c95ca0a714212b88c3b1 - source_ref: "CPCemu 3.0.2: National/CPC6128.ROM.DK, keyboard layout dialog on first start" - note: "Danish CPC 6128 firmware, configured when the Danish layout is picked." + source_ref: "cpcemu_portable.exe 3.0.2 FUN_0048202c 0x482045-0x48207d (layout dialog), 0x4820d3 (layout 4: \"National/CPC6128.ROM.DK\"), 0x4820d8-0x4820f6 (FUN_004405f0 sets ROM 0 block 1 and ROM 255 block 0, reloaded by FUN_004407d0 through FUN_00440304 0x4403cc), called from FUN_00481bcc 0x481e23-0x481e5a when no keyboard layout is configured" + note: "Danish CPC 6128 firmware, configured when the Danish layout is picked on first start." - name: CPC6128.ROM.SE path: "ROM/National/CPC6128.ROM.SE" @@ -238,14 +247,14 @@ files: required: false bundled: true min_size: 32768 - validation: [size, signature] + validation: [signature] md5: 8ca256a832e83c875f5432b3dee8a36f sha1: 6765a91a42fed68a807325bf62a728e5ac5d622f - source_ref: "CPCemu 2.5/3.0.2: ROM/National/CPC6128.ROM.SE" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004866e0 0x486881-0x486908 (system ROM picker: file selector FUN_00462fe0 rooted at ROM_PATH, path made relative, FUN_004405f0 sets ROM 255 or 0), FUN_004407d0 0x440848-0x440976 (ROM_PATH + name, open, read 0x4000 per block), no path constant names this file, FUN_0048202c 0x4820b3-0x4820d3 maps layouts 2, 3, 4 only" note: >- - Swedish CPC 6128 firmware. Ships in the National folder without being - named by any path constant, the layout dialog offering English, French, - Spanish and Danish only. + Swedish CPC 6128 firmware. Loaded only when the user names it in a + ROM_BLOCK line or picks it in the setup menu, the layout dialog offering + no Swedish ROM. # -- Expansion ROMs mapped through a user ROM_BLOCK line -- - name: XDDOS210.ROM @@ -256,11 +265,13 @@ files: size: 16384 md5: 1d91a9ef315b302d335cd7e04e8d8d86 sha1: 2f1bd4d6e2d2e62818b01e6e7a26488362a7a8ee - source_ref: "CPCemu 3.0.2: ROM/XDDOS210.ROM, cpcemu0.cfg commented ROM_BLOCK 7, help topic DOBBERTIN HD20 ENABLED" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_00486fc4 0x487026-0x487113 (expansion ROM picker: file selector FUN_00462fe0 rooted at ROM_PATH, FUN_004405f0 sets the slot), FUN_004665d0 (ROM_BLOCK line parser), FUN_004407d0 0x440848-0x440976 (ROM_PATH + name, open, read 0x4000), cpcemu0.cfg commented ROM_BLOCK 7, no path constant names this file" note: >- - X-DDOS 2.10 by Dobbertin, the disc operating system of the HD20 hard disk. - Required in a ROM slot to use DOBBERTIN_HD_ENABLED = 1. Added in 3.0, not - shipped with 2.5. + X-DDOS 2.10 by Dobbertin, the disc operating system of the HD20 hard disk + that DOBBERTIN_HD_ENABLED emulates. Loaded once the user maps it to a ROM + slot. Its header 01 02 01 is not taken as AMSDOS by FUN_00440cc4, so the + AMSDOS speedup stays off with it in slot 7. Added in 3.0, not shipped + with 2.5. - name: COPYMATE.ROM path: "ROM/COPYMATE.ROM" @@ -270,11 +281,11 @@ files: size: 16512 md5: e9c4288eab8885a1e6ae7504a4736115 sha1: 15d52de01320d9b954e03b4c2e71ec75fd301bbb - source_ref: "CPCemu 2.5/3.0.2: ROM/COPYMATE.ROM, cpcemu0.cfg commented ROM_BLOCK 4" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_004665d0 (ROM_BLOCK line parser), FUN_004407d0 0x440848-0x440976 (ROM_PATH + name, open, read 0x4000), FUN_004721e4 0x4721ef-0x472246 and 0x4722f8-0x472300 (128-byte AMSDOS header recognised by its checksum over bytes 0-0x42, data read from offset 0x80), cpcemu0.cfg commented ROM_BLOCK 4, FUN_00486fc4 0x487026-0x487113 (expansion ROM picker)" note: >- Copy utility ROM, carrying a 128-byte AMSDOS file header ahead of the - 16 KB image. Shipped as the example expansion ROM of the configuration - file and loaded once the line is uncommented. + 16 KB image, which the loader skips. Shipped as the example expansion ROM + of the configuration file and loaded once the line is uncommented. - name: multface.rom path: "ROM/multface.rom" @@ -284,7 +295,7 @@ files: size: 8192 md5: 4c9f014e91d407cc6509fad0095ab909 sha1: 1431ec628d38f000715545dd2186b684c5fe5a6f - source_ref: "CPCemu 2.5/3.0.2: ROM/multface.rom, ROM_BLOCK filename or ROM Manager entry" + source_ref: "cpcemu_portable.exe 3.0.2 FUN_00486fc4 0x487026-0x487113 (expansion ROM picker: file selector FUN_00462fe0 rooted at ROM_PATH, FUN_004405f0 sets the slot), FUN_004665d0 (ROM_BLOCK line parser), FUN_004407d0 0x440848-0x440976 (ROM_PATH + name, open, read up to 0x4000), no path constant names this file" note: >- - Romantic Robot Multiface Two ROM. Ships in the ROM folder for the user to - map into a slot, no path constant naming it. + Romantic Robot Multiface Two ROM. Ships in the ROM folder and enters only + as an ordinary ROM slot named by the user, no code path naming it. diff --git a/emulators/cspect.yml b/emulators/cspect.yml index fde57e9e5..34d4977ec 100644 --- a/emulators/cspect.yml +++ b/emulators/cspect.yml @@ -11,7 +11,7 @@ core_version: "3.3.1.0" version_basis: kind: package url: "https://mdf200.itch.io/cspect" - artifact: "CSpect zip from itch.io, CSpect.exe and ReadMe.txt" + artifact: "CSpect3_3_1_0.zip from itch.io, CSpect.exe AssemblyFileVersion 3.3.1.0" display_name: "Sinclair - ZX Spectrum Next (#CSpect)" verification: existence cores: [cspect] @@ -21,13 +21,18 @@ systems: - sinclair-zx-spectrum notes: | - ZX Spectrum Next emulator, assembler and debugger for Windows, macOS and - Linux, written in C# against .NET Framework 4.8 and run under Mono elsewhere. - It is closed source and shipped as a zip from its itch.io page, so every - reference below names a method and an IL offset in the CSpect.exe of 3.3.1.0. - Type and member names in that build are obfuscated and the string literals sit - XOR encoded in one 18146 byte blob, decoded at class load by b[i] ^ i ^ 0xAA. - ref: CSpect.exe 3.3.1.0, ReadMe.txt:9-11 + ZX Spectrum Next emulator, assembler and debugger written in C# against .NET + Framework 4.8. One assembly serves Windows, macOS and Linux and picks its host + from Environment.OSVersion at startup. It is closed source and shipped as + CSpect3_3_1_0.zip from its itch.io page (sha256 f6935abe6ed49b1e), so every + reference below names a method and an IL offset in its CSpect.exe, assembly + and file version 3.3.1.0. Type and member names in that build are obfuscated + and the string literals sit XOR encoded in one 18146 byte blob, decoded at + class load by b[i] ^ i ^ 0xAA. + ref: CSpect.exe 3.3.1.0 TargetFramework(".NETFramework,Version=v4.8"), + AssemblyFileVersion("3.3.1.0"), A.h::a(string[]) IL_0000-IL_0030, + .DB247AA5-38E0-44EF-99A2-2061F389A03D::.cctor + IL_000f-IL_0052 The machine carries no built-in ROM. A cold reset either loads the Next ROMs or allocates them zero filled, 65536 bytes for the ROM banks and 8192 each for diff --git a/emulators/drastic.yml b/emulators/drastic.yml index 515a8da80..4efdef257 100644 --- a/emulators/drastic.yml +++ b/emulators/drastic.yml @@ -26,15 +26,17 @@ notes: | Nintendo DS emulator by Exophase, closed source and distributed as a binary. Two releases are read here and they name the same files: the Android build r2.6.0.4a build 109, package com.dsemu.drastic, apk md5 - 7df979ef9420c5053b27c838e6a7e20c, whose loader is - lib/arm64-v8a/libdrastic_arm64.so and whose installer is the smali of - DraSticActivity. The second is the Linux AArch64 build r2.5.2.2, md5 - 17550db727f3b59d36b57746ad1944be, which ships unstripped with 2731 named - functions and is cited by function name. r2.5.2.2 predates the firmware editor - and the user database, and that is the whole of the divergence. Every - reference below is an address in one of the two binaries or a line in the - apktool decode of the Android one. - ref: libdrastic_arm64.so, drastic r2.5.2.2 (DWARF comp_dir + 7df979ef9420c5053b27c838e6a7e20c (sha256 d3a45b9bfd5a68cc), v1 signed by + CN=Gilead Kutnick over every entry, whose loader is + lib/arm64-v8a/libdrastic_arm64.so (sha256 3b27eee0c480df81) and whose + installer is the smali of DraSticActivity. The second is the Linux AArch64 + build r2.5.2.2, md5 17550db727f3b59d36b57746ad1944be (sha256 + dab3275ef772451b), which ships unstripped with 2731 named functions and is + cited by function name. r2.5.2.2 predates the firmware editor and the user + database, and that is the whole of the divergence. Every reference below is + an address in one of the two binaries, a line in the apktool decode of the + Android one or a line of an asset it ships. + ref: libdrastic_arm64.so r2.6.0.4a, drastic r2.5.2.2 (DWARF comp_dir /home/odroid/nds_emu/src/linux_odroid64), DraSticActivity.smali One root holds everything. On Android it is a directory named DraStic at the @@ -43,8 +45,8 @@ notes: | microphone and scripts below it, and the Android build adds backgrounds, icon_cache, users, shaders and virtual_controller. Paths below are relative to that root. - ref: drastic r2.5.2.2 initialize_system_directories 0xf780, - drastic r2.5.2.2 0x11ac08-0x11ac80, drastic r2.5.2.2 initialize_system 0xf9e8, + ref: drastic r2.5.2.2 initialize_system_directories 0xf784-0xf838, + drastic r2.5.2.2 initialize_system 0xf9e8, DraSticPathCache.smali:44-56, DraSticActivity.smali:4373-4429, DraSticActivity.smali:4187, DraSticActivity.smali:4482 @@ -53,7 +55,7 @@ notes: | for with "System file %s is the wrong size (should be %d bytes, is %d)", then reads it whole. Size is the only test: no hash is computed on any file. ref: drastic r2.5.2.2 load_system_file 0xea80-0xebe4, - libdrastic_arm64.so 0x1b4d4-0x1b510 + libdrastic_arm64.so r2.6.0.4a 0x1b4d4-0x1b510 Each BIOS slot has two candidates. The ARM9 slot takes nds_bios_arm9.bin, and on failure logs "Can't find Nintendo ARM9 BIOS. Trying free DraStic ARM9 @@ -70,7 +72,7 @@ notes: | drastic r2.5.2.2 initialize_system 0xf940-0xf944, drastic r2.5.2.2 initialize_system 0xf9f8-0xfa10, drastic r2.5.2.2 menu_bios_warning 0x801e0-0x80238, - libdrastic_arm64.so 0x2b6d0-0x2b764 + libdrastic_arm64.so r2.6.0.4a 0x2b6d0-0x2b764 Firmware is answered in code when no file loads: the 256 KB region is zeroed and patch_firmware_header_data writes the header, the console identity and the @@ -80,7 +82,7 @@ notes: | ref: drastic r2.5.2.2 initialize_memory 0x1c3e0-0x1c3f8, drastic r2.5.2.2 initialize_memory 0x1c560-0x1c578, drastic r2.5.2.2 patch_firmware_header_data 0x1b920, - libdrastic_arm64.so 0x2b768-0x2b7c4, libdrastic_arm64.so 0x774e0-0x7751c + libdrastic_arm64.so r2.6.0.4a 0x2b768-0x2b7c4, libdrastic_arm64.so r2.6.0.4a 0x774e0-0x7751c The Nintendo ARM7 image still decides one thing. gamecard_load_program passes the 0x1048 bytes at ARM7 BIOS offset 0x30 to gamecard_decrypt_secure_region as @@ -98,7 +100,7 @@ notes: | ref: drastic r2.5.2.2 initialize_gamecard 0x709bc-0x70a30, drastic r2.5.2.2 initialize_game_database 0x73180, drastic r2.5.2.2 initialize_game_database 0x73d24-0x73d38, - libdrastic_arm64.so 0x76ab8-0x76b58 + libdrastic_arm64.so r2.6.0.4a 0x76ab8-0x76b58 The Android package carries its own copies of the files it needs and lays them down on first run: the two free BIOS images into system, the default layout @@ -110,11 +112,22 @@ notes: | DraSticActivity.smali:5645, DraSticActivity.smali:5834, DraSticActivity.smali:5974 - A .dfx names the passes of a post-processing chain and pulls its GLSL stages, - its included headers and its lookup textures from paths relative to itself. - Nine chains ship: None, Linear, Quilez, Scale2X, Scanline, HQ2X, FXAA, FXAA HQ - and SMAA, the last two reading .raw lookup textures. - ref: assets/shaders/_shader_format_.txt:12-58, assets/shaders/SMAA.dfx:1-6 + fxLoad hands the path of the chosen .dfx to the chain loader, which opens it, + keeps its directory and reads it line by line. An reads its file= + whole, a whose input= is neither null nor framebuffer reads that + file whole as a lookup texture, and the shader= of each opens a .dsd + and splits its and blocks, all three relative to the + .dfx. A stage that fails to compile has its log written to .log beside + the .dsd. A .dfx that does not open or parse leaves a built-in pass-through + shader. Nine chains ship: None, Linear, Quilez, Scale2X, Scanline, HQ2X, + FXAA, FXAA HQ and SMAA, and SMAA is the only one naming .raw textures. + ref: libdrastic_arm64.so r2.6.0.4a Java_com_dsemu_drastic_DraSticJNI_fxLoad 0x18eec, + libdrastic_arm64.so r2.6.0.4a FUN_1ff78 0x1ffd4-0x20214, + libdrastic_arm64.so r2.6.0.4a FUN_1f0a0 0x1f17c-0x1f1c8, + libdrastic_arm64.so r2.6.0.4a FUN_1f260 0x1f464-0x1f52c, + libdrastic_arm64.so r2.6.0.4a FUN_1f734 0x1f850-0x1f894, + libdrastic_arm64.so r2.6.0.4a FUN_1ebfc 0x1ec20-0x1ecec, + assets/shaders/SMAA.dfx:108-122 Per-title inputs are read beside the ROM name. reset_spu answers the microphone with microphone/.wav then microphone/microphone.wav, load_nds @@ -144,7 +157,7 @@ files: validation: [size] description: "Nintendo DS ARM9 BIOS" note: "First candidate for the ARM9 slot. Booting continues on the free replacement when it is absent, and the slot ending empty is fatal." - source_ref: "drastic r2.5.2.2 initialize_memory 0x1c398-0x1c3b0, drastic r2.5.2.2 load_system_file 0xea80-0xebe4, libdrastic_arm64.so 0x2b6d0-0x2b6ec" + source_ref: "drastic r2.5.2.2 initialize_memory 0x1c398-0x1c3b0, drastic r2.5.2.2 load_system_file 0xea80-0xebe4, libdrastic_arm64.so r2.6.0.4a 0x2b6d0-0x2b6ec" - name: drastic_bios_arm9.bin sha1: 4dc29a1560e1cbd7afef1998f7a6c25c5db1cc3a @@ -156,8 +169,8 @@ files: size: 4096 validation: [size] description: "DraStic free ARM9 BIOS replacement" - note: "Second candidate for the ARM9 slot, written by Exophase from public documentation and released under a BSD licence. Installed from the package assets on first run." - source_ref: "drastic r2.5.2.2 initialize_memory 0x1c4b0-0x1c4d4, libdrastic_arm64.so 0x2b6f0-0x2b708, DraSticActivity.smali:4084-4090, drastic_bios_readme.txt:1-31" + note: "Second candidate for the ARM9 slot. Installed from the package assets on first run." + source_ref: "drastic r2.5.2.2 initialize_memory 0x1c4b0-0x1c4d4, libdrastic_arm64.so r2.6.0.4a 0x2b6f0-0x2b708, DraSticActivity.smali:4084-4090" - name: nds_bios_arm7.bin path: system/nds_bios_arm7.bin @@ -167,7 +180,7 @@ files: validation: [size] description: "Nintendo DS ARM7 BIOS" note: "First candidate for the ARM7 slot, and the only image carrying the Blowfish key table at offset 0x30 that the card secure area is decrypted with." - source_ref: "drastic r2.5.2.2 initialize_memory 0x1c3bc-0x1c3d4, drastic r2.5.2.2 gamecard_load_program 0x6fb98-0x6fbac, libdrastic_arm64.so 0x2b724-0x2b73c" + source_ref: "drastic r2.5.2.2 initialize_memory 0x1c3bc-0x1c3d4, drastic r2.5.2.2 gamecard_load_program 0x6fb98-0x6fbac, libdrastic_arm64.so r2.6.0.4a 0x2b724-0x2b73c" - name: drastic_bios_arm7.bin sha1: 31ae916c85d012582c7cdf47de6943ac6778253b @@ -180,7 +193,7 @@ files: validation: [size] description: "DraStic free ARM7 BIOS replacement" note: "Second candidate for the ARM7 slot. Offset 0x30 is zero filled, so cards whose secure area is encrypted do not decrypt under it." - source_ref: "drastic r2.5.2.2 initialize_memory 0x1c508-0x1c52c, libdrastic_arm64.so 0x2b740-0x2b758, DraSticActivity.smali:4078-4083" + source_ref: "drastic r2.5.2.2 initialize_memory 0x1c508-0x1c52c, libdrastic_arm64.so r2.6.0.4a 0x2b740-0x2b758, DraSticActivity.smali:4078-4083" - name: nds_firmware.bin path: system/nds_firmware.bin @@ -191,7 +204,7 @@ files: validation: [size] description: "Nintendo DS firmware" note: "Absent, the region is zeroed and patch_firmware_header_data writes a header, a console identity and a user settings block into it, so the emulator boots either way. r2.6.0.4a reads nds_firmware_modified.bin before this." - source_ref: "drastic r2.5.2.2 initialize_memory 0x1c3e0-0x1c3f8, drastic r2.5.2.2 initialize_memory 0x1c560-0x1c578, drastic r2.5.2.2 patch_firmware_header_data 0x1b920, libdrastic_arm64.so 0x2b794-0x2b7c4" + source_ref: "drastic r2.5.2.2 initialize_memory 0x1c3e0-0x1c3f8, drastic r2.5.2.2 initialize_memory 0x1c560-0x1c578, drastic r2.5.2.2 patch_firmware_header_data 0x1b920, libdrastic_arm64.so r2.6.0.4a 0x2b794-0x2b7c4" - name: nds_firmware_modified.bin path: system/nds_firmware_modified.bin @@ -203,7 +216,7 @@ files: unsourceable: "written by the firmware editor of r2.6.0.4a from the emulated user settings, so no dump of it exists" description: "firmware image edited in the emulator" note: "Read before nds_firmware.bin in r2.6.0.4a and absent from r2.5.2.2." - source_ref: "libdrastic_arm64.so 0x2b768-0x2b790, libdrastic_arm64.so 0x774e0-0x7751c" + source_ref: "libdrastic_arm64.so r2.6.0.4a 0x2b768-0x2b790, libdrastic_arm64.so r2.6.0.4a 0x774e0-0x7751c" - name: game_database.xml size: 1686069 @@ -225,7 +238,7 @@ files: unsourceable: "user overlay of the save type database, authored per collection" description: "user save type database" note: "Read after game_database.xml in r2.6.0.4a and absent from r2.5.2.2." - source_ref: "libdrastic_arm64.so 0x76af8-0x76b28" + source_ref: "libdrastic_arm64.so r2.6.0.4a 0x76af8-0x76b28" - name: usrcheat.dat path: usrcheat.dat @@ -235,7 +248,7 @@ files: category: game_data description: "Action Replay cheat library" note: "Read from the root of the data directory and written back when a cheat is toggled, so the file carries the enabled state. Installed from the package assets on first run." - source_ref: "drastic r2.5.2.2 initialize_gamecard 0x70a0c-0x70a30, libdrastic_arm64.so 0x76b34-0x76b58, DraSticActivity.smali:5974" + source_ref: "drastic r2.5.2.2 initialize_gamecard 0x70a0c-0x70a30, libdrastic_arm64.so r2.6.0.4a 0x76b34-0x76b58, DraSticActivity.smali:5974" - name: drastic_bios.zip size: 15583 @@ -245,8 +258,8 @@ files: bundled: true category: game_data description: "source archive of the free BIOS replacement" - note: "Copied to the root of the data directory on first run and never read back. Holds bios_common.S, a Makefile, the BSD licence notice and the two built images." - source_ref: "DraSticActivity.smali:5189-5200, drastic_bios_readme.txt:1-31" + note: "Copied to the root of the data directory on first run and never read back. Holds bios_common.S, a Makefile, drastic_bios_readme.txt and the two built images." + source_ref: "DraSticActivity.smali:5189-5200" - name: LC_default.dat size: 76 @@ -266,7 +279,7 @@ files: category: game_data description: "post-processing chain definition" note: "Android only. Names the passes, the texture inputs and the headers of one chain, all resolved relative to its own path. The package ships None, Linear, Quilez, Scale2X, Scanline, HQ2X, FXAA, FXAA HQ and SMAA." - source_ref: "DraSticActivity.smali:5619-5624, assets/shaders/_shader_format_.txt:11-21" + source_ref: "DraSticActivity.smali:5619-5624, libdrastic_arm64.so r2.6.0.4a Java_com_dsemu_drastic_DraSticJNI_fxLoad 0x18ea8-0x18f20 (path string handed to FUN_1d198, which tail-calls FUN_1ff78), FUN_1ff78 0x1ffd4-0x1ffe0 (open rb), 0x1fff4-0x20024 (strrchr '/' then '\\', directory kept for relative names), 0x20040-0x201d0 (fgets loop dispatching ,
, , , , ), 0x201ec-0x20214 (built-in pass-through shader when the file fails)" - name: ".dsd" path: "shaders/.dsd" @@ -274,8 +287,8 @@ files: bundled: true category: game_data description: "GLSL stage source named by a chain" - note: "Android only. Named by the shader entry of a pass, and carrying the vertex and fragment code for it, together with the .h and .hlsl files the include tags pull in. A stage that fails to compile leaves a dsd.log beside it." - source_ref: "assets/shaders/_shader_format_.txt:8-9, assets/shaders/_shader_format_.txt:36-40, assets/shaders/_shader_format_.txt:59-72, assets/shaders/_shader_format_.txt:75-98" + note: "Android only. Named by the shader entry of a pass relative to the .dfx, and carrying the vertex and fragment code for it. The .h and .hlsl headers an of the .dfx names are read whole the same way. A stage that fails to compile has its log written to .dsd.log beside it, and the chain falls back to the built-in shader." + source_ref: "libdrastic_arm64.so r2.6.0.4a FUN_1f734 0x1f850-0x1f894 (shader= value joined to the .dfx directory with %s/%s and passed to FUN_1ebfc), FUN_1ebfc 0x1ec20-0x1ec60 (open rb, FUN_1eaa4 splits and at 0x1eb10-0x1eb90, close), 0x1eca0-0x1ecec (compile, on failure FUN_1ed3c formats %s.log on the .dsd path and the log is written wb), FUN_1f0a0 0x1f17c-0x1f1c8 ( file= opened rb relative to the .dfx), 0x1f138 (read whole)" - name: ".raw" path: "shaders/.raw" @@ -283,8 +296,8 @@ files: bundled: true category: game_data description: "lookup texture named by a chain" - note: "Android only. Loaded when a texture tag names a file instead of the framebuffer or an FBO, with the dimensions and the format taken from the tag. SMAA is the one shipped chain that names any, taking smaa/AreaTexRGB.raw and smaa/SearchTexRGB.raw. The package also carries the non-RGB pair of the same two tables, which no shipped chain names." - source_ref: "assets/shaders/_shader_format_.txt:42-56, assets/shaders/SMAA.dfx:1-6" + note: "Android only. Loaded when a texture tag names a file instead of the framebuffer or an FBO, read whole with no length check and uploaded with the dimensions and the format taken from the tag. An absent file leaves the texture unloaded. SMAA is the one shipped chain that names any, taking smaa/AreaTexRGB.raw and smaa/SearchTexRGB.raw. The package also carries the non-RGB pair of the same two tables, which no shipped chain names." + source_ref: "libdrastic_arm64.so r2.6.0.4a FUN_1f260 0x1f464-0x1f49c (input= compared to null and framebuffer), 0x1f4c4-0x1f4d8 (any other name joined to the .dfx directory with %s/%s and opened rb), 0x1f4e0-0x1f52c (length by fseek and ftell, read whole), 0x1f628-0x1f638 (no upload when the open fails), 0x1f690 (glTexImage2D with the width, height, format and type of the tag), assets/shaders/SMAA.dfx:108-122" - name: ".zip" path: "virtual_controller/.zip" @@ -339,7 +352,7 @@ files: category: game_data description: "custom cheat file" note: "Plain text, one bracketed cheat name per block followed by its codes, a trailing plus marking the cheat active. Read on top of the entries usrcheat.dat holds and written back when a cheat is toggled." - source_ref: "drastic r2.5.2.2 load_custom_cheats 0x817b4, drastic r2.5.2.2 save_custom_cheats 0x81d24, drastic_readme.txt:789-812" + source_ref: "drastic r2.5.2.2 load_custom_cheats 0x817b4-0x817d8 (sprintf %s%ccheats%c%s.cht, fopen rb), 0x81888 (line opening with [), 0x818b4-0x818d4 (code words parsed by strtoul), 0x819cc-0x81a04 (strrchr ], then + marks the cheat active), drastic r2.5.2.2 save_custom_cheats 0x81d24" - name: ".gba" path: "slot2/.gba" @@ -397,8 +410,10 @@ exclusion_note: > unzipped_rom.nds, crash_dump.txt, the profiler dumps under profiles, and the drastic_mapped_memory.dat and drastic_mapped_memory_vram.dat scratch files of the memory mapper. - ref: official apk classes dex, libdrastic_arm64.so, drastic r2.5.2.2 0x11a938, - drastic r2.5.2.2 0x11aca8, drastic r2.5.2.2 0x11b440, drastic r2.5.2.2 0x11b650, - drastic r2.5.2.2 0x11edd8, drastic r2.5.2.2 0x120190, drastic r2.5.2.2 0x1201b0, - drastic r2.5.2.2 0x1202d0, drastic r2.5.2.2 0x1217f0, drastic r2.5.2.2 0x121868, - drastic r2.5.2.2 0x1249f8, drastic r2.5.2.2 0x124b08 + ref: official apk classes dex, libdrastic_arm64.so r2.6.0.4a, + drastic r2.5.2.2 initialize_system 0xf8b4-0xf8d4, drastic r2.5.2.2 quit 0xea08, + drastic r2.5.2.2 reset_system 0xfdac, drastic r2.5.2.2 select_delete_config_local 0x7a7b0, + drastic r2.5.2.2 initialize_memory 0x1bfa4, drastic r2.5.2.2 initialize_memory 0x1c1bc, + drastic r2.5.2.2 gamecard_load_program 0x6f6a8, drastic r2.5.2.2 savestate_index_to_path 0x75138, + drastic r2.5.2.2 nds_file_open 0x75688-0x757c0, drastic r2.5.2.2 icon_cache_load 0x7af60, + drastic r2.5.2.2 update_input 0x88b00, drastic r2.5.2.2 reset_input 0x89028 diff --git a/emulators/dreamm.yml b/emulators/dreamm.yml index e22c8ac61..d2e324e9a 100644 --- a/emulators/dreamm.yml +++ b/emulators/dreamm.yml @@ -51,9 +51,9 @@ notes: | %APPDATA%\Aaron Giles\DREAMM on Windows, ~/Library/Application Support/Aaron Giles/DREAMM on macOS, $XDG_DATA_HOME/Aaron Giles/DREAMM on Linux. Paths below are relative to that - directory. Startup writes config.json and creates install, gamedelta, - screenshots, logs and sounddata. - ref: SDL_GetPrefPath, strace of DREAMM 4.0 linux-x64 with a clean HOME + directory. + ref: DREAMM 4.0 linux-x64 SDL_GetPrefPath("Aaron Giles", "DREAMM") at + 0x1aadaa6-0x1aadab4 Audio hardware is set per game and per variant: speaker, cms, adlib, sb16, tandy, mt32 and gmidi. MT-32 and General MIDI output can go to an external @@ -73,17 +73,19 @@ notes: | both halves. The CM-32L sets name cm32l_pcm.rom as the full image, mt32_pcm_l.rom as the low half and cm32l_pcm_h.rom as the high half. munt identifies each file by size then SHA1 before opening the synth. - ref: set table 0x23db4a8, id lookup 0x164d050, availability 0x164d2a8, + ref: set table 0x23db4a8 read by 0x164d050 (record picked at + 0x164d165-0x164d2a1, file names read from 0x164d2a8), munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo The SC-55 is emulated by the Nuked SC-55 CLAP plug-in, unpacked to sounddata/Nuked-SC55.clap, which reads one model directory under - Nuked-SC55-Resources/ROMs. Five models are probed at startup: SC-55 v1.00, - v1.20, v1.21, v2.00 and SC-55mk2 v1.01. The plug-in identifies a set by - hashing the directory contents, so its own loader does not depend on the - file names. - ref: strace of DREAMM 4.0 linux-x64, Nuked-SC55-CLAP nuked_sc55.cpp:145-212 - GetRomBasePaths and Init, rom_loader.cpp:31-80 DetectRomsetsByHash + Nuked-SC55-Resources/ROMs. The DREAMM manifest names five model + directories: SC-55 v1.00, v1.20, v1.21, v2.00 and SC-55mk2 v1.01. The + plug-in identifies a set by hashing the directory contents, so its own + loader does not depend on the file names. + ref: DREAMM 4.0 linux-x64 manifest entries 0x23db118-0x23db298, + Nuked-SC55-CLAP nuked_sc55.cpp:145-212 GetRomBasePaths and Init, + rom_loader.cpp:31-80 DetectRomsetsByHash Both families install by dropping files on the Manage Sound Fonts & ROMs screen, or by copying them into sounddata by hand. A dropped file is matched @@ -93,7 +95,9 @@ notes: | sizes agree with the bundled munt ROM table. mt32_ctrl_2_03.rom is named by the v2.03 set but has no manifest entry, so it loads from sounddata and cannot be installed by drag and drop. - ref: manifest 0x23daf78, name match 0x16456a0, reverse lookup 0x1645880, + ref: manifest 0x23daf78 reached through the pointer at 0x242e9f0, name + match 0x16456a0 (load at 0x16456be), reverse lookup 0x1645880 (load + at 0x16458a1), "To install Sound Fonts (.sf2 files) or ROMs for Roland MIDI emulation, drop them onto this screen." @@ -123,7 +127,7 @@ files: crc32: "4c91fa96" sha1: "5a5cb5a77d7d55ee69657c2f870416daed52dea7" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23dafc8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23dafc8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_04_a.rom path: "sounddata/mt32emu/mt32_ctrl_1_04_a.rom" @@ -133,7 +137,7 @@ files: crc32: "a93b65f2" sha1: "9cd4858014c4e8a9dff96053f784bfaac1092a2e" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23dafd8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23dafd8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_04_b.rom path: "sounddata/mt32emu/mt32_ctrl_1_04_b.rom" @@ -143,7 +147,7 @@ files: crc32: "b5ee2192" sha1: "fe8db469b5bfeb37edb269fd47e3ce6d91014652" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23dafe8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23dafe8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_05.rom path: "sounddata/mt32emu/mt32_ctrl_1_05.rom" @@ -153,7 +157,7 @@ files: crc32: "e6bb2b77" sha1: "e17a3a6d265bf1fa150312061134293d2b58288c" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23daff8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23daff8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_05_a.rom path: "sounddata/mt32emu/mt32_ctrl_1_05_a.rom" @@ -163,7 +167,7 @@ files: crc32: "3281216c" sha1: "57a09d80d2f7ca5b9734edbe9645e6e700f83701" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db008, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db008 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_05_b.rom path: "sounddata/mt32emu/mt32_ctrl_1_05_b.rom" @@ -173,7 +177,7 @@ files: crc32: "e06d8020" sha1: "52e3c6666db9ef962591a8ee99be0cde17f3a6b6" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db018, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db018 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_06.rom path: "sounddata/mt32emu/mt32_ctrl_1_06.rom" @@ -183,7 +187,7 @@ files: crc32: "d63319e8" sha1: "a553481f4e2794c10cfe597fef154eef0d8257de" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db028, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db028 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_06_a.rom path: "sounddata/mt32emu/mt32_ctrl_1_06_a.rom" @@ -193,7 +197,7 @@ files: crc32: "29369ae1" sha1: "cc83bf23cee533097fb4c7e2c116e43b50ebacc8" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db038, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db038 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_06_b.rom path: "sounddata/mt32emu/mt32_ctrl_1_06_b.rom" @@ -203,7 +207,7 @@ files: crc32: "4d495d98" sha1: "bf4f15666bc46679579498386704893b630c1171" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db048, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db048 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_07.rom path: "sounddata/mt32emu/mt32_ctrl_1_07.rom" @@ -213,7 +217,7 @@ files: crc32: "a7c1531b" sha1: "b083518fffb7f66b03c23b7eb4f868e62dc5a987" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db058, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db058 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_07_a.rom path: "sounddata/mt32emu/mt32_ctrl_1_07_a.rom" @@ -223,7 +227,7 @@ files: crc32: "67fd8968" sha1: "13f06b38f0d9e0fc050b6503ab777bb938603260" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db068, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db068 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_1_07_b.rom path: "sounddata/mt32emu/mt32_ctrl_1_07_b.rom" @@ -233,7 +237,7 @@ files: crc32: "60f45882" sha1: "c55e165487d71fa88bd8c5e9c083bc456c1a89aa" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db078, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db078 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_bluer.rom path: "sounddata/mt32emu/mt32_ctrl_bluer.rom" @@ -243,7 +247,7 @@ files: crc32: "627b9a51" sha1: "7b8c2a5ddb42fd0732e2f22b3340dcf5360edf92" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0b8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0b8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_bluer_a.rom path: "sounddata/mt32emu/mt32_ctrl_bluer_a.rom" @@ -253,7 +257,7 @@ files: crc32: "d75fc3d9" sha1: "11a6ae5d8b6ee328b371af7f1e40b82125aa6b4d" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0c8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0c8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_bluer_b.rom path: "sounddata/mt32emu/mt32_ctrl_bluer_b.rom" @@ -263,7 +267,7 @@ files: crc32: "5816476f" sha1: "e0934320d7cbb5edfaa29e0d01ae835ef620085b" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0d8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0d8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_2_03.rom path: "sounddata/mt32emu/mt32_ctrl_2_03.rom" @@ -272,7 +276,7 @@ files: size: 131072 sha1: "5837064c9df4741a55f7c4d8787ac158dff2d3ce" validation: [size, sha1] - source_ref: "DREAMM 4.0 linux-x64: set table 0x23db5a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: set record 0x23db5a8 read by 0x164d050 (record picked at 0x164d28f, its file names read from 0x164d2a8), no manifest entry; munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_2_04.rom path: "sounddata/mt32emu/mt32_ctrl_2_04.rom" @@ -282,7 +286,7 @@ files: crc32: "59a49d5c" sha1: "2c16432b6c73dd2a3947cba950a0f4c19d6180eb" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db088, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db088 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_2_06.rom path: "sounddata/mt32emu/mt32_ctrl_2_06.rom" @@ -292,7 +296,7 @@ files: crc32: "94815415" sha1: "2869cf4c235d671668cfcb62415e2ce8323ad4ed" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db098, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db098 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_ctrl_2_07.rom path: "sounddata/mt32emu/mt32_ctrl_2_07.rom" @@ -302,7 +306,7 @@ files: crc32: "a016b607" sha1: "47b52adefedaec475c925e54340e37673c11707c" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0a8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0a8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: cm32l_ctrl_1_00.rom path: "sounddata/mt32emu/cm32l_ctrl_1_00.rom" @@ -312,7 +316,7 @@ files: crc32: "ee62022f" sha1: "73683d585cd6948cc19547942ca0e14a0319456d" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23daf88, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23daf88 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: cm32l_ctrl_1_02.rom path: "sounddata/mt32emu/cm32l_ctrl_1_02.rom" @@ -322,7 +326,7 @@ files: crc32: "b998047e" sha1: "a439fbb390da38cada95a7cbb1d6ca199cd66ef8" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23daf98, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23daf98 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: cm32ln_ctrl_1_00.rom path: "sounddata/mt32emu/cm32ln_ctrl_1_00.rom" @@ -332,7 +336,7 @@ files: crc32: "4a3bb4ef" sha1: "dc1c5b1b90a4646d00f7daf3679733c7badc7077" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23daf78, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23daf78 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" # -- MT-32 and CM-32L PCM ROMs -- - name: mt32_pcm.rom @@ -343,7 +347,7 @@ files: crc32: "573e31cc" sha1: "f6b1eebc4b2d200ec6d3d21d51325d5b48c60252" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0e8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0e8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_pcm_l.rom path: "sounddata/mt32emu/mt32_pcm_l.rom" @@ -353,7 +357,7 @@ files: crc32: "dd9deac3" sha1: "3a1e19b0cd4036623fd1d1d11f5f25995585962b" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db108, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db108 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: mt32_pcm_h.rom path: "sounddata/mt32emu/mt32_pcm_h.rom" @@ -363,7 +367,7 @@ files: crc32: "4ee6506c" sha1: "2cadb99d21a6a4a6f5b61b6218d16e9b43f61d01" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db0f8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db0f8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: cm32l_pcm.rom path: "sounddata/mt32emu/cm32l_pcm.rom" @@ -373,7 +377,7 @@ files: crc32: "4b961eba" sha1: "289cc298ad532b702461bfc738009d9ebe8025ea" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23dafa8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23dafa8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" - name: cm32l_pcm_h.rom path: "sounddata/mt32emu/cm32l_pcm_h.rom" @@ -383,7 +387,7 @@ files: crc32: "8e9ea06e" sha1: "3ad889fde5db5b6437cbc2eb6e305312fec3df93" validation: [size, crc32, sha1] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23dafb8, set table 0x23db4a8; sounddata/mt32emu-dreamm.so ROM table" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23dafb8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880; set record table 0x23db4a8 read by 0x164d050 (record picked at 0x164d165-0x164d2a1, its file names read from 0x164d2a8); munt ROMInfo.cpp:206-214 ROMInfo::getROMInfo, built into sounddata/mt32emu-dreamm.so" # -- Roland SC-55, sounddata/Nuked-SC55-Resources/ROMs -- # One complete set per model directory, the plugin loads a single directory. @@ -394,7 +398,7 @@ files: size: 32768 crc32: "d072c251" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db118" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db118 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.00/sc55_rom2.bin" @@ -403,7 +407,7 @@ files: size: 262144 crc32: "dbaaae8f" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db128" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db128 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.00/sc55_waverom1.bin" @@ -412,7 +416,7 @@ files: size: 1048576 crc32: "1ac774d3" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db138" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db138 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.00/sc55_waverom2.bin" @@ -421,7 +425,7 @@ files: size: 1048576 crc32: "8dcc592a" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db148" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db148 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom3.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.00/sc55_waverom3.bin" @@ -430,7 +434,7 @@ files: size: 1048576 crc32: "e21ebc04" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db158" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db158 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.20/sc55_rom1.bin" @@ -439,7 +443,7 @@ files: size: 32768 crc32: "4ed0d171" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db168" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db168 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.20/sc55_rom2.bin" @@ -448,7 +452,7 @@ files: size: 262144 crc32: "ebd488fd" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db178" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db178 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.20/sc55_waverom1.bin" @@ -457,7 +461,7 @@ files: size: 1048576 crc32: "1ac774d3" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db188" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db188 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.20/sc55_waverom2.bin" @@ -466,7 +470,7 @@ files: size: 1048576 crc32: "8dcc592a" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db198" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db198 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom3.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.20/sc55_waverom3.bin" @@ -475,7 +479,7 @@ files: size: 1048576 crc32: "e21ebc04" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1a8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1a8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.21/sc55_rom1.bin" @@ -484,7 +488,7 @@ files: size: 32768 crc32: "4ed0d171" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1b8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1b8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.21/sc55_rom2.bin" @@ -493,7 +497,7 @@ files: size: 262144 crc32: "2dc58549" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1c8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1c8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.21/sc55_waverom1.bin" @@ -502,7 +506,7 @@ files: size: 1048576 crc32: "1ac774d3" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1d8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1d8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.21/sc55_waverom2.bin" @@ -511,7 +515,7 @@ files: size: 1048576 crc32: "8dcc592a" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1e8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1e8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom3.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v1.21/sc55_waverom3.bin" @@ -520,7 +524,7 @@ files: size: 1048576 crc32: "e21ebc04" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db1f8" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db1f8 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v2.00/sc55_rom1.bin" @@ -529,7 +533,7 @@ files: size: 32768 crc32: "a160da90" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db208" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db208 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_rom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v2.00/sc55_rom2.bin" @@ -538,7 +542,7 @@ files: size: 262144 crc32: "1768cc18" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db218" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db218 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v2.00/sc55_waverom1.bin" @@ -547,7 +551,7 @@ files: size: 1048576 crc32: "1ac774d3" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db228" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db228 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v2.00/sc55_waverom2.bin" @@ -556,7 +560,7 @@ files: size: 1048576 crc32: "8dcc592a" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db238" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db238 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: sc55_waverom3.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55-v2.00/sc55_waverom3.bin" @@ -565,7 +569,7 @@ files: size: 1048576 crc32: "e21ebc04" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db248" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db248 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: rom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55mk2-v1.01/rom1.bin" @@ -574,7 +578,7 @@ files: size: 32768 crc32: "9b66631f" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db258" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db258 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: rom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55mk2-v1.01/rom2.bin" @@ -583,7 +587,7 @@ files: size: 524288 crc32: "fcee1e8e" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db268" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db268 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: rom_sm.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55mk2-v1.01/rom_sm.bin" @@ -592,7 +596,7 @@ files: size: 4096 crc32: "702c0a82" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db278" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db278 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: waverom1.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55mk2-v1.01/waverom1.bin" @@ -601,7 +605,7 @@ files: size: 2097152 crc32: "1519d3b3" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db288" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db288 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" - name: waverom2.bin path: "sounddata/Nuked-SC55-Resources/ROMs/SC-55mk2-v1.01/waverom2.bin" @@ -610,4 +614,4 @@ files: size: 1048576 crc32: "0f826c7f" validation: [size, crc32] - source_ref: "DREAMM 4.0 linux-x64: ROM manifest 0x23db298" + source_ref: "DREAMM 4.0 linux-x64: ROM manifest entry 0x23db298 {crc32, size, path} read through the pointer at 0x242e9f0 by the name, size and CRC32 match 0x16456a0 and the size and CRC32 to path lookup 0x1645880" diff --git a/emulators/dsperate.yml b/emulators/dsperate.yml index 528c5a43f..2017c7e2e 100644 --- a/emulators/dsperate.yml +++ b/emulators/dsperate.yml @@ -32,6 +32,32 @@ data_root: source_ref: "src/frontend/sdl/config.cpp:39-49" note: "~/.config/dsperate when XDG_CONFIG_HOME is unset. System files are read wherever the [paths] keys of the ini point." +config_reads: + - file: "dsperate.ini" + platforms: [rocknix] + revision: "ddf2910e6d80220c6b22b4df61f0786ac9879cda" + revision_from: "PKG_VERSION 3.0.5, the release binaries CI built from tag v3.0.5" + source_ref: "src/frontend/sdl/main.cpp:1065, 1155-1157, src/frontend/sdl/config.cpp:64-81" + keys: + - key: + - "[paths] bios9" + - "[paths] bios7" + source_ref: "src/frontend/sdl/main.cpp:1175, 1270-1274, src/core/nds.cpp:114-129" + condition: "both present, otherwise FreeBIOS" + - key: "[paths] firmware" + source_ref: "src/frontend/sdl/main.cpp:1178, 1270, src/core/nds.cpp:123, 134-135" + - key: + - "[paths] bios9i" + - "[paths] bios7i" + source_ref: "src/frontend/sdl/main.cpp:1179-1186, 1319-1322, 1331-1334, src/core/nds_dsi.cpp:88-99" + condition: "DSi session" + - key: "[paths] dsi_firmware" + source_ref: "src/frontend/sdl/main.cpp:1176-1178, 1270" + condition: "DSi session" + - key: "[paths] dsi_nand" + source_ref: "src/frontend/sdl/main.cpp:1158-1162, 1324-1326, 1337, src/core/nds_dsi.cpp:114-120" + condition: "--dsi-mode, BootMenuDSi.nds or a .dspr.nds shortcut" + notes: | Nintendo DS emulator for ARM handhelds with a DSi mode. ROCKNIX installs the release tarball for its architecture and runs it with --config pointing at diff --git a/emulators/duckstation.yml b/emulators/duckstation.yml index 739810077..bfb8f089d 100644 --- a/emulators/duckstation.yml +++ b/emulators/duckstation.yml @@ -33,6 +33,61 @@ data_root: source_ref: "src/core/core.cpp:137-151, src/core/core.cpp:190-215" note: "portable.txt or settings.ini beside the executable, or beside the AppImage, makes that folder the root" +pin_build: + - platform: emuelec + repo: "https://github.com/EmuELEC/EmuELEC" + revision: "v4.8" + path: "packages/sx05re/emulators/duckstation/package.mk" + variable: PKG_VERSION + value: "fd3507c16d098fb32806c281caaefb205946da8a" + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/duckstation-sa/package.mk" + variable: PKG_VERSION + value: "0.1-10998" +config_reads: + - file: "settings.ini" + platforms: [emuelec] + source_ref: "src/frontend-common/common_host_interface.cpp:403-407, 3042-3050, 3304-3327, src/duckstation-nogui/main.cpp:62-64, 137-140, src/duckstation-nogui/nogui_host_interface.cpp:39-42" + keys: + - key: "[BIOS] SearchDirectory" + source_ref: "src/core/host_interface.cpp:253-260" + - key: + - "[BIOS] PathNTSCU" + - "[BIOS] PathNTSCJ" + - "[BIOS] PathPAL" + source_ref: "src/core/host_interface.cpp:262-375, src/core/system.cpp:817" + condition: "the console region; an empty value scans SearchDirectory" + - file: "settings.ini" + platforms: [rocknix] + revision: "9b0a4ec559ae83bfdb14685932b036ad7c1701be" + revision_from: "PKG_VERSION 0.1-10998, the AppImage of tag v0.1-10998" + source_ref: "src/core/core.cpp:105-223, 227-230, 232-275, src/duckstation-qt/qthost.cpp:796-800" + keys: + - key: "[BIOS] SearchDirectory" + source_ref: "src/core/settings.cpp:2709-2719, 2723" + - key: + - "[BIOS] PathNTSCU" + - "[BIOS] PathNTSCJ" + - "[BIOS] PathPAL" + source_ref: "src/core/bios.cpp:351-458, src/core/system.cpp:2923" + condition: "the console region; an empty value scans SearchDirectory" + - file: "settings.ini" + platforms: [retrobat] + revision: "5fd366809053fe287291de7a39752c4d5d5b146b" + revision_from: "version 0.1-11752-g5fd366809 of duckstation.exe in RetroBat's stable duckstation.7z, 2026-11-10" + source_ref: "src/core/core.cpp:131-249, 253-256, 258-301, src/duckstation-qt/qthost.cpp:803-807" + keys: + - key: "[BIOS] SearchDirectory" + source_ref: "src/core/settings.cpp:2859-2869, 2873" + - key: + - "[BIOS] PathNTSCU" + - "[BIOS] PathNTSCJ" + - "[BIOS] PathPAL" + source_ref: "src/core/bios.cpp:351-456, src/core/system.cpp:2671" + condition: "the console region; an empty value scans SearchDirectory" + notes: | DuckStation auto-detects BIOS by MD5 hash from a flat scan of the BIOS directory. ref: src/core/bios.cpp:458-479 (FindBIOSImagesInDirectory, scans all files by size) diff --git a/emulators/epsxe.yml b/emulators/epsxe.yml index 1598b88e8..334de3a24 100644 --- a/emulators/epsxe.yml +++ b/emulators/epsxe.yml @@ -61,13 +61,10 @@ notes: | ends. The HLE branch, taken when the BiosHLE setting is on, skips the read entirely and logs " * ePSXe: using HLE BIOS (compatibility limited)", so any one of the images below fills the slot and none of them is needed on its own. - HLE arrived in 1.9.25 and savestates made under it are not interchangeable - with savestates made under a real image. ref: ePSXe 2.0.5 Linux x64 load_bios 0x433540-0x433621, ePSXe 2.0.5 Linux x64 bios_name_select 0x4334c0-0x4334f2, ePSXe 2.0.5 Linux x64 write_configfiledefault 0x42ae99-0x42aeeb, - ePSXeReadPreferences.java:20-30, ePSXe.java:445-453, - docs/ePSXe_en.txt:260-271, docs/ePSXe_en.txt:883-888 + ePSXeReadPreferences.java:20-30, ePSXe.java:445-453 Both consumer families carry a table of the images they recognise, and the two tables are built differently and do not hold the same set. Android ships 21 @@ -90,11 +87,8 @@ notes: | No region decides which image is taken. findBios keeps the first md5 that answers anywhere in the walk, the Windows ids only pick a label to display, and - the JP, US and PAL words are part of that label string. Automatic selection of - a required BIOS per game existed once and was removed because it stopped - Legend of Dragoon US and Wild Arms 2 US from running. - ref: ScanBiosTask.java:167-171, ePSXe 2.0.18 Windows 0x42f5aa-0x42f5c2, - docs/ePSXe_en.txt:1243-1244 + the JP, US and PAL words are part of that label string. + ref: ScanBiosTask.java:167-171, ePSXe 2.0.18 Windows 0x42f5aa-0x42f5c2 Video, sound, cdrom and input go through the PSEmu Pro plugin interface. init_gpu builds plugins/ from the configured name, dlopens it and diff --git a/emulators/fpse-ng.yml b/emulators/fpse-ng.yml index 9897c8943..5f38217fb 100644 --- a/emulators/fpse-ng.yml +++ b/emulators/fpse-ng.yml @@ -70,13 +70,11 @@ notes: | of 0x80000 bytes after "Loading '%s'...", and a miss reports "Can't load biosfile '%s', switching to HLE", sets the HLE bit and writes "CEX-3000/1001/1002 by K.S.", "System ROM Version 2.2 12/04/95 A" and the Sony - copyright line into BIOS memory, so no image is needed on its own. The FAQ on - the emulator's own site states that a file named scph1001.bin is recommended - and is not distributed with the emulator. + copyright line into BIOS memory, so no image is needed on its own. ref: Main.java:1169, Main.java:21925-21927, Main.java:25833-25835, Main.java:9943-9977, Main.java:30177-30192, Main.java:5392-5396, Main.java:36446-36451, Main.java:28751-28754, - libfpse.so 0x70e20-0x70f20, fpsece.net/faq.html + libfpse.so 0x70e20-0x70f20 Automatic detection recognises one dump and does it on content. Scanning storage, FPseNG keeps files whose lowercased name ends in .bin and whose length @@ -106,7 +104,8 @@ notes: | Android runtime and are not files anyone supplies. ref: Main.java:25134-25137, Main.java:27300-27312, Main.java:9985, Main.java:1116-1133, Main.java:8496, Main.java:13854, - Main.java:23615-23621, libfpse.so readelf -d + Main.java:23615-23621, + FPseNG 1.13 libfpse.so .dynamic DT_NEEDED 0x220ae0-0x220baf Resources unpack through helpers that differ in one respect. The guarded one writes only when the target is absent, so bios/kanji.rom, fpse.ini and the @@ -171,7 +170,7 @@ files: category: game_data description: "software renderer plugin" note: "Named by System.loadLibrary(\"soft1\") outside any catch and listed in DT_NEEDED by the core. Also holds the VR background loader." - source_ref: "Main.java:27302, libfpse.so readelf -d" + source_ref: "Main.java:27302, FPseNG 1.13 libfpse.so DT_NEEDED libsoft1.so at 0x220af0 (loader-resolved)" - name: libspuplugin.so size: 51120 @@ -181,7 +180,7 @@ files: category: game_data description: "sound plugin" note: "Named by System.loadLibrary(\"spuplugin\") outside any catch and listed in DT_NEEDED." - source_ref: "Main.java:27301, libfpse.so readelf -d" + source_ref: "Main.java:27301, FPseNG 1.13 libfpse.so DT_NEEDED libspuplugin.so at 0x220b00 (loader-resolved)" - name: libopengl.so size: 688072 @@ -192,7 +191,7 @@ files: aliases: ["libopengl1.so"] description: "OpenGL renderer plugin" note: "Named by System.loadLibrary(\"opengl\") outside any catch and listed in DT_NEEDED. A plugin chosen from the .so browser is copied over libopengl1.so under the root." - source_ref: "Main.java:27304, Main.java:9985, libfpse.so readelf -d" + source_ref: "Main.java:27304, Main.java:9985, FPseNG 1.13 libfpse.so DT_NEEDED libopengl.so at 0x220ae0 (loader-resolved)" - name: libnfsplugin.so size: 300944 @@ -202,7 +201,7 @@ files: category: game_data description: "NFS client plugin, for discs read from a network share" note: "Named by System.loadLibrary(\"nfsplugin\") outside any catch and listed in DT_NEEDED. Backs the isnfsbios and copyfromnfs entry points." - source_ref: "Main.java:27303, Main.java:25670, libfpse.so readelf -d" + source_ref: "Main.java:27303, Main.java:25670, FPseNG 1.13 libfpse.so DT_NEEDED libnfsplugin.so at 0x220b30 (loader-resolved)" - name: libsdl.so size: 67536 @@ -212,7 +211,7 @@ files: category: game_data description: "SDL audio backend" note: "Named by System.loadLibrary(\"sdl\") from a static block that catches UnsatisfiedLinkError, and listed in DT_NEEDED, so the core will not link without it." - source_ref: "Main.java:25134, libfpse.so readelf -d" + source_ref: "Main.java:25134, FPseNG 1.13 libfpse.so DT_NEEDED libsdl.so at 0x220b20 (loader-resolved)" - name: libneon.so size: 5688 @@ -222,7 +221,7 @@ files: category: game_data description: "NEON colour conversion routines" note: "Named by System.loadLibrary(\"neon\") from the same static block and listed in DT_NEEDED." - source_ref: "Main.java:25135, libfpse.so readelf -d" + source_ref: "Main.java:25135, FPseNG 1.13 libfpse.so DT_NEEDED libneon.so at 0x220b10 (loader-resolved)" - name: libuncompress.so size: 1512392 @@ -232,7 +231,7 @@ files: category: game_data description: "archive extractor for .zip, .rar, .7z, .ape and .ecm images" note: "Named by System.loadLibrary(\"uncompress\") outside any catch, and the only one of the plugins the core does not list in DT_NEEDED." - source_ref: "Main.java:27300, Main.java:25408, libfpse.so readelf -d" + source_ref: "Main.java:27300, Main.java:25408, FPseNG 1.13 libfpse.so .dynamic DT_NEEDED 0x220ae0-0x220baf (no libuncompress.so)" # The Shaders setting walks FPse64/shaders and reads the selected pair, # passing the bytes to setVSH and setFSH. The packaged set below is copied diff --git a/emulators/fpse.yml b/emulators/fpse.yml index 6386b8238..d8538e43e 100644 --- a/emulators/fpse.yml +++ b/emulators/fpse.yml @@ -95,7 +95,7 @@ notes: | ref: Main.java:29686-29698, Main.java:20405-20406, Main.java:11010, Main.java:3417-3423, Main.java:1120-1137, FPse 0.11.190 Main.java:24126-24207, FPse 0.11.190 Main.java:860-871, - FPse 12.1 libfpse.so readelf -d, + FPse 12.1 libfpse.so .dynamic DT_NEEDED 0x37652c-0x376593, fpse.net/plugins605v7.zip md5 ae5dbdc27452092af3e712448f427fd3 Resources unpack through two helpers that differ in one respect. b2 writes only @@ -181,7 +181,7 @@ files: category: game_data description: "SDL 1.2 audio backend" note: "Named by System.loadLibrary(\"sdl\") and listed in DT_NEEDED." - source_ref: "Main.java:20405, FPse 12.1 libfpse.so readelf -d" + source_ref: "Main.java:20405, FPse 12.1 libfpse.so DT_NEEDED libsdl.so at 0x37654c (loader-resolved)" - name: libneon.so size: 5308 @@ -191,7 +191,7 @@ files: category: game_data description: "NEON colour conversion routines" note: "Named by System.loadLibrary(\"neon\") and listed in DT_NEEDED, which resolves bgr555rgb565neon for the core." - source_ref: "Main.java:20406, FPse 12.1 libfpse.so readelf -d" + source_ref: "Main.java:20406, FPse 12.1 libfpse.so DT_NEEDED libneon.so at 0x376544 (loader-resolved)" - name: libuncompress.so size: 1138680 diff --git a/emulators/future-pinball-fploader.yml b/emulators/future-pinball-fploader.yml index 6e141e1c1..33c191bca 100644 --- a/emulators/future-pinball-fploader.yml +++ b/emulators/future-pinball-fploader.yml @@ -7,8 +7,9 @@ profiled_date: "2026-08-11" source_commit: "e13007994011ae57dd9d9f48674c1f774183914b" core_version: "1.5-408" version_basis: - kind: unverified - why: no_artifact + kind: package + url: "https://www.ravarcade.pl/files/BAM_v1.5-408.zip" + artifact: "BAM_v1.5-408.zip, BAM/BAM.dll fixed file version 1.5.408.0" display_name: "Future Pinball (BAM)" cores: - future-pinball-fploader @@ -42,7 +43,10 @@ notes: | /Open, /Play, /Exit and /ArcadeRender reach it. ref: BAM_FPloader FPLoader.cpp:40-48, 87-111, 166-240, 249-257 - BAM.dll is closed source. Its version resource reads 1.5.408 and its debug + BAM.dll is closed source. The copy in BAM_v1.5-408.zip, served by + ravarcade.pl, has sha256 + f3163c34adc3423d0b4c1f64399a91d090b4f7d0c54dc35049833466645645f7. Its version + resource reads 1.5.408 and its debug tags name BAM.cpp, dllmain.cpp, BallManager.cpp, RenderEngine.cpp, plugin.cpp, pbo.cpp, stereo3d.cpp and debug.cpp. Twenty five entry points are detoured in one pass: CreateFileA, CreateFileW, ReadFile, WriteFile, @@ -87,24 +91,36 @@ notes: | path and is what the presets under XML\ are edited copies of. The 83 GLSL programs BAM renders with are resources of type TEXT inside BAM.dll, so no shader file is read from disk. - ref: BAM.dll 1.5-408 .text:0x1002d4f3-0x1002d52d, 0x100ae8ec-0x100ae990, + ref: BAM.dll 1.5-408 FUN_1002d470 0x1002d4ff-0x1002d58b, FUN_1002d0d0 0x1002d2b8-0x1002d33c, + FUN_100ae3b0 0x100ae8ec-0x100ae990, 0x10037130-0x100371de, 0x1007e83b-0x1007e896, .rsrc TEXT, Future Pinball.exe 1.9.1.20101231 .rsrc BMP, SHADERS, XML Plugins are loaded by changing the working directory to plugins\, walking - *.dll with FindFirstFileA, calling LoadLibraryA on each and binding - BAM_PluginStart and BAM_PluginStop. A plugin keeps its settings by writing a - raw structure to .cfg in that working directory, which is why - the cfg files beside the plugins carry no text. - ref: BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c, - BAM_Plugins Common/BAM.h:116-157 + *.dll with FindFirstFileA and calling LoadLibraryA on each under + SetErrorMode(SEM_FAILCRITICALERRORS). A module without BAM_load is freed, so a + plugin whose own imports are missing is skipped and BAM carries on. The rest + get BAM_PluginStart, BAM_PluginStop, BAM_GetCOM and the other entry points + bound. BAM_Plugins, published by the same author, holds the source of the + OpenVR and PostFX plugins and the common header, read at commit aa27aa3a. + A plugin keeps its settings by writing a raw structure to + .cfg in that working directory, which is why the cfg files + beside the plugins carry no text. + ref: BAM.dll 1.5-408 FUN_100cf360 0x100cf3d2-0x100cf48c (GetModuleFileNameA, + plugins\, *.dll, _getcwd, _chdir, FindFirstFileA), 0x100cf74f-0x100cf767 + (SetErrorMode, LoadLibraryA), 0x100cf78e-0x100cf7aa (BAM_load, FreeLibrary), + 0x100cf7cf-0x100cf8c7 (BAM_PluginStart, BAM_PluginStop, BAM_GetCOM), + BAM_Plugins Common/BAM.h:117-157 renderingengine.dll is bound in BAM.dll's import directory through FindProgram, SetModuleWithResources, LoadFileToMemory and SaveFileFromMemory, so the loader resolves it before any BAM code runs. It carries Assimp, zlib, libpng and libjpeg, reads the zip packs and writes the per table shadow cache under Cache\. - ref: BAM.dll 1.5-408 import directory, .text:0x10105c18-0x1010697f + ref: BAM.dll 1.5-408 import descriptor renderingengine.dll IAT 0x1055ea0c-0x1055eb1f (69 functions, + no delay-load directory), FUN_1007d650 0x1007dccd-0x1007dcd6 (SetModuleWithResources, RE::Init), + FUN_101053d0 0x10105c65-0x10105cca (Cache\%s-shadows, %s\%s.%s with zip), + 0x10105df9 (LoadFileToMemory) ES-DE declares the emulator as FUTURE-PINBALL-FPLOADER for Windows only, finding FPLoader.exe under BAM\, BAM-OpenVR\ or BAM-OpenVR-OC\, and invokes it @@ -141,10 +157,11 @@ files: size: 8791552 sha1: "b471bb4affb974e0af9874ee6fe28c4417809926" description: "Rendering engine and asset loader behind BAM" - source_ref: "BAM.dll 1.5-408 import directory, BAM_FPloader FPLoader.cpp:249-257" + source_ref: "BAM.dll 1.5-408 import descriptor renderingengine.dll IAT 0x1055ea0c-0x1055eb1f (69 functions, no delay-load directory, so loader-resolved), FUN_1007d650 0x1007dccd (SetModuleWithResources), 0x1007dcd6 (RE::Init), FUN_1002d0d0 0x1002d2b8 (GetZipHandler on a ball zip), BAM_FPloader FPLoader.cpp:249-257" note: >- Bound statically by BAM.dll, so the injected LoadLibraryA fails without - it. The loader adds its own directory to %PATH% for this file alone. + it and no BAM code runs. The loader adds its own directory to %PATH% for + this file alone. - name: Future Pinball.exe system: fpinball @@ -166,11 +183,12 @@ files: bundled: true size: 207104 description: "Head tracking calibration host" - source_ref: "BAM-Tracker.exe import directory, BAM.dll 1.5-408 .text:0x1008320e" + source_ref: "BAM-Tracker.exe 1.5-408 (sha256 b2841b993dafde56) import descriptor BAM.dll IAT 0x41702c-0x41703b (BT::GetTrackersList, SetTracker, GetData, Kill, loader-resolved), FUN_00407460 0x407480 (GetTrackersList), 0x40750e (SetTracker), BAM.dll 1.5-408 FUN_100829a0 0x100831f0-0x10083260 (GetCommandLineA, _strlwr, strstr for bam-tracker.exe, flag 0x108009ab)" note: >- - Imports BAM.dll and runs it outside the game. BAM.dll lowercases the host - command line and looks for this name to know it is hosted by the tracker - rather than by Future Pinball. + A separate program the user starts. It imports BAM.dll and drives its + trackers outside the game. BAM.dll lowercases the host command line and + looks for this name to know it is hosted by the tracker rather than by + Future Pinball. Nothing in the loader or in BAM.dll starts it. - name: ModelImporter.exe sha1: dd3874742bfe5f9c2828cb9c4e249c2f4722bd51 @@ -179,10 +197,11 @@ files: bundled: true size: 4553472 description: "Converts models to the .fpm form tables import" - source_ref: "ModelImporter.exe import directory, .rdata dialog filter" + source_ref: "ModelImporter.exe 1.5-408 (sha256 a693549f20697b02) import descriptor renderingengine.dll IAT 0x71e4bc-0x71e60b (84 functions, loader-resolved), 0x42db53 (lpstrFilter 3D Models *.fpm;*.obj;*.ms3d;*.md5mesh;*.fbx), FUN_0042da70 0x42dae9 (GetOpenFileNameA), FUN_00431d40 0x431dc3 (ImportedModel::Load on the chosen file)" note: >- - Bound to renderingengine.dll for the Assimp side. Its open dialog accepts - .fpm, .obj, .ms3d, .md5mesh and .fbx. + A separate program the user starts. It needs renderingengine.dll beside it + for the Assimp side. Its open dialog accepts .fpm, .obj, .ms3d, .md5mesh + and .fbx. # -- Settings read from the BAM directory. BAM writes each of them, so a fresh # install has only default.seq and the first save creates the rest. @@ -294,7 +313,7 @@ files: category: game_data size: 480842 description: "Ball texture showing the rotation axes" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Baseball.zip sha1: badfe5b7ab16c88f3fe255143546932c09fc2097 @@ -305,7 +324,7 @@ files: category: game_data size: 248548 description: "Baseball ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Basketball 1.zip sha1: 5aff2d72c317d58a6f1951811a31ec1b99dfdfe4 @@ -316,7 +335,7 @@ files: category: game_data size: 148883 description: "Basketball ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Basketball 2.zip sha1: 1fa517b848c69c0b2c2f3a32e4097a157fff3aa2 @@ -327,7 +346,7 @@ files: category: game_data size: 74296 description: "Second basketball ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Cue Black.zip sha1: 9238286e57f346fd9b9ed3d8ffa977083b9d3feb @@ -338,7 +357,7 @@ files: category: game_data size: 548084 description: "Black cue ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Cue White.zip sha1: 948eec0af66150dc908622bd48e867e85fb0d6c5 @@ -349,7 +368,7 @@ files: category: game_data size: 554040 description: "White cue ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: earth.zip sha1: 0b30d717df74d90c26769d58055b507b89fdc1fc @@ -360,7 +379,7 @@ files: category: game_data size: 728508 description: "Globe ball texture, three BMP resources" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: EYETOY.zip sha1: 89d8f29048176e8faff89cd48d0eda7b4875bf49 @@ -371,7 +390,7 @@ files: category: game_data size: 373860 description: "EyeToy ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Fireball.zip sha1: 28a08c3911ef46aca8880587bed56dfa4f99062a @@ -382,7 +401,7 @@ files: category: game_data size: 240337 description: "Fireball ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Knight.zip sha1: 969d38e02a6759629cc827501a049c60582d9531 @@ -393,7 +412,7 @@ files: category: game_data size: 421287 description: "Knight ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: latlong.zip sha1: d2f65f0f32e21dfc65d61a384df525dedbc57a8a @@ -404,7 +423,7 @@ files: category: game_data size: 1066167 description: "Latitude and longitude grid ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" - name: Soccer Ball 1.zip sha1: 0a1e886e991d88761502d8434248e986bf9c238f @@ -415,7 +434,7 @@ files: category: game_data size: 54397 description: "Soccer ball texture" - source_ref: "BAM.dll 1.5-408 .text:0x1002d513-0x1002d52d" + source_ref: "BAM.dll 1.5-408 FUN_1002d470 0x1002d513-0x1002d52b (balls\\*.zip beside BAM.dll, FindFirstFileA), 0x1002d58b (FUN_1002d0d0: GetZipHandler 0x1002d2b8, LoadTexture BMP/452.BMP 0x1002d2e0)" # -- Physics documents, reached through XML_Presets.txt -- @@ -592,7 +611,7 @@ files: required: false size: 3388680 description: "Head tracking from any webcam, desktop geometry" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "Bound to AVICAP32 and MSVFW32 and reads the cascade files below. The 1.5-408 zip moves it to removed_plugins\\, while bam-setup.exe installs it here." - name: Simple Cam.dll @@ -601,7 +620,7 @@ files: required: false size: 3262728 description: "Head tracking from any webcam, cabinet geometry" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "The 1.5-408 zip moves it to removed_plugins\\, while bam-setup.exe installs it here." - name: PS3Eye.dll @@ -610,7 +629,7 @@ files: required: false size: 1699080 description: "Head tracking from a PlayStation Eye" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "Bound to CLEyeMulticam.dll, which comes from the CL-Eye SDK. The 1.5-408 zip moves it to removed_plugins\\, while bam-setup.exe installs it here." - name: DesktopPS3Eye.dll @@ -619,7 +638,7 @@ files: required: false size: 1813768 description: "PlayStation Eye tracking with desktop geometry" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "The 1.5-408 zip moves it to removed_plugins\\, while bam-setup.exe installs it here." - name: HT-PS3Eyes.dll @@ -630,7 +649,7 @@ files: bundled: true size: 1432272 description: "Two PlayStation Eye cameras tracking an infrared marker" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: >- Keeps its calibration in HT-PS3Eyes.dat and HT-PS3Eyes-FixCamExport.dat beside itself, both produced by the calibration pass. @@ -643,7 +662,7 @@ files: bundled: true size: 2792144 description: "Head tracking from a Kinect for Xbox 360" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "Bound to Kinect10.dll and FaceTrackLib.dll." - name: DesktopKinect.dll @@ -654,7 +673,7 @@ files: bundled: true size: 31952 description: "Kinect tracking with desktop geometry" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" - name: Kinect2.dll sha1: 22e32cd595f825b004c10d46746cd28c973f649b @@ -664,7 +683,7 @@ files: bundled: true size: 2791632 description: "Head tracking from a Kinect for Windows v2" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" note: "Bound to Kinect20.dll." - name: FaceTrackLib.dll @@ -675,7 +694,11 @@ files: bundled: true size: 920272 description: "Microsoft face tracking library used by the Kinect plugins" - source_ref: "DesktopKinect.dll, Kinect.dll import directories" + source_ref: "Kinect.dll (sha256 3e3225474bfca5ad) import descriptor FaceTrackLib.dll IAT 0x1021e000-0x1021e007 (FTCreateImage, FTCreateFaceTracker, loader-resolved), 0x10003ae2 (FTCreateFaceTracker), DesktopKinect.dll (sha256 4aa59e24530b739e) import descriptor FaceTrackLib.dll IAT 0x10005000-0x10005007, 0x10002954 (FTCreateFaceTracker)" + note: >- + A load time dependency of the two Kinect 1 plugins, resolved from the + plugins\ working directory. Without it their LoadLibraryA fails and BAM + skips them. - name: FaceTrackData.dll sha1: aeb806a4330ce8716feffdd844e71084a86b2f88 @@ -685,7 +708,11 @@ files: bundled: true size: 10650832 description: "Model data for the face tracking library" - source_ref: "FaceTrackLib.dll .rdata, wide literal FaceTrackData.dll" + source_ref: "FaceTrackLib.dll (sha256 381e24c0dc0e8471) FUN_10051fe0 0x10052072-0x100520af (no model path from the caller: GetModuleFileNameW, cut at the last backslash, StringCchCopyW of FaceTrackData.dll), 0x10052408 (FUN_1004d830 on \\AAMModel\\3DModel.txt), FUN_10009460 0x10009520 (the part of the path up to .dll passed to FUN_10009390), FUN_10009390 0x1000940c (LoadLibraryExW with flags 0x22, as a data file), FUN_10009460 0x1000956a (FUN_10008fc0, FindResourceW type RT_RCDATA at 0x10009032 for the rest)" + note: >- + The face tracker's models are RCDATA resources inside this file, named + AAMModel, MouthModel, EvalModel, NeuralNet and ViewModel paths under it. + FaceTrackLib looks for it beside itself, so in plugins\. - name: FreeTrack.dll sha1: 8bb00560edc99048cda818cb81afa823e8d1a682 @@ -695,7 +722,7 @@ files: bundled: true size: 95440 description: "Head tracking from a FreeTrack server" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" - name: TrackIR.dll sha1: 000deaf4533b239cd3c22f250dcbb0d55123dc16 @@ -705,11 +732,12 @@ files: bundled: true size: 20176 description: "Head tracking from a NaturalPoint TrackIR" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c, TrackIR.dll .text:0x100018c7" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent), TrackIR.dll (sha256 101dc5958e8e3df0) 0x10001970-0x1000198a (detours LoadLibraryA and GetProcAddress, originals kept at 0x100043c4 and 0x100043c8), FUN_100018c0 0x100018c7-0x100018e1 (strstr for NPClient, module handle kept), FUN_10001900 0x10001917-0x10001962 (NP_GetData from that module answered by the plugin's wrapper)" note: >- - Matches the name NPClient with strstr and pairs LoadLibraryA with - GetProcAddress on it. The plugin imports no registry function, so the - client library is resolved as a plain module name. + Loads nothing itself. It detours LoadLibraryA and GetProcAddress in the + game, so when Future Pinball loads NPClient.dll from the TrackIR install + the plugin keeps the module handle and puts its own NP_GetData in front of + the real one. - name: PostFX.dll sha1: 52a49fdbb9328a54e9add344def6636be3d151e1 @@ -719,7 +747,7 @@ files: bundled: true size: 39632 description: "Bloom and the unfinished ambient occlusion pass" - source_ref: "BAM.dll 1.5-408 .text:0x100cf5ff, BAM_Plugins PostFX/PostFX.cpp:41-45" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent), 0x100cf5ff-0x100cf605 (_stricmp of the file name with PostFX.dll), BAM_Plugins PostFX/PostFX.cpp:41-45" note: >- Named in BAM.dll and compared against the enumerated file names, so it is the one plugin the mod knows by name. Its nine GLSL programs are TEXT @@ -727,6 +755,17 @@ files: under this name, the 39632 bytes of bam-setup.exe and 191240 bytes in BAM-OpenVR.zip. + - name: PostFX.cfg + sha1: a191e0c95a4ef116d073f18ae7ccb8c0af3f68bb + system: fpinball + path: "plugins/PostFX.cfg" + required: false + bundled: true + size: 104 + description: "Settings block of the PostFX plugin" + source_ref: "PostFX.dll (sha256 30f9ce9cc725420f) FUN_10001280 0x100012ca-0x100012db (PostFX, .cfg after the working directory), FUN_10001320 0x10001668 (fopen_s rb), 0x10001683 (fread 0x68 bytes), BAM_Plugins PostFX/main.cpp:101, BAM_Plugins PostFX/main.cpp:130, BAM_Plugins Common/BAM.h:117-157" + note: "Read as a raw 104 byte structure and written back when a value changes. The OpenVR package carries its own copy for its PostFX build." + - name: PinballHighScore.dll sha1: 7734aecaa3cd1d019db365aecfd9df2a5ef8efbe system: fpinball @@ -735,7 +774,7 @@ files: bundled: true size: 918224 description: "Records high scores across tables" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent)" - name: PinballHighScore.cfg sha1: 852b39ba5db64e8a84e4b0612521caa5bd44fe02 @@ -745,7 +784,11 @@ files: bundled: true size: 1016 description: "Settings block the high score plugin reads and writes" - source_ref: "BAM_Plugins Common/BAM.h:136-157" + source_ref: "PinballHighScore.dll (sha256 f6fd7ed1c79302a7) FUN_10086c90 0x10086caa-0x10086cf9 (GetCurrentDirectoryA, backslash, PinballHighScore, .cfg), FUN_10084240 0x100842c5 (fopen_s rb), 0x100842e2 (fread 0x3f8 bytes), FUN_10084310 0x10084367 (fopen_s wb when the block changed)" + note: >- + Read whole as a 1016 byte block from the working directory, which BAM has + set to plugins\. Missing, the defaults stay in memory and the next change + writes it. - name: PinballHighScore.db system: fpinball @@ -753,7 +796,7 @@ files: required: false size: 45056 description: "Score database the plugin opens by name" - source_ref: "PinballHighScore.dll .rdata" + source_ref: "PinballHighScore.dll (sha256 f6fd7ed1c79302a7) FUN_100847e0 0x100847f5-0x100847fa (SQLite open of PinballHighScore.db, FUN_1007f9b0), 0x1008480e, 0x10084825 (CREATE TABLE localPlayerData and config), FUN_10085320 0x10085345-0x1008534a (the same open)" note: "Only BAM-OpenVR.zip carries a copy. The plugin creates one otherwise." - name: PuPPlugin.dll @@ -764,8 +807,10 @@ files: bundled: true size: 240216 description: "PuPCOM script object drawing PinUP Player video onto table textures" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c, PuPPlugin.dll .rdata IPuPCOM, PuPPlugin.dll PuPVideo" - note: "Takes BAM_GetTextureId and BAM_ReplaceTexture from the plugin API." + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent), 0x100cf8c7 (GetProcAddress BAM_GetCOM), PuPPlugin.dll (sha256 a9b3f1d04621cfc2) FUN_10001f50 0x10002167-0x1000217f (GetProcAddress BAM_GetTextureId, BAM_ReplaceTexture), BAM_GetCOM 0x10002687-0x100026ea (GetModuleFileNameW of itself, LoadTypeLib, GetTypeInfoOfGuid)" + note: >- + Takes BAM_GetTextureId and BAM_ReplaceTexture from the plugin API and + hands BAM the PuPCOM object described by its own embedded type library. - name: icom.dll sha1: 83a3b55b2cc1b29997d50cf38108f6725d9a0df2 @@ -775,11 +820,21 @@ files: bundled: true size: 67280 description: "Gives a table script the COM objects the cabinet stack exposes" - source_ref: "BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c, icom.dll .rdata ProgID pattern" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent), icom.dll (sha256 b569f792df2cc10e) FUN_10001670 0x100016d1-0x100016d9 (std::wregex over the ProgID), 0x10001720 (CLSIDFromProgID), 0x1000173b (CoCreateInstance)" note: >- - Matches created objects against - PinUpPlayer, Vpinmame, B2S, PUPDMDControl, UltraDMD, PinSSF and - DirectOutput. + Creates the object a script asks for when its ProgID matches + (PinUpPlayer|Vpinmame|B2S|PUPDMDControl|UltraDMD|PinSSF|DirectOutput)\.(.*). + + - name: iCom.cfg + sha1: 0aaf76f425c6e0f43a36197de768e67d9e035abb + system: fpinball + path: "plugins/iCom.cfg" + required: false + bundled: true + size: 4 + description: "Security level setting of the icom plugin" + source_ref: "icom.dll (sha256 b569f792df2cc10e) FUN_100015f0 0x1000160a-0x10001659 (GetCurrentDirectoryA, backslash, iCom, .cfg), FUN_100019f0 0x10001a74 (fopen_s rb), 0x10001a8e (fread 4 bytes)" + note: "The one value behind the menu entry Security Level." - name: OpenVR.dll system: fpinball @@ -787,7 +842,7 @@ files: required: false size: 419328 description: "Renders the table to an OpenVR headset" - source_ref: "BAM_Plugins OpenVR/main.cpp, BAM.dll 1.5-408 .text:0x100cf400-0x100cf75c" + source_ref: "BAM.dll 1.5-408 FUN_100cf360 (plugins::Load) 0x100cf48c (FindFirstFileA on plugins\\*.dll), 0x100cf75a (LoadLibraryA), 0x100cf794 (GetProcAddress BAM_load, FreeLibrary when absent), OpenVR.dll (sha256 52d598d0c964cd67) exports BAM_load 0x10001b90 and BAM_PluginStart 0x10001bf0, BAM_Plugins Common/BAM_inc.h:67-81, BAM_Plugins OpenVR/main.cpp:106" note: "Ships only in BAM-OpenVR.zip, a separate build with its own BAM.dll, which ES-DE also looks for as BAM-OpenVR\\." - name: openvr_api.dll @@ -796,7 +851,19 @@ files: required: false size: 620760 description: "Valve OpenVR runtime interface" - source_ref: "OpenVR.dll import directory" + source_ref: "OpenVR.dll (sha256 52d598d0c964cd67) import descriptor openvr_api.dll IAT 0x1003e1cc-0x1003e1e3 (6 functions, loader-resolved), FUN_100066f0 0x1000670e (VR_InitInternal2), BAM_Plugins OpenVR/OpenVR_client.cpp:785" + note: "A load time dependency of OpenVR.dll, resolved from the plugins\\ working directory." + + - name: OpenVR.cfg + sha1: 21cedece67cf04ee71617462c27b9b4a455e4fd7 + system: fpinball + path: "plugins/OpenVR.cfg" + required: false + bundled: true + size: 128 + description: "Settings block of the OpenVR plugin" + source_ref: "OpenVR.dll (sha256 52d598d0c964cd67) FUN_10001b10 0x10001b23-0x10001b77 (GetCurrentDirectoryA, backslash, OpenVR, .cfg), FUN_10001ef0 0x10002238-0x10002265 (FUN_10001b10, fopen rb, fread 0x90 bytes), reached from BAM_load at 0x10001bdd, BAM_Plugins OpenVR/main.cpp:42, BAM_Plugins OpenVR/main.cpp:106, BAM_Plugins OpenVR/main.cpp:291" + note: "The plugin reads up to 144 bytes, the copy in BAM-OpenVR.zip holds 128, and the rest keeps its defaults. Written back whenever the settings change." - name: haarcascade_frontalface_alt.xml sha1: 035eef24478ebf4b16c788dbd02f8b3a3f9b8951 @@ -807,7 +874,8 @@ files: category: game_data size: 919871 description: "OpenCV Haar cascade for frontal faces" - source_ref: "DesktopCam.dll, PS3Eye.dll, Simple Cam.dll .rdata" + source_ref: "BAM 1.5-408 plugins, PS3Eye.dll (sha256 191996d48372d75f) BAM_load 0x1000208d (FUN_10001c10 caches GetCurrentDirectoryA plus a backslash at 0x10228d48 while plugins::Load holds plugins\\ as the working directory), FUN_10002440 0x10002581-0x100025e3 (that directory, then entry 0 of the table 0x10175008, index 0x1018e360 clamped to 0..2), 0x1000266d (load FUN_100e2420: FileStorage 0x100e2529, open 0x10057fa3 reaching cvOpenFileStorage FUN_10067eb0, isOpened 0x100e2558, cvLoad FUN_100679d0 at 0x100e25a3), detectMultiScale empty test 0x100e01d0-0x100e01db, DesktopCam.dll (sha256 4928c27ab0ea5bd0) BAM_load 0x10001856 (FUN_100011d0, buffer 0x103b3330), FUN_10001ee0 0x10001fc0-0x10002022 (entry 0 of 0x1031aee0), 0x10002096 (load FUN_10127870: FileStorage 0x101279c8, isOpened 0x101279f3, cvLoad FUN_100732d0 at 0x10127a62), empty test 0x10127cbb-0x10127cc6, Simple Cam.dll (sha256 3b232df5e99b23c0) BAM_load 0x10002173 (FUN_10001cf0, buffer 0x103a09b8), FUN_10002370 0x1000245e-0x100024c0 (entry 0 of 0x102d9020), 0x1000254a (load FUN_10111db0: FileStorage 0x10111eb9, isOpened 0x10111ee8, cvLoad FUN_1006b1b0 at 0x10111f33), empty test 0x1010fb64-0x1010fb6b, DesktopPS3Eye.dll (sha256 14dbb5b11749622c) BAM_load 0x100018cd (FUN_10001250, buffer 0x1023d748), FUN_100021c0 0x1000231c-0x1000237e (entry 0 of 0x101a6fd8), 0x100023f5 (load FUN_100f97a0: FileStorage 0x100f98f8, isOpened 0x100f9923, cvLoad FUN_10070830 at 0x100f9992), empty test 0x100f9beb-0x100f9bf6" + note: "One cascade is read at a time, the one the plugin index selects (0, 1 or 2), from the plugins\\ directory cached by BAM_load. All four plugins link OpenCV 2.4 statically. cvLoad is the one function holding \"Could not find the/an object in file storage\", and its only caller is the routine the plugin calls with the path, which constructs a FileStorage, returns false when isOpened fails, then falls back to cvLoad: cv::CascadeClassifier::load. The plugin never tests the result. With no cascade, detectMultiScale returns at its empty() test, so no face is reported and the game runs on." - name: haarcascade_frontalface_default.xml sha1: 85a317ce2fc0415741a41736e99bd281d2437568 @@ -818,7 +886,8 @@ files: category: game_data size: 1254733 description: "Second OpenCV Haar cascade for frontal faces" - source_ref: "DesktopCam.dll, PS3Eye.dll, Simple Cam.dll .rdata" + source_ref: "BAM 1.5-408 plugins, PS3Eye.dll (sha256 191996d48372d75f) BAM_load 0x1000208d (FUN_10001c10 caches GetCurrentDirectoryA plus a backslash at 0x10228d48 while plugins::Load holds plugins\\ as the working directory), FUN_10002440 0x10002581-0x100025e3 (that directory, then entry 1 of the table 0x10175008, index 0x1018e360 clamped to 0..2), 0x1000266d (load FUN_100e2420: FileStorage 0x100e2529, open 0x10057fa3 reaching cvOpenFileStorage FUN_10067eb0, isOpened 0x100e2558, cvLoad FUN_100679d0 at 0x100e25a3), detectMultiScale empty test 0x100e01d0-0x100e01db, DesktopCam.dll (sha256 4928c27ab0ea5bd0) BAM_load 0x10001856 (FUN_100011d0, buffer 0x103b3330), FUN_10001ee0 0x10001fc0-0x10002022 (entry 1 of 0x1031aee0), 0x10002096 (load FUN_10127870: FileStorage 0x101279c8, isOpened 0x101279f3, cvLoad FUN_100732d0 at 0x10127a62), empty test 0x10127cbb-0x10127cc6, Simple Cam.dll (sha256 3b232df5e99b23c0) BAM_load 0x10002173 (FUN_10001cf0, buffer 0x103a09b8), FUN_10002370 0x1000245e-0x100024c0 (entry 1 of 0x102d9020), 0x1000254a (load FUN_10111db0: FileStorage 0x10111eb9, isOpened 0x10111ee8, cvLoad FUN_1006b1b0 at 0x10111f33), empty test 0x1010fb64-0x1010fb6b, DesktopPS3Eye.dll (sha256 14dbb5b11749622c) BAM_load 0x100018cd (FUN_10001250, buffer 0x1023d748), FUN_100021c0 0x1000231c-0x1000237e (entry 1 of 0x101a6fd8), 0x100023f5 (load FUN_100f97a0: FileStorage 0x100f98f8, isOpened 0x100f9923, cvLoad FUN_10070830 at 0x100f9992), empty test 0x100f9beb-0x100f9bf6" + note: "One cascade is read at a time, the one the plugin index selects (0, 1 or 2), from the plugins\\ directory cached by BAM_load. All four plugins link OpenCV 2.4 statically. cvLoad is the one function holding \"Could not find the/an object in file storage\", and its only caller is the routine the plugin calls with the path, which constructs a FileStorage, returns false when isOpened fails, then falls back to cvLoad: cv::CascadeClassifier::load. The plugin never tests the result. With no cascade, detectMultiScale returns at its empty() test, so no face is reported and the game runs on." - name: lbpcascade_frontalface.xml sha1: d668cbe8712f062bcc6af898ebb2937b73dcfd2d @@ -829,7 +898,8 @@ files: category: game_data size: 51856 description: "OpenCV local binary pattern cascade for frontal faces" - source_ref: "DesktopCam.dll, PS3Eye.dll, Simple Cam.dll .rdata" + source_ref: "BAM 1.5-408 plugins, PS3Eye.dll (sha256 191996d48372d75f) BAM_load 0x1000208d (FUN_10001c10 caches GetCurrentDirectoryA plus a backslash at 0x10228d48 while plugins::Load holds plugins\\ as the working directory), FUN_10002440 0x10002581-0x100025e3 (that directory, then entry 2 of the table 0x10175008, index 0x1018e360 clamped to 0..2), 0x1000266d (load FUN_100e2420: FileStorage 0x100e2529, open 0x10057fa3 reaching cvOpenFileStorage FUN_10067eb0, isOpened 0x100e2558, cvLoad FUN_100679d0 at 0x100e25a3), detectMultiScale empty test 0x100e01d0-0x100e01db, DesktopCam.dll (sha256 4928c27ab0ea5bd0) BAM_load 0x10001856 (FUN_100011d0, buffer 0x103b3330), FUN_10001ee0 0x10001fc0-0x10002022 (entry 2 of 0x1031aee0), 0x10002096 (load FUN_10127870: FileStorage 0x101279c8, isOpened 0x101279f3, cvLoad FUN_100732d0 at 0x10127a62), empty test 0x10127cbb-0x10127cc6, Simple Cam.dll (sha256 3b232df5e99b23c0) BAM_load 0x10002173 (FUN_10001cf0, buffer 0x103a09b8), FUN_10002370 0x1000245e-0x100024c0 (entry 2 of 0x102d9020), 0x1000254a (load FUN_10111db0: FileStorage 0x10111eb9, isOpened 0x10111ee8, cvLoad FUN_1006b1b0 at 0x10111f33), empty test 0x1010fb64-0x1010fb6b, DesktopPS3Eye.dll (sha256 14dbb5b11749622c) BAM_load 0x100018cd (FUN_10001250, buffer 0x1023d748), FUN_100021c0 0x1000231c-0x1000237e (entry 2 of 0x101a6fd8), 0x100023f5 (load FUN_100f97a0: FileStorage 0x100f98f8, isOpened 0x100f9923, cvLoad FUN_10070830 at 0x100f9992), empty test 0x100f9beb-0x100f9bf6" + note: "One cascade is read at a time, the one the plugin index selects (0, 1 or 2), from the plugins\\ directory cached by BAM_load. All four plugins link OpenCV 2.4 statically. cvLoad is the one function holding \"Could not find the/an object in file storage\", and its only caller is the routine the plugin calls with the path, which constructs a FileStorage, returns false when isOpened fails, then falls back to cvLoad: cv::CascadeClassifier::load. The plugin never tests the result. With no cascade, detectMultiScale returns at its empty() test, so no face is reported and the game runs on." # -- Named by the code, absent from both distributions -- @@ -847,28 +917,33 @@ files: system: fpinball required: false description: "CL-Eye Platform SDK driver interface for the PlayStation Eye" - source_ref: "PS3Eye.dll, DesktopPS3Eye.dll, HT-PS3Eyes.dll import directories" + source_ref: "HT-PS3Eyes.dll (sha256 eda430e18e445668) import descriptor CLEyeMulticam.dll IAT 0x10108000-0x10108023 (9 functions, loader-resolved), 0x10004962 (CLEyeGetCameraCount), 0x10004a2f (CLEyeCreateCamera), PS3Eye.dll 0x10002480, 0x10002501, DesktopPS3Eye.dll 0x10002200, 0x1000229a (the same two calls)" + note: "A load time dependency of the three PlayStation Eye plugins. Without it their LoadLibraryA fails and BAM skips them." - name: Kinect10.dll system: fpinball required: false description: "Kinect for Windows SDK 1.x runtime" - source_ref: "Kinect.dll, DesktopKinect.dll, FaceTrackLib.dll import directories" + source_ref: "Kinect.dll (sha256 3e3225474bfca5ad) import descriptor Kinect10.dll IAT 0x1021e1d8-0x1021e1fb (9 functions by ordinal, loader-resolved), FUN_10006980 0x10006ade (NuiInitialize, ordinal 14), DesktopKinect.dll (sha256 4aa59e24530b739e) FUN_10002e10 0x10002fa1 (NuiInitialize)" + note: "A load time dependency of the two Kinect 1 plugins. FaceTrackLib.dll does not import it." - name: Kinect20.dll system: fpinball required: false description: "Kinect for Windows SDK 2.0 runtime" - source_ref: "Kinect2.dll import directory" + source_ref: "Kinect2.dll (sha256 3038bd37cfb6abff) import descriptor Kinect20.dll IAT 0x1021c1c8 (GetDefaultKinectSensor, loader-resolved), FUN_100036b0 0x100036c5 (GetDefaultKinectSensor)" + note: "A load time dependency of the Kinect 2 plugin. Without it its LoadLibraryA fails and BAM skips it." - name: NPClient.dll system: fpinball required: false description: "NaturalPoint TrackIR client library" - source_ref: "TrackIR.dll .rdata" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_0045eff0 0x45f01a-0x45f08e (RegOpenKeyExA HKCU Software\\NaturalPoint\\NATURALPOINT\\NPClient Location, RegQueryValueExA Path), FUN_0045f100 0x45f1d9 (LoadLibraryA), TrackIR.dll FUN_100018c0 0x100018c7-0x100018e1 (the detoured LoadLibraryA keeps the handle of a name holding NPClient)" note: >- - Comes from a TrackIR install rather than from any BAM distribution, which - is why no path is given here. + Loaded by Future Pinball itself from the TrackIR install directory the + registry names, and intercepted by the TrackIR plugin. It comes from a + TrackIR install rather than from any BAM distribution, which is why no + path is given here. analysis: written_not_read: diff --git a/emulators/future-pinball.yml b/emulators/future-pinball.yml index 2e069ac97..878d11988 100644 --- a/emulators/future-pinball.yml +++ b/emulators/future-pinball.yml @@ -35,7 +35,9 @@ notes: | The release is named 1.9.1.20101231 but the executable inside it carries FileVersion 1.9.2008.1225 in its version resource and prints - "Version 1.9.1.20091231" in its own banner. + "Version 1.9.1.20091231" in its own banner. The executable unpacked from + FuturePinballSetup_v1.9.1.20101231.exe has sha256 + da400d3b80ab855a6a6f63fd1b552cb9900cd3355925e6086a2d409df3b27a2d. ref: Future Pinball.exe 1.9.1.20101231 .rsrc version, .text:0x0043d288-0x0043d298 Every relative path below hangs off one root. At startup GetModuleFileNameA @@ -51,20 +53,16 @@ notes: | out of the table file and no external media is opened while a table plays. ref: Future Pinball.exe 1.9.1.20101231 .text:0x00457ede,0x00457f6f,0x00457fe6,0x0045805b,0x004417f6 - What a table can pull from outside itself is a resource library. Libraries - are .fpl files, also OLE compound documents, holding models, textures, sounds, - DMD fonts and scripts under one storage per item. The Texture, Sound, Model - and DMD Font managers each offer Import, which copies the item into the table, - and Link, which records the library name and the item name instead. The manual - recommends always linking to the shipped model library. A linked library is - opened by StgOpenStorage on the name as written, which resolves against the - table's own folder, and on failure against the install directory plus - "Libraries\". Both failing raises "Unabled to Open Library - ''" followed - by "There will be some functions missing from the game." as a warning box, and - the program carries on. - ref: Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf, .rsrc string 149-150, - Future Pinball Manual.chm LibraryResourceManager.html, ModelManager.html, TextureManager.html, - SoundManager.html, FontManager.html + What a table can pull from outside itself is a resource library, an .fpl + file that is also an OLE compound document. A library the table names is + opened by StgOpenStorage on the name as written, which resolves + against the table's own folder, and on failure against the install directory + plus "Libraries\". Both failing raises "Unabled to Open Library - ''" + followed by "There will be some functions missing from the game." as a warning + box, and the program carries on. + ref: Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the name + as written), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\, name, second StgOpenStorage), + 0x4e6e1c-0x4e6eb7 (string resources 149 and 150, MessageBoxA with MB_ICONWARNING) A table script reaches outside itself through LoadExternalScript, whose result is handed to VBScript's ExecuteGlobal. When the reference ends in .fpl the @@ -73,34 +71,46 @@ notes: | "Scripts\" prefix, then with "Tables\", and a miss reports "Unable to load external script". No Scripts directory ships, so what it holds is whatever a given table asks for. - ref: Future Pinball.exe 1.9.1.20101231 .text:0x004797c0-0x00479905, 0x00478be0-0x00478c66, - 0x00478d20, Future Pinball Manual.chm GlobalScript.html + ref: Future Pinball.exe 1.9.1.20101231 FUN_004797c0 0x47985a-0x479881 (lstrcmpiA of the + extension with fpl, then FUN_00478d20, which reaches the library opener FUN_004e6cf0 + through FUN_004ed9c0 at 0x4eda31), 0x479891, 0x4798a7, 0x4798bd (FUN_00478be0 bare, with + Scripts\, with Tables\), 0x4798dc (the error string), FUN_00478be0 0x478c60 (CreateFileA + GENERIC_READ OPEN_EXISTING) Settings live in the registry under HKCU\Software\Future Pinball, split into GamePlayer, GamePlayer\Joypads and Editor keys. There is no ini file. RetroBat writes resolution, aspect ratio, camera, render preset and the whole - joypad map there before launching. Per table state is written to - fpRAM\.fpRAM beside the program. Nothing in the program verifies a size - or a hash on any file it opens, so the figures recorded below are those of the - 1.9.1.20101231 release and are informative. - ref: Future Pinball.exe 1.9.1.20101231 .text:0x0043aa80,0x00475602,0x00475892, + joypad map there before launching. Per table state is a compound file, + fpRam\
.fpRAM under the install directory, holding one nvRam stream. + Nothing in the program verifies a size or a hash on any file it opens, so the + figures recorded below are those of the 1.9.1.20101231 release and are + informative. + ref: Future Pinball.exe 1.9.1.20101231 FUN_0046fac0 0x46faf4-0x46fb65 (HKCU + 0x80000001, Software\Future Pinball\ plus the key, RegOpenKeyExA, + RegQueryValueExA), 0x46fbbc-0x46fc32 (the same key, RegCreateKeyExA, + RegSetValueExA), FUN_004362e0 0x43639b (GamePlayer), FUN_0043bc40 0x43bc6e + (GamePlayer\Joypads), FUN_00431e30 0x431e55 (Editor), FUN_004755a0 + 0x4755da-0x47562f (install directory, fpRam\, table name, .fpRAM), + 0x475752 (StgOpenStorage read, failure skips the restore at 0x47575a), + 0x475770 (nvRam stream), FUN_00475830 0x475892-0x475927 (same path, + StgCreateDocfile), FUN_00439f60 0x43aa5f-0x43aab7 (same path, DeleteFileA), retrobat emulatorLauncher/Generators/Fpinball.Generator.cs:326-491 - Front ends drive it with the documented switches /Open "
", /Play, /Exit - and /ArcadeRender. ES-DE declares it for Windows only, as FUTURE-PINBALL - finding "Future Pinball.exe" and as FUTURE-PINBALL-FPLOADER finding + Front ends drive it with the switches /Open "
", /Play, /Exit and + /ArcadeRender, which WinMain compares beside RegServer, UnregServer, + Minimise, DemoMode and TableNumber. ES-DE declares it for Windows only, as + FUTURE-PINBALL finding "Future Pinball.exe" and as FUTURE-PINBALL-FPLOADER finding "BAM\FPLoader.exe", both invoked with /Exit /Play /Open. The fpinball system is a placeholder on its six other platforms. RetroBat maps the emulator keys fpinball and bam to one generator, one install folder and the same "Future Pinball.exe" presence check, swapping only the launched binary, and - optionally starts dmdext against DmdDevice.ini to mirror the DMD. Batocera ran - it in a wine bottle on x86_64 and dropped it for Visual Pinball. BAM is + optionally starts dmdext against DmdDevice.ini to mirror the DMD. BAM is ravarcade's loader: FPLoader.exe starts the same executable with BAM.dll injected, and it names none of its own files from inside Future Pinball. ref: es-de resources/systems/windows/es_find_rules.xml:438-461, - es-de resources/systems/windows/es_systems.xml, Future Pinball Manual.chm CommandLine.html, - retrobat emulatorLauncher/Generators/Fpinball.Generator.cs:109-181, - batocera-linux batocera-Changelog.md:214 + es-de resources/systems/windows/es_systems.xml, + Future Pinball.exe 1.9.1.20101231 WinMain FUN_0042c480 0x42c5f0-0x42c710, + retrobat emulatorLauncher/Generators/Fpinball.Generator.cs:109-181 files: @@ -115,10 +125,12 @@ files: bundled: true size: 446464 description: "Newton Game Dynamics, the rigid body solver under the ball physics" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor Newton.dll IAT 0x53f340-0x53f48b (83 functions, no delay-load directory, so loader-resolved), FUN_00455b10 0x4581c4 (status line Initialising Newton..), 0x45823d (NewtonCreate, world kept in [esi+0x2d08] and 0x5cc80c), 0x458250 (NewtonWorldSetUserData), 0x45825f (NewtonSetSolverModel)" note: >- 83 functions are bound from it, the largest third party surface in the - binary. The process does not start without it. + binary. The loader resolves the import before WinMain, so the process does + not start without it. FUN_00455b10, reached from 0x4ede62, creates the + physics world. - name: fmod.dll sha1: ee8f68d94645de24be930d6f453297d5b7b4d052 @@ -127,11 +139,13 @@ files: bundled: true size: 162816 description: "FMOD 3 audio engine" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor fmod.dll IAT 0x53f820-0x53f877 (22 functions, loader-resolved), FUN_0044a0f0 0x44a3ff-0x44a413 (FSOUND_SetHWND, FSOUND_SetOutput 2, FSOUND_SetDriver 0, FSOUND_SetMixer 4 through the thunks at 0x51b656-0x51b668), 0x44a420 (FSOUND_Init 44100 Hz, 32 channels), 0x44a425-0x44a434 (a failed init sends WM_CLOSE to the window at [esi+0xac])" note: >- - 22 functions bound, FSOUND_Init through the sample and stream calls. Every - one of those calls passes FSOUND_LOADMEMORY, so it decodes the table's own - buffers rather than reading files. + 22 functions bound, FSOUND_Init through the sample and stream calls. The + import makes it a start condition. FUN_0044a0f0 is the startup routine + WinMain calls at 0x42c8d8. Every sample and stream call passes + FSOUND_LOADMEMORY, so it decodes the table's own buffers rather than + reading files. - name: devil.dll sha1: 313a23600a169adbe130b1ae1784d8de437ce7d9 @@ -142,9 +156,11 @@ files: bundled: true size: 269312 description: "DevIL image decoder" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor DevIL.dll IAT 0x53f074-0x53f093 (8 functions, loader-resolved), FUN_0044a0f0 0x44a3ea (ilInit at startup), FUN_00463420 0x463430 (ilGenImages), 0x46343b (ilBindImage), 0x463485 (ilLoadL on an image held in memory), 0x463495 (ilConvertImage to IL_RGB, IL_UNSIGNED_BYTE)" note: >- - 8 functions bound, ilInit through ilLoadL. Spelled DevIL.dll in the import + 8 functions bound, ilInit through ilLoadL, so the process does not start + without it. FUN_00463420 is the decoder the texture and preview paths call + (0x43f522, 0x4e6a7c, 0x4fb100). Spelled DevIL.dll in the import descriptors and shipped lowercase, which the case insensitive loader treats as one name. @@ -157,10 +173,11 @@ files: bundled: true size: 27648 description: "DevIL image utility library, scaling and canvas resize" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor ILU.dll IAT 0x53f13c-0x53f14b (4 functions, loader-resolved), FUN_0044a0f0 0x44a3f0 (iluInit at startup), FUN_00463420 0x463519 (iluImageParameter ILU_FILTER), 0x463523 (iluScale)" note: >- 4 functions bound: iluInit, iluScale, iluEnlargeCanvas and - iluImageParameter, used to fit imported artwork to texture dimensions. + iluImageParameter, used to fit decoded artwork to texture dimensions. The + import makes it a start condition. - name: ilut.dll sha1: 30566eda672fef3036fbd3998af3cc9fdcef38e7 @@ -171,10 +188,11 @@ files: bundled: true size: 16384 description: "DevIL toolkit layer, image to Windows bitmap conversion" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor ILUT.dll IAT 0x53f150-0x53f15b (3 functions, loader-resolved), FUN_0044a0f0 0x44a3f8 (ilutRenderer ILUT_WIN32), FUN_00463420 0x4634a3 (ilutConvertToHBitmap), 0x4634b2 (ilutGetBmpInfo)" note: >- 3 functions bound: ilutRenderer, ilutConvertToHBitmap and ilutGetBmpInfo, - which produce the preview bitmaps the editor's manager windows draw. + which turn a decoded image into the Windows bitmap the manager windows + draw. The import makes it a start condition. - name: libcurl.dll sha1: 8189136493d48adc2bdeff1e77297ab988ae789d @@ -183,13 +201,12 @@ files: bundled: true size: 626688 description: "HTTP client for the table feed" - source_ref: "Future Pinball.exe 1.9.1.20101231 import directory, .text:0x0043dc70" + source_ref: "Future Pinball.exe 1.9.1.20101231 import descriptor libcurl.dll IAT 0x53f87c-0x53f88b (4 functions, loader-resolved), FUN_0043d300 (dialog procedure of resource 0x1f0, DialogBoxParamA at 0x449559) 0x43dd3c (curl_easy_init), 0x43dd4f-0x43dd8d (curl_easy_setopt user agent FuturePinball-agent/1.0, URL http://www.pinsimdb.org/fpreleases/backend_xml.php, write callback 0x46e450), 0x43dd90 (curl_easy_perform), 0x43d694-0x43d6ff (the same sequence for a screenshot not yet in feeds\\)" note: >- Only four functions are bound, curl_easy_init, setopt, perform and cleanup, - and the single use is fetching the table list from - http://www.pinsimdb.org/fpreleases/backend_xml.php under the user agent - FuturePinball-agent/1.0. The binding is static all the same, so the process - still refuses to start without the file. + and both uses sit in the latest tables dialog, the table list and its + screenshots. The binding is static all the same, so the process still + refuses to start without the file. - name: SciLexer.dll sha1: 661675f4d8539e14f2be10d144ab986fc5fccb46 @@ -198,7 +215,7 @@ files: bundled: true size: 407552 description: "Scintilla, the editing control behind the table script editor" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x0042c501-0x0042c528" + source_ref: "Future Pinball.exe 1.9.1.20101231 WinMain FUN_0042c480 0x42c4fc-0x42c501 (LoadLibraryA SciLexer.DLL), 0x42c511-0x42c524 (null handle: MessageBoxA The Scintilla DLL could not be loaded., handle stored as 0, startup continues at 0x42c528)" note: >- The one library taken with LoadLibraryA rather than the import directory. A null return puts up "The Scintilla DLL could not be loaded.", stores a @@ -206,8 +223,7 @@ files: and only the script editor is lost. # -- Resource libraries, resolved against the table's folder then against - # \Libraries. Shipped names all start with fp and the manual asks - # designers not to modify them, because a release replaces them. + # \Libraries. - name: fpModels.fpl sha1: 81f809456ad9fba296eff46f035a607a3d2cfba2 @@ -217,13 +233,12 @@ files: bundled: true category: game_data size: 5166080 - description: "260 pinball part models, the library the manual tells tables to link" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf, Future Pinball Manual.chm ModelManager.html" + description: "260 pinball part models" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" note: >- - Models cannot be authored outside the development team, so a table that - wants a bumper cap or a flipper bat either embeds a copy or links here, and - the Model Manager documents linking as the recommended choice. Absent, the - table still loads and every model it linked is missing. + A table that links a model from here instead of embedding it loses that + model when the library is absent. The table still loads, after the warning + box. - name: fpTextures.fpl sha1: 255cb14da5f49c7aaa210135638cfdc924130397 @@ -234,7 +249,7 @@ files: category: game_data size: 3495424 description: "90 textures for the standard table objects" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf, Future Pinball Manual.chm TextureManager.html" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" note: >- Carries the surface art the built in parts expect, bulbs, triggers, plungers and the rest. Resolved the same way as every other library. @@ -248,7 +263,7 @@ files: category: game_data size: 2813440 description: "82 ramp models, keyed by profile, width and height" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" note: >- Storage names encode the shape and the dimensions, ramp-pool-t1_w30_h20 and so on, with a left and a right variant of each. @@ -262,7 +277,7 @@ files: category: game_data size: 170496 description: "20 machine sounds, ball release, bumpers, coin in and the rest" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf, Future Pinball Manual.chm SoundManager.html" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" - name: fpSphereMaps.fpl sha1: 04efb8fe46d0ba6381b160afa92b87bb213ba461 @@ -273,7 +288,7 @@ files: category: game_data size: 223744 description: "11 sphere maps giving metal and plastic parts their reflections" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" note: >- Storage names are bracketed, [chrome-silver], [chrome-gold] and similar, which is how a material references one. @@ -287,7 +302,7 @@ files: category: game_data size: 58880 description: "6 dot matrix fonts, named for their cell size" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf, Future Pinball Manual.chm FontManager.html" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" note: >- dmd05x05p through dmd08x13p. A DMD display element with no font draws nothing. @@ -301,7 +316,7 @@ files: category: game_data size: 364032 description: "3 playfield images, including the plunger cutout template" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004e6cf0-0x004e6ebf" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004e6cf0 0x4e6d66 (StgOpenStorage on the linked name), 0x4e6d8d-0x4e6dd8 (install directory, Libraries\\, name, second StgOpenStorage)" - name: fpScripts.fpl sha1: 5a928b81cb1a3364605158e0c0b573c51b0f468f @@ -311,13 +326,11 @@ files: bundled: true category: game_data size: 4096 - description: "Script library, holding the one sample script the manual quotes" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x00478d20, Future Pinball Manual.chm GlobalScript.html" + description: "Script library" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004797c0 0x47985a-0x479881 (a reference whose extension is fpl goes to FUN_00478d20), FUN_004ed9c0 0x4eda31 (FUN_004e6cf0, the library opener)" note: >- - The manual's worked example is - ExecuteGlobal LoadExternalScript("fpScripts.fpl\myscript"), which is the - branch taken when a reference carries the .fpl extension. What ships is a - single storage named testscript. + Reached by any LoadExternalScript reference whose library part ends in + .fpl. What ships is a single storage named testscript. # -- Named individually elsewhere in the binary -- @@ -329,7 +342,7 @@ files: category: game_data size: 226816 description: "Template opened by File then New" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x00448ea9-0x00448edb" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004486d0 0x448ea9-0x448ed0 (install directory then NewTable.fpt into the table path buffer), 0x448edb (FUN_0043ec20, the table open, which calls FUN_004fc580 at 0x43ec67 for StgOpenStorage at 0x4fc650)" note: >- The install directory is copied into the default table path buffer and this name appended, then the result goes through the ordinary table open. It is @@ -343,11 +356,11 @@ files: bundled: true size: 8992653 description: "Development guide, 79 topics" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x00478477-0x004784c4" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_00478250 0x478477-0x4784ad (install directory, then Help\\Future Pinball Manual.chm when the command id is 0x8043), 0x4784be-0x4784c4 (ShellExecuteA open)" note: >- Opened with ShellExecuteA on the install directory plus this path when the - help command carries id 0x8043. It is the only description of the library - link mechanism and of LoadExternalScript. + help command carries id 0x8043. The program hands the path to the shell + and reads nothing itself. - name: Script56.chm installed_on: [retrobat] @@ -355,13 +368,12 @@ files: path: "Help/Script56.chm" required: false description: "Microsoft Windows Script 5.6 documentation, the VBScript reference" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x004784a3-0x004784c4" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_00478250 0x47848f-0x4784ad (any command id other than 0x8043 appends Help\\Script56.chm), 0x4784be-0x4784c4 (ShellExecuteA open)" note: >- The script editor's help falls to this path for every command id other than 0x8043, again through ShellExecuteA against the install directory. No Future Pinball release ships it: table scripts are VBScript and this is - Microsoft's own reference for the language, expected to be dropped into - Help beside the manual. + Microsoft's own reference for the language. - name: fpLatestTables.xml sha1: bd9de21def48b65b5382c403971a9062928b9345 @@ -371,12 +383,13 @@ files: bundled: true size: 752639 description: "Cached table list from pinsimdb.org" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x0043dc70-0x0043dc99, 0x0043e776-0x0043e79c" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_0043d300 0x43dc46-0x43dca6 (install directory, feeds\\, fpLatestTables.xml, CreateFileA GENERIC_READ OPEN_EXISTING), 0x43dccf-0x43dd1e (GetFileTime against GetSystemTimeAsFileTime, a copy 7 days old or more is fetched again), 0x43ddbf (FUN_00470ff0, fopen w, UTF-8 BOM, the fetched list written back), 0x43e755-0x43e79c (DeleteFileA on command 0x17b)" note: >- - libcurl writes it, CreateFileA with OPEN_EXISTING reads it back and - DeleteFileA drops it when the panel refreshes. The code builds the path as - feeds\ against a directory the installer creates as Feeds. A snapshot ships - with the release, so the panel has something to show before any fetch. + Read with CreateFileA when present and younger than 7 days, fetched and + rewritten otherwise, deleted by the refresh command. The code builds the + path as feeds\ against a directory the installer creates as Feeds. A + snapshot ships with the release, so the panel has something to show + before any fetch. # -- Outside the program directory -- @@ -384,10 +397,11 @@ files: system: fpinball required: false description: "NaturalPoint TrackIR client library, head tracking" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x0045f1b8-0x0045f1f8" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_0045eff0 0x45f01a-0x45f08e (RegOpenKeyExA HKCU Software\\NaturalPoint\\NATURALPOINT\\NPClient Location, RegQueryValueExA Path), FUN_0045f100 0x45f16b-0x45f1cf (separator then NPClient.dll appended), 0x45f1d9 (LoadLibraryA, a null handle jumps to 0x45f35a), 0x45f1f2-0x45f1f8 (GetProcAddress NP_GetSignature)" note: >- - The directory is read from HKCU\Software\NaturalPoint\NATURALPOINT\NPClient - Location, this name appended and the result given to LoadLibraryA, + The directory is read from the Path value of + HKCU\Software\NaturalPoint\NATURALPOINT\NPClient Location, this name + appended and the result given to LoadLibraryA, then NP_GetSignature and the rest are bound with GetProcAddress. A null handle jumps past all tracking setup. It comes from a TrackIR install, not from any Future Pinball distribution, which is why no path is given here. @@ -399,7 +413,7 @@ analysis: than by a literal in the code, so there is no fixed filename to record. entries: - what: "Tables\\, four demonstration tables" - source_ref: "FuturePinballSetup_v1.9.1.20101231.exe app/Tables" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_0043ee20 0x43f1d1-0x43f223 (install directory, Tables\\, then the table name, into the table path buffer at +0x18b88)" note: >- DmdDisplayDemo.fpt, LightSequencerDemo.fpt, Ramp-VUK-Demo.fpt and SegmentDisplayDemo.fpt. The directory itself is the default table path @@ -419,12 +433,12 @@ analysis: LoadExternalScript takes whatever name the table's script passes. The bare attempt resolves against the working directory, which is the table's own folder. No Scripts directory ships. - - what: "fpRAM\\
.fpRAM, per table persistent state" - source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x0043aa80, 0x00475602, 0x00475892" + - what: "fpRam\\
.fpRAM, per table persistent state" + source_ref: "Future Pinball.exe 1.9.1.20101231 FUN_004755a0 0x4755da-0x47562f (install directory, fpRam\\, table name, .fpRAM), 0x475752 (StgOpenStorage, a failure skips the restore), FUN_00475830 0x475892-0x475927 (StgCreateDocfile on the same path), FUN_00439f60 0x43aab7 (DeleteFileA)" note: >- - Built as the prefix, the table name and the .fpRAM extension. Written - from play, so it is save data rather than something to obtain. The - installer creates the directory empty. + Built as the prefix, the table name and the .fpRAM extension, and + created by StgCreateDocfile from play, so it is save data rather than + something to obtain. A missing file only skips the restore. - what: "DmdFonts\\ and Models\\, editor working directories" source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x00443595, 0x00443efc, 0x00516ba8, 0x00516d31, 0x00441fc8, 0x004429bb, 0x004317fa" note: >- @@ -442,8 +456,7 @@ analysis: note: >- Passed to the toolbar builder, which calls CreateToolbarEx with hBMInst zero and a bitmap handle held in a global as wBMID. The module - has no resource under that name and neither syscall trace shows an open - for it, although both traces reach the main window. + has no resource under that name. - what: "tables\\ in lower case" source_ref: "Future Pinball.exe 1.9.1.20101231 .text:0x00439e40-0x00439e79" note: >- diff --git a/emulators/gzdoom.yml b/emulators/gzdoom.yml index ee25a5c18..d958edfa8 100644 --- a/emulators/gzdoom.yml +++ b/emulators/gzdoom.yml @@ -17,6 +17,17 @@ standalone_pools: "[IWADSearch.Directories] Path": "" "[IWADSearch.Directories] RecursivePath": "" +config_reads: + - file: "gzdoom.ini" + source_ref: "src/gameconfigfile.cpp:95-107, 942-951, src/common/platform/posix/unix/i_specialpaths.cpp:168-171" + keys: + - key: "[IWADSearch.Directories] Path" + source_ref: "src/d_iwad.cpp:456-470" + - key: "[FileSearch.Directories] Path" + source_ref: "src/common/utility/findfile.cpp:224-260" + - key: "[SoundfontSearch.Directories] Path" + source_ref: "src/common/audio/music/i_soundfont.cpp:393-410" + notes: | Doom-engine source port by Christoph Oelckers. Supports Doom, Heretic, Hexen, Strife, Chex Quest and derived games through a unified IWAD diff --git a/emulators/hatari.yml b/emulators/hatari.yml index 801bd818f..940f07f95 100644 --- a/emulators/hatari.yml +++ b/emulators/hatari.yml @@ -38,6 +38,45 @@ data_root: source_ref: "upstream src/paths.c:24-29, upstream src/paths.c:201-274" note: "~/.hatari is used instead when it exists and ~/.config/hatari does not. Holds hatari.cfg, hatari.nvram and auto.sav. The default tos.img is read from ../share/hatari beside the bin directory." +pin_build: + - platform: emuelec + repo: "https://github.com/EmuELEC/EmuELEC" + revision: "v4.8" + path: "packages/sx05re/emulators/hatarisa/package.mk" + variable: PKG_VERSION + value: "fda67f05188a925535fefc1b0ef24eb044a029d2" + - platform: amberelec + repo: "https://github.com/AmberELEC/AmberELEC" + revision: "a21975bfb1a3af68f66e07a931b994b523e1e6e2" + path: "packages/games/emulators/hatarisa/package.mk" + variable: PKG_VERSION + value: "d876db9c4b6911c059b1d9318f779f90c1c6f2d7" + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/hatarisa/package.mk" + variable: PKG_VERSION + value: "6da06056d89bb39777063388d82d065d9e2e31fd" +config_reads: + - file: "*.cfg" + platforms: [emuelec] + source_ref: "upstream src/options.c:1187-1193, upstream src/configuration.c:1088, 1149" + keys: + - key: "[ROM] szTosImageFileName" + source_ref: "upstream src/configuration.c:481, upstream src/tos.c:975-986" + - file: "*.cfg" + platforms: [amberelec] + source_ref: "upstream src/options.c:1283-1288, upstream src/configuration.c:1061, 1123" + keys: + - key: "[ROM] szTosImageFileName" + source_ref: "upstream src/configuration.c:489, upstream src/tos.c:976-987" + - file: "*.cfg" + platforms: [rocknix] + source_ref: "upstream src/options.c:1194-1199, upstream src/configuration.c:1050, 1111" + keys: + - key: "[ROM] szTosImageFileName" + source_ref: "upstream src/configuration.c:480, upstream src/tos.c:975-986" + notes: | The main branch of libretro/hatari is the upstream Hatari tree at c453b85f, whose libretro target in src/retro carries the VFS, disk diff --git a/emulators/lexaloffle.yml b/emulators/lexaloffle.yml index 1b28f72d4..9b76f151e 100644 --- a/emulators/lexaloffle.yml +++ b/emulators/lexaloffle.yml @@ -50,6 +50,13 @@ notes: | archive: which binary runs, and from which folder, is the launcher's choice. The amd64 and raspi archives carry pico8.dat 10b39730, byte for byte. + Refs to binary code cite these files by sha256 prefix: amd64 pico8 + b07e76cd6a033650, amd64 pico8_dyn ca4e55eda8933a83, raspi pico8 + cee03b8ffd89bd38, raspi pico8_dyn 443e9553a6aa81dd, raspi pico8_gpio + f9df817ffa37257e, raspi pico8_64 ad56e8ed1ad812ca, windows pico8.exe + 9d0b31219e536304. The Linux binaries keep their symbol tables, so the + function names are those of the binary. + Launchers by platform, each read at the revision the platform file pins: - Batocera lexaloffleGenerator.py runs bios/pico-8/pico8 and raises when it is missing or not executable, with LD_LIBRARY_PATH set to bios/pico-8. @@ -109,7 +116,7 @@ files: sha1: 946db0633966afecf81d2b33957c7db8fb3a2356 description: "PICO-8 0.2.7 armhf executable, SDL2 linked in" note: "The pico8 of pico-8_0.2.7_raspi.zip, a 32-bit ARM ELF that needs libbcm_host.so, so it runs on Raspberry Pi firmware only. Batocera's fixed path is the one a 32-bit Raspberry Pi board (bcm2835, bcm2836) can run." - source_ref: "batocera lexaloffleGenerator.py:17, 48-52" + source_ref: "pico-8 0.2.7 raspi pico8, DT_NEEDED libbcm_host.so at 0x27647c (loader-resolved), RPI_VideoInit 0x1741ac bl bcm_host_init at 0x1741b8, batocera lexaloffleGenerator.py:17, 48-52" - name: pico8 path: pico-8/pico8 @@ -132,8 +139,8 @@ files: md5: 70ab37eab4e7d162d36d9b2d91b84867 sha1: 4ed23b6578a2d93d67aa856791dc70e95d68a3f4 description: "PICO-8 0.2.7 aarch64 executable, system libSDL2" - note: "pico8_64 is only in pico-8_0.2.7_raspi.zip, the build for 64-bit Raspberry Pi OS, linked against the system SDL2. AmberELEC and ROCKNIX run it from roms/pico-8/, not from bios/. AmberELEC stops with a message when it is missing. ROCKNIX picks it when HW_ARCH is aarch64. Recalbox renames bios/pico-8/pico8_64 to pico8 before the first run, and a missing file fails the rename." - source_ref: "pico-8 0.2.7 raspi readme_raspi.txt:3-11, amberelec packages/amberelec/sources/pico-8.sh:51-54, amberelec packages/amberelec/sources/scripts/runemu.py:123, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:8-17, 35-40, 46-47, recalbox projects/configgen/configgen/generators/pico8/pico8Generator.py:14-19, dArkOS pico8/pico8.sh:47-60, 128-135" + note: "pico8_64 is only in pico-8_0.2.7_raspi.zip, an aarch64 ELF linked against the system SDL2. AmberELEC and ROCKNIX run it from roms/pico-8/, not from bios/. AmberELEC stops with a message when it is missing. ROCKNIX picks it when HW_ARCH is aarch64. Recalbox renames bios/pico-8/pico8_64 to pico8 before the first run, and a missing file fails the rename." + source_ref: "pico-8 0.2.7 raspi pico8_64, DT_NEEDED libSDL2-2.0.so.0 at 0x17cb08 (loader-resolved), codo_system_init 0xefd20 bl SDL_Init at 0xefd7c, amberelec packages/amberelec/sources/pico-8.sh:51-54, amberelec packages/amberelec/sources/scripts/runemu.py:123, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:8-17, 35-40, 46-47, recalbox projects/configgen/configgen/generators/pico8/pico8Generator.py:14-19, dArkOS pico8/pico8.sh:47-60, 128-135" - name: pico8_dyn path: pico-8/pico8_dyn @@ -145,7 +152,7 @@ files: sha1: 9b2e573250c70382b4071709a85c8d56c0371d59 description: "PICO-8 0.2.7 x86_64 executable, system libSDL2" note: "The pico8_dyn of pico-8_0.2.7_amd64.zip, the same program linked against the system SDL2. RetroDECK lists it as required in its manifest, but its launcher executes pico8 only. Batocera never runs it. ROCKNIX runs it from roms/pico-8/ on x86_64, its HW_ARCH other than aarch64." - source_ref: "pico-8 0.2.7 amd64 pico8_dyn, NEEDED libSDL2-2.0.so.0, RetroDECK pico-8/component_manifest.json:26-32, RetroDECK pico-8/component_launcher.sh:3, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:10-17, 48" + source_ref: "pico-8 0.2.7 amd64 pico8_dyn, DT_NEEDED libSDL2-2.0.so.0 at 0x796da0 (loader-resolved), codo_system_init 0x519b50 call SDL_Init@plt at 0x519bb3, RetroDECK pico-8/component_manifest.json:26-32, RetroDECK pico-8/component_launcher.sh:3, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:10-17, 48" - name: pico8_dyn path: pico-8/pico8_dyn @@ -157,7 +164,7 @@ files: sha1: 87ef68e70c53ba209e697bb51de45826e982d92d description: "PICO-8 0.2.7 armhf executable, system libSDL2" note: "The pico8_dyn of pico-8_0.2.7_raspi.zip, 32-bit, linked against the system SDL2. EmuELEC copies bios/pico-8 to /emuelec/bin/pico-8 and runs pico8_dyn with no existence check. KNULLI's installer stops when the archive lacks it and moves it to bios/pico-8, and the RG35XX simplermenu launcher runs it. ROCKNIX runs a pico8_dyn from roms/pico-8/ on a HW_ARCH other than aarch64, and ArkOS falls back to it when pico8_64 is absent." - source_ref: "pico-8 0.2.7 raspi readme_raspi.txt:3-11, emuelec packages/sx05re/emuelec/bin/pico8.sh:9-14, 39-43, knulli board/fsoverlay/usr/bin/knulli-install-pico8:9, 38-41, 67, knulli board/actions/atm7039/rg35xx/fsoverlay/usr/share/knulli/datainit/system/configs/simplermenu_plus/launchers/pico8_sa:3, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:14-16, dArkOS pico8/pico8.sh:49-50" + source_ref: "pico-8 0.2.7 raspi pico8_dyn, DT_NEEDED libSDL2-2.0.so.0 at 0x15b00c (loader-resolved), codo_system_init 0xf2660 bl SDL_Init at 0xf26a8, emuelec packages/sx05re/emuelec/bin/pico8.sh:9-14, 39-43, knulli board/fsoverlay/usr/bin/knulli-install-pico8:9, 38-41, 67, knulli board/actions/atm7039/rg35xx/fsoverlay/usr/share/knulli/datainit/system/configs/simplermenu_plus/launchers/pico8_sa:3, rocknix projects/ROCKNIX/packages/emulators/standalone/pico-8/scripts/start_pico8.sh:14-16, dArkOS pico8/pico8.sh:49-50" - name: pico8_gpio path: pico-8/pico8_gpio @@ -168,8 +175,8 @@ files: md5: 286ab30756dfc40749ecd72221f0d063 sha1: df77c64c95695710d23b451277325e0c37e7416e description: "PICO-8 0.2.7 armhf executable with GPIO access (wiringPi)" - note: "Only in pico-8_0.2.7_raspi.zip. The 32-bit build that maps the GPIO pins to 0x5f80..0x5fff, linked against libbcm_host.so and libwiringPi.so. KNULLI's installer stops when the archive lacks it and moves it to bios/pico-8, but no launcher runs it." - source_ref: "pico-8 0.2.7 raspi readme_raspi.txt:3-11, knulli board/fsoverlay/usr/bin/knulli-install-pico8:10, 43-46, 68" + note: "Only in pico-8_0.2.7_raspi.zip. The 32-bit build linked against libbcm_host.so and libwiringPi.so: a peek of 0x5f80+n reads GPIO pin n through wiringPi, pins 0 to 31. KNULLI's installer stops when the archive lacks it and moves it to bios/pico-8, but no launcher runs it." + source_ref: "pico-8 0.2.7 raspi pico8_gpio, DT_NEEDED libbcm_host.so at 0x27702c and libwiringPi.so at 0x277034 (loader-resolved), pico8_peek_1 0x860ac 0x863ac-0x863b4 (address minus 0x5f80 passed to gpio_read), gpio_read 0xae6c0 0xae70c (wiringPiSetup), 0xae730 (pin above 31 reads 0), 0xae750 (pinMode), 0xae75c (digitalRead), knulli board/fsoverlay/usr/bin/knulli-install-pico8:10, 43-46, 68" - name: pico8.dat path: pico-8/pico8.dat @@ -179,8 +186,8 @@ files: md5: 10b397305093c80109096319a538ba56 sha1: 0f92093752bddb12210c7db6d93af3ba2413cfce description: "PICO-8 0.2.7 data file (boot sequence, themes, demo carts)" - note: "PICO-8 opens it from its own folder and quits with \"couldn't load /pico8.dat\" when it is absent (the amd64 pico8, run without it). Paired with the binary's own version, identical in pico-8_0.2.7_amd64.zip, pico-8_0.2.7_raspi.zip and pico-8_0.2.7_windows.zip. AmberELEC and ArkOS check for it before starting PICO-8, and KNULLI's installer stops when the archive lacks it." - source_ref: "pico-8 0.2.7 amd64 pico8, string pico8.dat at 0x231bc0, pico-8 0.2.7 raspi pico8_64, string pico8.dat at 0x110138, amberelec packages/amberelec/sources/pico-8.sh:51-52, dArkOS pico8/pico8.sh:136-142, knulli board/fsoverlay/usr/bin/knulli-install-pico8:11, 48-51, 69" + note: "PICO-8 opens it from its own folder and quits with \"couldn't load /pico8.dat\" and exit status 0 when it is absent. Paired with the binary's own version, identical in pico-8_0.2.7_amd64.zip, pico-8_0.2.7_raspi.zip and pico-8_0.2.7_windows.zip. AmberELEC and ArkOS check for it before starting PICO-8, and KNULLI's installer stops when the archive lacks it." + source_ref: "pico-8 0.2.7 amd64 pico8 codo_main_init 0x407a90 0x407df8-0x407e09 (pico8.dat prefixed with the program folder), 0x407e1f (codo_load_pod, fopen rb at 0x4d1d90), 0x4084f2-0x408508 (printf couldn't load %s, exit when it returns null), pico-8 0.2.7 raspi pico8_64 codo_main_init 0xf724 0xfa34-0xfa50, 0xfa5c, 0x100c4-0x100d8 (same sequence), pico-8 0.2.7 windows pico8.exe _codo_main_init 0x403aa0 0x403e25-0x403e47, amberelec packages/amberelec/sources/pico-8.sh:51-52, dArkOS pico8/pico8.sh:136-142, knulli board/fsoverlay/usr/bin/knulli-install-pico8:11, 48-51, 69" - name: pico8.exe path: pico-8/pico8.exe @@ -204,22 +211,22 @@ files: sha1: 9174251921d675c204e683cdea65a8c906fcba28 description: "SDL2 library of the PICO-8 0.2.7 Windows build" note: "pico8.exe imports SDL2.dll, which Windows loads from the executable's folder. Shipped beside it in pico-8_0.2.7_windows.zip." - source_ref: "pico-8 0.2.7 windows pico8.exe, import table" + source_ref: "pico-8 0.2.7 windows pico8.exe import descriptor 0x912064 for SDL2.dll (93 functions from IAT 0x91277c, loader-resolved), _codo_system_init 0x4f9840 call _SDL_Init at 0x4f988e, thunk 0x521890 jmp [0x91285c] (SDL2.dll IAT slot)" - name: config.txt unsourceable: "written by the emulator on exit, no canonical file" system: pico8 required: false description: "PICO-8 settings" - source_ref: "pico-8 0.2.7 amd64 pico8, string config.txt at 0x244739, pico-8 0.2.7 pico-8_manual.txt:250-259, 284" - note: "Read beside the binary, then from the -home folder (~/.lexaloffle/pico-8 on Linux), and written there on exit when absent." + source_ref: "pico-8 0.2.7 amd64 pico8 codo_config_load 0x4d2900 0x4d2965-0x4d297d (config.txt in the -home folder), 0x4d2bbd (fopen r), 0x4d3411 (vdisk), 0x4d2a7b-0x4d2a85 and 0x4d348c (config.txt beside the binary), 0x4d34bb (neither: return with defaults), codo_config_save 0x4d37f0 0x4d37f4-0x4d3824 (written to the -home folder, called from codo_exit.part.1 at 0x4bf640), codo_prefix_with_appdata_path 0x518940 0x51894c (-home folder, else $HOME/.lexaloffle/)" + note: "Read from the -home folder (~/.lexaloffle/pico-8 on Linux), else from beside the binary, and written to the -home folder on exit." - name: sdl_controllers.txt unsourceable: "user supplied, no canonical file" system: pico8 required: false description: "Custom SDL controller mappings, one per line" - source_ref: "pico-8 0.2.7 amd64 pico8, string sdl_controllers.txt at 0x24c896, pico-8 0.2.7 pico-8_manual.txt:301-302, 4053" + source_ref: "pico-8 0.2.7 amd64 pico8 add_sdl_controllers 0x518c00 0x518c04-0x518c46 (beside the binary, fopen r), 0x518c54-0x518c73 (the -home folder), 0x518c8a-0x518cab (created there with a comment line when absent), 0x518d5c-0x518d7a (fgets, SDL_GameControllerAddMapping per line), called from codo_joystick_init at 0x518e74" note: "Processed first when present beside the binary, then read from the -home folder, where PICO-8 writes it when absent." - name: favourites.txt @@ -227,5 +234,5 @@ files: system: pico8 required: false description: "SPLORE favourites list" - source_ref: "pico-8 0.2.7 amd64 pico8, string favourites.txt at 0x242346" - note: "Read from the -home folder. The bbs/.pip.png images beside it are downloaded from the BBS." + source_ref: "pico-8 0.2.7 amd64 pico8 reload_favourites 0x4b0800 0x4b0801-0x4b0837, splore_init.part.19 0x4b2980 0x4b2bd5-0x4b2bed (populate_splore_list_from_text_file 0x4b0350, codo_fopen r at 0x4b038b), save_splore_favourites 0x4ab2d0 0x4ab2d4-0x4ab30c (fopen w)" + note: "Read from the -home folder and written there by SPLORE. The bbs/.pip.png images beside it are downloaded from the BBS." diff --git a/emulators/lrps2.yml b/emulators/lrps2.yml index 58cc5208d..d8541e5d8 100644 --- a/emulators/lrps2.yml +++ b/emulators/lrps2.yml @@ -24,6 +24,13 @@ systems: [sony-playstation-2] bios_directory: "pcsx2/bios/" resources_directory: "pcsx2/resources/" +config_reads: + - file: "core options" + source_ref: "libretro/main.cpp:506, 525-527" + keys: + - key: "pcsx2_bios" + source_ref: "libretro/main.cpp:525-536, 2552-2560" + notes: | Hard fork of PCSX2 (pre-Qt, 1.7-dev era) ported to libretro, x86_64 only, with much of the emulator since rewritten in C89. The system directory of diff --git a/emulators/mastergear.yml b/emulators/mastergear.yml index 824418703..e46170f66 100644 --- a/emulators/mastergear.yml +++ b/emulators/mastergear.yml @@ -42,12 +42,11 @@ notes: | and open the same files. The native libraries keep their symbol tables, so the Android readings below cite libmain.so offsets in the x86_64 slice, and the arm64-v8a, armeabi-v7a, armeabi and x86 slices carry the same filename set. - No source has ever been published: the site states the code is not available - to the general public and the documentation repeats it, while ColEm and fMSX - on the same site ship source archives. + No source has been published: every MG download on the site is a binary + package, while ColEm and fMSX on the same site ship source archives. ref: MG-Android-4900.apk META-INF/CERT.RSA, https://fms.komkon.org/MG/, - MG.html "There is no version of MG for my Unix!", - MG49-Windows-bin.zip, MG49-Ubuntu-x86-bin.tgz + MG49-Windows-bin.zip, MG49-Ubuntu-x86-bin.tgz (sha256 + 25c8a0de74ed6eda, mg sha256 2d6b714cdbd4e6bd) SF7000.ROM is the only system ROM either binary names, and it is read through the cartridge loader. ResetSMS loads it whenever the requested hardware @@ -66,14 +65,14 @@ notes: | size 0x43dfa-0x43f1a, read 0x43f4f), LoadDSK 0x46db0-0x46ecb, MG49-Ubuntu-x86-bin mg 0x3d0fd-0x3d124, 0x3c330 (0x3ca58) - The other machines need no file. SEGA consoles boot from a small ROM that - switches itself off and hands the hardware to the cartridge, which MG does - not emulate, so MasterSystem, GameGear, SG1000 and SC3000 start straight into - the cartridge. SC3000 mode adds the keyboard and 32kB of RAM, and its BASIC - arrives as a cartridge like any other program: the packaged title database - keys Basic 2.10 and Basic 3.10 by cartridge CRC32 under the SC3000 heading. - ref: MG.html "What are MasterSystem and GameGear?", "How do I use SC3000 - keyboard?", assets/names.dat + The other machines open no system file. SF7000.ROM is the only system ROM + name in either binary, and the desktop build references it once, from the + SF7000 branch of the reset routine, so MasterSystem, GameGear, SG1000 and + SC3000 start straight into the cartridge. The SC3000 BASIC arrives as a + cartridge like any other program: the packaged title database keys Basic 2.10 + and Basic 3.10 by cartridge CRC32 under the SC3000 heading. + ref: MG49-Ubuntu-x86-bin mg 0x3d0fd (sole reference to SF7000.ROM at + 0x5231a), libmain.so ResetSMS 0x43604, assets/names.dat On Android one directory holds everything. MainActivity hands EMULib.k() to jniStart, which copies it into the buffer GetHomeDir returns and passes that @@ -82,19 +81,17 @@ notes: | /, keeping the larger of the two when both open. That directory is external storage joined with the application label up to its first space, so /sdcard/MasterGear, falling back to getExternalFilesDirs(null) - when it is not a writable directory, and the author's own cheat file writes the - same path out in full. The desktop builds have no such directory and open - every name where they stand, which the documentation states as the current - directory. Every one of these opens ends in zlib, mopen handing the + when it is not a writable directory, and the cheat archive the author + publishes writes the same path out in full. The desktop builds have no such + directory and open every name where they stand. Every one of these opens ends in zlib, mopen handing the descriptor OpenRealFile returned to gzdopen while the disk loader and the desktop builds call gzopen straight, so each file also opens gzipped, and on Android a content:// name is routed to the Android storage framework instead. ref: MainActivity.java:2265-2276, EMULib.java:456, 494-553, 688-698, libmain.so jniStart 0x18bb0-0x193e1 (0x1921c, 0x1926c), SetPrivateDir 0x38f80, OpenRealFile 0x39190-0x393c3, - mopen 0x393d0-0x3959d, LoadFDI 0x558f7, - MG.html "How do I use SF7000 disk images?", - EmuAndroid "System ROMs", MasterGear-Cheats.zip ROOT.chts + mopen 0x393d0-0x3959d, LoadFDI 0x558f7, MasterGear-Cheats.zip + ROOT.chts files: - name: SF7000.ROM @@ -102,8 +99,8 @@ files: required: true size: 8192 description: "SF7000 IPL, read into the cartridge window before the machine starts" - note: "Loaded whenever the hardware becomes SF7000, and the only fixed ROM name in the binary. A failed open drops the emulator back to the previous hardware, which makes every disk image refuse to mount. The loader checks neither length nor contents, so the documented 8kB image is padded to 16kB with FFh and no hash is compared. Opened by bare name, so it resolves against the working directory and, on Android, against the home directory as well, and a gzipped copy answers too." - source_ref: "libmain.so ResetSMS 0x435a0-0x43b0d (LoadROM 0x43604), LoadROM 0x43c80-0x4451a, LoadDSK 0x46db0-0x46ecb, MG49-Ubuntu-x86-bin mg 0x3d0fd-0x3d124, MG.html \"How do I use SF7000 disk images?\"" + note: "Loaded whenever the hardware becomes SF7000, and the only fixed ROM name in the binary. A failed open drops the emulator back to the previous hardware, which makes every disk image refuse to mount. The loader checks neither length nor contents, so an 8kB image is padded to 16kB with FFh and no hash is compared. Opened by bare name, so it resolves against the working directory and, on Android, against the home directory as well, and a gzipped copy answers too." + source_ref: "libmain.so ResetSMS 0x435a0-0x43b0d (LoadROM 0x43604), LoadROM 0x43c80-0x4451a, LoadDSK 0x46db0-0x46ecb, MG49-Ubuntu-x86-bin mg 0x3d0fd-0x3d124" - name: MasterGear-Cheats.zip required: false @@ -115,10 +112,10 @@ files: - name: custom.chts required: false category: game_data - unsourceable: "cheat codes the user writes, in the format the documentation prints" + unsourceable: "cheat codes the user writes" description: "user cheat sets added to the Cheatopedia menu" note: "Pulled in by the File= directive that ROOT.chts carries, written out as /sdcard/MasterGear/custom.chts, and reached through the same lookup as any other set: package assets, then an absolute path, then the cheat directory." - source_ref: "Cheatopedia.java:504-508, 565-584, MasterGear-Cheats.zip ROOT.chts, EmuAndroid \"I want to add my own cheats to the Cheatopedia\"" + source_ref: "Cheatopedia.java:504-508, 565-584, MasterGear-Cheats.zip ROOT.chts" - name: names.dat sha1: 15f93bd7b0e58cc1ee8c5ff06cb5a085c686ace4 @@ -145,7 +142,7 @@ files: category: game_data description: "virtual joystick skin" note: "Read as /Controls.png when the joystick shape is set to Custom Skin, and by the layout editor. The author publishes a 320x276 template at fms.komkon.org/EmuAndroid/Controls.png to draw over." - source_ref: "MainActivity.java:1809, LayoutEditor.java:99, EmuAndroid \"Can I set my own virtual joystick images?\"" + source_ref: "MainActivity.java:1809, LayoutEditor.java:99" - name: Backdrop.png required: false diff --git a/emulators/mednafen.yml b/emulators/mednafen.yml index 5cdc34595..7d1a95297 100644 --- a/emulators/mednafen.yml +++ b/emulators/mednafen.yml @@ -43,6 +43,61 @@ systems: - snk-ngpc - sony-playstation +pin_build: + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/mednafen/package.mk" + variable: PKG_URL + value: "https://github.com/sydarn/mednafen/archive/refs/tags/1.32.1-chd.tar.gz" +config_reads: + - file: "mednafen.cfg" + platforms: [rocknix] + revision: "e46995e49cbaf1e9996a8e29cc5be16d7fe6d834" + revision_from: "tag 1.32.1-chd of the sydarn/mednafen fork, the PKG_URL ROCKNIX builds" + source_ref: "src/drivers/main.cpp:1469-1520, 1883-1974, 2249, 2405, src/general.cpp:277-300" + keys: + - key: "gba.bios" + source_ref: "src/gba/GBA.cpp:3278, 772, 2472-2481" + - key: "md.cdbios" + source_ref: "src/md/system.cpp:755, 630-640, src/md/cd/cd.cpp:894-912, 971-982" + condition: "CD content" + - key: "nes.ggrom" + source_ref: "src/nes/nes.cpp:455, 298-299, src/nes/cart.cpp:570-583" + condition: "nes.gg 1" + - key: "pce.cdbios" + source_ref: "src/pce/pce.cpp:1103, 647-649" + condition: "disc not detected as Games Express" + - key: "pce.gecdbios" + source_ref: "src/pce/pce.cpp:1104, 647-649" + condition: "disc detected as Games Express" + - key: "pce_fast.cdbios" + source_ref: "src/pce_fast/pce.cpp:647, 476-487" + - key: "pcfx.bios" + source_ref: "src/pcfx/pcfx.cpp:1115, 606-611" + - key: + - "psx.bios_eu" + - "psx.bios_jp" + - "psx.bios_na" + source_ref: "src/psx/psx.cpp:2373-2375, 1764-1775" + condition: "the disc's region" + - key: + - "ss.bios_jp" + - "ss.bios_na_eu" + source_ref: "src/ss/ss.cpp:2441-2442, 1430-1439" + condition: "not ST-V, by SMPC area" + - key: + - "ss.bios_stv_eu" + - "ss.bios_stv_jp" + - "ss.bios_stv_na" + source_ref: "src/ss/ss.cpp:2444-2446, 1420-1439" + condition: "ST-V cart, by area" + - key: + - "ss.cart.kof95_path" + - "ss.cart.ultraman_path" + source_ref: "src/ss/ss.cpp:2477-2478, 1811-1840, 1320-1350, 1389-1396" + condition: "cart type KOF95 or ULTRAMAN" + notes: | Multi-system emulator by the Mednafen Team, the upstream of the beetle_* and mednafen_* libretro cores, which are forks of individual modules. A module is diff --git a/emulators/melonds.yml b/emulators/melonds.yml index 432e036a9..02e8ac401 100644 --- a/emulators/melonds.yml +++ b/emulators/melonds.yml @@ -28,6 +28,58 @@ data_root: source_ref: "upstream src/frontend/qt_sdl/main.cpp:182-184, 196-200, 206-211" note: "portable beside the executable when that folder exists" +pin_build: + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/melonds-sa/package.mk" + variable: PKG_VERSION + value: "906e9ebb27da8c6a715cd7abab4abfe8a8d29427" +config_reads: + - file: "melonDS.ini" + platforms: [rocknix] + source_ref: "upstream src/frontend/qt_sdl/main.cpp:366, upstream src/frontend/qt_sdl/Config.cpp:682-774, 777-783, 785-795, upstream src/frontend/qt_sdl/Platform.cpp:144-166, ROCKNIX projects/ROCKNIX/packages/emulators/standalone/melonds-sa/patches/001-default-config.patch:8-13, ROCKNIX projects/ROCKNIX/packages/emulators/standalone/melonds-sa/patches/003-hotkeys.patch:41-76" + keys: + - key: "BIOS9Path" + source_ref: "upstream src/frontend/qt_sdl/Config.cpp:238, 240, upstream src/frontend/qt_sdl/EmuInstance.cpp:855-876, 1261-1263" + condition: "ExternalBIOSEnable=1" + - key: "BIOS7Path" + source_ref: "upstream src/frontend/qt_sdl/Config.cpp:238, 241, upstream src/frontend/qt_sdl/EmuInstance.cpp:878-898, 1265-1267" + condition: "ExternalBIOSEnable=1" + - key: "FirmwarePath" + source_ref: "upstream src/frontend/qt_sdl/Config.cpp:238, 242, upstream src/frontend/qt_sdl/EmuInstance.cpp:992-1016, 1269" + condition: "ExternalBIOSEnable=1 and ConsoleType=0" + - key: "DSiNANDPath" + source_ref: "upstream src/frontend/qt_sdl/Config.cpp:227, 249, upstream src/frontend/qt_sdl/EmuInstance.cpp:1039-1043, 1227, 1312-1322" + condition: "ConsoleType=1" + - file: "melonDS.toml" + platforms: [emudeck, retrobat] + revision: "b86390e4428bf38ce4c1ce0e9ca446d6d25955e8" + revision_from: "melonDS 1.1: the Flathub manifest net.kuribo64.melonDS at e5ce4504 builds it, and RetroBat's melonDS.exe names it" + source_ref: "upstream src/frontend/qt_sdl/main.cpp:196-213, 328, upstream src/frontend/qt_sdl/Config.cpp:42, 785-799" + keys: + - key: "[DS] BIOS9Path" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:868-889, 1277" + condition: "[Emu] ExternalBIOSEnable = true" + - key: "[DS] BIOS7Path" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:891-911" + condition: "[Emu] ExternalBIOSEnable = true" + - key: "[DS] FirmwarePath" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:1013-1031, 1285" + condition: "[Emu] ExternalBIOSEnable = true and ConsoleType = 0" + - key: "[DSi] BIOS9Path" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:913-938, 1328-1336" + condition: "[Emu] ConsoleType = 1" + - key: "[DSi] BIOS7Path" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:940-965, 1328-1332" + condition: "[Emu] ConsoleType = 1" + - key: "[DSi] FirmwarePath" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:1013-1029, 1285" + condition: "[Emu] ConsoleType = 1" + - key: "[DSi] NANDPath" + source_ref: "upstream src/frontend/qt_sdl/EmuInstance.cpp:1064-1068, 1338-1340" + condition: "[Emu] ConsoleType = 1" + notes: | FreeBIOS fallback for DS mode (NTR), while DSi mode requires all native files. Libretro fork based on melonDS ~0.9.x era, validates size only. diff --git a/emulators/mfme.yml b/emulators/mfme.yml index 96d373a11..6ff717311 100644 --- a/emulators/mfme.yml +++ b/emulators/mfme.yml @@ -3,12 +3,12 @@ type: standalone core_classification: embedded_hle source: "https://www.desertislandfruits.com/" upstream: closed-source -profiled_date: "2026-08-08" +profiled_date: "2026-11-10" core_version: "20.1" version_basis: kind: package - url: "https://www.desertislandfruits.com/" - artifact: "MFME v20 Windows installer, MFME.exe FileVersion 20.1.0.0" + url: "https://archive.org/download/mfmev-20/MFMEv20.zip" + artifact: "MFMEv20.exe installer (zip md5 5f5faa0a99f993c27aa118ebb1a8e6b2), MFME.exe FileVersion 20.1.0.0, ProductVersion 20.0, sha256 8b3c873078b4a9d6edfcd24d18f8f6405253f8fcd8f3266bf944988b0fd4066a" display_name: "MFME (Fruit Machines)" cores: - mfme @@ -18,68 +18,88 @@ systems: mode: standalone notes: | - Closed-source Delphi emulator for fruit machine and slot machine hardware, + Closed-source C++Builder VCL emulator for fruit machine and slot machine hardware, written by Chris Wren (Wizard) and distributed as a Windows installer. MFME.exe carries FileVersion 20.1.0.0, FileDescription "Multiple Fruit Machine Emulator" and - copyright "C.J.Wren 1997-2020", and the installer targets Windows 10, defaults to - C:\MFME\v20 (history.txt:323) and writes HKCU\Software\CJW\MFME. The binary is - ASPack compressed, imports dinput8, xaudio2_9, d2d1 and d3d11 for input, sound - and the hardware accelerated scaler added in v19.0 (history.txt:8-9), and holds - its layout engine in Delphi units around an EasyCompression Library core. - Development ended with the author's death, and Update.exe, reached from File -> - Check For Updates (history.txt:235), no longer finds a server. ES-DE calls - MFME.exe with a .gam path and the working directory set to the emulator - folder, through find rules MFME and MFME-WINDOWS, and runs - it under Wine or Proton on Linux; .gam is in the arcade and mame extension + copyright "C.J.Wren 1997-2020". The installer's setup data enables Windows 10 + only (OS.dat), sets InstallDir C:\MFME\v20 (SC.dat) and writes InstallPath and + Installed under HKCU\Software\CJW\MFME (Registry.dat). MFME.exe keeps its + settings in a TRegIniFile opened on SOFTWARE\CJW, under the current user root + (FUN_004e2920 0x4e2e1b-0x4e2e28, key name at 0xae0a2e), section MFME + (0xae0a24). The binary is ASPack compressed, imports dinput8, xaudio2_9, d2d1 + and d3d11 for input, sound and the hardware accelerated scaler, and holds its + layout engine in Delphi units around an EasyCompression Library core. + Addresses in the source_ref fields are virtual addresses of the image the ASPack + stub unpacks (image base 0x400000, entry 0x402a88), read from MFME.exe sha256 + 8b3c873078b4a9d6. + The File menu item Check For Updates (form resource, OnClick + CheckForUpdates1Click at 0x5194f4) calls FUN_00515fec, which checks FileExists + on Update.exe in the MFME folder (0x516006-0x516042) and starts a thread that + fills a SHELLEXECUTEINFO with verb runas and that path (0x5195ca-0x519657) and + calls ShellExecuteExW (0x519945). + ES-DE calls MFME.exe with a .gam path and the working directory set to the + emulator folder, through find rules MFME and MFME-WINDOWS, and runs it under + Wine or Proton on Linux. .gam is in the arcade and mame extension lists. A machine is a folder holding a .gam file, the .fml layout it names and the ROM set. The .gam is plain text: a System line naming the tech, DIP switch, reel, stake, jackpot, percentage and meter state, a Layout line naming the .fml, a - Game line, and one ROM line per ROM file. Layouts before v5 used .dat and are - converted by loading them in v5 or v6 and saving, while v20 loads .fml only. The .fml - is an AACS container whose password is derived from a four byte seed at the end + Game line, and one ROM line per ROM file. The .fml is an AACS container whose password is derived from a four byte seed at the end of the file through a mixer, hashed with RIPEMD-128 into a Rijndael key, and each chunk is zlib compressed. It holds the Delphi layout stream with every bitmap embedded, carries no external file path, and text components name a font - family rather than a font file. MFME.exe is started with the .gam path as its - argument (history.txt:271). + family rather than a font file. FUN_00509a68 walks ParamStr 1 to ParamCount + (0x50a3c7-0x50aac8), takes the switches -g, -x, -y, -w, -h, -i, -mode, + -nohistory and -slave, and keeps any other argument that FileExists accepts, + expanded to a full path, as the file to open. Its extension sends a .gam to + FUN_004e85c0 (0x50ab40-0x50abb4) and a .fml to FUN_004f5a90 (0x50abc1-0x50ac2d). ROM sets are per machine and self contained. Barcrest S4 and S5 sets are .LO and .HI program files with a .BIN sound ROM, MPU5 sets are .p1 to .p4, and other techs use .hex or .rom members named by the .gam. Fruit machine hardware has no system BIOS, so nothing is shared between machines, and sound ROMs belong to the - machine as well: an S4 game whose sound ROMs are absent still runs and reports - Wrong Snd Err (history.txt:301). v20.0 added an automatic ROM download for DIF - legacy layouts (history.txt:293). Ctrl-K resets a game with its alternate ROM - set (tips.txt). + machine as well. FUN_00625c88 opens a file name starting with http through the + download path (0x625cc6-0x625d64), opens a local file when FileExists holds + (0x625d77-0x625d8a), and otherwise, unless the extension is .ram, .fml, .rtc, + .eep, .wsp or e2p (0x625dac-0x625f6e), prefixes it with + https://www.desertislandfruits.com/legacy/ (0xae531a, 0x625f7a) and fetches it + from there. Effect samples are the mechanical cabinet sounds MFME plays itself, distinct - from the game audio the sound ROM produces. Each effect has a fixed filename - resolved in the game folder first, then DefaultSounds\Custom\\, then DefaultSounds (DefaultSounds/Readme.txt:78-84), and files are - opened when required rather than at layout load (history.txt:210-211). A - preference forces the defaults over the ones a layout selects - (history.txt:219). The distribution ships Custom folders for 40 techs: ACEVIDEO, + from the game audio the sound ROM produces. The effect table at 0xad7ac8 holds + 55 entries of 12 bytes (file name, label, flags). FUN_005fad6c loads every + entry through FUN_005faa24, and FUN_005fb284 reloads one entry with the path + FUN_005158fc builds: the game folder unless the force defaults flag at 0xb915cc + is set (0x515b61-0x515b9c), then DefaultSounds\Custom\\\ + with the style taken from the table at 0xa84cf4 (0x515a87-0x515afd, 0x515c38), + then DefaultSounds\. Each file goes through FUN_005f9584, which opens it with + mmio, expects a RIFF WAVE with a PCM fmt chunk and a data chunk, and returns + nothing otherwise, so a missing or unreadable sample leaves its effect silent. + The distribution ships Custom folders for 40 techs: ACEVIDEO, ADDER5, ASTRASYSA1, BLACKBOX, COINMASTER, ELECTROCOIN, EPOCH, IGTS+, IGTS2000, IMPACT, INDER, M1AB, M1VIDEO, MACH2000A, MACH2000E, MACH2000S, MMM, MPS2, MPU2, MPU3, MPU4, MPU4PLASMA, MPU4VIDEO, MPU5, PCLMAXI, PHOENIX, PHOENIX2, PLUTO5, PROCONN, SCORPION1, SCORPION2, SCORPION4, SCORPION5, SRU, SYS1, SYS5, SYS83, SYS85, SYSTEM80 and spACE, with cabinet subfolders Eclipse for ADDER5, SCORPION4 and SCORPION5, Elegance for EPOCH, and Genesis for MPU4 and MPU5. - DefaultSounds/Readme.txt:35-37 lists the electronic token mech effects as - CoinInToken, CoinInTokenSwitch and CoinInTokenRejected, but the files that ship and - the entry that introduced them name them TokenIn, TokenInSwitch and - TokenInRejected (history.txt:80). + The table names the electronic token mech effects TokenIn.wav, TokenInSwitch.wav + and TokenInRejected.wav (0xadb143, 0xadb158, 0xadb17a), the names the + distribution ships, and holds RelayOn.wav and RelayOff.wav, which the + distribution does not ship. Three shipped directories are enumerated rather than looked up by name and therefore expect no particular filename. DefaultBackdrops and DefaultTiles hold - the images offered as a backdrop or tiled background in the full screen modes, - picked at random when the preference is set (history.txt:48, 55-56), and ship - one wallpaper and six tiles. DefaultSounds/MiscSounds holds alternate payout, + the images offered as a backdrop or tiled background in the full screen modes. + FUN_0051336c and FUN_005137dc walk \DefaultTiles\* and + \DefaultBackdrops\* with FindFirst and FindNext (0x5133ea-0x51379a, + 0x51385a-0x513c0a), keep .bmp, .jpg and .png names, and add each full path to + the lists at +0x1f78 and +0x1f7c. FUN_00513c4c and FUN_00513cf4 pick one entry + with System Random over the list count (0x513c90, 0x513d38). The distribution + ships one wallpaper and six tiles. DefaultSounds/MiscSounds holds alternate payout, coin and note recordings that a user copies over an effect name. Fonts is - scanned for the fonts a layout names, so its contents grow with the layouts - installed. + enumerated by FUN_00511f0c, which registers up to 100 font files of any name, + so its contents grow with the layouts installed. files: # -- Output hardware library -- @@ -91,13 +111,12 @@ files: required: true bundled: true description: "Ultimarc PacDrive, PacLed64 and UltimateIO output library" - source_ref: "MFME.exe import directory, history.txt:278-279" + source_ref: "MFME.exe 20.1.0.0 packed PE import descriptor 0xdba03c (pacdrive32.dll, ordinal 11 into IAT 0xdba2c0, loader-resolved), ASPack stub restores IAT 0xc692ac-0xc692d4 (ordinals 11, 12, 6, 27, 20, 25, 26, 23, 2, 5, 3), FUN_0050f998 0x50fa27 (PacInitialize through thunk 0xa42234), 0x50fa55-0x50fa82 (PacGetDeviceType, PacGetDevicePath, PacGetVersionNumber, PacGetProductName, PacGetSerialNumber), 0x50fe21 (PacShutdown)" note: >- - Listed in the MFME.exe import descriptors, so the Windows loader resolves it - at process start and MFME does not launch when it is absent from the - application directory. Drives real cabinet lamps, hoppers and meters through - Ultimarc boards. v20.0 updated the library and added PacLed64 and UltimateIO - support. + A static import of the packed executable, so the Windows loader maps it before + any MFME code runs and the process does not start without it. Drives cabinet + lamps, hoppers and meters through Ultimarc PacDrive, PacLed64 and UltimateIO + boards. # -- Fonts, scanned from the Fonts folder beside MFME.exe -- @@ -110,12 +129,12 @@ files: bundled: true category: game_data description: "Lithograph Bold, the font layouts name for machine text" - source_ref: "history.txt:38, 309" + source_ref: "MFME.exe 20.1.0.0 FUN_00511f0c 0x511f9e (exe folder + L\"Fonts\\*\"), 0x511fe0 (FindFirst), 0x512166-0x512306 (extension .ttf, .ttc, .fon, .otf, .pfb or .pfm), 0x5123d4 (L\"Fonts\\\" + name added to the list, at most 100), 0x51249f (AddFontResourceExW, FR_PRIVATE), called from 0x4e2920" note: >- - v19.0 moved font loading from installed system fonts to the Fonts folder - where MFME is located. Layouts store a font family name, not a file: the - decoded layout stream names Lithograph. A layout whose font is missing shows - the name in red in the properties screen and renders with a substitute. + Fonts is enumerated, not looked up by file name: every font file found is + registered for the process only. The family Lithograph is the Font.Name of + MFME's own forms (DFM at 0xce48d9) and is set on new text at 0x5ec418. + Layouts store a family name, so a missing font falls back to a substitute. - name: LITHOGRL.TTF size: 61484 @@ -126,8 +145,8 @@ files: bundled: true category: game_data description: "Lithograph Light, the font layouts name for machine text" - source_ref: "history.txt:38, 309" - note: "Same mechanism as LITHOGRB.TTF, the light weight of the same family." + source_ref: "MFME.exe 20.1.0.0 FUN_00511f0c 0x511f9e (exe folder + L\"Fonts\\*\"), 0x511fe0 (FindFirst), 0x512166-0x512306 (extension .ttf, .ttc, .fon, .otf, .pfb or .pfm), 0x5123d4 (L\"Fonts\\\" + name added to the list, at most 100), 0x51249f (AddFontResourceExW, FR_PRIVATE), called from 0x4e2920" + note: "Registered by the same Fonts enumeration as LITHOGRB.TTF, family LithographLight." - name: MFME.ttf size: 264428 @@ -137,9 +156,9 @@ files: required: false bundled: true category: game_data - description: "MFME segment and display font" - source_ref: "history.txt:38, 168" - note: "Shipped font used by MFME's own displays, updated in v19.5." + description: "MFME font, family MFME" + source_ref: "MFME.exe 20.1.0.0 FUN_00511f0c 0x511f9e (exe folder + L\"Fonts\\*\"), 0x511fe0 (FindFirst), 0x512166-0x512306 (extension .ttf, .ttc, .fon, .otf, .pfb or .pfm), 0x5123d4 (L\"Fonts\\\" + name added to the list, at most 100), 0x51249f (AddFontResourceExW, FR_PRIVATE), called from 0x4e2920" + note: "Registered by the same Fonts enumeration as LITHOGRB.TTF." # -- Reel masks, applied when the Default option is selected -- @@ -152,10 +171,10 @@ files: bundled: true category: game_data description: "Reel gradient mask applied to reel bands" - source_ref: "DefaultMasks/Readme.txt:1" + source_ref: "MFME.exe 20.1.0.0 FUN_005e67c6 0x5e67e7 (exe folder + \"\\DefaultMasks\"), 0x5e6a9c (+ \"\\ReelGradientMask.bmp\"), 0x5e6ae7 (FileExists, nothing loaded when absent), 0x5e6b40 (bitmap load from the same path)" note: >- - Used when the Default option is chosen for the mask in the reel properties - window. A custom mask stored in the layout replaces it. + Applied when the Default mask is chosen for a reel. A custom mask stored in + the layout replaces it. - name: ReelLampMask.bmp size: 108734 @@ -166,7 +185,7 @@ files: bundled: true category: game_data description: "Reel lamp mask applied to reel bands" - source_ref: "DefaultMasks/Readme.txt:1" + source_ref: "MFME.exe 20.1.0.0 FUN_005e67c6 0x5e67e7 (exe folder + \"\\DefaultMasks\"), 0x5e690c (+ \"\\ReelLampMask.bmp\"), 0x5e6957 (FileExists, nothing loaded when absent), 0x5e69af-0x5e69fa (bitmap created and loaded from the same path), FUN_0051bb70 0x51bb9b (exe folder + \"\\DefaultMasks\\ReelLampMask.bmp\"), 0x51bc33 (FileExists)" note: "Same mechanism as ReelGradientMask.bmp, for the reel lamp overlay." # -- Payout solenoid slides -- @@ -180,7 +199,7 @@ files: bundled: true category: game_data description: "2p payout solenoid" - source_ref: "DefaultSounds/Readme.txt:9, history.txt:44" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 39 at 0xad7c9c (\"2pSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: 10pSlide.wav size: 60834 @@ -191,7 +210,7 @@ files: bundled: true category: game_data description: "10p payout solenoid" - source_ref: "DefaultSounds/Readme.txt:10" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 4 at 0xad7af8 (\"10pSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: 20pSlide.wav size: 60834 @@ -202,7 +221,7 @@ files: bundled: true category: game_data description: "20p payout solenoid" - source_ref: "DefaultSounds/Readme.txt:11" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 17 at 0xad7b94 (\"20pSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: 50pSlide.wav size: 60834 @@ -213,7 +232,7 @@ files: bundled: true category: game_data description: "50p payout solenoid" - source_ref: "DefaultSounds/Readme.txt:12" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 18 at 0xad7ba0 (\"50pSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: PoundSlide.wav size: 60834 @@ -224,7 +243,7 @@ files: bundled: true category: game_data description: "One pound payout solenoid" - source_ref: "DefaultSounds/Readme.txt:13" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 31 at 0xad7c3c (\"PoundSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: TokenSlide.wav size: 84928 @@ -235,7 +254,7 @@ files: bundled: true category: game_data description: "10p and 20p token payout solenoid" - source_ref: "DefaultSounds/Readme.txt:14" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 5 at 0xad7b04 (\"TokenSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: MiscSlide.wav size: 63898 @@ -246,21 +265,39 @@ files: bundled: true category: game_data description: "Five by 50p slide" - source_ref: "DefaultSounds/Readme.txt:15" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 32 at 0xad7c48 (\"MiscSlide.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Meters and buttons -- - - name: meter.wav + - name: Meter.wav size: 9260 sha1: d4c70ecc12d3be10d5a07784b6d07e9e3880e39a system: fruitmachine - path: "DefaultSounds/meter.wav" + path: "DefaultSounds/Meter.wav" required: false bundled: true category: game_data description: "Electromechanical meter step" - source_ref: "DefaultSounds/Readme.txt:17" - note: "Listed as Meter.wav in the readme, shipped as meter.wav." + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 12 at 0xad7b58 (\"Meter.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" + note: "The table names Meter.wav, the distribution ships it as meter.wav on a case insensitive file system." + + - name: RelayOn.wav + system: fruitmachine + path: "DefaultSounds/RelayOn.wav" + required: false + category: game_data + description: "Relay switched on" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 13 at 0xad7b64 (\"RelayOn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" + note: "Effect slot Relay On in the table, with no sample in the distribution." + + - name: RelayOff.wav + system: fruitmachine + path: "DefaultSounds/RelayOff.wav" + required: false + category: game_data + description: "Relay switched off" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 14 at 0xad7b70 (\"RelayOff.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" + note: "Effect slot Relay Off in the table, with no sample in the distribution." - name: ButtonDown.wav size: 3264 @@ -271,7 +308,7 @@ files: bundled: true category: game_data description: "Layout button pressed" - source_ref: "DefaultSounds/Readme.txt:19" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 9 at 0xad7b34 (\"ButtonDown.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: "PROCONN ships its own copy under DefaultSounds/Custom/PROCONN/." - name: ButtonUp.wav @@ -283,7 +320,7 @@ files: bundled: true category: game_data description: "Layout button released" - source_ref: "DefaultSounds/Readme.txt:20" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 10 at 0xad7b40 (\"ButtonUp.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: "PROCONN ships its own copy under DefaultSounds/Custom/PROCONN/." # -- Hoppers -- @@ -297,7 +334,7 @@ files: bundled: true category: game_data description: "Hopper 1 motor running" - source_ref: "DefaultSounds/Readme.txt:22" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 20 at 0xad7bb8 (\"HopperMotor1.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: >- Cabinet specific copies ship under DefaultSounds/Custom/ for ADDER5/Eclipse, EPOCH/Elegance, MPU4/Genesis, MPU5/Genesis, SCORPION4/Eclipse and @@ -312,7 +349,7 @@ files: bundled: true category: game_data description: "Coin paid out from hopper 1" - source_ref: "DefaultSounds/Readme.txt:23" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 21 at 0xad7bc4 (\"HopperCoin1.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: "Same cabinet specific copies as HopperMotor1.wav." - name: HopperMotor2.wav @@ -324,7 +361,7 @@ files: bundled: true category: game_data description: "Hopper 2 motor running" - source_ref: "DefaultSounds/Readme.txt:24" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 33 at 0xad7c54 (\"HopperMotor2.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: "Same cabinet specific copies as HopperMotor1.wav." - name: HopperCoin2.wav @@ -336,7 +373,7 @@ files: bundled: true category: game_data description: "Coin paid out from hopper 2" - source_ref: "DefaultSounds/Readme.txt:25" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 34 at 0xad7c60 (\"HopperCoin2.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: >- Same cabinet specific copies as HopperMotor1.wav, plus an alternate in DefaultSounds/MiscSounds/. @@ -352,7 +389,7 @@ files: bundled: true category: game_data description: "Note inserted into the note acceptor" - source_ref: "DefaultSounds/Readme.txt:27" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 25 at 0xad7bf4 (\"NoteIn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: NoteInReject.wav size: 96688 @@ -363,7 +400,7 @@ files: bundled: true category: game_data description: "Note rejected by the note acceptor" - source_ref: "DefaultSounds/Readme.txt:28" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 30 at 0xad7c30 (\"NoteInReject.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: NoteInStack.wav size: 254880 @@ -374,7 +411,7 @@ files: bundled: true category: game_data description: "Note accepted and sent to the stacker" - source_ref: "DefaultSounds/Readme.txt:29" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 26 at 0xad7c00 (\"NoteInStack.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Roll down electronic coin mech -- @@ -387,7 +424,7 @@ files: bundled: true category: game_data description: "Coin inserted into a roll down electronic mech" - source_ref: "DefaultSounds/Readme.txt:31" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 22 at 0xad7bd0 (\"CoinIn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInSwitch.wav size: 33008 @@ -398,7 +435,7 @@ files: bundled: true category: game_data description: "Coin accepted by the mech" - source_ref: "DefaultSounds/Readme.txt:32" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 23 at 0xad7bdc (\"CoinInSwitch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInRejected.wav size: 88144 @@ -409,7 +446,7 @@ files: bundled: true category: game_data description: "Coin rejected by the mech into the payout tray" - source_ref: "DefaultSounds/Readme.txt:33" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 24 at 0xad7be8 (\"CoinInRejected.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: TokenIn.wav size: 60816 @@ -420,7 +457,7 @@ files: bundled: true category: game_data description: "Token inserted into an electronic token mech" - source_ref: "history.txt:80, DefaultSounds/Readme.txt:35" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 44 at 0xad7cd8 (\"TokenIn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: TokenInSwitch.wav size: 33008 @@ -431,7 +468,7 @@ files: bundled: true category: game_data description: "Token accepted by an electronic token mech" - source_ref: "history.txt:80, DefaultSounds/Readme.txt:36" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 45 at 0xad7ce4 (\"TokenInSwitch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: TokenInRejected.wav size: 88144 @@ -442,7 +479,7 @@ files: bundled: true category: game_data description: "Token rejected by an electronic token mech" - source_ref: "history.txt:80, DefaultSounds/Readme.txt:37" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 46 at 0xad7cf0 (\"TokenInRejected.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- S1 and S10 mechs -- @@ -455,7 +492,7 @@ files: bundled: true category: game_data description: "Coin inserted in an S1 type mech" - source_ref: "history.txt:148" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 47 at 0xad7cfc (\"CoinInS1.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS1Switch.wav size: 33008 @@ -466,7 +503,7 @@ files: bundled: true category: game_data description: "Coin accepted by an S1 type mech" - source_ref: "history.txt:148" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 49 at 0xad7d14 (\"CoinInS1Switch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS1Token.wav size: 60816 @@ -477,7 +514,7 @@ files: bundled: true category: game_data description: "Token inserted in an S1 token type mech" - source_ref: "history.txt:148" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 48 at 0xad7d08 (\"CoinInS1Token.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS1TokenSwitch.wav size: 33008 @@ -488,7 +525,7 @@ files: bundled: true category: game_data description: "Token accepted by an S1 token type mech" - source_ref: "history.txt:148" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 50 at 0xad7d20 (\"CoinInS1TokenSwitch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10.wav size: 60816 @@ -499,7 +536,7 @@ files: bundled: true category: game_data description: "Coin inserted in an S1 or S10 type mech" - source_ref: "DefaultSounds/Readme.txt:39" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 35 at 0xad7c6c (\"CoinInS10.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10Rejected.wav size: 80834 @@ -510,7 +547,7 @@ files: bundled: true category: game_data description: "Coin rejected from an S10 type mech" - source_ref: "DefaultSounds/Readme.txt:40, history.txt:47, 153" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 42 at 0xad7cc0 (\"CoinInS10Rejected.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10Switch.wav size: 33008 @@ -521,7 +558,7 @@ files: bundled: true category: game_data description: "Coin accepted by an S1 or S10 type mech" - source_ref: "DefaultSounds/Readme.txt:41, history.txt:47" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 40 at 0xad7ca8 (\"CoinInS10Switch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10Token.wav size: 60816 @@ -532,7 +569,7 @@ files: bundled: true category: game_data description: "Token inserted in an S10 token type mech" - source_ref: "DefaultSounds/Readme.txt:43" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 36 at 0xad7c78 (\"CoinInS10Token.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10TokenRejected.wav size: 80834 @@ -543,7 +580,7 @@ files: bundled: true category: game_data description: "Token rejected from an S10 token type mech" - source_ref: "DefaultSounds/Readme.txt:44, history.txt:47, 153" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 43 at 0xad7ccc (\"CoinInS10TokenRejected.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinInS10TokenSwitch.wav size: 33008 @@ -554,7 +591,7 @@ files: bundled: true category: game_data description: "Token accepted by an S10 token type mech" - source_ref: "DefaultSounds/Readme.txt:45, history.txt:47" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 41 at 0xad7cb4 (\"CoinInS10TokenSwitch.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: S1Locked.wav size: 7596 @@ -565,7 +602,7 @@ files: bundled: true category: game_data description: "Coin refused by a locked out S1 mech" - source_ref: "DefaultSounds/Readme.txt:50" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 27 at 0xad7c0c (\"S1Locked.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Comparator mech -- @@ -578,7 +615,7 @@ files: bundled: true category: game_data description: "Coin inserted in a comparator style mech" - source_ref: "DefaultSounds/Readme.txt:47" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 28 at 0xad7c18 (\"CoinInDrop.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: CoinDropReject.wav size: 12018 @@ -589,7 +626,7 @@ files: bundled: true category: game_data description: "Coin rejected from a comparator style mech" - source_ref: "DefaultSounds/Readme.txt:48" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 29 at 0xad7c24 (\"CoinDropReject.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Lockout solenoid -- @@ -602,7 +639,7 @@ files: bundled: true category: game_data description: "Lockout solenoid activated" - source_ref: "DefaultSounds/Readme.txt:52" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 15 at 0xad7b7c (\"LockoutOn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: LockoutOff.wav size: 9204 @@ -613,7 +650,7 @@ files: bundled: true category: game_data description: "Lockout solenoid deactivated" - source_ref: "DefaultSounds/Readme.txt:53" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 16 at 0xad7b88 (\"LockoutOff.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Stepper reels -- @@ -623,11 +660,11 @@ files: required: false category: game_data description: "SRU, SYS80 and MPS2 200 step reel motor" - source_ref: "DefaultSounds/Readme.txt:55, history.txt:74" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 19 at 0xad7bac (\"Stepper.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" note: >- Shipped only as tech copies under DefaultSounds/Custom/ for ELECTROCOIN, - MPS2, SRU and SYSTEM80, and as stepper.wav for M1AB. Reel effects were - extended to Maygay M1a and made available to other techs in v20.0. + MPS2, SRU and SYSTEM80, and as stepper.wav for M1AB, which FUN_005158fc + finds before the DefaultSounds folder. # -- Prize vend -- @@ -640,7 +677,7 @@ files: bundled: true category: game_data description: "Prize vend motor started" - source_ref: "DefaultSounds/Readme.txt:57" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 37 at 0xad7c84 (\"PrizeMotor.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: PrizeVend.wav size: 62288 @@ -651,8 +688,7 @@ files: bundled: true category: game_data description: "Prize dispensed" - source_ref: "DefaultSounds/Readme.txt:58" - note: "Listed as Prizevend.wav in the readme, shipped as PrizeVend.wav." + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 38 at 0xad7c90 (\"PrizeVend.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Pull handle -- @@ -665,7 +701,7 @@ files: bundled: true category: game_data description: "Pull handle drawn slowly" - source_ref: "DefaultSounds/Readme.txt:60, history.txt:207" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 51 at 0xad7d2c (\"PullHandleSlow.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: PullHandleNormal.wav size: 70700 @@ -676,7 +712,7 @@ files: bundled: true category: game_data description: "Pull handle drawn at normal speed" - source_ref: "DefaultSounds/Readme.txt:61, history.txt:207" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 52 at 0xad7d38 (\"PullHandleNormal.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: PullHandleFast.wav size: 30252 @@ -687,7 +723,7 @@ files: bundled: true category: game_data description: "Pull handle drawn quickly" - source_ref: "DefaultSounds/Readme.txt:62, history.txt:207" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 53 at 0xad7d44 (\"PullHandleFast.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: PullHandleRelease.wav size: 43372 @@ -698,7 +734,7 @@ files: bundled: true category: game_data description: "Pull handle released" - source_ref: "DefaultSounds/Readme.txt:63, history.txt:207" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 54 at 0xad7d50 (\"PullHandleRelease.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" # -- Electromechanical cabinets -- @@ -711,7 +747,7 @@ files: bundled: true category: game_data description: "Reel motor activated on an EM machine" - source_ref: "DefaultSounds/Readme.txt:68" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 0 at 0xad7ac8 (\"MotorOn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: Wiper.wav size: 117804 @@ -722,7 +758,7 @@ files: bundled: true category: game_data description: "Reel with studs spinning on an EM machine" - source_ref: "DefaultSounds/Readme.txt:69" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 3 at 0xad7aec (\"Wiper.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: SolenoidOn.wav size: 5450 @@ -733,7 +769,7 @@ files: bundled: true category: game_data description: "Reel solenoid activated on an EM machine" - source_ref: "DefaultSounds/Readme.txt:70" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 1 at 0xad7ad4 (\"SolenoidOn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: SolenoidOff.wav size: 17766 @@ -744,7 +780,7 @@ files: bundled: true category: game_data description: "Reel solenoid deactivated on an EM machine" - source_ref: "DefaultSounds/Readme.txt:71" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 2 at 0xad7ae0 (\"SolenoidOff.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: BellOn.wav size: 97512 @@ -755,7 +791,7 @@ files: bundled: true category: game_data description: "Bell switched on" - source_ref: "DefaultSounds/Readme.txt:72" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 7 at 0xad7b1c (\"BellOn.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: BellOff.wav size: 13702 @@ -766,7 +802,7 @@ files: bundled: true category: game_data description: "Bell switched off" - source_ref: "DefaultSounds/Readme.txt:73" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 8 at 0xad7b28 (\"BellOff.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: Buzzer.wav size: 9082 @@ -777,7 +813,7 @@ files: bundled: true category: game_data description: "Nudge buzzer activated" - source_ref: "DefaultSounds/Readme.txt:74" + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 6 at 0xad7b10 (\"Buzzer.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" - name: Sounder.wav system: fruitmachine @@ -785,5 +821,5 @@ files: required: false category: game_data description: "Feature sounder activated on an EM machine" - source_ref: "DefaultSounds/Readme.txt:75" - note: "Effect name documented by MFME with no sample in the distribution." + source_ref: "MFME.exe 20.1.0.0 effect table 0xad7ac8 entry 11 at 0xad7b4c (\"Sounder.wav\"), FUN_005fad6c 0x5fadca-0x5fae1c (loads entries 0 to 0x36), FUN_005faa24 0x5faac6-0x5fac04 (FileExists in game folder, Custom, DefaultSounds), 0x5fac35 (FUN_005f9584 mmio RIFF WAVE PCM read, null on failure), FUN_005fb284 0x5fb2c4-0x5fb487 (reload of one entry)" + note: "Effect slot Sounder in the table, with no sample in the distribution." diff --git a/emulators/nanoboyadvance.yml b/emulators/nanoboyadvance.yml index 0e113e0f4..1141ff63e 100644 --- a/emulators/nanoboyadvance.yml +++ b/emulators/nanoboyadvance.yml @@ -24,6 +24,14 @@ cores: systems: - nintendo-gba +config_reads: + - file: "/storage/.config/nanoboyadvance/config.toml" + platforms: [rocknix] + source_ref: "src/platform/sdl/main.cpp:293, src/platform/core/src/config.cpp:16-31" + keys: + - key: "[general] bios_path" + source_ref: "src/platform/core/src/config.cpp:36, src/platform/sdl/main.cpp:177-191, src/platform/core/src/loader/bios.cpp:19-46" + notes: | Game Boy Advance emulator. ROCKNIX builds the SDL2 frontend only (PLATFORM_SDL2=ON, PLATFORM_QT=OFF). diff --git a/emulators/nethersx2-turnip-classic.yml b/emulators/nethersx2-turnip-classic.yml index 527927143..7472d87c3 100644 --- a/emulators/nethersx2-turnip-classic.yml +++ b/emulators/nethersx2-turnip-classic.yml @@ -778,7 +778,7 @@ files: note: >- Loaded as icons/flags/.png with the region string of the entry. Thirty are carried, seven NTSC and twenty-two PAL plus Other. - source_ref: "nethersx2-turnip-classic v0.7 classes.dex icons/flags/%s.png" + source_ref: "classes.dex nethersx2-turnip-classic v0.7 xyz.aethersx2.android.e.h(e.b, int) formats icons/flags/%s.png (jadx 1.5.1 e.java line 71), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 559-567)" - name: "star-.png" path: assets/icons/star-0.png @@ -786,7 +786,7 @@ files: bundled: true description: "Game list compatibility rating icon" note: "Loaded as icons/star-.png for ratings 0 to 5." - source_ref: "nethersx2-turnip-classic v0.7 classes.dex icons/star-%d.png" + source_ref: "classes.dex nethersx2-turnip-classic v0.7 xyz.aethersx2.android.e.h(e.b, int) formats icons/star-%d.png (jadx 1.5.1 e.java line 73), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 559-567)" - name: faq.html path: assets/faq.html @@ -797,7 +797,7 @@ files: sha1: 9163d4a3d19b87483f843e4bf3afe236a50a72d2 description: "Help page" note: "Opened under the android_asset scheme by the setup wizard's browser view." - source_ref: "nethersx2-turnip-classic v0.7 classes.dex android_asset faq.html" + source_ref: "classes.dex nethersx2-turnip-classic v0.7 xyz.aethersx2.android.SetupWizardActivity.a.onCreateView(LayoutInflater, ViewGroup, Bundle) WebView.loadUrl (jadx 1.5.1 SetupWizardActivity.java line 44)" - name: 3rdparty.html path: assets/3rdparty.html @@ -808,7 +808,7 @@ files: sha1: 7743bf1d7e6e09a02f1b2972aa63bd8a9f26050d description: "Third party notices page" note: "Opened under the android_asset scheme in the built-in browser view." - source_ref: "nethersx2-turnip-classic v0.7 classes.dex android_asset 3rdparty.html" + source_ref: "classes.dex nethersx2-turnip-classic v0.7 xyz.aethersx2.android.MainActivity.A(MainActivity, MenuItem) action_third_party_notices then WebView.loadUrl (jadx 1.5.1 MainActivity.java lines 164-171), classes.dex NativeLibrary.readPackageFileToString(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 652-654)" exclusion_note: > Left out are the libraries the package carries for the dynamic linker rather diff --git a/emulators/nethersx2-turnip.yml b/emulators/nethersx2-turnip.yml index a9450063b..bf4162a88 100644 --- a/emulators/nethersx2-turnip.yml +++ b/emulators/nethersx2-turnip.yml @@ -753,7 +753,7 @@ files: note: >- Loaded as icons/flags/.png with the region string of the entry. Thirty are carried, seven NTSC and twenty-two PAL plus Other. - source_ref: "nethersx2-turnip v0.7 classes.dex icons/flags/%s.png" + source_ref: "classes.dex nethersx2-turnip v0.7 xyz.aethersx2.android.e.h(e.b, int) formats icons/flags/%s.png (jadx 1.5.1 e.java line 73), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 576-584)" - name: "star-.png" path: assets/icons/star-0.png @@ -761,7 +761,7 @@ files: bundled: true description: "Game list compatibility rating icon" note: "Loaded as icons/star-.png for ratings 0 to 5." - source_ref: "nethersx2-turnip v0.7 classes.dex icons/star-%d.png" + source_ref: "classes.dex nethersx2-turnip v0.7 xyz.aethersx2.android.e.h(e.b, int) formats icons/star-%d.png (jadx 1.5.1 e.java line 75), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 576-584)" - name: faq.html path: assets/faq.html @@ -772,7 +772,7 @@ files: sha1: 9163d4a3d19b87483f843e4bf3afe236a50a72d2 description: "Help page" note: "Opened under the android_asset scheme in the built-in browser view." - source_ref: "nethersx2-turnip v0.7 classes.dex android_asset faq.html" + source_ref: "classes.dex nethersx2-turnip v0.7 xyz.aethersx2.android.MainActivity.A(MainActivity, MenuItem) action_show_faq (jadx 1.5.1 MainActivity.java lines 154-156), classes.dex MainActivity.G(String) WebView.loadUrl (jadx 1.5.1 MainActivity.java lines 371-376), classes.dex SetupWizardActivity.a.onCreateView(LayoutInflater, ViewGroup, Bundle) WebView.loadUrl (jadx 1.5.1 SetupWizardActivity.java line 46)" - name: 3rdparty.html path: assets/3rdparty.html @@ -783,7 +783,7 @@ files: sha1: 7743bf1d7e6e09a02f1b2972aa63bd8a9f26050d description: "Third party notices page" note: "Opened under the android_asset scheme in the built-in browser view." - source_ref: "nethersx2-turnip v0.7 classes.dex android_asset 3rdparty.html" + source_ref: "classes.dex nethersx2-turnip v0.7 xyz.aethersx2.android.MainActivity.A(MainActivity, MenuItem) action_third_party_notices (jadx 1.5.1 MainActivity.java lines 192-194), classes.dex MainActivity.G(String) WebView.loadUrl (jadx 1.5.1 MainActivity.java lines 371-376)" exclusion_note: > Left out are the libraries the package carries for the dynamic linker rather diff --git a/emulators/nethersx2.yml b/emulators/nethersx2.yml index 87f5be289..7084a1f2a 100644 --- a/emulators/nethersx2.yml +++ b/emulators/nethersx2.yml @@ -559,7 +559,7 @@ files: Loaded as icons/flags/.png with the region string of the entry. Thirty are carried, seven NTSC and twenty-two PAL plus Other, the Polish flag being one the project adds. - source_ref: "nethersx2 v2.2n-4248 classes.dex icons/flags/%s.png" + source_ref: "classes.dex nethersx2 v2.2n-4248 xyz.aethersx2.android.e.h(e.b, int) formats icons/flags/%s.png (jadx 1.5.1 e.java line 72), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 575-583)" - name: "star-.png" path: assets/icons/star-0.png @@ -567,7 +567,7 @@ files: bundled: true description: "Game list compatibility rating icon" note: "Loaded as icons/star-.png for ratings 0 to 5." - source_ref: "nethersx2 v2.2n-4248 classes.dex icons/star-%d.png" + source_ref: "classes.dex nethersx2 v2.2n-4248 xyz.aethersx2.android.e.h(e.b, int) formats icons/star-%d.png (jadx 1.5.1 e.java line 74), classes.dex NativeLibrary.loadDrawableFromPackage(Context, String) AssetManager.open (jadx 1.5.1 NativeLibrary.java lines 575-583)" - name: faq.html path: assets/faq.html @@ -578,7 +578,7 @@ files: sha1: 9163d4a3d19b87483f843e4bf3afe236a50a72d2 description: "Help page" note: "Opened under the android_asset scheme in the built-in browser view." - source_ref: "nethersx2 v2.2n-4248 classes.dex android_asset faq.html" + source_ref: "classes.dex nethersx2 v2.2n-4248 xyz.aethersx2.android.MainActivity.A(MainActivity, MenuItem) action_show_faq (jadx 1.5.1 MainActivity.java lines 154-156), classes.dex MainActivity.G(String) WebView.loadUrl (jadx 1.5.1 MainActivity.java lines 371-376), classes.dex SetupWizardActivity.a.onCreateView(LayoutInflater, ViewGroup, Bundle) WebView.loadUrl (jadx 1.5.1 SetupWizardActivity.java line 45)" - name: 3rdparty.html path: assets/3rdparty.html @@ -589,7 +589,7 @@ files: sha1: 7743bf1d7e6e09a02f1b2972aa63bd8a9f26050d description: "Third party notices page" note: "Opened under the android_asset scheme in the built-in browser view." - source_ref: "nethersx2 v2.2n-4248 classes.dex android_asset 3rdparty.html" + source_ref: "classes.dex nethersx2 v2.2n-4248 xyz.aethersx2.android.MainActivity.A(MainActivity, MenuItem) action_third_party_notices (jadx 1.5.1 MainActivity.java lines 192-194), classes.dex MainActivity.G(String) WebView.loadUrl (jadx 1.5.1 MainActivity.java lines 371-376)" exclusion_note: > Left out are the assets the package carries that no code path on this platform diff --git a/emulators/phoenix.yml b/emulators/phoenix.yml index 9944c2b96..0f33b4f0f 100644 --- a/emulators/phoenix.yml +++ b/emulators/phoenix.yml @@ -21,8 +21,9 @@ systems: notes: | Closed-source 3DO and Atari Jaguar emulator by Altmer (Arts-Union), the author of FreeDO. This profile reads the build RetroBat installs, - PhoenixEmuProject.exe 2.8.JAG (x86-64, dated 2023-01-05), with objdump and - the strings it carries. + PhoenixEmuProject.exe 2.8.JAG (x86-64, dated 2023-01-05, sha256 + 82298a9db3e0e53ad5ca2c659adecc86c0715d2864012bb84c50e02aecf5db67 inside + phoenix.7z sha256 8290e1463f94c456...afc7b6), disassembled. Phoenix names no BIOS file. Every dump is registered in phoenix.config.xml under a platform and a dump type: BIOS, CD-ROM, FMV-ROM, FONT-ROM and NVRAM @@ -31,19 +32,29 @@ notes: | 3DO or "[BIOS] Atari Jaguar (World).j64" for Jaguar from the RetroBat bios folder (emulatorLauncher Generators/Phoenix.Generator.cs:23-95). - The 3DO machine is emulated at hardware level (MADAM, CLIO, the CEL engine - and the ARM CPU) and starts from the BIOS dump. Its md5 is compared with - two values, the PAL Anvil BIOS a48e6746 and the same image with RSA - disabled cf11bbb5 (function at 0x4a10d0, strings at 0xb03a38 and - 0xb03a60), which the 2.8.J changelog lists as PAL BIOS support. FMV-ROM is - the video module ROM, which the 1.2 changelog describes as viewable only, - and FONT-ROM the kanji font of Japanese consoles. Two further md5 values - (0xb03bd0, 0xb03bf8) are compared against the CD-ROM dump and set per game - video parameters. + Each machine declares its dump slots with a flag word. A slot whose flag + has bit 0 clear is mandatory: with no dump registered there, the launch + stops on "You must select %1.". 3DO declares CD-ROM 3, BIOS 0, FONT-ROM 1, FMV-ROM 1 and + NVRAM 1, Jaguar CARTRIDGE 2 and BIOS 1. QFrontend reads a slot by seeking + its dump to 0 and reading at most the size the machine asks for, and + returns -1 when the slot is empty. - Jaguar cartridges run through the boot ROM, and the File menu offers to add - a header, or a generic header, to a headerless cartridge - dump so that the boot ROM accepts it. + The 3DO machine is emulated at hardware level (MADAM, CLIO, the CEL engine + and the ARM CPU) and starts from the BIOS dump, read into the first + megabyte of a 2 MB ROM area, the FONT-ROM dump into the second, the whole + area then byte swapped by 32-bit words. The md5 of the BIOS dump is + compared with two values, the PAL Anvil BIOS a48e6746 and the same image + with RSA disabled cf11bbb5, and a match is passed to the CLIO setup as the + PAL flag. The FMV-ROM slot is declared but the machine setup never reads + it. NVRAM starts from a built-in 0xac-byte image and is then overlaid with + the NVRAM slot. Two further md5 values (0xb03bd0, 0xb03bf8) are compared + against the CD-ROM dump and set per game video parameters. + + Jaguar cartridges run through the boot ROM when one is registered. Without + one, or for a cartridge with a JAGR header, the machine writes the reset + vectors itself and starts at the entry address the cartridge holds at + offset 0x404 (or the JAGR load address). The File menu offers to add a + header, or a generic header, to a headerless cartridge dump. files: - name: panafz10.bin @@ -52,26 +63,44 @@ files: description: "3DO BIOS" note: >- Read from the path registered as the 3DO BIOS in phoenix.config.xml, - under any name. The name is a label for the Panasonic FZ-10 dump. + under any name. The name is a label for the Panasonic FZ-10 dump. The + slot is mandatory and the read is capped at 1 MB. + source_ref: "PhoenixEmuProject.exe 2.8.JAG (sha256 82298a9db3e0e53a) FUN_004a3980 0x4a3a74-0x4a3aa9 (3DO slot BIOS declared with flag 0), FUN_004fd550 0x4ff197-0x4ff220 (empty slot with flag bit 0 clear) and 0x4ff22d-0x4ff409 (QMessageBox You must select %1, returns false at 0x4fdae6), FUN_004a7f60 0x4a8ad0-0x4a8b3b (QFrontend read of slot BIOS, at most 0x100000 bytes, into this+0x1097558), 0x4a8be2-0x4a8c02 (byte swap of the 2 MB ROM area), FUN_004b1460 0x4b1489-0x4b14c4 (slot lookup, seek 0, read, -1 when empty)" - name: panafz10e-anvil.bin system: 3do required: false md5: "a48e6746bd7edec0f40cff078f0bb19f" description: "PAL Anvil BIOS" - note: "Recognized by md5 for PAL operation (0xb03a38, compared at 0x4a1144)." + note: "A BIOS slot dump with this md5 turns on PAL timing." + source_ref: "PhoenixEmuProject.exe 2.8.JAG (sha256 82298a9db3e0e53a) FUN_004a10d0 0x4a1144-0x4a11e4 (md5 of the BIOS slot dump through QFrontend FUN_004b12b0, compared with a48e6746...), called from FUN_004a7f60 0x4a81c1, result passed to the CLIO setup FUN_00491a70 at 0x4a8247-0x4a827b" - name: panafz10e-anvil-norsa.bin system: 3do required: false md5: "cf11bbb5a16d7af9875cca9de9a15e09" description: "PAL Anvil BIOS, RSA check disabled" - note: "Recognized by md5 for PAL operation (0xb03a60, compared at 0x4a120d)." + note: "A BIOS slot dump with this md5 turns on PAL timing." + source_ref: "PhoenixEmuProject.exe 2.8.JAG (sha256 82298a9db3e0e53a) FUN_004a10d0 0x4a120d-0x4a128d (md5 of the BIOS slot dump compared with cf11bbb5... when the first value differs), called from FUN_004a7f60 0x4a81c1, result passed to the CLIO setup FUN_00491a70 at 0x4a8247-0x4a827b" + + - name: panafz1j-kanji.bin + system: 3do + required: false + description: "3DO kanji font ROM" + note: >- + Read from the path registered as the 3DO FONT-ROM in phoenix.config.xml, + under any name, into the second megabyte of the ROM area. The name is a + label for the Panasonic FZ-1 kanji font dump. The slot is optional. + source_ref: "PhoenixEmuProject.exe 2.8.JAG (sha256 82298a9db3e0e53a) FUN_004a3980 0x4a3aae-0x4a3ae3 (3DO slot FONT-ROM declared with flag 1, optional), FUN_004a7f60 0x4a8b48-0x4a8bd5 (QFrontend read of slot FONT-ROM, at most 0x100000 bytes, into this+0x1197558), 0x4a8be2-0x4a8c02 (byte swap of the 2 MB ROM area)" - name: "[BIOS] Atari Jaguar (World).j64" system: atari-jaguar - required: true + required: false + hle_fallback: true description: "Jaguar boot ROM" note: >- Read from the path registered as the Jaguar BIOS in phoenix.config.xml, - under any name. The name is a label for the No-Intro boot ROM dump. + under any name. The name is a label for the No-Intro boot ROM dump. The + slot is optional: without it the cartridge is started directly from + its entry address. + source_ref: "PhoenixEmuProject.exe 2.8.JAG (sha256 82298a9db3e0e53a) FUN_0089e230 0x89e40c-0x89e432 (Jaguar slot BIOS declared with flag 1, optional), FUN_008a0aa0 0x8a1498-0x8a14c4 (QFrontend read of slot 1, at most 0x100000 bytes, into this+0x5bab8), 0x8a14c6-0x8a14e8 (16-bit byte swap), 0x8a14ea-0x8a1514 (reset vectors taken from the boot ROM when the read returned data), 0x8a2279-0x8a22b8 and 0x8a2360-0x8a2371 (no boot ROM: reset vectors written directly, PC from the cartridge at offset 0x404 or the JAGR header)" diff --git a/emulators/rpix86.yml b/emulators/rpix86.yml index 093b50660..97738d0e8 100644 --- a/emulators/rpix86.yml +++ b/emulators/rpix86.yml @@ -25,11 +25,12 @@ notes: | input and serial devices, and the log and screenshot files it writes. C:\ is the directory given with -d, the working directory by default - (usage text). The emulator looks for its shell as C:\4DOS.COM or - C:\4DOS\4DOS.COM. When neither exists it stops with "Unable to find - 4DOS.COM command interpreter (shell)" and offers to fetch it with - "wget http://rpix86.patrickaalto.com/4DOS.COM". RetroPie runs the binary - from its install directory and unpacks + (usage text). Started without a program to run, the emulator looks for + its shell as C:\4DOS\4DOS.COM, then C:\4DOS.COM. When neither exists it + asks "Unable to find 4DOS.COM command interpreter (shell)", runs + "wget http://rpix86.patrickaalto.com/4DOS.COM" into C:\ on yes and + exits on no. The binary itself is sha256 48769ffb388822b6...68c0. + RetroPie runs the binary from its install directory and unpacks files.retropie.org.uk/archives/4dos.zip (sha256 801441f3f65e...5b636a, 4DOS 7.50 from JP Software) there (scriptmodules/emulators/rpix86.sh). @@ -44,5 +45,5 @@ files: sha1: "a44f65d6318582501d22e27831eb2b1f0df58f79" md5: "fc3a0078a13d98e611a62c1d6724f8c5" crc32: "8300d4cb" - source_ref: "rpix86 0.19 binary, file offsets 0x1b2c48 (C:\\4DOS.COM), 0x1b2c34 (C:\\4DOS\\4DOS.COM), 0x1b515c (Unable to find 4DOS.COM), 0x1b504c (wget .../4DOS.COM -O%s/4DOS.COM)" + source_ref: "rpix86 0.19 (sha256 48769ffb388822b6) main 0xbf34: 0xc380-0xc388 (no program on the command line, start the shell), 0xc6d4-0xc6e0 (retry after a download), 0xcbbc (exit when declined); FUN_0000d72c 0xd814-0xd8c0 (tries C:\\4DOS\\4DOS.COM then C:\\4DOS.COM from the table at 0x1ca810 with tail /P through the DOS EXEC at 0x22da0, returns -1 when both fail); FUN_00015e80 0x15ea4-0x15eb0 (Unable to find 4DOS.COM prompt), 0x15eec-0x15f00 and 0x1636c-0x1637c (sprintf of wget .../4DOS.COM -O%s/4DOS.COM into the C: directory, system)" note: "Same bytes at rpix86.patrickaalto.com/4DOS.COM, the URL the binary downloads from, and in RetroPie's 4dos.zip. Read from the emulated C: root, not a BIOS directory. The author's rpix86.zip and rpix86.tar.gz hold the binary alone, and RetroPie unpacks 4dos.zip into the install directory." diff --git a/emulators/speccy.yml b/emulators/speccy.yml index cfa22dd4b..4a062aa6f 100644 --- a/emulators/speccy.yml +++ b/emulators/speccy.yml @@ -56,7 +56,8 @@ notes: | through 5.9, is a binary package, while ColEm and fMSX on the same site ship source archives. ref: com.fms.speccy.apk APK Signing Block, https://fms.komkon.org/Speccy/, - Speccy59-Windows-bin.zip, Speccy59-Ubuntu-x86-bin.tgz + Speccy59-Windows-bin.zip, Speccy59-Ubuntu-x86-bin.tgz (sha256 + 723eef7f34c50532, speccy sha256 2c335e4b7ead43f8) One directory holds everything. MainActivity hands the home directory to jniStart, which copies it into the buffer GetHomeDir returns and passes that @@ -65,21 +66,23 @@ notes: | of when it is done. That directory is external storage joined with the application label up to its first space, so /sdcard/Speccy for the package read here, falling back to getExternalFilesDirs(null) when it is - not a writable directory. The author's own instructions give the same - placement. Every open goes through mopen, which calls OpenRealFile first: the + not a writable directory. Every open goes through mopen, which calls OpenRealFile first: the name is tried as given, and again as /, keeping the larger of the two when both open. mopen then layers gzdopen over the descriptor, so any of these files also opens gzipped, and a content:// name is routed to the Android storage framework. The desktop builds have no home - directory of their own and open every name where they stand, which -home - changes for the system ROMs alone. + directory of their own and open every name where they stand. Option -home + stores its argument as the one directory LoadBIOS changes into before the + first ROM and back out of after the last, so it moves the system ROMs alone. ref: MainActivity.java:1091-1104, EMULib.java:178, 315-361, 363-373, libmain.so jniStart 0x30ad8-0x310e3 (0x30eec-0x30efc, 0x30f58), GetHomeDir 0x2e73c, SetPrivateDir 0x509e0, Application 0x57784-0x577a4, OpenRealFile 0x50bd8-0x50dff, mopen 0x50e00-0x50f8f, LoadBIOS 0x5b0c4-0x5b0e8, 0x5b3d4-0x5b3e0, - Speccy59-Ubuntu-x86-bin speccy 0x3dae5-0x3db17, Speccy.html - "-home ", EmuAndroid "System ROMs" + Speccy59-Ubuntu-x86-bin speccy main 0xc000-0xc053 (option table + 0x593b0, entry 48 home), 0xc22f-0xc258 (argument stored at 0x6f9f0), + LoadBIOS 0x3dae5-0x3db17 (getcwd, chdir to 0x6f9f0), 0x3de68-0x3de6e + (chdir back) LoadBIOS drives the whole set from one word of hardware flags, calling TryLoadROM once per name in a fixed order with the length to read and the bit @@ -108,7 +111,7 @@ notes: | ROM. ref: libmain.so LoadBIOS 0x5b29c-0x5b2c4, 0x5b32c-0x5b348, 0x5b2fc-0x5b3b4, Speccy59-Ubuntu-x86-bin speccy 0x3dc79-0x3dca1, 0x3ddf0-0x3de10, - 0x3dcd9-0x3dd64, Speccy.html "Now trying to load ZXS128TR.ROM BIOS file" + 0x3dcd9-0x3dd64 Thirteen of the nineteen ROMs ship inside the Android package. MainActivity reads assets/memfs.mp3 whole and jniStart mounts it through SetMemoryFS as an @@ -132,7 +135,9 @@ notes: | ref: libmain.so LoadFile 0x5c100, 0x5c1e8, 0x5c210, 0x5c234, Application 0x57874-0x578d0, StartZXS 0x5af00-0x5af10, LoadPAL 0x5b5f4, Speccy59-Ubuntu-x86-bin speccy 0x3f4ac-0x3f4bd, - 0x3e450-0x3e494, Speccy.html "-palette " + 0x3e450-0x3e494, main 0xc25d-0xc29b (option -palette, entry 47: a + one digit argument picks a built-in palette at 0xc809-0xc833, any + other is stored at 0x6a708, which defaults to Speccy.pal at 0x5aca9) files: - name: ZXS48.ROM @@ -273,7 +278,7 @@ files: crc32: "39ff160a" description: "Sam Coupe ROM" note: "Read as 32768 bytes for the Sam Coupe, which is a machine of its own in the same flag word, so selecting it clears every Spectrum bit and the trapdoor devices are switched off with it." - source_ref: "libmain.so LoadBIOS 0x5b24c-0x5b25c, TryLoadROM 0x5c728-0x5c744, Speccy59-Ubuntu-x86-bin speccy 0x3dc26-0x3dc39, Speccy.html \"Now disabling all trapdoor-based devices in Sam Coupe mode\"" + source_ref: "libmain.so LoadBIOS 0x5b24c-0x5b25c, TryLoadROM 0x5c728-0x5c744, Speccy59-Ubuntu-x86-bin speccy LoadBIOS 0x3dc26-0x3dc39, reset 0x3df04-0x3df12 (Sam Coupe bit 0x20000000 clears the TRDOS.ROM, IF1.ROM, DISCIPLE.ROM, PLUSD.ROM and Multiface bits, mask 0x7fff0fff)" - name: TRDOS.ROM system: sinclair-zx-spectrum @@ -296,8 +301,8 @@ files: sha1: 5cfb6bca4177c45fefd571734576b55e3a127c08 crc32: "bb66dd1e" description: "Sinclair Interface I ROM" - note: "Read as 8192 bytes when the Interface I is on, and dropped silently when it is missing. Snapshots that page it in need it to restore." - source_ref: "libmain.so LoadBIOS 0x5b144-0x5b154, Speccy59-Ubuntu-x86-bin speccy 0x3db4c-0x3db5f, Speccy.html \"Fixed some .Z80 snapshots not loading when IF1.ROM is missing\"" + note: "Read as 8192 bytes when the Interface I is on, and dropped silently when it is missing." + source_ref: "libmain.so LoadBIOS 0x5b144-0x5b154, Speccy59-Ubuntu-x86-bin speccy 0x3db4c-0x3db5f" - name: DISCIPLE.ROM system: sinclair-zx-spectrum @@ -355,8 +360,8 @@ files: sha1: 0b53d51635a2ce3d4e12c2077df9aeffeac02517 crc32: "b58e81f1" description: "cheat database read by the Cheatopedia browser" - note: "The package ships no cheat set. Cheatopedia looks for the file in the package assets, then in the home directory and its subdirectories, and takes it from Speccy-Cheats.zip in the Downloads directory when that is newer, unpacking it into /Cheats. The author publishes that archive at fms.komkon.org/EmuAndroid/Speccy-Cheats.zip and states it is what re-enables the cheat features Google Play made him disable in March 2019. The copy read here holds this one file." - source_ref: "CheatHelper.java:16-49, Cheatopedia.java:181-188, 256-290, 455, EmuAndroid \"Cheats support\"" + note: "The package ships no cheat set. Cheatopedia looks for the file in the package assets, then in the home directory and its subdirectories, and takes it from Speccy-Cheats.zip in the Downloads directory when that is newer, unpacking it into /Cheats. The author publishes that archive at fms.komkon.org/EmuAndroid/Speccy-Cheats.zip, and the copy read here holds this one file." + source_ref: "CheatHelper.java:16-49, Cheatopedia.java:181-188, 256-290, 455" - name: Controls.png required: false @@ -430,5 +435,6 @@ exclusion_note: > SndName 0x8b048, StartZXS 0x5aeb0-0x5aec0, Application 0x57848-0x57874, LoadRPL 0x77b64, SaveRPL 0x777f8, SaveSCR 0x60838, bi.java:189-218, EMULib.java:779, 809, - Speccy59-Ubuntu-x86-bin speccy 0xbf50, - Speccy.html "[filename] = Name of the file to load [DEFAULT.Z80]" + Speccy59-Ubuntu-x86-bin speccy main 0xbf50-0xbf57 (DEFAULT.Z80 as + the file to load), 0xbf9a-0xbfa2, 0xbfd4 (a non-option argument + replaces it), 0xc05c-0xc060 (passed to the startup routine) diff --git a/emulators/ssf.yml b/emulators/ssf.yml index 86a83c144..45f70463b 100644 --- a/emulators/ssf.yml +++ b/emulators/ssf.yml @@ -29,35 +29,43 @@ notes: | emulator is the 64-bit SSF.exe and which is cited by virtual address, and the Android build SSF_AndroidVer.zip of 2022-08-07, package com.xrea.g2.aaaaaaaa.ssf, whose lib/arm64-v8a/libnative-lib.so keeps its 40738 - dynamic symbols and which is cited by symbol. Prose references name the - Japanese documentation shipped in Document/. + dynamic symbols and which is cited by symbol. Every path below is stored in full in SSF.ini and picked through a file dialog filtered on "all files (*.*)". SSF fixes no filename and no directory for any of them and looks for none, so the names used here are the dumps that fill each slot rather than names the code searches. - Saturn BIOS, [Peripheral] SaturnBIOS. Readme.txt describes the image as the - console address range 00000000-0007FFFF and states that the filename is free. - Neither a length nor a hash is compared against the file. The one routine that - walks the 512 KiB BIOS area is CStateSaveBase::_GetBIOSHash, which folds it - into the checksum pair that tags a save state. + Saturn BIOS, [Peripheral] SaturnBIOS. The boot routine at 0xae0950 opens the + configured path with fopen "rb" and succeeds only when fread returns 0x80000 + bytes (0xa61f70), so a shorter file fails and a longer one is cut at 512 KiB. + No hash is compared against the file. The one routine that walks the 512 KiB + BIOS area is CStateSaveBase::_GetBIOSHash, which folds it into the checksum + pair that tags a save state. - Running without it is a supported mode, [Program4] NoBIOS. SSF carries a boot - ROM of its own, an embedded program with the SYS_* system calls and the - interrupt vectors, and in that mode the backup library is always hooked. - Readme.txt records lower compatibility and advises supplying a BIOS. + Running without it is a supported mode, [Program4] NoBIOS, inverted by holding + Ctrl at launch (GetAsyncKeyState(VK_CONTROL) at 0xae0cf3, applied at + 0xae0d9b-0xae0da7). A failed read leads to the same state: the BIOS present + flag is cleared (0xae0e95, published at 0xaccc46-0xaccc50) and the setup at + 0xa7cfa3-0xa7cfbc passes its negation to the embedded boot ROM, a program with + the SYS_* system calls and the interrupt vectors decompressed into the BIOS + area (0xa756c0), and to the ST-V system call layer (0xa77630). - ST-V is entered by holding left Shift at launch. [Peripheral] STVBIOS names - the motherboard EPROM, and both the option reference and the No BIOS entry of - Readme.txt state that ST-V does not run without it. + ST-V is entered by holding left Shift at launch or by a command-line ROM whose + extension is zip (GetAsyncKeyState(VK_LSHIFT) at 0xae0c08, extension compare + at 0xae0c9d-0xae0ce0). [Peripheral] STVBIOS names the motherboard EPROM. In + that mode the EPROM is read whatever NoBIOS says (0xae0db4-0xae0e63), and an + image carrying SEGA ST-V(TITAN) at 0x500 is byte-swapped in 16-bit units + (0xae0ea6-0xae0ef6). When it is missing the boot carries on with the BIOS + present flag cleared, which arms STVSystemCall::Initialize (0xa77630, the 1 + MiB clear and table reset of the Android symbol) and writes its stub into the + BIOS area. ST-V cartridges are the game and are read from a ZIP: the loader takes the extension of each member as its IC number, accepts 1 through 13, byte-swaps every mask ROM in 16-bit units, doubles each byte of the IC13 EPROM across the 16-bit bus, then mirrors each chip over its window. IC7 and IC13 are - exclusive. STV_ROM.html gives the same layout and notes that MAME ROM sets fit - once the extensions are changed. + exclusive. Cheat scripts live in Cheat/ under the disc product number. Six ship with the emulator and the memory cheat dialog writes more. @@ -82,7 +90,7 @@ files: size: 524288 description: "Saturn BIOS" note: "Any dump of the 512 KiB console ROM, the compatible machines included. Area code is chosen by [Peripheral] Areacode and AutoAreacode, not by the image, so no region selects this file. Each alias labels one of those dumps: mpr-17933.bin, sega_100.bin, sega_100a.bin, sega1003.bin, hisaturn.bin and vsaturn.bin." - source_ref: "SSF.exe 0x43d770 (SaturnBIOS 0x129b1f8), SSF.exe 0x129a2f8 with the filter at 0x129a310, SSF.exe 0x43ff96 (NoBIOS 0x129b4cc), libnative-lib.so SSF::CStateSaveBase::_GetBIOSHash 0x134b8ec-0x134b924, SSF-archive Document/Readme.txt BIOSファイルについて" + source_ref: "SSF.exe 0x43d770 (SaturnBIOS 0x129b1f8), SSF.exe 0x129a2f8 with the filter at 0x129a310, SSF.exe 0x43ff96 (NoBIOS 0x129b4cc), SSF.exe 0xae0950 0xae0e4b-0xae0e95 (path chosen, read of 0x80000 bytes through 0xa61f70), SSF.exe 0xa61f70 0xa61fad-0xa6200e (fopen rb, fread count compared to the size), libnative-lib.so SSF::CStateSaveBase::_GetBIOSHash 0x134b8ec-0x134b924" - name: "epr-20091.ic8" aliases: @@ -98,19 +106,20 @@ files: - epr-17741a.ic8 - epr-17742a.ic8 system: sega-stv - required: true + required: false + hle_fallback: true size: 524288 description: "ST-V BIOS" note: "Loose 512 KiB EPROM image, read outside the cartridge ZIP. Any of the board revisions is accepted, the code branching on none of them." - source_ref: "SSF.exe 0x43d91f (STVBIOS 0x129b218), SSF.exe 0x129a328, SSF-archive Document/Readme.txt ST-V BIOS option, SSF-archive Document/Readme.txt No BIOS option" + source_ref: "SSF.exe 0x43d91f (STVBIOS 0x129b218), SSF.exe 0x129a328, SSF.exe 0xae0950 0xae0db4-0xae0e93 (ST-V mode reads this path through 0xa61f70 whatever NoBIOS says), 0xae0ea6-0xae0ef6 (SEGA ST-V(TITAN) compare, 16-bit swap), 0xa7cfa3-0xa7cfbc (BIOS absent passed to STVSystemCall::Initialize 0xa77630)" - name: ".bin" system: sega-saturn required: false category: game_data description: "cartridge image mapped at A-Bus CS0" - note: "[Peripheral] DataCartridge, gated by DataCartridgeEnable and off by default. SSF reads the file at the configured path into the 32 MiB A-Bus CS0 window and identifies it in no way. The dumps that belong there are the two Saturn ROM carts, mpr-18811-mx.ic1 for The King of Fighters '95 and mpr-19367-mx.ic1 for Ultraman. Readme.txt records the option as unverified." - source_ref: "SSF.exe 0x43e26b (DataCartridge 0x1298838), SSF.exe 0x43e178 (DataCartridgeEnable 0x1298820), SSF.exe 0x129a340, SSF.exe 0x916e5e-0x916e84, SSF-archive Document/Readme.txt Data Cartridge option" + note: "[Peripheral] DataCartridge, gated by DataCartridgeEnable and off by default. SSF reads the file at the configured path into the 32 MiB A-Bus CS0 window and identifies it in no way. The dumps that belong there are the two Saturn ROM carts, mpr-18811-mx.ic1 for The King of Fighters '95 and mpr-19367-mx.ic1 for Ultraman." + source_ref: "SSF.exe 0x43e26b (DataCartridge 0x1298838), SSF.exe 0x43e178 (DataCartridgeEnable 0x1298820), SSF.exe 0x129a340, SSF.exe 0x916e5e-0x916e84" - name: ".cht" path: "Cheat//.cht" diff --git a/emulators/superzsnes.yml b/emulators/superzsnes.yml index 622381f47..49ee7dc68 100644 --- a/emulators/superzsnes.yml +++ b/emulators/superzsnes.yml @@ -31,7 +31,9 @@ notes: | v0.320b. The Windows and Linux archives (SuperZSNES_v0.320.zip, sha1 c934d6b74a050ef8857595a0529ee0e0006e2d93, and SuperZSNES_v0.320.tar.gz, sha1 7630f6bbcda789a329ee4198ec11934feaf56e32, from zsnes.com/files) - carry the same VersionNo object in level0. + carry the same VersionNo object in level0. Method addresses are those the + Windows GameAssembly.dll (sha256 5643f3364802cea8) assigns to the metadata + methods (global-metadata.dat version 39, sha256 99a8e5dbfa9f6028). One NEC uPD7725 interpreter serves every cartridge whose header declares a DSP. RomLoader.GetROMType reads the cartridge type byte at $FFD6 and returns @@ -74,7 +76,7 @@ files: size: 8192 crc32: 465c4e1c validation: [crc32] - source_ref: "GameAssembly DSP1..ctor (name and expected CRC32 0x465C4E1C, compare, warn on mismatch), DSP1Core.LoadROM (8192-byte layout)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (name and expected CRC32 0x465C4E1C loaded at 0x1805588e8, compare, warn on mismatch, zero-filled 0x2000 buffer at 0x180558e33), DSP1Core.LoadROM at 0x180555280 (8192-byte layout)" note: "Default for every DSP cartridge with no table entry, so it covers DSP-1 and DSP-1A titles as well. A mismatched CRC32 warns and the data is used anyway." - name: "dsp2.rom" @@ -83,7 +85,7 @@ files: description: "NEC uPD7725 DSP-2 microcode" required: true size: 8192 - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 0, title CRC32 0x84690f8b)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 0, title CRC32 0x84690f8b)" note: "Selected for header title 'DUNGEON MASTER' (Dungeon Master)." - name: "dsp3.rom" @@ -92,7 +94,7 @@ files: description: "NEC uPD7725 DSP-3 microcode" required: true size: 8192 - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 1, title CRC32 0xfa7f8076)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 1, title CRC32 0xfa7f8076)" note: "Selected for the half-width katakana header title of SD Gundam GX, 'SD' then $B6 $DE $DD $C0 $DE $D1 then 'GX'." - name: "dsp4.rom" @@ -101,7 +103,7 @@ files: description: "NEC uPD7725 DSP-4 microcode" required: true size: 8192 - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 2, title CRC32 0x42578645)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 2, title CRC32 0x42578645)" note: "Selected for header title 'TOP GEAR 3000' (Top Gear 3000)." # Seta parts. The table routes their cartridges to the same uPD7725 @@ -113,7 +115,7 @@ files: system: nintendo-snes description: "Seta ST010 microcode" required: true - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 3, title CRC32 0x04e7aca6)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 3, title CRC32 0x04e7aca6)" note: "Selected for header title 'F1 ROC II' with $00 as the 21st byte (F1 ROC II: Race of Champions)." - name: "st011.rom" @@ -121,7 +123,7 @@ files: system: nintendo-snes description: "Seta ST011 microcode" required: true - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 4, title CRC32 0xc96d71c1)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 4, title CRC32 0xc96d71c1)" note: "Selected for header title '2DAN MORITA SHOUGI' with $00 as the 21st byte (Hayazashi Nidan Morita Shougi)." - name: "st018.rom" @@ -129,5 +131,5 @@ files: system: nintendo-snes description: "Seta ST018 firmware" required: true - source_ref: "GameAssembly DSP1..ctor (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 5, title CRC32 0x85885c5e)" + source_ref: "GameAssembly.dll v0.320 DSP1..ctor at 0x1805587d0 (table lookup, no CRC32 check), SUPERZSNES_Data/level0 (VersionNo.dspDetections entry 5, title CRC32 0x85885c5e)" note: "Selected for header title 'NIDAN MORITASHOGI2' (Hayazashi Nidan Morita Shougi 2)." diff --git a/emulators/teknoparrot.yml b/emulators/teknoparrot.yml index f54cfbf91..2634434c9 100644 --- a/emulators/teknoparrot.yml +++ b/emulators/teknoparrot.yml @@ -76,9 +76,9 @@ notes: | Play! runs System 246/256 games from its arcadedefs (dongle, CD or HDD image) with HLE and loads no BIOS. CrediarDolphin ships Sys/Triforce/segaboot.gcm, which it opens for the test menus, and the free DSP ROMs in Sys/GC. The - RPCS3 fork refuses to boot without installed PS3 firmware ("PS3 firmware is - not installed or the installed firmware is invalid."). The cxbxr fork keeps - the Chihiro media board files of Cxbx-Reloaded under EmuMediaBoard. + RPCS3 fork refuses to boot without installed PS3 firmware ("Missing Firmware + Detected!"). The cxbxr fork keeps the Chihiro media board files of + Cxbx-Reloaded under EmuMediaBoard. Not documented: the BIOS sets of TeknoMVS, TeknoCPS, TeknoSS32 and the other Tekno* board emulators. TeknoParrotUI names only the game ZIP for them @@ -238,8 +238,8 @@ files: required: true storage: large_file description: "PlayStation 3 system software update" - note: "Installed into dev_flash through Install firmware from PS3UPDAT.PUP. Without installed firmware the fork stops with \"PS3 firmware is not installed or the installed firmware is invalid.\"" - source_ref: "RPCS3 rpcs3.exe, release RPCS3_1.0.0.7" + note: "Installed into dev_flash through Install firmware from PS3UPDAT.PUP. Without dev_flash/sys/external/liblv2.sprx the boot stops and the \"Missing Firmware Detected!\" dialog asks for PS3UPDAT.PUP." + source_ref: "RPCS3 1.0.0.7 rpcs3.exe (sha256 89990c08039bdb21) Emulator::Load 0x14109dac2-0x14109db62 (ppu_exec ok and fs::is_file of dev_flash sys/external/liblv2.sprx false), 0x14109dbc0-0x14109dbd2 (an LLE firmware module is configured), 0x14109dc75-0x14109dced (Kill, then on_missing_fw on the main thread, boot ends), main_window 0x140cc6b50-0x140cc6b82 (Missing Firmware Detected! dialog), HandlePupInstallation 0x140cc1456: 0x140cc15a7 (fs::file open of the selected PUP), 0x140cc15ff (could not be opened), 0x140cc1635-0x140cc16d3 (pup_object parse: empty, not a PUP, incomplete)" # cxbxr component, Chihiro (RetroBat core chihiro) - name: fpr21042_m29w160et.bin @@ -247,33 +247,34 @@ files: system: sega-chihiro required: true size: 2097152 + validation: [size] description: "Chihiro media board flash ROM" - note: "Read to write out the two SEGABOOT halves when they are absent." - source_ref: "cxbxr cxbxr-emu.dll, release cxbxr_1.0.0.20" + note: "Opened when a title is started directly (boot flags zero), the system is Chihiro and a boot.id sits beside the XBE. The emulator aborts when it is missing or not 2 MB, then writes the two SEGABOOT halves out of it when they are absent." + source_ref: "cxbxr 1.0.0.20 cxbxr-emu.dll (sha256 4396e61e874359c9) FUN_100c2dc0 0x100c2dc0-0x100c2dfa (static std::string fpr21042_m29w160et.bin), FUN_103deed0 0x103df12c-0x103df16c (xbeDirectory, parent_path FUN_10200420 of the XBE path), 0x103df408-0x103df4d4 (auto detect: XbeType 0, 1 or other gives system 2, 4 or 8, then filesystem::exists FUN_100cbc80 of xbeDirectory / boot.id, string 0x10652c54, sets 8 Chihiro), 0x103df572-0x103df646 (BootFlags zero, system 8 and a second exists of xbeDirectory / boot.id, otherwise jump to 0x103dfa07 past the ROM block), 0x103df6a7-0x103df72d (EmuMediaBoard path plus that name, exists check, CxbxrAbort Chihiro Media Board ROM could not be found), 0x103df744-0x103df769 (fopen, abort when it fails), 0x103df777-0x103df7b2 (fseek end, ftell, abort unless 0x200000), 0x103df83a-0x103df92e (SEGABOOT halves written when absent)" - name: ic10_g24lc64.bin path: "EmuMediaBoard/Chihiro/ic10_g24lc64.bin" system: sega-chihiro required: true description: "Base board QC microcontroller firmware" - note: "\"Failed to load base board qc firmware\" when it cannot be opened." - source_ref: "cxbxr cxbxr-emu.dll, release cxbxr_1.0.0.20" + note: "\"Failed to load base board firmware\" and abort when it cannot be loaded." + source_ref: "cxbxr 1.0.0.20 cxbxr-emu.dll (sha256 4396e61e874359c9) FUN_102d0f70 0x102d10ae-0x102d10d7 (std::string ic10_g24lc64.bin), 0x102d12f7-0x102d13d6 (EmuMediaBoard\\Chihiro path, fopen and mapped-file helper FUN_102d0bf0 into 0x1070e560), 0x102d1461-0x102d1465 and 0x102d1af1-0x102d1b04 (CxbxrAbort Failed to load base board firmware)" - name: pc20_g24lc64.bin path: "EmuMediaBoard/Chihiro/pc20_g24lc64.bin" system: sega-chihiro required: true description: "Base board SC microcontroller firmware" - note: "\"Failed to load base board firmware\" when it cannot be opened." - source_ref: "cxbxr cxbxr-emu.dll, release cxbxr_1.0.0.20" + note: "\"Failed to load base board qc firmware\" and abort when it cannot be loaded." + source_ref: "cxbxr 1.0.0.20 cxbxr-emu.dll (sha256 4396e61e874359c9) FUN_102d0f70 0x102d10ff-0x102d1128 (std::string pc20_g24lc64.bin), 0x102d1496-0x102d1576 (path, FUN_102d0bf0 into 0x1070e590), 0x102d15d1-0x102d15d5 and 0x102d1b0e-0x102d1b21 (CxbxrAbort Failed to load base board qc firmware)" - name: ic11_24lc024.bin path: "EmuMediaBoard/Chihiro/ic11_24lc024.bin" system: sega-chihiro required: true description: "Base board configuration EEPROM" - note: "\"Failed to load base board EEPROM\" when it cannot be opened." - source_ref: "cxbxr cxbxr-emu.dll, release cxbxr_1.0.0.20" + note: "\"Failed to load base board EEPROM\" and abort when it cannot be loaded." + source_ref: "cxbxr 1.0.0.20 cxbxr-emu.dll (sha256 4396e61e874359c9) FUN_102d0f70 0x102d1150-0x102d117c (std::string ic11_24lc024.bin), 0x102d1606-0x102d1669 (path, FUN_102d0bf0 into 0x1070e578), 0x102d1688-0x102d168c and 0x102d1b2b-0x102d1b3e (CxbxrAbort Failed to load base board EEPROM)" - name: backup_ram.bin path: "EmuMediaBoard/Chihiro/backup_ram.bin" @@ -282,8 +283,8 @@ files: unsourceable: "written by the emulator, no canonical file" has_builtin: true description: "Base board backup memory" - note: "Created by the emulator when absent (\"Could not create Backup File\" on failure)." - source_ref: "cxbxr cxbxr-emu.dll, release cxbxr_1.0.0.20" + note: "Created by the emulator as 128 KiB of zeros when absent (\"Could not create Backup File\" on failure), then loaded." + source_ref: "cxbxr 1.0.0.20 cxbxr-emu.dll (sha256 4396e61e874359c9) FUN_102d0f70 0x102d1180-0x102d11c2 (std::string backup_ram.bin), 0x102d16eb-0x102d1725 (exists check), 0x102d1789-0x102d17cb (fopen, fseek 0x1ffff, fputc 0, fclose), 0x102d17ad and 0x102d1b4d-0x102d1b60 (CxbxrAbort Could not create Backup File), 0x102d1865 and 0x102d1887-0x102d188b, 0x102d1b6a-0x102d1b7d (FUN_102d0bf0 load, CxbxrAbort Failed to load base board BACKUP RAM)" # CrediarDolphin component, Triforce (RetroBat core triforce) - name: segaboot.gcm @@ -294,5 +295,5 @@ files: size: 2097152 sha1: "87918619c632ac9de270d4fdf396a57eb57fc620" description: "Triforce boot program" - note: "Shipped in the CrediarDolphin 1.0.0.10 release. Opened for the test menus, \"Failed to open segaboot.gcm, which is required for test menus\" otherwise." - source_ref: "CrediarDolphin Dolphin.exe, release CrediarDolphin_1.0.0.10" + note: "Shipped in the CrediarDolphin 1.0.0.10 release. User/Triforce/segaboot.gcm is preferred when present. Read into the media board firmware for the test menus, \"Failed to open segaboot.gcm, which is required for test menus\" and no test menu otherwise." + source_ref: "CrediarDolphin Source/Core/Core/HW/DVD/AMMediaboard.cpp:498-526 at ReaverTeknoGods/CrediarDolphin 44afbabf7135303e9a29805f4b0bc12080545d3a (the revision Dolphin.exe 1.0.0.10, sha256 d7e5a7fe2989c7db, reports as its build and whose message it carries)" diff --git a/emulators/voxatron.yml b/emulators/voxatron.yml index bc3350742..b75a12430 100644 --- a/emulators/voxatron.yml +++ b/emulators/voxatron.yml @@ -26,8 +26,15 @@ notes: | Batocera's generator runs bios/voxatron/vox with LD_LIBRARY_PATH set to bios/voxatron. x86_64 only. vox_dyn is the variant linked against the - system SDL2. libHoloPlayCore.so is the Looking Glass SDK the binary links - against. + system SDL2. + + Refs to binary code cite vox (sha256 045d95a428c10d7e) and vox_dyn + (sha256 3e20fa90c40abe2d), both with their symbol tables. For a Looking + Glass display codo_choose_display (0x16b7a0) matches the SDL display + name against looking and holoplay. Neither binary loads + libHoloPlayCore.so: no NEEDED entry, no string or immediate naming it or + an hpc_ symbol, and every dlopen site is SDL's own loader for system + libraries. files: - name: vox @@ -43,7 +50,7 @@ files: system: voxatron required: false description: "Voxatron dynamically linked executable" - source_ref: "voxatron vox_dyn, NEEDED libSDL2-2.0.so.0, batocera lexaloffleGenerator.py:20, 42" + source_ref: "voxatron 0.3.5b vox_dyn, DT_NEEDED libSDL2-2.0.so.0 at 0x3b2780 (loader-resolved), codo_system_init 0x15f810 call SDL_Init@plt at 0x15f831, batocera lexaloffleGenerator.py:20, 42" note: "The same program linked against the system SDL2 (its only extra NEEDED library). Batocera's generator never runs it." - name: vox.dat @@ -51,48 +58,48 @@ files: system: voxatron required: true description: "Voxatron data file" - source_ref: "voxatron vox, string vox.dat at 0x2a58f, voxatron vox_dyn, string vox.dat at 0x1f1af" - note: "Opened from the folder of the binary that runs. Absent, vox stops with \"FATAL ERROR: could not load vox.dat\"." + source_ref: "voxatron 0.3.5b vox load_all_pods 0x2a560 0x2a58d-0x2a5ad (movabs vox.dat, prefixed with the program folder, codo_load_pod_set, fopen rb at 0x122d65), 0x2a670-0x2a67a (retry vox.dat in the working directory), 0x2a687-0x2a6b0 (codo_fatal_error, exit at 0x16abe4), vox_dyn load_all_pods 0x1f180 0x1f1ad-0x1f1cd, 0x1f29a, 0x1f2d0 (same sequence)" + note: "Opened from the folder of the binary that runs, then from the working directory. Absent from both, Voxatron stops with \"** FATAL ERROR: could not load vox.dat\"." - name: libHoloPlayCore.so path: voxatron/libHoloPlayCore.so system: voxatron required: false description: "Looking Glass holographic display support library" - source_ref: "voxatron vox, voxatron vox_dyn, batocera lexaloffleGenerator.py:41, 87-90" - note: "Neither binary links it or names it, and neither opens it in a run (strace, with and without the file). Batocera's generator sets LD_LIBRARY_PATH to bios/voxatron, where it keeps the library." + source_ref: "batocera lexaloffleGenerator.py:41, 87-90" + note: "Put on LD_LIBRARY_PATH by Batocera's generator. Neither binary loads it." - name: config.txt unsourceable: "written by the emulator on exit, no canonical file" system: voxatron required: false description: "Voxatron settings" - source_ref: "voxatron vox, string config.txt at 0x27bea0" - note: "Read beside the binary, then from ~/.lexaloffle/Voxatron, and written there when absent." + source_ref: "voxatron 0.3.5b vox codo_config_load 0x11a970 0x11a974-0x11a9d8 (home folder, fopen r), 0x11b156 (vdisk), 0x11b167-0x11b1a3 (beside the binary), 0x11b1d2 (neither: return with defaults), codo_config_save 0x11b480 0x11b484-0x11b4df (written to the home folder, called from codo_exit.part.2 at 0x10eb30)" + note: "Read from ~/.lexaloffle/Voxatron, else from beside the binary, and written to ~/.lexaloffle/Voxatron on exit." - name: sdl_controllers.txt unsourceable: "user supplied, no canonical file" system: voxatron required: false description: "Custom SDL controller mappings" - source_ref: "voxatron vox, string sdl_controllers.txt at 0x2847f7" - note: "Read beside the binary, then from ~/.lexaloffle/Voxatron, where Voxatron writes it when absent." + source_ref: "voxatron 0.3.5b vox add_sdl_controllers 0x169cc0 0x169cc4-0x169d06 (beside the binary, fopen r), 0x169d14-0x169d33 (home folder), 0x169d40-0x169d6b (created there with a comment line when absent), 0x169e1c-0x169e3a (fgets, SDL_GameControllerAddMapping per line), called from codo_joystick_init at 0x169f23" + note: "Processed beside the binary when present, then from ~/.lexaloffle/Voxatron, where Voxatron writes it when absent." - name: favourites.txt unsourceable: "written by the emulator, no canonical file" system: voxatron required: false description: "Cart browser favourites list" - source_ref: "voxatron vox, string favourites.txt at 0x27a39e" - note: "Read from ~/.lexaloffle/Voxatron." + source_ref: "voxatron 0.3.5b vox reload_favourites 0xf6bb0 0xf6bb1-0xf6be7, splore_init 0xfaeb0 0xfb15d-0xfb175 (populate_splore_list_from_text_file), save_splore_favourites 0xf4ee0 0xf4ee4" + note: "Read from ~/.lexaloffle/Voxatron and written there by the cart browser." - name: internal_carts.txt unsourceable: "written by the emulator, no canonical file" system: voxatron required: false description: "Voxatron internal cart list" - source_ref: "voxatron vox, string internal_carts.txt at 0x27a446" - note: "Read from ~/.lexaloffle/Voxatron and written there at startup." + source_ref: "voxatron 0.3.5b vox splore_init 0xfaeb0 0xfaefc-0xfaf0e (codo_file_exists in the home folder), 0xfaf21-0xfaf45 (written from a built-in list when absent), 0xfaf54 (populate_splore_list_from_text_file), populate_internal_carts_list 0xfae10 0xfae12-0xfae87 (same sequence)" + note: "Read from ~/.lexaloffle/Voxatron, written there from a list built into the binary when absent." - name: player_1.vpp path: player/player_1.vpp @@ -100,5 +107,5 @@ files: system: voxatron required: false description: "Voxatron player profile" - source_ref: "voxatron vox, string player/player_%d.vpp at 0x273f90" + source_ref: "voxatron 0.3.5b vox switch_to_profile 0x88220 0x8822d-0x8828e (player/player_%d.vpp in the home folder), 0x882cf (codo_fopen rb), 0x882d7 (absent: nothing read), save_current_player_profile 0x88460 0x88463-0x884be (codo_fopen wb)" note: "Read from ~/.lexaloffle/Voxatron/player, and written there when absent." diff --git a/emulators/xemu.yml b/emulators/xemu.yml index 573fd6be8..b18aa80a1 100644 --- a/emulators/xemu.yml +++ b/emulators/xemu.yml @@ -45,6 +45,37 @@ data_root: source_ref: "ui/xemu-settings.cc:51-63, 73-92" note: "xemu.toml beside the executable makes its folder the root" +pin_build: + - platform: rocknix + repo: "https://github.com/ROCKNIX/distribution" + revision: "20261101" + path: "projects/ROCKNIX/packages/emulators/standalone/xemu-sa/package.mk" + variable: PKG_VERSION + value: "cbffb57d084c70351a596e99e32a8b73e0c5eabf" +config_reads: + - file: "xemu.toml" + platforms: [rocknix] + source_ref: "ui/xemu.c:1314-1325, ui/xemu-settings.cc:65-71, 94-104, 158-207" + keys: + - key: "[sys.files] bootrom_path" + source_ref: "system/vl.c:2983-3016" + - key: "[sys.files] flashrom_path" + source_ref: "system/vl.c:3041-3054" + condition: "[general] show_welcome false" + - key: "[sys.files] eeprom_path" + source_ref: "system/vl.c:2909-2949, 3030-3039" + - key: "[sys.files] hdd_path" + source_ref: "system/vl.c:3060-3074" + - file: "xemu.toml" + platforms: [retrobat] + revision: "fc24584ce88f0915ad7f04775bb7712c2e3f49ee" + revision_from: "xemu.exe 0.8.136 in RetroBat's stable xemu.7z, 2026-11-10" + source_ref: "ui/xemu.c:1325, ui/xemu-settings.cc:51-63, 73-92, 94-104, 158-207" + keys: + - key: "[sys.files] flashrom_path" + source_ref: "system/vl.c:3041-3054" + condition: "[general] show_welcome false" + notes: | Full-system Xbox emulator built on QEMU. The libretro core is built from libretro's xemu-libretro tree on its libretro branch, which merges diff --git a/emulators/xm6pro68k.yml b/emulators/xm6pro68k.yml index a55a596a7..e23319d71 100644 --- a/emulators/xm6pro68k.yml +++ b/emulators/xm6pro68k.yml @@ -7,7 +7,7 @@ version_source: url: "https://mijet.eludevisibility.org/XM6%20Pro-68k/Version.txt" pattern: '^(\d+)' based_on: "XM6 v2.06 by PI." -profiled_date: "2026-10-20" +profiled_date: "2026-11-10" core_version: "260920" version_basis: kind: package @@ -24,72 +24,63 @@ systems: - sharp-x68000 notes: | - Closed-source Windows fork of PI's XM6 v2.06 (README.txt:6) by M.I.J.E.T., - distributed only from mijet.eludevisibility.org as three 7-Zip packages: the - program, a mandatory DLL Package and an optional Web Package that adds signed - update downloads. Version.txt in the build analysed here reads 260920, and the - DLL Package it pairs with is version 260101. Release 81 (261031) reads the - same system files, its executable naming only the .IPS patch extension in - addition. The first - release, 120303, forked XM6 v2.05. XM6.exe is a 32-bit MFC application whose - import directory names mfc90u.dll and MSVCR90.dll, so the Visual C++ 2008 runtime - carried by the DLL Package, or the redistributable, must sit beside the executable - for the process to start. A second non-Unicode build lives in MBCS/ and needs the - same files duplicated there. ES-DE launches it through the XM6PRO68K and - XM6PRO68K-WINDOWS find rules with the working directory set to the emulator - folder, on Linux under Wine or Proton. RetroBat registers it as xm6pro - (Program.cs:189, Installer.cs:151), runs XM6.exe from its own directory and - rewrites XM6.ini before launch (Xm6pro.Generator.cs:22-79). + Closed-source Windows fork of PI's XM6 by M.I.J.E.T., distributed from + mijet.eludevisibility.org as three 7-Zip packages: the program, a mandatory DLL + Package and an optional Web Package. The build analysed here is the one RetroBat + serves as xm6pro.7z (sha256 2b44820429989fa2...), Version.txt 260920, with + XM6.exe sha256 df1ed921f5f00cfb54950f1672f659e3ceecc756016d0a76f3ccb5c1354a76ed + and MBCS/XM6.exe sha256 a4ac21e5fe15c865b931921068b03f5c8238dd992727ddc95b5f434f74a9a453. + Every address below is a virtual address in that Unicode XM6.exe. Release 81 + (261031, XM6.exe sha256 4eb66f0229ca992c...) names the same system files, its only + new file name being the .IPS disk delta extension. XM6.exe is a 32-bit MFC + application whose import directory names mfc90u.dll and MSVCR90.dll, both + loader-resolved, so the Visual C++ 2008 runtime carried by the DLL Package, or the + redistributable, must sit beside the executable for the process to start. A + second non-Unicode build lives in MBCS/ and needs the same files duplicated there. + ES-DE launches it through the XM6PRO68K and XM6PRO68K-WINDOWS find rules with the + working directory set to the emulator folder, on Linux under Wine or Proton. + RetroBat registers it as xm6pro (Program.cs:189, Installer.cs:151), runs XM6.exe + from its own directory and rewrites XM6.ini before launch + (Xm6pro.Generator.cs:22-79). - System files are resolved beside XM6.exe. XM6 v2.06 declares them in - Filepath::SystemFile[] (vm/filepath.cpp:394-405) and Filepath::SysFile - (vm/filepath.cpp:121-137) builds each path from SystemDir when one is set and from - the executable's own directory otherwise. XM6 Pro-68k references all ten names, - nine of them in one contiguous string block mirroring that table in reverse, and - exposes no ROM directory setting, while README.txt:71-73 requires the DLL Package - files to be extracted next to the executable rather than into a subdirectory. - Loading goes through Fileio::Load and - Fileio::Read (vm/fileio.cpp:35-51, 175-192), which succeed only when the file - holds at least the requested byte count, so every size below is a floor: a longer - file loads and its tail is ignored. The XM6 v2.06 sources cited throughout are - readable in mixerjdp/XM6_Libretro, which preserves the vm/ layer. + System files sit in a ten-entry pointer table at 0x57a898 (IPLROM.DAT, + IPLROMXV.DAT, IPLROMCO.DAT, IPLROM30.DAT, ROM30.DAT, CGROM.DAT, CGROM.TMP, + SCSIINROM.DAT, SCSIEXROM.DAT, SRAM.DAT). Filepath::SysFile at 0x48b054 copies the + entry and calls 0x48ac18, which takes drive and directory from the executable + path that 0x48ab44 caches from GetModuleFileNameW (0x48aac0), so every system + file is read beside XM6.exe and no directory setting takes part. + Fileio::Load (0x489a75) opens the file and Fileio::Read (0x489d8b) succeeds only + when _read returns the full count, so the IPL and CG sizes below are floors. The + SCSI ROM loader compares _filelengthi64 (0x489e54) with the expected size and + rejects any other length. - Machine selection follows ROM presence. Memory::Init (vm/memory.cpp:171-196) - loads the base SASI machine, then probes XVI, Compact and X68030 in that order and - keeps the first that succeeds. Memory::LoadROM (vm/memory.cpp:236-372) pairs each - machine with its ROMs: XVI and Compact need their IPL plus SCSIINROM.DAT, X68030 - needs IPLROM30.DAT plus ROM30.DAT read at 0x20000 bytes instead of 0x2000, and the - base machine needs no SCSI ROM. Internal SCSI is the interface built into the - X68000 SUPER and later models, external SCSI is the CZ-6BS1 add-on board - (Reference Manual.txt:1529-1536). - - Two files diverge from XM6 v2.06. The base IPL ROM is compiled into the - executable: "The program now includes an internal copy of the basic IPL ROM. It - will still try to load IPL ROMs externally first" (Change Log.txt:124-125), and - README.txt:23-25 tells users to leave IPLROM.DAT out because loading it only costs - startup time. The hard CG ROM requirement was dropped (Change Log.txt:128), so a - missing font ROM yields garbage glyphs instead of failing initialisation - (README.txt:278-281). + Memory::LoadROM (0x4903d7) takes the memory type stored by Memory::ApplyCfg + (0x4908af, 0x4908cb) from the saved configuration: 1 to 3 are the base X68000 with + no SCSI, internal SCSI or external SCSI, 4 XVI, 5 Compact and 6 X68030. It loads + the IPL ROM, the CG ROM (0x48e737, called at 0x490560) and the SCSI ROM (0x49016a, + called at 0x490570). Memory::Init loads type 1 at 0x4909f7 and fails only when that + load fails, which cannot happen since the base IPL is built in and neither the CG + ROM nor the SCSI slot is mandatory for type 1. A requested type that fails to + load falls back to type 1 (0x49063b, 0x490658-0x49066a). Two menu tools synthesise replacements. Synthesize replacement CG-ROM builds - CGROM.TMP from the installed MS Gothic and MS Mincho fonts and aborts when either - is absent, and README.txt:295-299 warns that different machines produce different - files. Synthesize replacement SCSI ROMs asks for a Human68k version 3.02 disk - image, dialog default HUMAN302.XDF with filter *HUMAN*3*02*.???, extracts - /BIN/FORMAT.X and writes SCSIINROM.DAT and SCSIEXROM.DAT. + CGROM.TMP from the installed MS Gothic and MS Mincho fonts, resolving CGROM.TMP at + 0x45f8eb-0x45f8f4 and CGROM.DAT at 0x45fa47-0x45fa50. Synthesize replacement + SCSI ROMs asks for a Human68k version 3.02 disk image, dialog default + HUMAN302.XDF (0x45fd6a) with filter *HUMAN*3*02*.??? (0x45fced), extracts + /BIN/FORMAT.X and writes SCSIINROM.DAT and SCSIEXROM.DAT, whose paths it resolves + at 0x45fc7a-0x45fc9e. - The ROM Warning section of the Advanced options holds three checks, all enabled - by default and individually suppressible: an IPLROM.DAT version check naming - version 1.0 (05/07/1987) as recommended, a CGROM.DAT contents check and a - SCSIEXROM.DAT / SCSIINROM.DAT contents check. Since release 78 the SCSI ROMs are - read at startup only when the saved configuration needs them, and their check - otherwise runs from the SCSI page of the options (Change Log.txt:3093-3096). - Each check raises a dialog, but none rejects the file, so no hash below is + The ROM Warning options hold three checks, each suppressible. The IPL check + (0x48ee5c) accepts the base IPL when the IOCS date bytes at 0x1000a, 0x1000c and + 0x1000d spell 87/05/07, and LoadROM identifies the IPL revision from the dword at + 0x1000a against a table at 0x572458 (0x490519-0x490552). The CG check (0x48eea3) + sums and XORs 0x1000 bytes at 0x3a800 of the font and wants 0xec and 0x84. The + SCSI check (0x48eedc) reads 0x2000 bytes of SCSIINROM.DAT and SCSIEXROM.DAT and + flags a file holding "XM6 " at 0x1ff8, the stamp of synthesised replacements + (0x48ef82, 0x48efc6). Each check only raises a dialog, so no hash below is enforced by the program. - Reference Manual.txt ships with the program and Software Notes.txt is fetched by - the Web Package through Scripts\Update Notes.bat. Both are prose documents that - the Help menu and Help > Peruse Notes hand to a text editor, not data XM6 parses. XM6.ini and XM6U.ini are written by the program. files: @@ -104,17 +95,15 @@ files: md5: 7fd4caabac1d9169e289f0f7bbf71d8e sha1: 0ed038ed2133b9f78c6e37256807424e0d927560 description: "X68000 boot ROM, base SASI model" - source_ref: "Change Log.txt:124-125, README.txt:23-25, XM6 2.06 vm/memory.cpp:256-276" + source_ref: "XM6.exe 260920 Memory::LoadROM 0x4903d7: 0x490461-0x490478 (types 1 to 3 give table entry 0, Filepath::SysFile 0x48b054), 0x490496 (Fileio::Load 0x20000), 0x49049f-0x4904bf (types 1 to 3 on failure copy the built-in 0x20000 bytes from 0x552458 and skip the swap), 0x4904f8 (16-bit swap 0x407710), IPL check 0x48ee5c" note: >- XM6.exe carries this ROM internally and only reads the file when it is - present, so the emulator boots without it. The embedded copy sits at file - offset 1382488 in .rdata of the Unicode build and 1332664 in the MBCS build, - stored in the 16-bit pairwise swapped form the loader produces at - vm/memory.cpp:278-285. Unswapped it is the 131072-byte dump hashed here, + present, so the emulator boots without it. The embedded copy sits at + 0x552458, file offset 1382488, in .rdata of the Unicode build and at file + offset 1332664 in the MBCS build, stored in the 16-bit pairwise swapped form + the loader produces. Unswapped it is the 131072-byte dump hashed here, catalogued by TOSEC as Sharp X68000 Boot ROM (1987)(Sharp), and it is the - version 1.0 (05/07/1987) the startup warning recommends. README.txt:23-25 - advises against installing the file at all because reading and swapping it - only lengthens startup. + version 1.0 (05/07/1987) the IPL check accepts. - name: IPLROMXV.DAT system: sharp-x68000 @@ -122,11 +111,11 @@ files: min_size: 131072 validation: [size] description: "X68000 XVI boot ROM" - source_ref: "XM6 2.06 vm/memory.cpp:178-180, 261-263" + source_ref: "XM6.exe 260920 Memory::LoadROM 0x4903d7: 0x49041e-0x49045f (type 4 gives table entry 1), 0x490478 (Filepath::SysFile 0x48b054), 0x490496 (Fileio::Load 0x20000), 0x4904c1-0x4904eb (failure logs Missing or invalid ROM file and returns 0), 0x49063b 0x490658-0x49066a (fallback to type 1)" note: >- - Probed after the base machine loads. Its presence, together with - SCSIINROM.DAT, is what makes the XVI machine available. Absent, the base - X68000 still runs. No internal copy is compiled into XM6.exe. + Read when the configuration selects the XVI. Absent or short, LoadROM + fails and the base X68000 runs instead. No internal copy is compiled into + XM6.exe. - name: IPLROMCO.DAT system: sharp-x68000 @@ -134,10 +123,10 @@ files: min_size: 131072 validation: [size] description: "X68000 Compact boot ROM" - source_ref: "XM6 2.06 vm/memory.cpp:181-185, 264-266" + source_ref: "XM6.exe 260920 Memory::LoadROM 0x4903d7: 0x490423-0x49045a (type 5 gives table entry 2), 0x490478 (Filepath::SysFile 0x48b054), 0x490496 (Fileio::Load 0x20000), 0x4904c1-0x4904eb (failure returns 0), 0x49063b 0x490658-0x49066a (fallback to type 1)" note: >- - Probed after XVI. Selects the Compact machine when found, and that machine - also needs SCSIINROM.DAT. No internal copy is compiled into XM6.exe. + Read when the configuration selects the Compact, under the same rules as + IPLROMXV.DAT. No internal copy is compiled into XM6.exe. - name: IPLROM30.DAT system: sharp-x68000 @@ -145,25 +134,25 @@ files: min_size: 131072 validation: [size] description: "X68030 boot ROM" - source_ref: "XM6 2.06 vm/memory.cpp:186-190, 267-269" + source_ref: "XM6.exe 260920 Memory::LoadROM 0x4903d7: 0x490428-0x49042b and 0x490417 (type 6 gives table entry 3), 0x490478 (Filepath::SysFile 0x48b054), 0x490496 (Fileio::Load 0x20000), 0x4904c1-0x4904eb (failure returns 0), 0x49063b 0x490658-0x49066a (fallback to type 1)" note: >- - Probed last. Selects the X68030 machine, which also needs ROM30.DAT. No - internal copy is compiled into XM6.exe. + Read when the configuration selects the X68030, which also reads + ROM30.DAT. No internal copy is compiled into XM6.exe. - # -- X68030 SCSI ROM, the one SCSI ROM read at 0x20000 bytes -- + # -- X68030 SCSI ROM, the one SCSI-slot ROM read at 0x20000 bytes -- - name: ROM30.DAT system: sharp-x68000 required: false - min_size: 131072 + size: 131072 validation: [size] description: "X68030 SCSI ROM" - source_ref: "README.txt:25, XM6 2.06 vm/memory.cpp:316-319, 334-337" + source_ref: "XM6.exe 260920 LoadSCSIROM 0x49016a: 0x4901cc-0x4901ea (type 6 gives table entry 4 and size 0x20000), 0x49025e (open, failure logs Unable to open ROM file), 0x4902a3-0x4902b9 (_filelengthi64 must equal 0x20000, else Wrong size for ROM file), 0x4902e5 (read), 0x49034f (16-bit swap), Memory::LoadROM 0x4903d7 0x4905aa-0x490613 (absent: stub slot with the SCSIIN signature)" note: >- - The SCSI half of the X68030 machine, and the only SCSI ROM read at 0x20000 - bytes rather than 0x2000. Without it LoadROM(X68030) fails and the X68030 - machine is not offered. README.txt:25 calls it non-critical and notes that - installing it can cost performance. + The SCSI half of the X68030 machine, and the only SCSI-slot ROM read at + 0x20000 bytes, at exactly that length. When it is missing or of another + size LoadROM fills the slot with 0xff, writes a stub header carrying the + SCSIIN signature at offset 0x24, and the X68030 still starts. The copy here is the X68000 Firmware set's ROM30.DAT (SCSIIN, ROM Human 2.x, ROM FLOAT and the SCSI-IOCS binary), read out of an X68030 by the XM6 2.06 utility, which stamps its name at the tail of the image. # -- Font ROM, read at 0xc0000 bytes, CGROM.DAT first then CGROM.TMP -- @@ -177,15 +166,14 @@ files: md5: cb0a5cfcf7247a7eab74bb2716260269 sha1: 8d72c5b4d63bb14c5dbdac495244d659aa1498b6 description: "X68000 character generator ROM" - source_ref: "README.txt:278-281, Change Log.txt:128, XM6 2.06 vm/memory.cpp:287-295" + source_ref: "XM6.exe 260920 0x48e737: 0x48e783-0x48e78c (table entry 5), 0x48e7a3 (Fileio::Load 0xc0000), 0x48e7ac-0x48e7cb (CGROM.TMP tried next), 0x48e7cd-0x48e7ef (both absent: logs Unable to load CGROM.DAT or CGROM.TMP and fills the font with 0x55 at 0x42245f), 0x48e7fe (16-bit swap), CG check 0x48eea3" note: >- - Supplies the glyphs for text the X68000 renders. Stock XM6 v2.06 fails - initialisation when neither font file loads, but XM6 Pro-68k dropped that - requirement, so a missing font ROM shows garbage glyphs and the emulator - keeps running, and what remains is the suppressible contents warning. - The mandatory DLL Package ships this exact 786432-byte file, catalogued by - TOSEC as Sharp X68000 CG ROM (1987)(Sharp). The hash identifies that copy and - is not verified by the program. + Supplies the glyphs for text the X68000 renders. When neither font file + loads, the font area is filled with 0x55, text shows as garbage and the + emulator keeps running. The mandatory DLL Package ships this exact + 786432-byte file, catalogued by TOSEC as Sharp X68000 CG ROM + (1987)(Sharp), and it passes the CG check. The hash identifies that copy + and is not verified by the program. - name: CGROM.TMP system: sharp-x68000 @@ -194,63 +182,61 @@ files: min_size: 786432 validation: [size] description: "Synthesised font ROM, fallback when CGROM.DAT is absent" - source_ref: "README.txt:295-299, XM6 2.06 vm/memory.cpp:290-294" + source_ref: "XM6.exe 260920 0x48e737: 0x48e7ac-0x48e7b2 (table entry 6, reached only after CGROM.DAT fails), 0x48e7c4 (Fileio::Load 0xc0000), 0x48e7fe (16-bit swap)" note: >- - Read only when CGROM.DAT is missing, at the same size. Tools > Synthesize - replacement CG-ROM writes it from the installed MS Gothic and MS Mincho fonts - and fails when either is absent. No hash is declared because the output - depends on the fonts of the machine that generated it. XM6 refuses to use it - while CGROM.DAT is present. + Read only when CGROM.DAT is missing or short, at the same size. Tools > + Synthesize replacement CG-ROM writes it from the installed MS Gothic and MS + Mincho fonts. No hash is declared because the output depends on the fonts + of the machine that generated it. - # -- SCSI ROMs, read at 0x2000 bytes, required by the interface they drive -- + # -- SCSI ROMs, exact 0x2000 bytes, required by the interface they drive -- - name: SCSIINROM.DAT system: sharp-x68000 required: false bundled: true - min_size: 8192 + size: 8192 validation: [size] md5: aeb4607a14612606c833227437aaa16a sha1: 15a17798839a3f7f361119205aebc301c2df5967 description: "Internal SCSI interface ROM, X68000 SUPER and later" - source_ref: "Reference Manual.txt:1529-1536, XM6 2.06 vm/memory.cpp:309-315" + source_ref: "XM6.exe 260920 LoadSCSIROM 0x49016a: 0x4901b7-0x4901ea (types 2, 4 and 5 give table entry 7, size 0x2000), 0x4901fc-0x490219 (deferred while the flag read by 0x40b726 is set), 0x49025e (open), 0x4902a3-0x4902b5 (_filelengthi64 must equal 0x2000), 0x4902e5 (read), 0x49034f (swap), Memory::LoadROM 0x4903d7 0x49057d-0x4905ad (types 4 and 5 continue with the slot at 0xff, types 2 and 3 fail), SCSI check 0x48eedc 0x48ef1f-0x48ef82" note: >- - Needed to use internal SCSI drives, and also loaded as part of the XVI and - Compact machines, so those two models are unavailable without it whatever - their IPL. The mandatory DLL Package ships this exact 8192-byte file and the - hash identifies that copy, while the startup contents check only warns. + Needed for the internal SCSI option on the base X68000, which otherwise + falls back to the plain base machine. The XVI and Compact start without it + with the SCSI slot left at 0xff. The mandatory DLL Package ships this exact + 8192-byte file and the hash identifies that copy, while the startup SCSI + check only warns. - name: SCSIEXROM.DAT system: sharp-x68000 required: false bundled: true - min_size: 8160 + size: [8160, 8192] validation: [size] md5: 237be014374b74d327f15f250d4d62bf sha1: 49616c09a8986ffe6a12ad600febe512f7ba8ae4 description: "External SCSI interface ROM, CZ-6BS1 board" - source_ref: "Reference Manual.txt:1529-1536, XM6 2.06 vm/memory.cpp:320-324, 346-357" + source_ref: "XM6.exe 260920 LoadSCSIROM 0x49016a: 0x4901bc-0x4901ea (type 3 gives table entry 8, size 0x2000), 0x4902a3-0x4902d4 (_filelengthi64 must be 0x2000, or 0x1fe0 loaded at offset 0x20 behind 0x20 bytes of 0xff), 0x4902e5 (read), 0x490315-0x490346 (an 8192-byte image whose first dword is neither 0 nor 0xffffffff is moved up 0x20 bytes), 0x49034f (swap), SCSI check 0x48eedc 0x48ef8f-0x48efc6" note: >- - Needed to use the external SCSI interface, which is the only SCSI variant - that can coexist with SASI. The loader first reads 0x2000 bytes and, on - failure, retries with the 0x1fe0-byte WinX68k layout loaded at buffer offset - 0x20, so 8160 is the real floor. The mandatory DLL Package ships the - 8192-byte form hashed here. + Needed for the external SCSI option on the base X68000, which otherwise + falls back to the plain base machine. Two lengths are accepted: 8192 bytes, + and the 8160-byte WinX68k layout. An 8192-byte image that starts with + data rather than the blank register window is shifted to the same layout. + The mandatory DLL Package ships the 8192-byte form hashed here. # -- Battery-backed NVRAM -- - name: SRAM.DAT system: sharp-x68000 required: false - size: 16384 + size: [16384, 65536] description: "X68000 SRAM image, boot device and memory switch settings" - source_ref: "Reference Manual.txt:1366-1368, 2648-2651, XM6 2.06 vm/filepath.cpp:404" + source_ref: "XM6.exe 260920 SRAM init 0x4abb9d: 0x4abb9f (fills 0x10000 bytes with 0xff at 0x4ab4d8), 0x4abba4-0x4abbaa (table entry 9), 0x4abbc1 (Fileio::Load 0x10000, result ignored), 0x4abc15 (swap), 0x4ab50f 0x4ab517-0x4ab52c (save writes the configured size in KB, 16 by default at 0x4abb11)" note: >- - Read at startup and rewritten on exit when the contents changed, so XM6 - creates it on first run and a supplied image only preloads the settings. The - Tools > SRAM menu reloads, duplicates and write-protects it, and the boot - counter option updates it on exit. Size is the X68000 SRAM size and is not - checked by the program. + Read at startup and rewritten on exit, so XM6 creates it on first run and + a supplied image only preloads the settings. Up to 64 KB is read with no + size check. The program writes 16 KB, or 64 KB with the SRAM64K option. # -- Optional libraries loaded by name at runtime, shipped in the DLL Package -- @@ -261,12 +247,12 @@ files: required: false bundled: true description: "7-Zip library for .7z, .zip and .xz support" - source_ref: "README.txt:166-170, XM6.exe strings 7z.dll, Optional DLL Not Present" + source_ref: "XM6.exe 260920 0x401ce4: 0x401cfd-0x401d02 (7Z.DLL through the loader 0x40ce48: LoadLibraryW beside XM6.exe at 0x40ce90, then the system directory at 0x40cf01, then the Windows directory at 0x40cf67), 0x401d1c-0x401d22 (GetProcAddress CreateObject), 0x4505f0-0x4505fb (absent: 0x412122 index 0 shows Optional DLL Not Present at 0x412109)" note: >- - Absent from the import directory and looked up by name at runtime, so XM6 + Absent from the import directory and loaded on first archive use, so XM6 starts without it and reports Optional DLL Not Present, Archive support is - not available. Enables loading disk images and state files from archives and - writing XZ-compressed state files. + not available. Enables loading disk images and state files from archives + and writing XZ-compressed state files. - name: zlib1.dll size: 59904 @@ -275,9 +261,9 @@ files: required: false bundled: true description: "zlib, used for PNG output and deflate archives" - source_ref: "XM6.exe strings 7z.dll or zlib1.dll, ZLIB1.DLL, deflateInit2_, deflate, deflateReset, deflateEnd" + source_ref: "XM6.exe 260920 delay-load descriptor 0x5761ec for zlib1.dll, IAT 0x585a68 (crc32, inflate, inflateEnd, inflateInit2_, deflateEnd, deflateInit2_, deflateReset, deflate), 0x40cf85 0x40cf8e-0x40cf98 (ZLIB1.DLL through the loader 0x40ce48, handle cached at 0x59e66c), callers 0x414487, 0x4280bc and 0x489151-0x48915d (absent: 0x412122 index 1 names 7z.dll or zlib1.dll in the Optional DLL Not Present dialog)" note: >- - Looked up by name at runtime alongside 7z.dll and named in the same Optional - DLL Not Present dialog. XM6.exe resolves deflateInit2_, deflate, - deflateReset and deflateEnd from it, and the display capture commands - write PNG files. + Delay-loaded, so the process starts without it, and every caller first + loads it by name and skips its zlib path when that fails. XM6.exe resolves + inflate, deflate and crc32 from it for deflate archives and PNG display + captures. diff --git a/emulators/xm6typeg.yml b/emulators/xm6typeg.yml index 615e29d17..6cf3777ae 100644 --- a/emulators/xm6typeg.yml +++ b/emulators/xm6typeg.yml @@ -7,7 +7,7 @@ version_source: url: "http://retropc.net/pi/xm6/index.html" pattern: '\(version [0-9.]+ \S+ version ([0-9.]+)\)' based_on: "XM6 v2.06 by PI." -profiled_date: "2026-08-10" +profiled_date: "2026-11-10" core_version: "3.38" version_basis: kind: package @@ -25,69 +25,101 @@ systems: - sharp-x68000 notes: | - Closed-source Windows fork of XM6 v2.06, extended by GIMONS from 2010 and - maintained again by PI. since version 3.34 (xm6g.pdf p.1, p.3). Distributed from - PI's XM6 page as a single archive, xm6_typeg_338_20260223.zip, holding an x64 - xm6g.exe, the Visual C++ 2015-2019 runtime it imports (mfc140u.dll, - msvcp140.dll, vcruntime140.dll, vcruntime140_1.dll) and the 32-page manual - xm6g.pdf. No source is published. The analysis below reads xm6g.exe, and the - XM6 v2.06 sources cited alongside are PI's own release, xm6_206s.zip from the - same page. ES-DE launches it through the XM6TYPEG and XM6TYPEG-WINDOWS find - rules with the working directory set to the emulator folder, on Linux under - Wine or Proton. The archive alone does not run: the manual opens with that - warning (xm6g.pdf p.5). + Closed-source Windows fork of XM6 v2.06 by GIMONS, maintained again by PI. + Distributed from PI's XM6 page as one archive, xm6_typeg_338_20260223.zip + (sha256 71c2b3429163128f...), holding an x64 xm6g.exe (sha256 + 3d50aab23ce6c8ae1677b1ca8adaa8b0c6c9dabb1c06b98d0f2ea10fe44ac5de), the Visual + C++ 2015-2019 runtime it imports (mfc140u.dll, msvcp140.dll, vcruntime140.dll, + vcruntime140_1.dll, loader-resolved) and xm6g.pdf. No source is published. + Every address below is a virtual address in that xm6g.exe, function bounds taken + from its .pdata. ES-DE launches it through the XM6TYPEG and XM6TYPEG-WINDOWS find + rules with the working directory set to the emulator folder, on Linux under Wine + or Proton. - Machines emulated are X68000, XVI, Compact, X68030 and the 040turbo and - 060turbo accelerator configurations (xm6g.pdf p.3). System files are resolved - beside xm6g.exe. A twenty-entry name table at xm6g.exe:0x140592350 holds them, - against ten in Filepath::SystemFile[] (XM6 2.06 vm/filepath.cpp:472-483), and - each path is built by copying the name, splitting it, and refilling drive and - directory from GetModuleFileNameW, the sequence XM6 2.06 spells out in - Filepath::SysFile and Filepath::SetBaseDir (vm/filepath.cpp:88-105, 172-186). - The path is rebuilt from the module path on every load, with no configured - directory taking part. Loading reads a fixed byte count and compares it - against the count returned, so every min_size below is a floor: a longer file - loads and its tail is ignored. + System files sit in a twenty-entry pointer table at 0x140592350 (IPLROM.DAT + first, STATE.XM6 last). Filepath::SysFile at 0x1404e76d0 indexes it, copies the + name, splits it and jumps to 0x1404e7950, which refills drive and directory from + GetModuleFileNameW, so every system file is read beside xm6g.exe and no + configured directory takes part. LoadROM inlines the same sequence for index 0 + (0x1404fca8d-0x1404fcb52). Fileio::Open is 0x1404e7390 (CreateFileW) and + Fileio::Load 0x1404e7200 (ReadFile, success only when the full count is read). - Two files are mandatory. LoadROM (xm6g.exe:0x1404fc9a5) leaves through its - failure exit when the IPL read fails, and the CG read falls back to CGROM.TMP - before failing the same way, which is the string "XM6 requires two ROM files, - IPLROM.DAT file and CGROM.DAT(or CGROM.TMP) file." Nothing in the executable - substitutes for either. The system options page probes IPLROM.DAT, - IPLROMXV.DAT, IPLROMCO.DAT and IPLROM30.DAT with GetFileSizeEx and accepts a - file only at exactly 131072 bytes (xm6g.exe:0x140428f80, size test at - 0x14042920a). + LoadROM (0x1404fc990) takes a memory type set by Memory::ApplyCfg + (0x1404fe390): types 1 to 3 are the base X68000 with no SCSI, internal SCSI or + external SCSI, 4 is XVI, 5 Compact, 6 X68030 and 7 X68030 with the expansion ROM + option on. It reads the IPL ROM, then the CG ROM, then the SCSI ROM, and a short + ReadFile count fails the load, so every min_size below is a floor and a longer + file loads with its tail ignored. + + The startup path to LoadROM(1). The CRT calls wWinMain at 0x1405767ad, a thunk + at 0x1405776fc to AfxWinMain (mfc140u.dll 14.42.34433.0 ordinal 2370), which + calls InitInstance through vtable offset 0xb0 (0x1802b2ba7-0x1802b2bae in that + DLL). The application object at 0x14084db20 is built by the static initializer + 0x140425b90 (initializer table entry 0x14057e990) with vtable 0x14057ec20, whose + slot 22 (+0xb0) is InitInstance 0x140425e30. InitInstance allocates the frame + window (0x140425fb0), sets its vtable 0x1405aed50 (0x140425fd4) and creates it + through slot 91 (+0x2d8, 0x14042614d-0x140426186). WM_CREATE reaches OnCreate + 0x140470ef0 through the frame message map 0x1405acf78 (GetMessageMap slot 12, + 0x140470eb0, entry 0x1405acf90). OnCreate allocates the 0x208c0-byte VM + (0x140471135), stores it at 0x140822790 (0x14047120e) and calls VM::Init + 0x140565f60 at 0x140471218. VM::Init constructs the memory device at + 0x140566443 (constructor 0x1404fc3d0 sets vtable 0x1405c0830 at 0x1404fc3f9, and + the device constructor 0x1404c1270 appends it to the device list at VM+0x20040), + then walks that list calling vtable slot 1 (+0x8) at 0x14056762a. Slot 1 of the + memory vtable (0x1405c0838) is Memory::Init 0x1404fc5d0, which calls LoadROM(1) + at 0x1404fc669 and returns 0 on failure (0x1404fc97f). A zero clears the result + at 0x140567631, VM::Init returns it at 0x140567640, and OnCreate sets error state + 1 at 0x140471221 and posts message 0x8000 at 0x14047123b. Message map entry + 0x1405ad110 routes 0x8000 to 0x1404737a0, which for state 1 (0x1404737d6) loads + string 47002 or 42002, "XM6 requires two ROM files, IPLROM.DAT file and + CGROM.DAT(or CGROM.TMP) file", shows it with MB_ICONSTOP (0x14047383e) and posts + WM_CLOSE (0x140473853). + + Memory::Reset (0x1404fd610) + loads any other type on demand: type 7 falls back to 6 (0x1404fd682), and any + failure falls back to type 1 (0x1404fd6bc), so a missing model ROM only loses + that machine. + + SRAM::Reset picks its file from the machine index at VM+0x2002c (0x1405565f7). + The index is the [Basic] ModelType setting of xm6g.ini, 0 to 3 for the base + machine, XVI, Compact and X68030: INI table entry 0x140581240 binds that key to + configuration offset 0x2bfc (0x14082539c), read by the INI loader 0x1404270a0 + (0x1404270fe), the field Memory::ApplyCfg reads at 0x1404fe3b8. The configuration apply at 0x140473630 copies it to VM+0x20028 + (0x14047367f), and VM::Reset 0x140567660 copies VM+0x20028 to VM+0x2002c at + 0x14056768e. OnCreate runs the two at 0x14047148e and 0x14047149a. When + Memory::Reset falls back to the base machine, VM::Reset finds the loaded type at + Memory+0xcbc outside the model (0x1405676b2-0x1405676e8) and zeroes the index at + 0x1405676f3 before the devices reset, so SRAM.DAT is read. A saved state + restores the index (0x140567c11). + + The options page (0x140428f80) offers XVI, Compact and X68030 only when + IPLROMXV.DAT, IPLROMCO.DAT and IPLROM30.DAT have GetFileSizeEx exactly 0x20000. + Three startup checks run from 0x1404738b5 through 0x140472860, each skippable by + its option. The IPL check (0x140472a99) reads the IOCS date bytes at 0x1000a, + 0x1000c and 0x1000d of the base IPL and warns unless they spell 87/05/07. The CG + check (0x14047296e) sums and XORs 0x1000 bytes at 0x3a800 of the font and warns + unless they give 0xec and 0x84. The SCSI check (0x140501290) reads 0x2000 bytes of + SCSIINROM.DAT (0x14050142d) and SCSIEXROM.DAT (0x140501599) and warns when + 0x1ff8 holds "XM6 ", the stamp of the XM6 Utility replacements (0x14050147c, + 0x1405015da). Each warning dialog (0x140487730) continues on OK and closes XM6 on + Cancel. No genuine ROM is hashed anywhere in the executable. XM6 Utility, published separately at the same address, synthesises CGROM.TMP from the installed Windows fonts and SCSIINROM.DAT or SCSIEXROM.DAT from the Human68k version 3.02 disk image HUMAN302.XDF, which it requires at 0x134000 - bytes (XM6Util scsirom.cpp:86-90). It stamps the SCSI ROMs with "XM6 " at - offset 0x1ff8 and a version at 0x1ffc (XM6Util scsirom.cpp:243-245), and - xm6g.exe reads both files back and tests that signature - (xm6g.exe:0x14050147c, 0x1405015e0) to raise the startup warning that names - these files as substitutes and discourages them. Nothing rejects the file, and - no genuine ROM is hashed anywhere in the executable. + bytes (XM6Util scsirom.cpp:86-90), and stamps "XM6 " at offset 0x1ff8 and a + version at 0x1ffc (XM6Util scsirom.cpp:243-245). - SCSI ROM requirements follow the machine (xm6g.pdf p.17). SCSIINROM.DAT is - needed by SUPER, XVI and Compact and by any machine set to the internal SCSI - interface. SCSIEXROM.DAT drives the CZ-6BS1 external board, which is the only - SCSI variant the SASI models can take. X68030 needs neither, its SCSI ROM - being part of IPLROM30.DAT or IPLROM30S.DAT. IPLROM30S.DAT and ROM30S.DAT are - a pair used only when Expansion ROM is enabled on the X68030 options tab, for - ROMs patched for 060turbo (xm6g.pdf p.17). + The Mercury Unit OPN (YMF288) samples its rhythm section from files. The fmgen + and X68Sound engines read six WAV files named from a table at 0x1405c0090 + (0x1404ed610), and the ymfm engine reads ym2608_adpcm_rom.bin instead + (0x140574eb0). - The Mercury Unit carries an OPN (YMF288) whose rhythm section is sampled from - external files. The fmgen and X68Sound engines read six WAV files named from a - table at xm6g.exe:0x1405c0090 (0x1404ed610, CreateFileW at 0x1404ed8bf), and the - ymfm engine reads ym2608_adpcm_rom.bin instead (0x140574fec, ReadFile at - 0x140575095), which is why the rhythm level control is documented as inert for - ymfm. - - xm6g.ini and the state file STATE.XM6, the twentieth table entry, are written - by the program and are not listed below. RTC.DAT and the SRAM files are listed + xm6g.ini and the state file STATE.XM6, the twentieth table entry, are written by + the program and are not listed below. RTC.DAT and the SRAM files are listed because they are battery-backed images with hardware counterparts that preload - settings when supplied, even though XM6 TypeG creates them on exit when they - are absent (xm6g.pdf p.18). + settings when supplied. XM6 TypeG writes them back on exit (SRAM 0x140556498, + RTC 0x1405321a9), so it creates them when they are absent. files: # -- IPL ROMs, one per emulated model, read at 0x20000 bytes and byte-swapped -- @@ -98,13 +130,13 @@ files: size: 131072 validation: [size] description: "X68000 boot ROM version 1.0, base models" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x1404fc9a5 (read at 0x1404fcbb7), xm6g.exe:0x14042920a, XM6 2.06 vm/memory.cpp:249-270" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fca8d-0x1404fcb52 (table entry 0 joined to the module directory), 0x1404fcb90 (Fileio::Open), 0x1404fcbb7-0x1404fcbc4 (ReadFile 0x20000, short count exits through 0x1404fd159), 0x1404fcc00 (16-bit swap), Memory::Init 0x1404fc5d0 (memory vtable 0x1405c0830 slot 1) 0x1404fc669 (LoadROM(1), failure returns 0 at 0x1404fc97f), VM::Init 0x140565f60 0x14056762a (device Init through vtable slot 1), 0x140567631 (failure kept), OnCreate 0x140470ef0 0x140471218 (VM::Init call), 0x140471221 (error state 1), 0x14047123b (posts 0x8000), handler 0x1404737a0 0x1404737d6, 0x14047383e (MB_ICONSTOP message 47002 or 42002), 0x140473853 (WM_CLOSE), options page 0x140428f80 0x14042920a (GetFileSizeEx == 0x20000)" note: >- - Covers the first model, ACE, EXPERT, PRO and SUPER. LoadROM reads 0x20000 - bytes and fails when fewer are returned, and the failure aborts - initialisation. The startup warning naming version 1.00 (05/07/1987) as - recommended only advises: it does not reject the file. The recommended - source is the free X68BIOSE.LZH package (xm6g.pdf p.6). + Memory types 1 to 3, the first model, ACE, EXPERT, PRO and SUPER. Memory::Init + loads it first and the program closes when it fails. The IPL check at + 0x140472a99 warns when the IOCS date is not 87/05/07 and does not reject the + file. The options page requires exactly 131072 bytes, while the loader only + needs at least that many. - name: IPLROMXV.DAT system: sharp-x68000 @@ -112,10 +144,11 @@ files: size: 131072 validation: [size] description: "X68000 XVI boot ROM version 1.1" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x14042927c, XM6 2.06 vm/memory.cpp:256-258" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd4f4 case 4, 0x1404fcb5a (index 1), 0x1404fcb77 (Filepath::SysFile 0x1404e76d0), 0x1404fcbb7 (ReadFile 0x20000), options page 0x140428f80 0x140429279 (table entry 1), 0x1404293de (GetFileSizeEx == 0x20000)" note: >- - Selects the XVI machine, which also needs SCSIINROM.DAT. The options page - offers the machine only when this file is exactly 131072 bytes. + Memory type 4. The options page offers the XVI machine only when this file + is exactly 131072 bytes, and Memory::Reset falls back to the base machine + when it fails to load. - name: IPLROMCO.DAT system: sharp-x68000 @@ -123,10 +156,9 @@ files: size: 131072 validation: [size] description: "X68000 Compact boot ROM version 1.2" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x14042946b, XM6 2.06 vm/memory.cpp:259-261" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd4f4 case 5, 0x1404fcb5f (index 2), 0x1404fcb77 (Filepath::SysFile 0x1404e76d0), 0x1404fcbb7 (ReadFile 0x20000), options page 0x140428f80 0x140429468 (table entry 2), 0x1404295cd (GetFileSizeEx == 0x20000)" note: >- - Selects the Compact machine, which also needs SCSIINROM.DAT. Same exact - size test as the other IPL ROMs. + Memory type 5, offered and loaded under the same rules as IPLROMXV.DAT. - name: IPLROM30.DAT system: sharp-x68000 @@ -134,11 +166,11 @@ files: size: 131072 validation: [size] description: "X68030 boot ROM version 1.3, $FE0000-$FFFFFF half" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x14042965a, XM6 2.06 vm/memory.cpp:262-264" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd4f4 case 6, 0x1404fcb66 (index 3), 0x1404fcb77 (Filepath::SysFile 0x1404e76d0), 0x1404fcbb7 (ReadFile 0x20000), options page 0x140428f80 0x140429657 (table entry 3), 0x1404297bc (GetFileSizeEx == 0x20000)" note: >- - Upper half of the X68030 and X68030 Compact boot ROM, paired with - ROM30.DAT. It carries the SCSI ROM for those machines, so neither - SCSIINROM.DAT nor SCSIEXROM.DAT applies to them. + Memory type 6, the X68030, paired with ROM30.DAT. Its SCSI ROM is + ROM30.DAT, so SCSIINROM.DAT and SCSIEXROM.DAT are not read for this + machine. - name: ROM30.DAT system: sharp-x68000 @@ -146,11 +178,11 @@ files: min_size: 131072 validation: [size] description: "X68030 boot ROM version 1.3, $FC0000-$FDFFFF half" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x1404fd1f8, XM6 2.06 vm/memory.cpp:311-313, 328-335" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd510 case 6, 0x1404fd1f5 (table entry 12), 0x1404fd304 (Fileio::Open), 0x1404fd327-0x1404fd334 (ReadFile 0x20000), 0x1404fd354-0x1404fd35b (types 6 and 7 fail on a short read)" note: >- - Lower half of the X68030 boot ROM, loaded through the SCSI ROM slot and - the only one of those read at 0x20000 bytes rather than 0x2000. Without it - the X68030 machine does not load. + Loaded into the SCSI ROM slot and the only file of that slot that must + deliver the full 0x20000 bytes. Without it LoadROM(6) fails and + Memory::Reset falls back to the base machine. The copy here is the X68000 Firmware set's ROM30.DAT (SCSIIN, ROM Human 2.x, ROM FLOAT and the SCSI-IOCS binary), read out of an X68030 by the XM6 2.06 utility, which stamps its name at the tail of the image. - name: IPLROM30S.DAT @@ -159,11 +191,11 @@ files: min_size: 131072 validation: [size] description: "Expansion boot ROM, $FE0000-$FEFFFF" - source_ref: "xm6g.pdf p.16-17, xm6g.exe:0x140592350 index 4" + source_ref: "xm6g.exe 3.38 Memory::ApplyCfg 0x1404fe390 0x1404fe3d1-0x1404fe3ff (X68030 with the expansion ROM flag gives type 7), LoadROM 0x1404fc990: jump table 0x1404fd4f4 case 7, 0x1404fcb6d (index 4), 0x1404fcb77 (Filepath::SysFile 0x1404e76d0, table entry 4 at 0x140592370), 0x1404fcbb7 (ReadFile 0x20000), Memory::Reset 0x1404fd610 0x1404fd672-0x1404fd694 (type 7 failure retries type 6)" note: >- - Read in place of IPLROM30.DAT when Expansion ROM is checked on the X68030 - options tab, the setting stored as EXTROM. Paired with ROM30S.DAT and - intended for ROMs patched for 060turbo. + Read in place of IPLROM30.DAT when the X68030 expansion ROM option is on, + the setting stored as EXTROM. Paired with ROM30S.DAT. When either fails, + Memory::Reset loads the plain X68030 instead. The copy here is XEIJIPLROM30.DAT written by XEiJ 0.26.08.08 with -model=X68030 -iplrom16=on -memory=12 -cgrom=CGROM30.DAT: IPLROM 1.6 of 2025-08-03, the patched IPL its documentation names for the 060turbo, since no dump of the Mankai replacement ROM circulates. - name: ROM30S.DAT @@ -172,10 +204,10 @@ files: min_size: 131072 validation: [size] description: "Expansion boot ROM, lower half" - source_ref: "xm6g.pdf p.16, xm6g.exe:0x1404fd201" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd510 case 7, 0x1404fd1fe (table entry 13), 0x1404fd304 (Fileio::Open), 0x1404fd327-0x1404fd334 (ReadFile 0x20000), 0x1404fd354-0x1404fd35b (short read fails type 7)" note: >- - The other half of the expansion pair, loaded through the same SCSI ROM - slot as ROM30.DAT and read at the same size. + The other half of the expansion pair, loaded into the SCSI ROM slot and + read at the same size as ROM30.DAT. The copy here is XEIJROM30.DAT from the same XEiJ run: SCSIINROM 16, ROM Human 2.60, ROM FLOAT 2.03 and ROM Debugger 3.60. # -- CG ROMs, read at 0xc0000 bytes, model specific first then CGROM.DAT then CGROM.TMP -- @@ -186,11 +218,12 @@ files: min_size: 786432 validation: [size] description: "X68000 character generator ROM" - source_ref: "xm6g.pdf p.17-18, xm6g.exe:0x1404fcf11 (read at 0x1404fd013), XM6 2.06 vm/memory.cpp:283-289" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fcf0e (table entry 5), 0x1404fcfed (Fileio::Open), 0x1404fd013-0x1404fd023 (ReadFile 0xc0000), 0x1404fd03e (falls back to CGROM.TMP), 0x1404fd1a0 (16-bit swap), Memory::Init 0x1404fc5d0 (memory vtable 0x1405c0830 slot 1) 0x1404fc669 (LoadROM(1), failure returns 0 at 0x1404fc97f), VM::Init 0x140565f60 0x14056762a (device Init through vtable slot 1), 0x140567631 (failure kept), OnCreate 0x140470ef0 0x140471218 (VM::Init call), 0x140471221 (error state 1), 0x14047123b (posts 0x8000), handler 0x1404737a0 0x1404737d6, 0x14047383e (MB_ICONSTOP message 47002 or 42002), 0x140473853 (WM_CLOSE), CG check 0x14047296e" note: >- Supplies the glyphs the X68000 renders, mapped at $F00000-$FBFFFF. Used by the base models and as the fallback for every machine whose own CG ROM is - absent. Initialisation fails when neither this file nor CGROM.TMP loads. + absent. LoadROM(1) fails when neither this file nor CGROM.TMP loads, and + the program closes. The startup CG check only warns. - name: CGROMXV.DAT system: sharp-x68000 @@ -200,10 +233,10 @@ files: min_size: 786432 validation: [size] description: "X68000 XVI character generator ROM" - source_ref: "xm6g.pdf p.17-18, xm6g.exe:0x1404fcd99" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fcd90-0x1404fcd96 (type 4, table entry 6), 0x1404fce88 (Fileio::Open), 0x1404fceb8-0x1404fcec8 (ReadFile 0xc0000, a short read continues at CGROM.DAT 0x1404fcf0e)" note: >- Preferred when the XVI machine is selected. CGROM.DAT is used when it is - missing. + missing or short. - name: CGROMCO.DAT system: sharp-x68000 @@ -213,7 +246,7 @@ files: min_size: 786432 validation: [size] description: "X68000 Compact character generator ROM" - source_ref: "xm6g.pdf p.17-18, xm6g.exe:0x1404fcdac" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fcd9f-0x1404fcda9 (type 5, table entry 7), 0x1404fce88 (Fileio::Open), 0x1404fceb8-0x1404fcec8 (ReadFile 0xc0000, fallback to CGROM.DAT 0x1404fcf0e)" note: >- Preferred when the Compact machine is selected, with the same fallback to CGROM.DAT. @@ -224,9 +257,9 @@ files: min_size: 786432 validation: [size] description: "X68030 character generator ROM" - source_ref: "xm6g.pdf p.17-18, xm6g.exe:0x1404fcc36 (read at 0x1404fcd42)" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fcc23-0x1404fcc33 (types 6 and 7, table entry 8), 0x1404fcd12 (Fileio::Open), 0x1404fcd42-0x1404fcd52 (ReadFile 0xc0000, fallback through 0x1404fcd90 to CGROM.DAT)" note: >- - Preferred when X68030 or X68030 Compact is selected, with the same + Preferred for the X68030 with or without the expansion ROM, with the same fallback to CGROM.DAT. - name: CGROM.TMP @@ -236,12 +269,12 @@ files: min_size: 786432 validation: [size] description: "Synthesised font ROM, fallback when no CG ROM is present" - source_ref: "xm6g.pdf p.18, p.6, xm6g.exe:0x1404fd041, XM6 2.06 vm/memory.cpp:286-289" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: 0x1404fd03e (table entry 9, reached only after CGROM.DAT fails), 0x1404fd11d (Fileio::Open, failure exits LoadROM), 0x1404fd147-0x1404fd157 (ReadFile 0xc0000, short read exits LoadROM)" note: >- Read at the same size, only after CGROM.DAT fails. XM6 Utility builds it from the fonts installed on the machine that generated it, so no hash is - declared. XM6 TypeG treats it as non-recommended and raises a suppressible - startup warning whenever it is in use. + declared. A synthesised font fails the CG sum and XOR check at + 0x14047296e, which raises the startup warning. # -- SCSI ROMs, tried at 0x20000 then 0x2000, external also at 0x1fe0 -- @@ -251,13 +284,14 @@ files: min_size: 8192 validation: [size] description: "Internal SCSI interface ROM, SUPER and later" - source_ref: "xm6g.pdf p.17, xm6g.exe:0x1404fd1ef (reads at 0x1404fd327, 0x1404fd3dd), XM6 2.06 vm/memory.cpp:305-310, 328-345" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd510 cases 2, 4 and 5, 0x1404fd1ec (table entry 10), 0x1404fd327 (ReadFile 0x20000), 0x1404fd361-0x1404fd391 and 0x1404fd442-0x1404fd44f (type 2 reopens and must read 0x2000), 0x1404fd39a (types 4 and 5 continue without the file), SCSI check 0x140501290 0x14050131e, 0x14050142d, 0x14050147c" note: >- - Required by SUPER, XVI and Compact, and by any machine whose SCSI - interface option is set to internal, that option defaulting to none. The - loader tries 0x20000 bytes first and falls back to 0x2000. A copy carrying - "XM6 " at offset 0x1ff8 was synthesised by XM6 Utility and raises the - startup warning. + Read for the internal SCSI option on the base machine (memory type 2), + where a missing file or a read under 0x2000 bytes fails the load and + Memory::Reset falls back to the plain base machine. XVI and Compact read it + with one 0x20000-byte ReadFile whose count is not checked, so a shorter + file still fills the slot, and without the file those machines start with + the slot left at 0xff. - name: SCSIEXROM.DAT system: sharp-x68000 @@ -265,13 +299,12 @@ files: min_size: 8160 validation: [size] description: "External SCSI interface ROM, CZ-6BS1 board" - source_ref: "xm6g.pdf p.17, xm6g.exe:0x1404fd20a (retry at 0x1404fd419), XM6 2.06 vm/memory.cpp:316-318, 341-352" + source_ref: "xm6g.exe 3.38 LoadROM 0x1404fc990: jump table 0x1404fd510 case 3, 0x1404fd207 (table entry 11), 0x1404fd327 (ReadFile 0x20000), 0x1404fd3a0-0x1404fd3ea (ReadFile 0x2000), 0x1404fd401-0x1404fd44f (retry 0x1fe0 bytes at buffer offset 0x20, a short read fails the load), SCSI check 0x140501290 0x14050148a, 0x140501599, 0x1405015da" note: >- - Drives the CZ-6BS1 board, the only SCSI variant the first model, ACE, - EXPERT and PRO can take, and mutually exclusive with the internal - interface everywhere else. After 0x20000 and 0x2000 the loader retries at - 0x1fe0 bytes into buffer offset 0x20, the WinX68k high-speed layout, so - 8160 is the real floor. + Read only for the external SCSI option on the base machine (memory type + 3). After 0x20000 and 0x2000 the loader retries at 0x1fe0 bytes into buffer + offset 0x20, the WinX68k layout, so 8160 is the real floor. Missing, the + load fails and Memory::Reset falls back to the plain base machine. # -- Battery-backed images, read at startup, written on exit when changed -- @@ -281,12 +314,12 @@ files: required: false size: [16384, 65536] description: "SRAM image for EXPERT and the other base models" - source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 14, XM6 2.06 vm/sram.cpp:70-81, 112" + source_ref: "xm6g.exe 3.38 SRAM::Init 0x140556320: 0x140556373-0x14055637c (Filepath::SysFile index 14), 0x140556397 (Fileio::Load 0x10000, result ignored), SRAM::Reset 0x140556510 (SRAM vtable 0x1405c2728 slot 3) 0x1405565f7 (machine index VM+0x2002c, ModelType copied at 0x14056768e), 0x14055662a (index 0), 0x140556667 (ReadFile 0x10000, count not checked), SRAM cleanup 0x140556420 0x140556498 (writes the configured size in KB)" note: >- - Holds the boot device and memory switch settings for the first model, ACE, - EXPERT, PRO and SUPER. A supplied image preloads those settings. The - standard capacity is the 16 KB X68000 SRAM, and the SRAM64K modification the - emulator reproduces raises it to 64 KB. No size is enforced. + Holds the boot device and memory switch settings for the base models. The + buffer is filled with 0xff first and up to 64 KB is read with no size + check. The program writes the configured SRAM size back, 16 KB as standard + and 64 KB with the 62C256 SRAM option. - name: SRAMXVI.DAT system: sharp-x68000 @@ -294,7 +327,7 @@ files: unsourceable: "written by the emulator on exit, no canonical file" size: [16384, 65536] description: "SRAM image for XVI" - source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 15" + source_ref: "xm6g.exe 3.38 SRAM::Reset 0x140556510: 0x1405565f3-0x140556623 (machine index VM+0x2002c, ModelType 1, gives Filepath::SysFile index 15), 0x140556632 (Filepath::SysFile 0x1404e76d0), 0x140556643 (Fileio::Open), 0x140556667 (ReadFile 0x10000)" note: >- Per-model SRAM introduced by XM6 TypeG, which keeps one image per machine instead of the single SRAM.DAT of XM6 v2.06. @@ -305,7 +338,7 @@ files: unsourceable: "written by the emulator on exit, no canonical file" size: [16384, 65536] description: "SRAM image for Compact" - source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 16" + source_ref: "xm6g.exe 3.38 SRAM::Reset 0x140556510: 0x1405565f7 (machine index VM+0x2002c), 0x14055661c (ModelType 2 gives Filepath::SysFile index 16), 0x140556632 (Filepath::SysFile 0x1404e76d0), 0x140556643 (Fileio::Open), 0x140556667 (ReadFile 0x10000)" note: >- Read when the Compact machine is selected. @@ -314,69 +347,70 @@ files: required: false unsourceable: "written by the emulator on exit, no canonical file" size: [16384, 65536] - description: "SRAM image for X68030, 040turbo and 060turbo" - source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 17" + description: "SRAM image for X68030" + source_ref: "xm6g.exe 3.38 SRAM::Reset 0x140556510: 0x1405565f7 (machine index VM+0x2002c), 0x140556615 (ModelType 3 gives Filepath::SysFile index 17), 0x140556632 (Filepath::SysFile 0x1404e76d0), 0x140556643 (Fileio::Open), 0x140556667 (ReadFile 0x10000)" note: >- - Shared by X68030, X68030 Compact and the 040turbo and 060turbo - configurations. + Read when the X68030 machine class is selected, with or without the + expansion ROM. - name: RTC.DAT system: sharp-x68000 required: false unsourceable: "written by the emulator on exit, no canonical file" + size: 120 description: "RTC alarm settings for timer start" - source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 18" + source_ref: "xm6g.exe 3.38 RTC::Init 0x140531ee0: 0x14053210b-0x140532117 (Filepath::SysFile index 18), 0x140532132 (Fileio::Load 0x78 bytes, result ignored), RTC cleanup 0x140532170 0x1405321a9 (writes 0x78 bytes)" note: >- - Alarm registers of the battery-backed clock, used by the timer start - feature and applying to every machine. XM6 TypeG creates it on exit when - it is absent. + Alarm registers of the battery-backed clock, applying to every machine. + The program reads and writes 120 bytes and runs with defaults when the file + is absent. # -- Mercury Unit rhythm samples, read by the OPN (YMF288) section -- - name: ym2608_adpcm_rom.bin system: sharp-x68000 required: false + size: 8192 description: "YM2608 ADPCM-A rhythm ROM, ymfm engine" - source_ref: "xm6g.exe:0x140574eb0 (name at 0x140574fec, read at 0x140575095)" + source_ref: "xm6g.exe 3.38 0x140574eb0: 0x140574fac-0x140574fbe (clears the 0x2000-byte buffer), 0x140574fdb-0x140574fec (wcscat_s of the name onto the directory argument), 0x14057506e (Fileio::Open, failure skips the read), 0x140575095 (ReadFile 0x2000, count not checked)" note: >- - Rhythm source for the Mercury Unit OPN when the FM engine is set to ymfm. - The name is appended to a directory and the file is read whole. When it is - absent the rhythm section stays silent and the emulator runs. + Rhythm source for the Mercury Unit OPN when the FM engine is ymfm. When it + is absent the buffer stays zeroed, the rhythm section is silent and the + emulator runs. - name: 2608_BD.WAV system: sharp-x68000 required: false description: "Mercury Unit rhythm sample, bass drum" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090, CreateFileW at 0x1404ed8bf" + source_ref: "xm6g.exe 3.38 0x1404ed610: 0x1404ed677 (name table 0x1405c0090 entry 0), 0x1404ed6fa-0x1404ed76d (directory + 2608_ + name + .WAV), 0x1404ed7af (CreateFileW), 0x1404ed7cf-0x1404ed7d8 (ERROR_FILE_NOT_FOUND handled), 0x1404ed950 (ReadFile)" note: >- One of the six rhythm samples the fmgen and X68Sound engines read for the - Mercury Unit OPN. The name is built as 2608_ plus the table entry plus - .WAV. A missing file is handled through ERROR_FILE_NOT_FOUND and leaves - that instrument silent. + Mercury Unit OPN. A missing file is handled through ERROR_FILE_NOT_FOUND + and leaves that instrument silent. - name: 2608_SD.WAV system: sharp-x68000 required: false description: "Mercury Unit rhythm sample, snare drum" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090" + source_ref: "xm6g.exe 3.38 0x1404ed610: name table 0x1405c0090 entry 1, 0x1404ed6fa-0x1404ed76d (name built), 0x1404ed7af (CreateFileW)" - name: 2608_TOP.WAV system: sharp-x68000 required: false description: "Mercury Unit rhythm sample, top cymbal" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090" + source_ref: "xm6g.exe 3.38 0x1404ed610: name table 0x1405c0090 entry 2, 0x1404ed6fa-0x1404ed76d (name built), 0x1404ed7af (CreateFileW)" - name: 2608_HH.WAV system: sharp-x68000 required: false description: "Mercury Unit rhythm sample, hi-hat" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090" + source_ref: "xm6g.exe 3.38 0x1404ed610: name table 0x1405c0090 entry 3, 0x1404ed6fa-0x1404ed76d (name built), 0x1404ed7af (CreateFileW)" - name: 2608_TOM.WAV system: sharp-x68000 required: false description: "Mercury Unit rhythm sample, tom-tom" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090" + source_ref: "xm6g.exe 3.38 0x1404ed610: name table 0x1405c0090 entry 4, 0x1404ed6fa-0x1404ed76d (name built), 0x1404ed7af (CreateFileW)" - name: 2608_RIM.WAV system: sharp-x68000 @@ -384,10 +418,10 @@ files: - 2608_RYM.WAV required: false description: "Mercury Unit rhythm sample, rim shot" - source_ref: "xm6g.exe:0x1404ed610, name table 0x1405c0090, 0x1404ed808-0x1404ed841" + source_ref: "xm6g.exe 3.38 0x1404ed610: name table 0x1405c0090 entry 5, 0x1404ed7af (CreateFileW of 2608_RIM.WAV), 0x1404ed808 (entry 5 not found), 0x1404ed841-0x1404ed8bf (CreateFileW of 2608_RYM.WAV)" note: >- Last of the six. This entry alone has a second accepted name, - 2608_RYM.WAV, the spelling carried by widely circulated sample sets. + 2608_RYM.WAV, opened when 2608_RIM.WAV is not found. # -- Libraries looked up by name at runtime, absent from the import directory -- @@ -395,39 +429,39 @@ files: system: sharp-x68000 required: false description: "FM synthesis engine by m_puusan" - source_ref: "xm6g.pdf p.29, p.31, xm6g.exe:LoadLibraryW at 0x140488dfb" + source_ref: "xm6g.exe 3.38 0x140488a50: 0x140488df4-0x140488dfb (LoadLibraryW), 0x140488e0d-0x140488e65 (absent: stub entry points), 0x140488e6a-0x140488e74 (GetProcAddress X68Sound_Reset and the rest)" note: >- - One of the three FM engines the sound options offer, alongside the - built-in fmgen and ymfm. Not shipped in the archive, and without it that - engine cannot be selected. + One of the three FM engines, alongside the built-in fmgen and ymfm. Not + shipped in the archive. Without it the engine object is wired to internal + stubs and the emulator continues. - name: c86ctl.dll system: sharp-x68000 required: false description: "Control library for external OPM hardware" - source_ref: "xm6g.exe:0x1404b2da6, version query at 0x1404b2daa" + source_ref: "xm6g.exe 3.38 0x1404b2d60: 0x1404b2da3-0x1404b2daa (GetFileVersionInfoSizeW, absent exits at 0x1404b3057), 0x1404b2e62-0x1404b2e69 (LoadLibraryW), 0x1404b2e89 (GetProcAddress CreateInstance)" note: >- Loaded by name to drive a real YM2151 through a C86BOX class device instead of software synthesis. The executable reads its file version - before use. + before loading it. - name: pcidebug.dll system: sharp-x68000 required: false description: "PCI bus bridge library, used to reach a ROMEO sound board" - source_ref: "xm6g.exe:LoadLibraryW at 0x1404fa344, FreeLibrary at 0x1404fa2f5" + source_ref: "xm6g.exe 3.38 0x1404fa2e0: 0x1404fa2f5 (FreeLibrary of the previous handle), 0x1404fa31a-0x1404fa344 (LoadLibraryW), 0x1404fa354 (absent skips the setup)" note: >- - Loaded on demand and freed again. Absent, the feature that needs it is - unavailable and the emulator continues. + Loaded on demand and freed again. Absent, the ROMEO output is unavailable + and the emulator continues. - name: SOUND Canvas VA.dll system: sharp-x68000 required: false path: "%ProgramFiles%/Roland/Sound Canvas VA/SOUND Canvas VA.dll" description: "Roland Sound Canvas VA plugin used as MIDI output" - source_ref: "xm6g.exe:0x14048418a, INI key VstSCVA" + source_ref: "xm6g.exe 3.38 0x140484170: 0x140484181-0x14048418e (empty VstSCVA setting gives the default path), 0x14048421e (ExpandEnvironmentStringsW), 0x1404823d0 0x14048249e (PathFileExistsW), 0x14048258a and 0x140482891 (VST host 0x1404aea40), 0x1404afd30 0x1404afd6c (LoadLibraryW)" note: >- Hosted as the MIDI output device when the VSTi option is selected. The - path is fixed to the Roland installation directory and the setting is + path defaults to the Roland installation directory and the setting is stored as VstSCVA. The plugin does not synthesise on its own: the Roland installer places SCCore.dll and eleven data files (GM, GM2 and SC-VSC .drk, .tnf and .drf sets, parameter1.dat to parameter3.dat) beside it, and the DLL loads them from its own directory. diff --git a/emulators/xroar.yml b/emulators/xroar.yml index 3aa57fb79..ccf2e4f28 100644 --- a/emulators/xroar.yml +++ b/emulators/xroar.yml @@ -29,6 +29,57 @@ standalone_pools: rompath: "" "-rompath": "" +config_reads: + - file: "xroar.conf" + source_ref: "src/xroar.c:882-909, 975-993" + keys: + - key: "rompath" + source_ref: "src/xroar.c:3266, src/romlist.c:125-140" + - key: + - "romlist dragon" + - "romlist d64_1" + - "romlist d64_2" + - "romlist d32" + - "romlist d200e_1" + - "romlist d200e_2" + - "romlist dragon64" + - "romlist dragon64_alt" + - "romlist dragon32" + - "romlist dragon200e" + - "romlist dragon200e_alt" + - "romlist dragon200e_charset" + - "romlist dragonpro_boot" + - "romlist dragonpro_basic" + - "romlist coco" + - "romlist coco_ext" + - "romlist deluxecoco" + - "romlist deluxecoco1" + - "romlist deluxecoco2" + - "romlist deluxecoco3" + - "romlist mx1600" + - "romlist mx1600ext" + - "romlist coco3" + - "romlist coco3p" + - "romlist glenside_ide" + - "romlist mc10" + - "romlist alice" + - "romlist dragondos" + - "romlist dosplus" + - "romlist superdos" + - "romlist cumana" + - "romlist dragondos_compat" + - "romlist rsdos" + - "romlist delta" + - "romlist rsdos_becker" + - "romlist mcx128" + - "romlist mcx128_azerty" + source_ref: "src/xroar.c:646-731, 3267, src/romlist.c:125-140" + - file: "command line" + source_ref: "src/xroar.c:1007" + keys: + - key: "-rompath" + source_ref: "src/xroar.c:3266, src/romlist.c:125-140" + notes: | XRoar by Ciaran Anscomb emulates Dragon 32/64, Tandy CoCo 1/2/3, MC-10, Alice, and clones (MX-1600, CP-400, Dragon 200-E, Deluxe CoCo). diff --git a/emulators/zinc.yml b/emulators/zinc.yml index 8c45a43af..5fb22bad9 100644 --- a/emulators/zinc.yml +++ b/emulators/zinc.yml @@ -35,21 +35,24 @@ notes: | (*.znc, s11player.dll) ship beside it. ref: ZiNc.exe 0x493f60 - Games are picked by number on the command line, not by set name. Each of the - 79 driver records holds the description, parent, set name, a pointer to its - ROM list and the name of the BIOS set, then the list gives name, region, - load offset and CRC32 of every ROM, the BIOS ROM first. RetroBat maps the - set name to that number in zincGameNumber. - ref: ZiNc.exe 0x496404 (glpracr record), + Games are picked by number on the command line, not by set name. The + driver table at 0x49fc08 holds 71 records (count returned at 0x463250). + Each record holds the description, parent, set name, a pointer to its ROM + list and the name of the BIOS set, then the list gives name, region, load + offset and CRC32 of every ROM, the BIOS ROM first. Records for glpracr, + glpracr2, btchamp, mgcldate, sfchamp, PointBlank2, sws99 and mdhorse sit in + the image but no table entry points at them, so they cannot be run. + RetroBat maps the set name to the number in zincGameNumber. + ref: ZiNc.exe 0x463250, 0x463590-0x4635a2, emulatorlauncher emulatorLauncher/Generators/Zinc.Generator.cs:136-209 ROMs are read from the directory given by -roms-directory (default roms), which RetroBat writes into zinc.cfg as the folder of the launched game. A ROM - is looked up in .zip, then in the parent's zip, then in the BIOS set's - zip, each also as a plain directory. A missing ROM stops the load with - "ERROR: missing rom file", and every ROM is checked against the CRC32 of its - record ("ERROR: BAD CRC ... expected"). - ref: ZiNc.exe 0x494134, 0x49fdfc, 0x4a018c, 0x49fe24, 0x49fe48, + is looked up in the parent's zip, then in the BIOS set's zip, then in the + game's own zip. A missing ROM stops the load with "ERROR: missing rom file", + and every ROM is checked against the CRC32 of its record ("ERROR: BAD CRC + ... expected"). + ref: ZiNc.exe 0x46366d-0x4636f0, 0x463724-0x463833, 0x463838-0x4638ac, emulatorlauncher emulatorLauncher/Generators/Zinc.Generator.cs:109-114 The Namco System 11 records name no BIOS set: the first ROM of each list is @@ -63,8 +66,8 @@ files: category: bios_zip system: capcom-zn1 description: "Capcom ZN-1 BIOS" - note: "BIOS set of starglad, sfex, sfexa, sfexj, sfexp, sfexpu1, sfexpj, ts2, ts2j and glpracr." - source_ref: "ZiNc.exe 0x49926c, ZiNc.exe 0x496404" + note: "BIOS set of starglad, sfex, sfexa, sfexj, sfexp, sfexpu1, sfexpj, ts2 and ts2j." + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x49926c (starglad, first ROM coh-1000c.353)" contents: - name: "coh-1000c.353" crc32: "50033af6" @@ -75,7 +78,7 @@ files: system: capcom-zn2 description: "Capcom ZN-2 BIOS" note: "BIOS set of tgmj, stargld2, plsmaswd, sfex2, sfex2j, sfex2p, sfex2pa, sfex2pj, shiryu2, strider2, kikaioh, techromn, rvschool, rvschola and jgakuen." - source_ref: "ZiNc.exe 0x499054" + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x499054 (tgmj, first ROM coh-3002c.353)" contents: - name: "coh-3002c.353" crc32: "e860ea8b" @@ -85,8 +88,8 @@ files: category: bios_zip system: tecmo-tps description: "Tecmo TPS BIOS" - note: "BIOS set of glpracr2, glpracr3, shngmtkb, mfjump, cbaj, tondemo, doapp and brvblade." - source_ref: "ZiNc.exe 0x496dec" + note: "BIOS set of glpracr3, shngmtkb, mfjump, cbaj, tondemo, doapp and brvblade." + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x496dec (cbaj, first ROM coh-1002m.353)" contents: - name: "coh-1002m.353" crc32: "69ffbcb4" @@ -96,8 +99,8 @@ files: category: bios_zip system: taito-fx1 description: "Taito FX-1 BIOS" - note: "BIOS set of psyforce, psyforcj, psyfrcex, mgcldate, mgcldtex, sfchamp, gdarius, gdarius2, raystorm, raystorj and ftimpcta." - source_ref: "ZiNc.exe 0x49cb98" + note: "BIOS set of psyforce, psyforcj, psyfrcex, mgcldtex, gdarius, gdarius2, raystorm, raystorj and ftimpcta." + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x49cb98 (psyforce, first ROM coh-1000t.353)" contents: - name: "coh-1000t.353" crc32: "e3f23b6e" @@ -108,7 +111,7 @@ files: system: eighting-zn1 description: "Raizing/Eighting PS Arcade 95 BIOS" note: "BIOS set of beastrzr, beastrzb and bldyror2." - source_ref: "ZiNc.exe 0x49c3ac" + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x49c3ac (beastrzr, first ROM coh-1002e.353)" contents: - name: "coh-1002e.353" crc32: "910f3a8b" @@ -119,7 +122,7 @@ files: system: atlus-zn1 description: "Atlus PSX BIOS" note: "BIOS set of hvnsgate." - source_ref: "ZiNc.exe 0x49ed34" + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x49ed34 (hvnsgate, first ROM coh-1001l.353)" contents: - name: "coh-1001l.353" crc32: "6721146b" @@ -129,8 +132,8 @@ files: category: bios_zip system: konami-gv description: "Konami GV BIOS" - note: "BIOS set of weddingr, hyperath, btchamp, pbball96 and susume." - source_ref: "ZiNc.exe 0x49f0e4" + note: "BIOS set of weddingr, hyperath, pbball96 and susume." + source_ref: "ZiNc.exe 1.1 0x463590-0x4638ac (game load: record from the driver table at 0x49fc08, BIOS set name at record+0x28 formatted %s/%s.zip at 0x4636ae-0x4636d7, each ROM looked up in the parent, BIOS and own set zip at 0x463724-0x463808, missing ROM fatal at 0x46381e-0x463833, CRC32 mismatch fatal at 0x463838-0x4638ac), record 0x49f0e4 (weddingr, first ROM 999a01.7e)" contents: - name: "999a01.7e" crc32: "ad498d2d" diff --git a/platforms/amberelec.yml b/platforms/amberelec.yml index a4085d839..dbbe87c88 100644 --- a/platforms/amberelec.yml +++ b/platforms/amberelec.yml @@ -3180,6 +3180,11 @@ launchers: search_dir: ~/roms/bios passes_to: retroarch.cfg system_directory fails_when_missing: false + installs: + path: /storage/.config/retroarch/retroarch.cfg + source_ref: "packages/sysutils/systemd/scripts/userconfig-setup:20" + kept_if_present: true + overrides: [] source_ref: "packages/games/tools/retroarch/sources/retroarch.cfg:611" - emulator: retrorun build: libretro @@ -3198,25 +3203,6 @@ launchers: fails_when_missing: false depends_on_option: self.emulator == 'mame' source_ref: "packages/amberelec/sources/scripts/runemu.py:233, 252, 255" -- emulator: atari800 - build: libretro - kind: fixed_name - names: - - ATARIOSA.ROM - - ATARIXL.ROM - - 5200.rom - - 5200a.rom - - BASIC_Rev_A.rom - - BASIC_Rev_B.rom - - ATARIBAS.ROM - - ATARIOSB.ROM - case_insensitive: false - search_dir: /storage/roms/bios - passes_to: atari800.cfg ROM_OS_A_PAL, ROM_OS_BB01R2, ROM_5200, ROM_5200_A, ROM_BASIC_A, - ROM_BASIC_B, ROM_BASIC_C, ROM_400/800_CUSTOM - fails_when_missing: false - source_ref: "packages/games/libretro/atari800/patches/atari800-01-add-emuelec-platform.patch:27,\ - \ packages/amberelec/config/distribution/configs/atari800.cfg:3, 8, 16-22" - emulator: scummvm build: libretro kind: passes_path @@ -3291,7 +3277,13 @@ launchers: passes_to: "AmigaA1200-default.uae kickstart_rom_file, $(FILE_PATH) = /storage/.config/amiberry/kickstarts/" fails_when_missing: false depends_on_option: "[ `echo $1 | egrep 'AGA|CD32' | wc -l` -eq 1 -o `echo \"$AMIBERRY_TMP_DIR\"\ - /* | egrep 'AGA|CD32' | wc -l` -eq 1 ]" + /* | egrep 'AGA|CD32' | wc -l` -eq 1 ], content not booted with --autoload, a\ + \ WHDLoad .lha or .zip (amiberry.sh:83, 122)" + installs: + path: /tmp/emulation/amiberry/.amiberry_conf.uae + source_ref: "packages/games/emulators/amiberry/scripts/amiberry.sh:59" + kept_if_present: false + overrides: [] source_ref: "packages/amberelec/sources/scripts/runemu.py:111, packages/games/emulators/amiberry/scripts/amiberry.sh:57-59,\ \ packages/games/emulators/amiberry/config/conf/AmigaA1200-default.uae:35, 85" - emulator: AMIBERRY @@ -3305,7 +3297,13 @@ launchers: passes_to: "AmigaA500-default.uae kickstart_rom_file, $(FILE_PATH) = /storage/.config/amiberry/kickstarts/" fails_when_missing: false depends_on_option: "not ([ `echo $1 | egrep 'AGA|CD32' | wc -l` -eq 1 -o `echo \"\ - $AMIBERRY_TMP_DIR\"/* | egrep 'AGA|CD32' | wc -l` -eq 1 ])" + $AMIBERRY_TMP_DIR\"/* | egrep 'AGA|CD32' | wc -l` -eq 1 ]), content not booted\ + \ with --autoload, a WHDLoad .lha or .zip (amiberry.sh:83, 122)" + installs: + path: /tmp/emulation/amiberry/.amiberry_conf.uae + source_ref: "packages/games/emulators/amiberry/scripts/amiberry.sh:62" + kept_if_present: false + overrides: [] source_ref: "packages/amberelec/sources/scripts/runemu.py:111, packages/games/emulators/amiberry/scripts/amiberry.sh:60-62,\ \ packages/games/emulators/amiberry/config/conf/AmigaA500-default.uae:35, 85" - emulator: HATARISA @@ -3317,6 +3315,11 @@ launchers: search_dir: /storage/roms/bios passes_to: "Atari-ST-default.cfg [ROM] szTosImageFileName" fails_when_missing: false + installs: + path: /tmp/hatari/.hatari-temp.cfg + source_ref: "packages/games/emulators/hatarisa/scripts/hatari.sh:36" + kept_if_present: false + overrides: [] source_ref: "packages/amberelec/sources/scripts/runemu.py:113, packages/games/emulators/hatarisa/scripts/hatari.sh:36,\ \ 66, packages/games/emulators/hatarisa/config/conf/Atari-ST-default.cfg:200" - emulator: pico8 diff --git a/platforms/emudeck.yml b/platforms/emudeck.yml index 5ef9d2ebd..6513cf18f 100644 --- a/platforms/emudeck.yml +++ b/platforms/emudeck.yml @@ -937,6 +937,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml ColecoVision/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:270, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -948,6 +954,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml MSX/Firmware/BIOS.Japan fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:278, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -959,6 +971,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml MSX2/Firmware/BIOS.Japan fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:283, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -971,6 +989,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml PCEngineCD/Firmware/BIOS.US, PCEngineCD/Firmware/BIOS.Japan fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:291-292, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -982,6 +1006,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml SuperGrafxCD/Firmware/BIOS.Japan fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:300, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -993,6 +1023,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml FamicomDiskSystem/Firmware/BIOS.Japan fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:308, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1007,6 +1043,12 @@ launchers: passes_to: settings.bml Nintendo64DD/Firmware/BIOS.Japan, Nintendo64DD/Firmware/BIOS.US, Nintendo64DD/Firmware/BIOS.DEV fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:319-321, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1018,6 +1060,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml GameBoyAdvance/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:332, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1032,6 +1080,12 @@ launchers: passes_to: settings.bml MasterSystem/Firmware/BIOS.US, MasterSystem/Firmware/BIOS.Japan, MasterSystem/Firmware/BIOS.Europe fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:340-342, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1043,6 +1097,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml GameGear/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:347, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1056,6 +1116,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml MegaCD/Firmware/BIOS.US, MegaCD/Firmware/BIOS.Japan, MegaCD/Firmware/BIOS.Europe fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:358-360, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1067,6 +1133,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml NeoGeoAES/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:368, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1078,6 +1150,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml NeoGeoPocket/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:378, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1089,6 +1167,12 @@ launchers: search_dir: "${biosPath}" passes_to: settings.bml NeoGeoPocketColor/Firmware/BIOS.World fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:383, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: ares @@ -1103,6 +1187,12 @@ launchers: passes_to: settings.bml PlayStation/Firmware/BIOS.US, PlayStation/Firmware/BIOS.Japan, PlayStation/Firmware/BIOS.Europe fails_when_missing: false + installs: + path: "${HOME}/.var/app/dev.ares.ares/data/ares/settings.bml" + source_ref: "functions/EmuScripts/emuDeckares.sh:26, 42, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "configs/dev.ares.ares/data/ares/settings.bml:388-390, functions/EmuScripts/emuDeckares.sh:6,\ \ 63-64" - emulator: melonds @@ -1121,6 +1211,12 @@ launchers: DSiFirmwarePath, DSiNANDPath fails_when_missing: false depends_on_option: ExternalBIOSEnable = 0 in the shipped melonDS.ini + installs: + path: "${HOME}/.var/app/net.kuribo64.melonDS/config/melonDS/melonDS.ini" + source_ref: "functions/EmuScripts/emuDeckMelonDS.sh:29, 48, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] source_ref: "functions/EmuScripts/emuDeckMelonDS.sh:7, 62-68, 71-77, configs/net.kuribo64.melonDS/config/melonDS/melonDS.ini:77" - emulator: melonds build: standalone @@ -1137,8 +1233,15 @@ launchers: passes_to: "melonDS.toml [DS] FirmwarePath, BIOS7Path, BIOS9Path [DSi] FirmwarePath,\ \ NANDPath, BIOS7Path, BIOS9Path" fails_when_missing: false - depends_on_option: ExternalBIOSEnable = false in the shipped melonDS.toml - source_ref: "configs/net.kuribo64.melonDS/config/melonDS/melonDS.toml:176, 181-183,\ + depends_on_option: "[DS] keys: ExternalBIOSEnable = true, false in the shipped melonDS.toml;\ + \ [DSi] keys: ConsoleType = 1, 0 in the shipped melonDS.toml" + installs: + path: "${HOME}/.var/app/net.kuribo64.melonDS/config/melonDS/melonDS.toml" + source_ref: "functions/EmuScripts/emuDeckMelonDS.sh:29, 48, functions/configEmuFP.sh:11,\ + \ 15" + kept_if_present: true + overrides: [] + source_ref: "configs/net.kuribo64.melonDS/config/melonDS/melonDS.toml:176-178, 181-183,\ \ 186-189, functions/EmuScripts/emuDeckMelonDS.sh:8, 32" - emulator: mupen64plus_next build: standalone diff --git a/platforms/emuelec.yml b/platforms/emuelec.yml index 1c0622059..3c181e6a4 100644 --- a/platforms/emuelec.yml +++ b/platforms/emuelec.yml @@ -4241,96 +4241,6 @@ launchers: fails_when_missing: false depends_on_option: /storage/roms/bios/mame/ini/mame.ini absent source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame - passes_to: mame.ini homepath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:10, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/bios - passes_to: mame.ini rompath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:11, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/hash - passes_to: mame.ini hashpath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:12, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/samples - passes_to: mame.ini samplepath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:13, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/artwork - passes_to: mame.ini artpath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:14, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/ini - passes_to: mame.ini inipath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:16, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/cheat - passes_to: mame.ini cheatpath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:18, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/crosshair - passes_to: mame.ini crosshairpath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:19, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" -- emulator: mame - build: libretro - kind: passes_path - names: [] - search_dir: /storage/roms/bios/mame/plugins - passes_to: mame.ini pluginspath - fails_when_missing: false - depends_on_option: mame_read_config = enabled - source_ref: "packages/sx05re/libretro/mame/config/ini/mame.ini:20, packages/sx05re/libretro/mame/config/MAME/MAME.opt:19,\ - \ packages/sx05re/emuelec/bin/emuelecRunEmu.sh:357-358, packages/sx05re/libretro/mame/scripts/mame.sh:21-23" - emulator: pico8 build: standalone kind: moves @@ -4384,6 +4294,11 @@ launchers: passes_to: "settings.ini [BIOS] SearchDirectory (-settings), [BIOS] PathNTSCU, PathNTSCJ,\ \ PathPAL unset" fails_when_missing: false + installs: + path: /emuelec/configs/duckstation/settings.ini + source_ref: "packages/sx05re/emulators/duckstation/scripts/duckstation.sh:15" + kept_if_present: true + overrides: [] source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:207-209, packages/sx05re/emulators/duckstation/config/settings.ini:6-9,\ \ packages/sx05re/emulators/duckstation/package.mk:56, packages/sx05re/emulators/duckstation/scripts/duckstation.sh:40" - emulator: yabasanshiroSA @@ -4439,6 +4354,11 @@ launchers: search_dir: /storage/roms/bios passes_to: "Atari-ST-default.cfg [ROM] szTosImageFileName (--configfile)" fails_when_missing: false + installs: + path: /tmp/hatari/.hatari-temp.cfg + source_ref: "packages/sx05re/emulators/hatarisa/scripts/hatari.start:36" + kept_if_present: false + overrides: [] source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:172-174, packages/sx05re/emulators/hatarisa/config/conf/Atari-ST-default.cfg:200,\ \ packages/sx05re/emulators/hatarisa/package.mk:39, packages/sx05re/emulators/hatarisa/scripts/hatari.start:36,\ \ 66, 73" @@ -4450,6 +4370,12 @@ launchers: passes_to: advmame.rc dir_artwork fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4463,6 +4389,12 @@ launchers: search_dir: /storage/roms/arcade/artwork passes_to: advmame.rc dir_artwork fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4475,6 +4407,12 @@ launchers: passes_to: advmame.rc dir_diff fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4488,6 +4426,12 @@ launchers: search_dir: /storage/roms/arcade/diff passes_to: advmame.rc dir_diff fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4500,6 +4444,12 @@ launchers: passes_to: advmame.rc dir_hi fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4513,6 +4463,12 @@ launchers: search_dir: /storage/roms/arcade/hi passes_to: advmame.rc dir_hi fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4525,6 +4481,12 @@ launchers: passes_to: advmame.rc dir_image fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4538,6 +4500,12 @@ launchers: search_dir: /storage/roms/arcade/image passes_to: advmame.rc dir_image fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4550,6 +4518,12 @@ launchers: passes_to: advmame.rc dir_inp fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4563,6 +4537,12 @@ launchers: search_dir: /storage/roms/arcade/inp passes_to: advmame.rc dir_inp fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4575,6 +4555,12 @@ launchers: passes_to: advmame.rc dir_memcard fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4588,6 +4574,12 @@ launchers: search_dir: /storage/roms/arcade/memcard passes_to: advmame.rc dir_memcard fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4600,6 +4592,12 @@ launchers: passes_to: advmame.rc dir_nvram fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4613,6 +4611,12 @@ launchers: search_dir: /storage/roms/arcade/nvram passes_to: advmame.rc dir_nvram fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4625,6 +4629,12 @@ launchers: passes_to: advmame.rc dir_rom fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4638,6 +4648,12 @@ launchers: search_dir: /storage/roms/arcade passes_to: advmame.rc dir_rom fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4649,6 +4665,12 @@ launchers: search_dir: /storage/roms/bios/advmame/samples passes_to: advmame.rc dir_sample fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:80" @@ -4660,6 +4682,12 @@ launchers: passes_to: advmame.rc dir_snap fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4673,6 +4701,12 @@ launchers: search_dir: /storage/roms/arcade/snap passes_to: advmame.rc dir_snap fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4685,6 +4719,12 @@ launchers: passes_to: advmame.rc dir_sta fails_when_missing: false depends_on_option: system != arcade + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4698,6 +4738,12 @@ launchers: search_dir: /storage/roms/arcade/nvram passes_to: advmame.rc dir_sta fails_when_missing: false + installs: + path: /emuelec/configs/advmame/advmame.rc + source_ref: "packages/sx05re/emulators/advancemame/bin/advmame.sh:17, 21" + kept_if_present: false + overrides: + - "packages/sx05re/emulators/advancemame/bin/advmame.sh:27" source_ref: "packages/sx05re/emuelec/bin/emuelecRunEmu.sh:213-215, packages/sx05re/emulators/advancemame/config/advmame.rc_oga:1-11,\ \ packages/sx05re/emulators/advancemame/config/advmame.rc_gf:1-11, packages/sx05re/emulators/advancemame/config/advmame.rc:4-14,\ \ packages/sx05re/emulators/advancemame/package.mk:45-49, packages/sx05re/emulators/advancemame/bin/advmame.sh:26-27,\ @@ -4720,7 +4766,8 @@ launchers: search_dir: /storage/.config/scummvm passes_to: /storage/roms/bios/scummvm.ini fails_when_missing: false - depends_on_option: scummvm.start add + depends_on_option: "scummvm.start add, an action no launch runs (emuelecRunEmu.sh\ + \ passes libretro, sa)" source_ref: "packages/sx05re/emulators/scummvmsa/bin/scummvm.start:9, 49-51, 54" - emulator: dolphin build: standalone diff --git a/platforms/knulli.yml b/platforms/knulli.yml index 2bbbad334..63aadbd72 100644 --- a/platforms/knulli.yml +++ b/platforms/knulli.yml @@ -5662,9 +5662,10 @@ launchers: depends_on_option: "bootdisk (not (messSysName[messMode] == '' or messMode == -1)\ \ and softList == '' and system.name == 'macintosh' and system.isOptSet('bootdisk')\ \ and not (system.config['bootdisk'] in ['macos30', 'macos608', 'macos701', 'macos75']))" + choices_from: "package/emulationstation/knulli-es-system/es_features.yml:11037-11043" source_ref: "package/system/knulli-configgen/configgen/configgen/generators/mame/mameGenerator.py:303-305,\ - \ 375-379, 384-385, package/emulationstation/knulli-es-system/es_features.yml:11037-11043" -- emulator: mame, mess, mamevirtual, same_cdi + \ 375-379, 384-385" +- emulator: mame build: libretro kind: fixed_name names: @@ -5685,7 +5686,7 @@ launchers: \ in ['macos30', 'macos608', 'macos701', 'macos75'])" source_ref: "package/system/knulli-configgen/configgen/configgen/generators/libretro/libretroMAMEConfig.py:64,\ \ 123, 197, 265-268, 270, 274" -- emulator: mame, mess, mamevirtual, same_cdi +- emulator: mame build: libretro kind: fixed_name names: @@ -5704,8 +5705,9 @@ launchers: \ 'plugnplay', 'vis']) and not (messSysName[messMode] == '') and not (softList\ \ != '') and system.name == 'macintosh' and system.isOptSet('bootdisk') and not\ \ (system.config['bootdisk'] in ['macos30', 'macos608', 'macos701', 'macos75']))" + choices_from: "package/emulationstation/knulli-es-system/es_features.yml:3727-3733" source_ref: "package/system/knulli-configgen/configgen/configgen/generators/libretro/libretroMAMEConfig.py:64,\ - \ 123, 197, 265-268, 273-274, package/emulationstation/knulli-es-system/es_features.yml:3727-3733" + \ 123, 197, 265-268, 273-274" - emulator: dolphin build: standalone kind: fixed_name diff --git a/platforms/retrobat.yml b/platforms/retrobat.yml index 185be4204..290d649fa 100644 --- a/platforms/retrobat.yml +++ b/platforms/retrobat.yml @@ -4259,7 +4259,8 @@ launchers: passes_to: "settings.ini [BIOS] PathNTSCJ = PathNTSCU = PathPAL = " fails_when_missing: not checked by the launcher depends_on_option: duck_bios - source_ref: "emulatorLauncher/Generators/Duckstation.Generator.cs:197-202, .emulationstation/es_features.cfg:12489-12497" + choices_from: ".emulationstation/es_features.cfg:12489-12497" + source_ref: "emulatorLauncher/Generators/Duckstation.Generator.cs:197-202" - emulator: eka2l1 build: standalone kind: passes_path @@ -4599,7 +4600,8 @@ launchers: passes_to: "hatari.cfg [ROM] szTosImageFileName=/hatari/tos/" fails_when_missing: ApplicationException 'Missing TOS file in 'bios' folder.' depends_on_option: hatari_tos - source_ref: "emulatorLauncher/Generators/Hatari.Generator.cs:410-415, 454, .emulationstation/es_features.cfg:13768-13774" + choices_from: ".emulationstation/es_features.cfg:13768-13774" + source_ref: "emulatorLauncher/Generators/Hatari.Generator.cs:410-415, 454" - emulator: hatari build: standalone kind: fixed_name @@ -4639,7 +4641,8 @@ launchers: passes_to: hatari_tosimage = , if the file is there | default fails_when_missing: hatari_tosimage = default depends_on_option: hatari2014_tos - source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3409-3417, .emulationstation/es_features.cfg:7095-7102" + choices_from: ".emulationstation/es_features.cfg:7095-7102" + source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3409-3417" - emulator: hatarib build: libretro kind: fixed_name @@ -4667,8 +4670,8 @@ launchers: passes_to: hatarib_tos = hatarib/ fails_when_missing: hatarib_tos = , or when bios holds it depends_on_option: hatarib_tos - source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3434-3435, 3457-3474,\ - \ .emulationstation/es_features.cfg:7125-7134" + choices_from: ".emulationstation/es_features.cfg:7125-7134" + source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3434-3435, 3457-3474" - emulator: hatarib build: libretro kind: copies @@ -4885,7 +4888,8 @@ launchers: fails_when_missing: falls back to dsi_nand.bin depends_on_option: melonds_console == "dsi", melonds_nandregion set, rom extension not ".bin" - source_ref: "emulatorLauncher/Generators/MelonDS.Generator.cs:193-202, .emulationstation/es_features.cfg:16816-16823" + choices_from: ".emulationstation/es_features.cfg:16816-16823" + source_ref: "emulatorLauncher/Generators/MelonDS.Generator.cs:193-202" - emulator: mesen build: standalone kind: copies @@ -5081,7 +5085,8 @@ launchers: passes_to: "kronos.ini [1.0] General\\Bios = /, only if the file exists" fails_when_missing: General\Bios not written depends_on_option: kronos_force_bios - source_ref: "emulatorLauncher/Generators/Kronos.Generator.cs:162-170, .emulationstation/es_features.cfg:14519-14524" + choices_from: ".emulationstation/es_features.cfg:14519-14524" + source_ref: "emulatorLauncher/Generators/Kronos.Generator.cs:162-170" - emulator: ssf build: standalone kind: core_option @@ -5094,7 +5099,8 @@ launchers: passes_to: "SSF.ini [Peripheral] SaturnBIOS = /, only if the file exists" fails_when_missing: SaturnBIOS not written depends_on_option: use_external_bios - source_ref: "emulatorLauncher/Generators/SSF.Generator.cs:76-83, .emulationstation/es_features.cfg:20762-20767" + choices_from: ".emulationstation/es_features.cfg:20762-20767" + source_ref: "emulatorLauncher/Generators/SSF.Generator.cs:76-83" - emulator: yabasanshiro build: standalone kind: fixed_name @@ -5119,7 +5125,8 @@ launchers: \ exists" fails_when_missing: General\Bios not written depends_on_option: yabasanshiro_force_bios - source_ref: "emulatorLauncher/Generators/Yabasanshiro.Generator.cs:123-131, .emulationstation/es_features.cfg:22724-22729" + choices_from: ".emulationstation/es_features.cfg:22724-22729" + source_ref: "emulatorLauncher/Generators/Yabasanshiro.Generator.cs:123-131" - emulator: ymir build: standalone kind: fixed_name @@ -5144,7 +5151,8 @@ launchers: \ check" fails_when_missing: path written without an existence check depends_on_option: ymir_force_bios - source_ref: "emulatorLauncher/Generators/Ymir.Generator.cs:120-125, .emulationstation/es_features.cfg:22784-22788" + choices_from: ".emulationstation/es_features.cfg:22784-22788" + source_ref: "emulatorLauncher/Generators/Ymir.Generator.cs:120-125" - emulator: ymir build: standalone kind: passes_path @@ -5222,7 +5230,8 @@ launchers: fails_when_missing: ApplicationException 'BIOS file does not exist in ''.' depends_on_option: lrps2_bios - source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3695-3704, .emulationstation/es_features.cfg:5875-5881" + choices_from: ".emulationstation/es_features.cfg:5875-5881" + source_ref: "emulatorLauncher/Generators/LibRetro.CoreOptions.cs:3695-3704" - emulator: pcsx2 build: libretro kind: scans_dir @@ -5635,8 +5644,10 @@ launchers: search_dir: bios passes_to: "xemu.toml [sys.files] flashrom_path=/, default Complex_4627.bin" fails_when_missing: path written without an existence check - depends_on_option: xemu_flashrom - source_ref: "emulatorLauncher/Generators/Xemu.Generator.cs:286-289, .emulationstation/es_features.cfg:22081-22085" + depends_on_option: "xemu_flashrom, not (emulator == \"xemu-chihiro\" || system ==\ + \ \"chihiro\")" + choices_from: ".emulationstation/es_features.cfg:22081-22085" + source_ref: "emulatorLauncher/Generators/Xemu.Generator.cs:48, 284-289" - emulator: xemu build: standalone kind: names_searched @@ -5752,7 +5763,8 @@ launchers: - coco3h - coco3p - coco3ph - source_ref: "emulatorLauncher/Generators/Xroar.Generator.cs:76-80, .emulationstation/es_features.cfg:22650-22659" + choices_from: ".emulationstation/es_features.cfg:22650-22659" + source_ref: "emulatorLauncher/Generators/Xroar.Generator.cs:76-80" - emulator: xroar build: standalone kind: passes_path diff --git a/platforms/retrodeck.yml b/platforms/retrodeck.yml index 3592a2537..5df006cdd 100644 --- a/platforms/retrodeck.yml +++ b/platforms/retrodeck.yml @@ -16763,6 +16763,11 @@ launchers: search_dir: $roms_path/doom passes_to: "gzdoom.ini [IWADSearch.Directories] Path" fails_when_missing: false + installs: + path: $gzdoom_config + source_ref: "gzdoom/component_prepare.sh:23, 26-30" + kept_if_present: false + overrides: [] source_ref: "gzdoom/rd_assets/rd_config/gzdoom.ini:9, gzdoom/component_prepare.sh:23,\ \ 27-28" - emulator: gzdoom @@ -16772,6 +16777,11 @@ launchers: search_dir: $roms_path/doom passes_to: "gzdoom.ini [FileSearch.Directories] Path" fails_when_missing: false + installs: + path: $gzdoom_config + source_ref: "gzdoom/component_prepare.sh:23, 26-30" + kept_if_present: false + overrides: [] source_ref: "gzdoom/rd_assets/rd_config/gzdoom.ini:18, gzdoom/component_prepare.sh:23,\ \ 27-28" - emulator: gzdoom @@ -16781,6 +16791,11 @@ launchers: search_dir: $bios_path/gzdoom passes_to: "gzdoom.ini [FileSearch.Directories] Path" fails_when_missing: false + installs: + path: $gzdoom_config + source_ref: "gzdoom/component_prepare.sh:23, 26-30" + kept_if_present: false + overrides: [] source_ref: "gzdoom/rd_assets/rd_config/gzdoom.ini:19, gzdoom/component_prepare.sh:23,\ \ 28" - emulator: gzdoom @@ -16790,6 +16805,11 @@ launchers: search_dir: $roms_path/bios/gzdoom passes_to: "gzdoom.ini [SoundfontSearch.Directories] Path" fails_when_missing: false + installs: + path: $gzdoom_config + source_ref: "gzdoom/component_prepare.sh:23, 26-30" + kept_if_present: false + overrides: [] source_ref: "gzdoom/rd_assets/rd_config/gzdoom.ini:31, gzdoom/component_prepare.sh:23,\ \ 27-28" - emulator: mame @@ -17023,6 +17043,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: xroar.conf rompath fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:290, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17033,6 +17058,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:291, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17048,6 +17078,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist d64_1 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:292, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17062,6 +17097,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist d64_2 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:293, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17075,6 +17115,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist d32 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:294, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17087,6 +17132,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist d200e_1 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:295, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17099,6 +17149,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist d200e_2 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:296, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17115,6 +17170,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon64 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:297, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17129,6 +17189,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon64_alt fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:298, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17143,6 +17208,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon32 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:299, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17162,6 +17232,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon200e fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:300, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17179,6 +17254,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon200e_alt fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:301, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17190,6 +17270,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragon200e_charset fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:302, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17204,6 +17289,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragonpro_boot fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:303, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17222,6 +17312,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragonpro_basic fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:304, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17236,6 +17331,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist coco fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:305, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17249,89 +17349,12 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist coco_ext fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:306, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco1 - names: - - bas10 - - bas13 - - bas12 - - "Color Basic v1.2 (1982)(Tandy)" - - bas11 - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco1 - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:307, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco1e - names: - - bas11 - - bas13 - - bas12 - - "Color Basic v1.2 (1982)(Tandy)" - - bas10 - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco1e - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:308, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco1e_ext - names: - - extbas10 - - extbas11 - - coco - - COCO - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco1e_ext - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:309, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco2 - names: - - bas12 - - bas13 - - "Color Basic v1.2 (1982)(Tandy)" - - bas11 - - bas10 - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco2 - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:310, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco2_ext - names: - - extbas11 - - extbas10 - - coco - - COCO - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco2_ext - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:311, xroar/component_prepare.sh:13-15" -- emulator: xroar - build: standalone - kind: names_searched - slot: coco2b - names: - - bas13 - - bas12 - - "Color Basic v1.2 (1982)(Tandy)" - - bas11 - - bas10 - search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" - passes_to: romlist coco2b - fails_when_missing: false - source_ref: "xroar/rd_assets/rd_config/xroar.conf:312, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone kind: names_searched @@ -17342,6 +17365,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist deluxecoco fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:313, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17352,6 +17380,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist deluxecoco1 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:314, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17362,6 +17395,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist deluxecoco2 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:315, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17373,6 +17411,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist deluxecoco3 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:316, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17384,6 +17427,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist mx1600 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:317, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17394,6 +17442,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist mx1600ext fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:318, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17404,6 +17457,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist coco3 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:319, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17414,6 +17472,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist coco3p fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:320, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17425,6 +17488,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist glenside_ide fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:321, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17435,6 +17503,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist mc10 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:322, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17445,6 +17518,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist alice fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:323, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17460,6 +17538,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragondos fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:324, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17473,6 +17556,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dosplus fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:325, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17486,6 +17574,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist superdos fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:326, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17498,6 +17591,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist cumana fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:327, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17524,6 +17622,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist dragondos_compat fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:328, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17535,6 +17638,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist rsdos fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:329, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17550,6 +17658,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist delta fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:330, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17560,6 +17673,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist rsdos_becker fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:331, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17571,6 +17689,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist mcx128 fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:332, xroar/component_prepare.sh:13-15" - emulator: xroar build: standalone @@ -17582,6 +17705,11 @@ launchers: search_dir: "$roms_path/coco:$roms_path/dragon32:$roms_path/tanodragon:$bios_path" passes_to: romlist mcx128_azerty fails_when_missing: false + installs: + path: $xroar_config + source_ref: "xroar/component_prepare.sh:13-15" + kept_if_present: false + overrides: [] source_ref: "xroar/rd_assets/rd_config/xroar.conf:333, xroar/component_prepare.sh:13-15" - emulator: retroarch build: libretro @@ -17590,6 +17718,11 @@ launchers: - scph5500.bin passes_to: core option duckstation_BIOS.PathNTSCJ fails_when_missing: false + installs: + path: $retroarch_config_core_options + source_ref: "retroarch/component_prepare.sh:24" + kept_if_present: false + overrides: [] source_ref: "retroarch/rd_assets/rd_config/retroarch-core-options.cfg:165, retroarch/component_prepare.sh:24" - emulator: retroarch build: libretro @@ -17598,6 +17731,11 @@ launchers: - scph5501.bin passes_to: core option duckstation_BIOS.PathNTSCU fails_when_missing: false + installs: + path: $retroarch_config_core_options + source_ref: "retroarch/component_prepare.sh:24" + kept_if_present: false + overrides: [] source_ref: "retroarch/rd_assets/rd_config/retroarch-core-options.cfg:166, retroarch/component_prepare.sh:24" - emulator: retroarch build: libretro @@ -17606,6 +17744,11 @@ launchers: - scph5502.bin passes_to: core option duckstation_BIOS.PathPAL fails_when_missing: false + installs: + path: $retroarch_config_core_options + source_ref: "retroarch/component_prepare.sh:24" + kept_if_present: false + overrides: [] source_ref: "retroarch/rd_assets/rd_config/retroarch-core-options.cfg:167, retroarch/component_prepare.sh:24" - emulator: retroarch build: libretro @@ -17614,4 +17757,9 @@ launchers: - scph10000.bin passes_to: core option pcsx2_bios fails_when_missing: false + installs: + path: $retroarch_config_core_options + source_ref: "retroarch/component_prepare.sh:24" + kept_if_present: false + overrides: [] source_ref: "retroarch/rd_assets/rd_config/retroarch-core-options.cfg:515, retroarch/component_prepare.sh:24" diff --git a/platforms/rocknix.yml b/platforms/rocknix.yml index b01c2b45d..9f85b7126 100644 --- a/platforms/rocknix.yml +++ b/platforms/rocknix.yml @@ -570,6 +570,11 @@ launchers: passes_to: retroarch.cfg system_directory = "~/roms/bios", systemfiles_in_content_dir = "false" fails_when_missing: false + installs: + path: /storage/.config/retroarch/retroarch.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/libretro/retroarch/sources/AMD64/retroarch.cfg:3395-3396,\ \ projects/ROCKNIX/packages/emulators/libretro/retroarch/sources/H700/retroarch.cfg:711-712,\ \ projects/ROCKNIX/packages/emulators/libretro/retroarch/sources/RK3326/retroarch.cfg:716-717,\ @@ -594,7 +599,13 @@ launchers: search_dir: /storage/roms/bios passes_to: "AmigaA1200-default.uae kickstart_rom_file (amiberry -f)" fails_when_missing: false - depends_on_option: game name matches AGA|CD32 + depends_on_option: "game name matches AGA|CD32, content not booted with --autoload,\ + \ a WHDLoad .lha or .zip (start_amiberry.sh:90, 129)" + installs: + path: /tmp/emulation/amiberry/.amiberry_conf.uae + source_ref: "projects/ROCKNIX/packages/emulators/standalone/amiberry/scripts/start_amiberry.sh:64" + kept_if_present: false + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/amiberry/scripts/start_amiberry.sh:17,\ \ 62-69, projects/ROCKNIX/packages/emulators/standalone/amiberry/config/conf/AmigaA1200-default.uae:114" - emulator: amiberry @@ -606,7 +617,13 @@ launchers: search_dir: /storage/roms/bios passes_to: "AmigaA500-default.uae kickstart_rom_file (amiberry -f)" fails_when_missing: false - depends_on_option: game name does not match AGA|CD32 + depends_on_option: "game name does not match AGA|CD32, content not booted with --autoload,\ + \ a WHDLoad .lha or .zip (start_amiberry.sh:90, 129)" + installs: + path: /tmp/emulation/amiberry/.amiberry_conf.uae + source_ref: "projects/ROCKNIX/packages/emulators/standalone/amiberry/scripts/start_amiberry.sh:67" + kept_if_present: false + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/amiberry/scripts/start_amiberry.sh:17,\ \ 62-69, projects/ROCKNIX/packages/emulators/standalone/amiberry/config/conf/AmigaA500-default.uae:114" - emulator: amiberry @@ -645,6 +662,11 @@ launchers: search_dir: /storage/roms/bios passes_to: "Atari-ST-default.cfg [ROM] szTosImageFileName (--configfile)" fails_when_missing: false + installs: + path: /tmp/hatari/.hatari-temp.cfg + source_ref: "projects/ROCKNIX/packages/emulators/standalone/hatarisa/scripts/start_hatarisa.sh:35" + kept_if_present: false + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/hatarisa/config/conf/Atari-ST-default.cfg:200,\ \ projects/ROCKNIX/packages/emulators/standalone/hatarisa/scripts/start_hatarisa.sh:35,\ \ 65" @@ -652,13 +674,20 @@ launchers: build: standalone kind: fixed_name names: [] - passes_to: melonDS.ini BIOS9Path, BIOS7Path, FirmwarePath, DSiBIOS9Path, DSiBIOS7Path, - DSiFirmwarePath, DSiNANDPath left empty + passes_to: melonDS.ini BIOS9Path, BIOS7Path, FirmwarePath, DSiNANDPath left empty fails_when_missing: false depends_on_option: direct_boot = 0 sets ExternalBIOSEnable=1, otherwise 0 device: AMD64 - source_ref: "projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/AMD64/melonDS.ini:84-90,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/package.mk:60, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:41,\ + installs: + path: /storage/.config/melonDS/melonDS.ini + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:20,\ + \ 34" + kept_if_present: true + overrides: [] + source_ref: "projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/AMD64/melonDS.ini:84-86,\ + \ 90, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/package.mk:60,\ + \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:41,\ \ 71-73" - emulator: melonds build: standalone @@ -667,24 +696,28 @@ launchers: - bios9.bin - bios7.bin - firmware.bin - - dsi_bios9.bin - - dsi_bios7.bin - - dsi_firmware.bin - dsi_nand.bin search_dir: /storage/roms/bios - passes_to: melonDS.ini BIOS9Path, BIOS7Path, FirmwarePath, DSiBIOS9Path, DSiBIOS7Path, - DSiFirmwarePath, DSiNANDPath + passes_to: melonDS.ini BIOS9Path, BIOS7Path, FirmwarePath, DSiNANDPath fails_when_missing: false depends_on_option: direct_boot = 0 sets ExternalBIOSEnable=1, otherwise 0 device: RK3399, RK3566, RK3576, RK3588, S922X, SDM845, SM4450, SM6115, SM8250, SM8550, SM8650, SM8750 - source_ref: "projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/InputPlumber/melonDS.ini:94-100,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3399/melonDS.ini:93-99,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3566/melonDS.ini:93-99,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3588/melonDS.ini:93-99,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/S922X/melonDS.ini:95-101,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/SM4450/melonDS.ini:90-96,\ - \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/package.mk:60, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:41,\ + installs: + path: /storage/.config/melonDS/melonDS.ini + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:20,\ + \ 34" + kept_if_present: true + overrides: [] + source_ref: "projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/InputPlumber/melonDS.ini:94-96,\ + \ 100, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3399/melonDS.ini:93-95,\ + \ 99, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3566/melonDS.ini:93-95,\ + \ 99, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/RK3588/melonDS.ini:93-95,\ + \ 99, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/S922X/melonDS.ini:95-97,\ + \ 101, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/config/SM4450/melonDS.ini:90-92,\ + \ 96, projects/ROCKNIX/packages/emulators/standalone/melonds-sa/package.mk:60,\ + \ projects/ROCKNIX/packages/emulators/standalone/melonds-sa/scripts/start_melonds.sh:41,\ \ 71-73" - emulator: dsperate build: standalone @@ -701,6 +734,12 @@ launchers: passes_to: "dsperate.ini [paths] bios9, bios7, firmware, bios9i, bios7i, dsi_firmware,\ \ dsi_nand (--config)" fails_when_missing: false + installs: + path: /storage/.config/dsperate/dsperate.ini + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/dsperate-sa/scripts/start_dsperate.sh:19" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/dsperate-sa/config/H700/dsperate.ini:11-17,\ \ projects/ROCKNIX/packages/emulators/standalone/dsperate-sa/config/InputPlumber/dsperate.ini:11-17,\ \ projects/ROCKNIX/packages/emulators/standalone/dsperate-sa/config/RK3326/dsperate.ini:11-17,\ @@ -716,7 +755,13 @@ launchers: - gba_bios.bin search_dir: /storage/roms/bios passes_to: "config.toml [general] bios_path" - fails_when_missing: false + fails_when_missing: true + installs: + path: /storage/.config/nanoboyadvance/config.toml + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/nanoboyadvance-sa/scripts/start_nanoboyadvance.sh:12" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/nanoboyadvance-sa/config/config.toml:2,\ \ projects/ROCKNIX/packages/emulators/standalone/nanoboyadvance-sa/package.mk:30" - emulator: xemu @@ -731,6 +776,13 @@ launchers: passes_to: "xemu.toml [sys.files] bootrom_path, flashrom_path, eeprom_path, hdd_path\ \ (copied at each launch)" fails_when_missing: false + installs: + path: /storage/.config/xemu/xemu.toml + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/xemu-sa/scripts/start_xemu.sh:15,\ + \ 19" + kept_if_present: false + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/xemu-sa/config/AMD64/xemu.toml:28-31,\ \ projects/ROCKNIX/packages/emulators/standalone/xemu-sa/config/SM4450/xemu.toml:29-32,\ \ projects/ROCKNIX/packages/emulators/standalone/xemu-sa/config/SM8250/xemu.toml:29-32,\ @@ -747,6 +799,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg gba.bios fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 729, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -758,6 +816,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg md.cdbios fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 1050, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -769,6 +833,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg nes.ggrom fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 2292, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -781,6 +851,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg pce.cdbios, pce.gecdbios fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 3309, 3342, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -792,6 +868,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg pce_fast.cdbios fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 4128, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -803,6 +885,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg pcfx.bios fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 4611, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -816,6 +904,12 @@ launchers: search_dir: /storage/roms/bios/ passes_to: mednafen.cfg psx.bios_eu, psx.bios_jp, psx.bios_na fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 7366-7370, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: mednafen @@ -834,6 +928,12 @@ launchers: passes_to: mednafen.cfg ss.bios_jp, ss.bios_na_eu, ss.bios_stv_eu, ss.bios_stv_jp, ss.bios_stv_na, ss.cart.kof95_path, ss.cart.ultraman_path fails_when_missing: false + installs: + path: /storage/.config/mednafen/mednafen.cfg + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:21" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/mednafen/config/common/mednafen.template:570,\ \ 9818-9820, 9824-9828, 9834-9836, projects/ROCKNIX/packages/emulators/standalone/mednafen/scripts/start_mednafen.sh:19-21" - emulator: yabasanshiro @@ -861,6 +961,13 @@ launchers: passes_to: "settings.ini [BIOS] SearchDirectory = /storage/roms/bios, [BIOS] PathNTSCU,\ \ PathNTSCJ, PathPAL unset" fails_when_missing: false + installs: + path: /storage/.config/duckstation/settings.ini + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/duckstation-sa/scripts/start_duckstation.sh:19,\ + \ 22" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/duckstation-sa/config/AMD64/settings.ini:134,\ \ projects/ROCKNIX/packages/emulators/standalone/duckstation-sa/config/H700/settings.ini:24,\ \ projects/ROCKNIX/packages/emulators/standalone/duckstation-sa/config/InputPlumber/settings.ini:29-32,\ @@ -878,6 +985,13 @@ launchers: passes_to: "PCSX2.ini [Folders] Bios = /storage/roms/bios/armsx2, [Filenames] BIOS\ \ unset" fails_when_missing: false + installs: + path: /storage/.config/ARMSX2/inis/PCSX2.ini + source_ref: "projects/ROCKNIX/packages/sysutils/systemd/scripts/userconfig-setup:13,\ + \ projects/ROCKNIX/packages/emulators/standalone/armsx2-sa/scripts/start_armsx2.sh:11,\ + \ 16" + kept_if_present: true + overrides: [] source_ref: "projects/ROCKNIX/packages/emulators/standalone/armsx2-sa/config/S922X/ARMSX2/inis/PCSX2.ini:21,\ \ 475, projects/ROCKNIX/packages/emulators/standalone/armsx2-sa/config/inputplumber/ARMSX2/inis/PCSX2.ini:21,\ \ 473, projects/ROCKNIX/packages/emulators/standalone/armsx2-sa/package.mk:117-118" diff --git a/schemas/emulator.schema.json b/schemas/emulator.schema.json index 7de174331..7bb563009 100644 --- a/schemas/emulator.schema.json +++ b/schemas/emulator.schema.json @@ -11,15 +11,16 @@ ], "allOf": [ { - "comment": "A build reference documents why a pin is held: it never stands without the pin_frozen that says so.", + "comment": "A build reference documents why a pin is held, or the build config_reads are read at: it never stands without the pin_frozen or the config_reads that say so.", "if": { "required": [ "pin_build" ] }, "then": { - "required": [ - "pin_frozen" + "anyOf": [ + {"required": ["pin_frozen"]}, + {"required": ["config_reads"]} ] } }, @@ -1078,14 +1079,36 @@ "standalone_directories": { "type": "array", "items": { - "type": "string" + "oneOf": [ + {"type": "string"}, + { + "type": "object", + "additionalProperties": false, + "required": ["handle", "source_ref"], + "properties": { + "handle": {"type": "string", "minLength": 1}, + "source_ref": {"type": "string", "minLength": 1, "description": "Where the build reads the handle and resolves its files against it"} + } + } + ] }, "description": "What the standalone build resolves standalone_path against, as its code names it: a directory ($XDG_DATA_HOME/flycast), a setting (Dreamcast.BiosPath), an environment variable or the function returning the directory. A platform launcher record that links or passes a folder of its BIOS tree under one of these puts the standalone files in that folder." }, "standalone_pools": { "type": "object", "additionalProperties": { - "type": "string" + "oneOf": [ + {"type": "string"}, + { + "type": "object", + "additionalProperties": false, + "required": ["folder", "source_ref"], + "properties": { + "folder": {"type": "string"}, + "source_ref": {"type": "string", "minLength": 1, "description": "Where the build reads the setting as a search list"} + } + } + ] }, "description": "Settings the standalone build reads as a list of directories it searches one after the other, each mapped to the subfolder of the layout (relative to standalone_directories, empty for the whole of it) its directories stand for: openMSX's filepool entries are searched like share/systemroms, XRoar's rompath entries hold the ROMs themselves. A file in any entry is read, so several platform records naming entries give the first one a pack can fill." }, @@ -1101,7 +1124,7 @@ "pin_build": { "type": "array", "minItems": 1, - "description": "The build file each platform that ships a pin_frozen build reads its revision from, so check_freshness can read it again where the platform's YAML now stands and say when the platform builds another revision.", + "description": "The build file each platform that ships a pin_frozen build, or the build a config_reads entry is read at, reads its revision from, so check_freshness can read it again where the platform's YAML now stands and say when the platform builds another revision.", "items": { "type": "object", "additionalProperties": false, @@ -1135,6 +1158,37 @@ } } }, + "config_reads": { + "type": "array", + "description": "The configs the build loads and the keys it opens a file from, as a platform launcher record citing a config needs them: link (c) is where the file is found and loaded, link (d) where each key is read and its value opened. An entry naming platforms is read at their pin_build revision, one naming none at source_commit.", + "items": { + "type": "object", + "additionalProperties": false, + "required": ["file", "source_ref", "keys"], + "dependentRequired": {"revision": ["platforms", "revision_from"]}, + "properties": { + "file": {"type": "string", "minLength": 1, "description": "The config as the code finds it: a name, a glob for any file a flag passes (*.uae), a path, the flag itself, \"command line\" or \"core options\""}, + "platforms": {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true, "description": "Registry slugs of the platforms shipping the build these refs are read at, each with a pin_build entry unless revision names the build"}, + "revision": {"type": "string", "pattern": "^[0-9a-f]{40}$", "description": "The commit these refs are read at, for platforms installing a package no build file of theirs pins (RetroBat's stable archives, a Flathub app)"}, + "revision_from": {"type": "string", "minLength": 1, "description": "Where revision was read: the version string of the shipped binary, the Flathub manifest commit"}, + "source_ref": {"type": "string", "minLength": 1}, + "keys": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "additionalProperties": false, + "required": ["key", "source_ref"], + "properties": { + "key": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "items": {"type": "string", "minLength": 1}, "minItems": 1}], "description": "Spelled as a launcher record's passes_to spells it: [Section] Key, or Key"}, + "source_ref": {"type": "string", "minLength": 1}, + "condition": {"type": "string", "description": "What else the read depends on"} + } + } + } + } + } + }, "pin_follows": { "type": "string", "description": "Why source_commit follows the branch tip although a single platform ships the profile: that platform builds the tip, cited by its build file. Without it or pin_frozen, a bump refuses a profile one platform ships." diff --git a/schemas/platform.schema.json b/schemas/platform.schema.json index c0a972192..1b3fb9479 100644 --- a/schemas/platform.schema.json +++ b/schemas/platform.schema.json @@ -341,6 +341,29 @@ "type": "string", "description": "Devices whose shipped config this record reads, comma-separated, set only where the configs of a package differ between devices" }, + "installs": { + "type": "object", + "additionalProperties": false, + "required": ["path", "source_ref"], + "properties": { + "path": {"type": "string", "minLength": 1, "description": "Where the config the record cites lands on the device, as the platform's code spells it"}, + "source_ref": {"type": "string", "minLength": 1, "description": "path:lines of the code that puts it there"} + }, + "description": "How the config file a record cites reaches the emulator: link (a) of the evidence a config record carries" + }, + "kept_if_present": { + "type": "boolean", + "description": "True when the install leaves a file already there in place (cp if absent, rsync --ignore-existing): the record holds on a fresh install" + }, + "overrides": { + "type": "array", + "items": {"type": "string"}, + "description": "path:lines of launch code that rewrites the record's keys or replaces the installed config, empty when the launch path writes neither: link (b)" + }, + "choices_from": { + "type": "string", + "description": "path:lines of the feature or option file (es_features, a core .opt) listing the values the option the record writes takes. It is never the record's evidence: source_ref cites the code writing the choice" + }, "source_ref": { "type": "string", "description": "path:lines in the platform's repository at the pinned revision" diff --git a/scripts/common.py b/scripts/common.py index 414fd5f4d..41bd5f527 100644 --- a/scripts/common.py +++ b/scripts/common.py @@ -3210,11 +3210,12 @@ def standalone_bindings_for( ``systems`` are those the entry is launched for (entry_launch_systems). """ - declared = profile.get("standalone_directories") or [] - pools = profile.get("standalone_pools") or {} + from launchers import directory_handles, pool_folders, standalone_bindings # noqa: PLC0415 + + declared = directory_handles(profile) + pools = pool_folders(profile) if not declared and not pools: return {} - from launchers import standalone_bindings # noqa: PLC0415 names = {emu_name, *(str(c) for c in profile.get("cores") or [])} layout = [ @@ -3330,9 +3331,9 @@ def _build_layouts( # The layout folders a search setting stands for (standalone_pools): # bound, the launcher passes the setting and the default is not read. - pool_folders = { - str(v).strip("/") for v in (profile.get("standalone_pools") or {}).values() - } - {""} + from launchers import pool_folders as _pool_folders # noqa: PLC0415 + + pool_folders = {v.strip("/") for v in _pool_folders(profile).values()} - {""} def passed_setting(entry: dict) -> bool: layout = str(standalone_layout_path(entry, profile) or "") diff --git a/scripts/cross_reference.py b/scripts/cross_reference.py index 2f993d8c8..580bacd39 100644 --- a/scripts/cross_reference.py +++ b/scripts/cross_reference.py @@ -56,9 +56,11 @@ from common import ( from hashing import parse_hash_list from launchers import ( LauncherLayer, + bound_launchers, catalogued_model_files, declared_destinations, held_record, + launcher_unproven, name_settings, set_by, setting_readers, @@ -1095,6 +1097,8 @@ def _settle_launcher_places( # The --json key of the launcher reads category, beside the emulator keys. LAUNCHER_READS_KEY = "_launcher_reads_not_held" +# The --json key of the launcher records a config file does not prove. +LAUNCHER_UNPROVEN_KEY = "_launcher_unproven" # A package record names no file: it records what a package builds. _NAMELESS_KINDS = frozenset({"package"}) @@ -1238,7 +1242,9 @@ def launcher_reads_not_held( rows: list[dict] = [] for platform, config in configs.items(): by_key: dict[str, dict] = {} - for record in config.get("launchers") or []: + # A record resting on a config file it cannot prove reads nothing + # yet: it is reported apart (launcher_unproven). + for record in bound_launchers(config, profiles): names = launcher_file_names(record) if not names: continue @@ -1331,6 +1337,25 @@ def launcher_reads_not_held( return rows +def print_launcher_unproven(rows: list[dict]) -> None: + """The launcher records resting on a config file the code does not prove. + + Neither a pack, a manifest nor a severity reads them: each is listed + with the links it lacks. + """ + if not rows: + return + platforms = sorted({r["platform"] for r in rows}) + noun = "platform" if len(platforms) == 1 else "platforms" + print(f"\nLauncher records unproven: {len(rows)} across {len(platforms)} {noun}") + for platform in platforms: + print(f"\n{platform}") + for row in (r for r in rows if r["platform"] == platform): + print(f" [{row['index']}] {row['emulator']} {row['kind']}: {row['passes_to']}") + for link in row["missing"]: + print(f" missing {link}") + + def print_launcher_reads(rows: list[dict]) -> None: """The launcher reads gap category, after the profile gaps. @@ -1649,8 +1674,25 @@ def main() -> None: db, all_profiles, registry, emulator or "", ) + unproven = [ + row for row in launcher_unproven( + { + name: load_platform_config(name, args.platforms_dir) + for name in (selected or list_registered_platforms(args.platforms_dir)) + }, + all_profiles, + ) + if not emulator or any( + emulator in LauncherLayer._profiles_named(part, all_profiles, set(all_profiles)) + for part in row["emulator"].split(", ") + ) + ] + if args.json: - print(json.dumps({**report, LAUNCHER_READS_KEY: launcher_reads}, indent=2)) + print(json.dumps( + {**report, LAUNCHER_READS_KEY: launcher_reads, LAUNCHER_UNPROVEN_KEY: unproven}, + indent=2, + )) else: if emulator: scope = emulator @@ -1660,6 +1702,7 @@ def main() -> None: scope = "all emulators" print_report(report, scope, show_clean=bool(args.emulator)) print_launcher_reads(launcher_reads) + print_launcher_unproven(unproven) if __name__ == "__main__": diff --git a/scripts/generate_site.py b/scripts/generate_site.py index 8272392a7..e1fb0141f 100644 --- a/scripts/generate_site.py +++ b/scripts/generate_site.py @@ -95,6 +95,7 @@ import siteentries import siteinputs import retired_files import siteagents +import sitediagrams import sitestarlight import sitesteps from siteexports import generate_exports_page, load_export_reports @@ -416,8 +417,8 @@ def _date_line() -> str: def _stat(value: str, label: str) -> list[str]: return [ markup.block_open("div", 'class="rb-stat"'), - f'{value}', - f'{label}', + # One line, a space between: the page text read "168/168Coverage". + f'{value} {label}', "", "", ] @@ -3646,13 +3647,15 @@ def _served_line(f: dict, declared_sha1: str = "") -> str: def _launcher_refs(config: dict) -> dict[str, list[str]]: """Entry name, casefolded -> each launcher record that opens it, rendered.""" from launchers import _names as launcher_names + from launchers import bound_launchers from sitesources import launcher_ref_markdown, list_source # Every scraper reads its launchers in the repository and at the revision - # of the list it scrapes, so `source` pins each source_ref. + # of the list it scrapes, so `source` pins each source_ref. A record a + # config file does not prove opens nothing: it is listed apart. source = list_source(str(config.get("source") or "")) found: dict[str, list[str]] = {} - for record in config.get("launchers") or []: + for record in bound_launchers(config): if not isinstance(record, dict) or not record.get("source_ref"): continue text = (f"{_escape_tags(str(record.get('emulator', '')))} at " @@ -3664,6 +3667,31 @@ def _launcher_refs(config: dict) -> dict[str, list[str]]: return found +UNPROVEN_TITLE = "Launcher records a config does not prove" + + +def _launcher_unproven_section(config: dict) -> list[str]: + """The platform's launcher records resting on a config the code does not prove. + + A config file is proof only when the code installing it and the code + reading it are shown: these records place no file. + """ + from launchers import launcher_unproven + from sitesources import launcher_ref_markdown, list_source + + rows = launcher_unproven({str(config.get("_key") or ""): config}) + if not rows: + return [] + source = list_source(str(config.get("source") or "")) + body = [ + f"- {_escape_tags(row['emulator'])}, `{_escape_tags(row['passes_to'] or row['kind'])}` " + f"at {launcher_ref_markdown(source, row['source_ref'])}: " + f"{_escape_tags('; '.join(row['missing']))}" + for row in rows + ] + return ["", *markup.details("note", f"{UNPROVEN_TITLE} ({len(rows)})", body)] + + # The hash a row shows first, when the list does not say which it checks. _ROW_HASHES = ("sha1", "md5", "sha256", "crc32") # An untested entry whose reason is a hash the bytes do not match. @@ -3802,8 +3830,10 @@ def _platform_file_row(f: dict, cfg_entry: dict, hash_type: str = "", facts.append(_inline_html(_category_evidence_md(f["category_evidence"], launched))) path = _row_path(fname, cfg_entry) - summary = (_text_html(fname) + (f"{_text_html(path)}" if path else "") - + _status_chip(f)) + # Spaces between name, path and status: the summary lays them out as + # columns, and the page text read "SVI603.ROMbios/Machines/...OK". + summary = " ".join([_text_html(fname), *([f"{_text_html(path)}"] if path else []), + _status_chip(f)]) copy = _copy_hash(shown, hashes[shown]) if shown else "" return (f'
{summary}' f'{"
".join(facts)}
{copy}') @@ -3817,14 +3847,8 @@ def _platform_file_list(rows: list[str], has_path: bool, anchor: str) -> list[st """ lines: list[str] = [] if len(rows) >= FILTER_ROWS: - field = f"rb-files-filter-{anchor}" - lines += [ - '
' - f'' - f'' - f'{len(rows):,} rows
', - "", - ] + lines += [siteentries.filter_box(f"rb-files-filter-{anchor}", "files", + ["File", "path", "status", "hash"], len(rows)), ""] kind = "rb-files rb-files-path" if has_path else "rb-files" return [*lines, f'
', *rows, "
"] @@ -4802,6 +4826,7 @@ def generate_platform_page( _render_platform_systems(by_system, config_files, emulator_files, (name, display), moved, config) ) + lines.extend(_launcher_unproven_section(config)) lines.extend(["", _date_line()]) return "\n".join(lines) + "\n" @@ -12497,6 +12522,9 @@ def _generate(args: argparse.Namespace) -> None: source = Path("docs_assets") / folder if source.is_dir(): shutil.copytree(source, public / "assets" / dest, dirs_exist_ok=True) + # The diagrams and the drawn install steps, one SVG per layout and theme. + sitediagrams.write_diagram_files(public / sitediagrams.DIAGRAM_DIR, + {**sitediagrams.figure_files(), **sitesteps.steps_files()}) demo_dest = public / "assets" / "demo" demo_dest.mkdir(parents=True, exist_ok=True) for name in DEMO_ASSETS: diff --git a/scripts/launchers.py b/scripts/launchers.py index 2884035b9..c790af076 100644 --- a/scripts/launchers.py +++ b/scripts/launchers.py @@ -254,11 +254,318 @@ def _names(record: dict) -> list[str]: return names -def launcher_places(config: dict) -> list[LauncherPlace]: +# How a record's passes_to names what carries the file when it names no +# config file: an option on the command line, or a libretro core option. +COMMAND_LINE = "command line" +CORE_OPTIONS = "core options" +_TAIL_WORDS = re.compile(r"\s+(?:unset|left empty)$") +_KEY_TOKEN = re.compile(r"^-{0,2}[\w.$()/\\]+$") + + +def config_target(record: dict) -> tuple[str, list[str]]: + """The config a record writes its file to, and the keys it names there. + + passes_to spells them as describe_keys does: "settings.ini [BIOS] + SearchDirectory, [BIOS] PathNTSCU, PathNTSCJ unset", "command line + -hard", "core option pcsx2_bios", "hatarib_tos = hatarib/". A + part that reads as prose ("only if the file exists") names no key. When + passes_to names no file ("romlist coco"), the file is the one the record + installs and the whole of passes_to is the key. + """ + # A parenthesis says how the file is passed, unless a config variable + # opens it: $(FILE_PATH) is amiberry's. + text = re.sub(r"(?" sets every key before the value. + names = [p.strip() for p in re.split(r"\s*=\s*", chunk)] + if len(names) > 1: + names = names[:-1] + for name in names: + if not _KEY_TOKEN.match(name): + continue + key = f"{section} {name}" if section else name + if key not in keys: + keys.append(key) + return head, keys + + +def _read_keys(read: dict) -> dict[str, str]: + """Each key a config_reads entry says the build reads, to its source_ref.""" + found: dict[str, str] = {} + for entry in read.get("keys") or []: + spelled = entry.get("key") + for key in spelled if isinstance(spelled, list) else [spelled]: + if key: + found[str(key)] = str(entry.get("source_ref") or "") + return found + + +def _handle_refs(profile: dict) -> dict[str, str]: + """The handles a profile names with the code that reads them.""" + found: dict[str, str] = {} + for item in profile.get("standalone_directories") or []: + if isinstance(item, dict) and item.get("source_ref"): + handle = str(item.get("handle") or "").partition(" = ")[0] + found[handle] = str(item["source_ref"]) + for handle, value in (profile.get("standalone_pools") or {}).items(): + if isinstance(value, dict) and value.get("source_ref"): + found[str(handle)] = str(value["source_ref"]) + return found + + +def directory_handles(profile: dict) -> list[str]: + """standalone_directories as handle strings, a {handle, source_ref} item + by its handle.""" + return [ + str(item.get("handle") or "") if isinstance(item, dict) else str(item) + for item in profile.get("standalone_directories") or [] + ] + + +def pool_folders(profile: dict) -> dict[str, str]: + """standalone_pools as handle to subfolder, a {folder, source_ref} value + by its folder.""" + return { + str(handle): str(value.get("folder") or "") if isinstance(value, dict) else str(value) + for handle, value in (profile.get("standalone_pools") or {}).items() + } + + +def _reads_apply(read: dict, profile: dict, platform: str) -> bool: + """Whether a config_reads entry describes the build ``platform`` ships. + + An entry naming platforms is read at their pin_build revision. One that + names none is read at the profile's pin, the build of every platform + with no pin_build of its own or one pinning the same commit. + """ + named = [str(p) for p in read.get("platforms") or []] + if named: + return platform in named + pin = str(profile.get("source_commit") or "") + builds = [b for b in profile.get("pin_build") or [] if b.get("platform") == platform] + return all(pin and str(b.get("value") or "").startswith(pin[:12]) for b in builds) + + +def _file_matches(read_file: str, file: str, record: dict) -> bool: + """Whether a config_reads file is the one a record writes. + + The entry names the file as the build finds it: a name, a glob ("*.uae", + any file the launcher passes), a path, or the flag the launcher passes + it with (amiberry's -f). + """ + from fnmatch import fnmatch # noqa: PLC0415 + + spelled = read_file.rsplit("/", 1)[-1].casefold() + if file and fnmatch(file.casefold(), spelled): + return True + installed = str((record.get("installs") or {}).get("path") or "").rsplit("/", 1)[-1] + if installed and fnmatch(installed.casefold(), spelled): + return True + return read_file.startswith("-") and read_file in str(record.get("passes_to") or "").split() + + +@dataclass(frozen=True) +class ConfigEvidence: + """Whether a launcher record that rests on a config holds, and why not. + + ``config`` holds the parts of its source_ref that cite a config, option + or feature file. A record citing none, and choosing among no listed + option values, rests on code alone and holds. + """ + + config: tuple[str, ...] + missing: tuple[str, ...] + readers: tuple[str, ...] = () + + @property + def proven(self) -> bool: + return not self.missing + + +def _named_profiles(record: dict, profiles: Mapping[str, dict], platform: str) -> list[str]: + """The profiles a record's emulator names, a platform's own build first.""" + found = [] + for part in (e.strip() for e in str(record.get("emulator", "")).split(",")): + named = [ + key for key, profile in profiles.items() + if profile.get("type") not in ("alias", "launcher") + and (key == part or part in {str(c) for c in profile.get("cores") or []}) + ] + own = [k for k in named if platform in (profiles[k].get("built_by") or [])] + found.extend(own or [k for k in named if not profiles[k].get("built_by")]) + return sorted(set(found)) + + +def config_evidence( + record: dict, profiles: Mapping[str, dict], platform: str = "" +) -> ConfigEvidence: + """What a record citing a config file proves, link by link. + + A config file is proof only when the code that installs it and the code + that reads it are shown: (a) the platform installs the file at a path + (``installs``), (b) its launch code was read for what replaces the file + or the key (``overrides``), (c) the emulator loads that file and (d) + reads each key and opens the value (``config_reads`` of its profile, at + the build the platform ships). A feature or option file only lists the + values a menu offers: it goes in ``choices_from``, beside the code that + writes the choice, and such a record needs (c) and (d) too. + """ + from scraper.shell_launchers import config_ref, is_feature_ref # noqa: PLC0415 + + cited = config_ref(str(record.get("source_ref") or "")) + choices = str(record.get("choices_from") or "") + if not cited and not choices: + return ConfigEvidence((), ()) + missing: list[str] = [] + features = [part for part in cited if is_feature_ref(part)] + if features: + missing.append("an option list cited as source, not as choices_from") + shipped = [part for part in cited if not is_feature_ref(part)] + if shipped: + installs = record.get("installs") or {} + if not (installs.get("path") and installs.get("source_ref")): + missing.append("installs: the code that puts the config in place") + if "overrides" not in record: + missing.append("overrides: the launch code read for what replaces it") + file, keys = config_target(record) + if not keys: + missing.append("a key the config hands the file to") + readers: list[str] = [] + uncovered = list(keys) + loaded = False + for key in _named_profiles(record, profiles, platform) or sorted(profiles): + profile = profiles[key] + handles = _handle_refs(profile) + for read in profile.get("config_reads") or []: + if not _reads_apply(read, profile, platform): + continue + if not _file_matches(str(read.get("file") or ""), file, record): + continue + loaded = True + known = _read_keys(read) + before = len(uncovered) + uncovered = [k for k in uncovered if not (known.get(k) or handles.get(k))] + if len(uncovered) < before and key not in readers: + readers.append(key) + if not loaded: + missing.append(f"config_reads: an emulator that loads {file or 'the config'}") + elif uncovered: + missing.append("config_reads: no read of " + ", ".join(uncovered)) + return ConfigEvidence(tuple(cited or [choices]), tuple(missing), tuple(readers)) + + +_DEFAULT_PROFILES: dict[str, dict] | None = None + + +def _profiles_or_repo(profiles: Mapping[str, dict] | None) -> Mapping[str, dict]: + """The profiles given, else this repository's, read once.""" + global _DEFAULT_PROFILES # noqa: PLW0603 + if profiles is not None: + return profiles + if _DEFAULT_PROFILES is None: + from pathlib import Path # noqa: PLC0415 + + from common import load_emulator_profiles # noqa: PLC0415 + + _DEFAULT_PROFILES = load_emulator_profiles( + str(Path(__file__).resolve().parent.parent / "emulators") + ) + return _DEFAULT_PROFILES + + +def _cites_config(record: dict) -> bool: + from scraper.shell_launchers import config_ref # noqa: PLC0415 + + return bool(record.get("choices_from")) or bool(config_ref(str(record.get("source_ref") or ""))) + + +def bound_launchers(config: dict, profiles: Mapping[str, dict] | None = None) -> list[dict]: + """The launcher records a platform's packs, manifests and reports consume. + + A record resting on a config file binds only when config_evidence holds + for it. The repository's profiles are read only when a record cites one. + """ + records = [r for r in config.get("launchers") or [] if isinstance(r, dict)] + if not any(_cites_config(r) for r in records): + return records + known = _profiles_or_repo(profiles) + platform = str(config.get("_key") or "") + return [r for r in records if config_evidence(r, known, platform).proven] + + +def launcher_unproven( + configs: Mapping[str, dict], profiles: Mapping[str, dict] | None = None +) -> list[dict]: + """The records resting on a config file whose evidence does not hold. + + One row per record, with the config parts it cites and each missing + link. Reported apart: no severity, count or exit code reads it. + """ + rows: list[dict] = [] + for platform, config in configs.items(): + records = [r for r in config.get("launchers") or [] if isinstance(r, dict)] + if not any(_cites_config(r) for r in records): + continue + known = _profiles_or_repo(profiles) + for index, record in enumerate(records): + evidence = config_evidence(record, known, str(config.get("_key") or platform)) + if evidence.proven: + continue + rows.append({ + "platform": platform, + "index": index, + "emulator": str(record.get("emulator", "")), + "kind": str(record.get("kind", "")), + "passes_to": str(record.get("passes_to") or ""), + "source_ref": str(record.get("source_ref", "")), + "config": list(evidence.config), + "missing": list(evidence.missing), + }) + return rows + + +def launcher_places( + config: dict, profiles: Mapping[str, dict] | None = None +) -> list[LauncherPlace]: """Every place a platform's launchers open a named file from.""" base = str(config.get("base_destination") or "bios") places: list[LauncherPlace] = [] - for record in config.get("launchers") or []: + for record in bound_launchers(config, profiles): kind = record.get("kind") if kind not in PLACE_KINDS: continue @@ -484,7 +791,9 @@ def _listed_directories(raw: str) -> list[str] | None: return None -def handed_directories(config: dict) -> list[HandedDirectory]: +def handed_directories( + config: dict, profiles: Mapping[str, dict] | None = None +) -> list[HandedDirectory]: """Every whole directory a platform links or passes to a standalone build. A record naming files (gpsp's gba_bios.bin) or one slot of a directory @@ -499,7 +808,7 @@ def handed_directories(config: dict) -> list[HandedDirectory]: natives = native_systems(config) declared = {d.lower() for d in declared_destinations(config)} found: list[HandedDirectory] = [] - for record in config.get("launchers") or []: + for record in bound_launchers(config, profiles): if record.get("build") != "standalone" or record.get("kind") not in HANDED_KINDS: continue if record.get("names") or record.get("slot"): @@ -988,7 +1297,7 @@ class LauncherLayer: db: dict, declared: Iterable[str], ) -> None: - self.places = launcher_places(config) + self.places = launcher_places(config, profiles) self.declared = set(declared) self.declared_folded = {d.lower() for d in self.declared} self.declared_names = {d.rsplit("/", 1)[-1] for d in self.declared} diff --git a/scripts/profile_sync.py b/scripts/profile_sync.py index b10c2531c..94c663b81 100644 --- a/scripts/profile_sync.py +++ b/scripts/profile_sync.py @@ -1047,6 +1047,11 @@ class ProfileReport: new_files_elided: dict[str, int] = field(default_factory=dict) new_hashes: list[dict] | None = None detection_skipped: str | None = None + # config_reads refs written for a build a platform ships, each read at + # that build (pin_build) rather than at source_commit: {platform, + # revision, ref, status, detail}. A status other than BUILD_OK is review + # work. + build_refs: list[dict] = field(default_factory=list) # Skips that say the profile cannot be checked as written: a repository # that no longer answers, no pin to read, a death the forge contradicts. @@ -1070,6 +1075,7 @@ class ProfileReport: + len(self.orphaned) + len(self.stale_prose or ()) + len(self.moved_repos) + + sum(1 for ref in self.build_refs if ref["status"] != "BUILD_OK") ) @@ -1603,6 +1609,81 @@ def moved_repositories( return moved +def shipped_build_holders(profile: dict) -> dict[int, dict]: + """The source_ref holders of config_reads entries naming platforms, by id. + + Such an entry describes the build those platforms ship, so its refs are + read at their pin_build revision, never at source_commit. + """ + found: dict[int, dict] = {} + for read in profile.get("config_reads") or []: + if not isinstance(read, dict) or not read.get("platforms"): + continue + found[id(read)] = read + for key in read.get("keys") or []: + if isinstance(key, dict): + found[id(key)] = read + return found + + +def build_revision(profile: dict, platform: str) -> str | None: + """The emulator revision a platform's pin_build entry names, None when + its value is no revision (a URL, a package name).""" + for build in profile.get("pin_build") or []: + if build.get("platform") != platform: + continue + value = str(build.get("value") or "").strip() + return value if value and re.fullmatch(r"[\w.+-]+", value) else None + return None + + +def _check_build_refs( + profile: dict, + deferred: list[tuple[Citation, dict]], + views: list[RepoView], + fetch: Callable[[upstream.Repo, str, str], list[str] | None], +) -> list[dict]: + """Each deferred config_reads ref read at the build of its platforms. + + The file must exist at that revision and every cited line lie inside + it. The entry declares no value to anchor on, so this is the check a + ref past the end of its file fails (BUILD_GONE), not a content match. + """ + results: list[dict] = [] + for citation, read in deferred: + for platform in read.get("platforms") or []: + revision = str(read.get("revision") or "") or build_revision(profile, str(platform)) + row = {"platform": str(platform), "revision": revision or "", + "ref": citation.ref, "field": citation.field} + if revision is None: + results.append({**row, "status": "BUILD_UNREAD", + "detail": "no pin_build revision for this platform"}) + continue + problems: list[str] = [] + for part in split_source_ref(citation.ref): + role, path = ref_role(part.path) + if " " in path: + # A project word in front (`ROCKNIX patches/x.patch:4`): + # a file of the platform's tree, read with the record. + continue + lines = next( + (found for view in views + if (not role or view.field == role) + and (found := fetch(view.repo, revision, path)) is not None), + None, + ) + if lines is None: + problems.append(f"{part.path} absent at {revision[:12]}") + elif (part.end or part.start or 0) > len(lines): + problems.append(f"{part.raw} past the end ({len(lines)} lines)") + results.append({ + **row, + "status": "BUILD_GONE" if problems else "BUILD_OK", + "detail": "; ".join(problems), + }) + return results + + def build_report( name: str, profile: dict, cache_dir: str, offline: bool = False, text: str | None = None, @@ -1621,7 +1702,13 @@ def build_report( ) modes = {mode for _, mode, _ in declared_repositories(profile) if mode} refs = [] + at_build = shipped_build_holders(profile) + deferred: list[tuple[Citation, dict]] = [] for citation in collect_citations(profile, text): + if citation.kind == "ref" and id(citation.holder) in at_build: + # Written for the build a platform ships: read at pin_build. + deferred.append((citation, at_build[id(citation.holder)])) + continue if citation.kind == "ref": entry = citation.entry display = str(entry.get("name") or "") or citation.field @@ -2204,6 +2291,8 @@ def build_report( ) return result + report.build_refs = _check_build_refs(profile, deferred, views, fetch_from) + staged = [] for entry_name, ref, tokens, hashes, ref_parts, citation in refs: flags = [self_checked(part, tokens) for part in ref_parts] @@ -2335,6 +2424,14 @@ def format_report(report: ProfileReport, changed_only: bool = False) -> str: lines.append(f" {len(report.entries)} refs: {summary}") for line in report.stale_prose or (): lines.append(f" prose under an older pin: {line}") + for ref in report.build_refs: + if changed_only and ref["status"] == "BUILD_OK": + continue + detail = f": {ref['detail']}" if ref["detail"] else "" + lines.append( + f" {ref['status']} at {ref['platform']} build " + f"{ref['revision'][:12] or '-'} {ref['ref']}{detail}" + ) lines.append(f" {report.needs_review()} to review") return "\n".join(lines) diff --git a/scripts/scraper/amberelec_launchers.py b/scripts/scraper/amberelec_launchers.py index 259d46cd4..f4f7819a0 100644 --- a/scripts/scraper/amberelec_launchers.py +++ b/scripts/scraper/amberelec_launchers.py @@ -7,7 +7,7 @@ runs the script its standalone_emulators table names (/usr/bin/.sh, installed from the package). Those scripts, and the configs their packages install, say which file under /storage/roms/bios is opened: yabasanshiro.sh tests saturn_bios.bin and passes it with -b, Hatari's default config names -tos.img, the atari800 core is built to read a config naming its OS ROMs. +tos.img. runemu.py is read with ast, the scripts with shell_launchers' readers. An extractor whose construct is gone raises instead of returning nothing. @@ -26,7 +26,9 @@ try: from .shell_launchers import ( LauncherPatternMissing, Script, + config_placement, describe_keys, + evidence_fields, settings, source_ref, ) @@ -35,7 +37,9 @@ except ImportError: from shell_launchers import ( # type: ignore[no-redef] LauncherPatternMissing, Script, + config_placement, describe_keys, + evidence_fields, settings, source_ref, ) @@ -45,8 +49,8 @@ RUNEMU = "packages/amberelec/sources/scripts/runemu.py" RETROARCH_CFG = "packages/games/tools/retroarch/sources/retroarch.cfg" RETRORUN = "packages/games/tools/retrorun/retrorun.sh" HATARI_CONFIG = "packages/games/emulators/hatarisa/config/conf/Atari-ST-default.cfg" -ATARI800_CONFIG = "packages/amberelec/config/distribution/configs/atari800.cfg" -ATARI800_PATCH = "packages/games/libretro/atari800/patches/atari800-01-add-emuelec-platform.patch" +# The first-boot copy of every package's /usr/config into /storage/.config. +USERCONFIG = "packages/sysutils/systemd/scripts/userconfig-setup" AMIBERRY_PACKAGE = "packages/games/emulators/amiberry/package.mk" AMIBERRY_CONFIGS = "packages/games/emulators/amiberry/config/conf" FREEJ2ME = ( @@ -103,16 +107,35 @@ class Runemu: return path, line +def _evidence( + read: Read, record: Launcher, target: str, keys: list[str], + start: Script | None = None, source_name: str = "", +) -> Launcher: + """A config record with the steps that put its file at ``target``: the + first-boot copy of /usr/config, then the start script's own copy.""" + setup = Script(USERCONFIG, read(USERCONFIG)) + placements = [config_placement(setup, target, required=False, sources=("/usr/config/",))] + if start is not None: + placements.append( + config_placement(start, target, keys, source_name=source_name, required=False) + ) + fields = evidence_fields(placements) + record.installs = fields["installs"] + record.kept_if_present = fields["kept_if_present"] + record.overrides = fields["overrides"] + return record + + def retroarch(read: Read) -> list[Launcher]: """system_directory of the retroarch.cfg the retroarch package installs.""" found = [s for s in settings(read(RETROARCH_CFG)) if s.key == "system_directory"] if len(found) != 1: raise LauncherPatternMissing(RETROARCH_CFG, "one system_directory") - return [Launcher( + return [_evidence(read, Launcher( emulator="retroarch", build="libretro", kind="passes_path", names=[], search_dir=found[0].value, passes_to="retroarch.cfg system_directory", fails_when_missing=False, source_ref=source_ref([(RETROARCH_CFG, [found[0].line])]), - )] + ), "/storage/.config/retroarch/retroarch.cfg", ["system_directory"])] def retrorun(read: Read) -> list[Launcher]: @@ -170,10 +193,12 @@ def hatari(read: Read, runemu: Runemu) -> list[Launcher]: path, table_line = runemu.script("HATARISA") script = Script(path, read(path)) name = posixpath.basename(HATARI_CONFIG) - copied, _ = script.find(rf"^\s*cp\s+\S*/{re.escape(name)}\s", f"cp of {name}") + copied, copy = script.find( + rf"^\s*cp\s+\S*/{re.escape(name)}\s+\"?(\$\{{?\w+\}}?)", f"cp of {name}" + ) passed, _ = script.find(r"\shatari\s+--configfile\s", "hatari --configfile") files, lines = _bios_files(HATARI_CONFIG, read(HATARI_CONFIG)) - return [Launcher( + return [_evidence(read, Launcher( emulator="HATARISA", build="standalone", kind="fixed_name", names=[n for _k, n in files], case_insensitive=False, search_dir=BIOS, passes_to=describe_keys(name, tuple(k for k, _n in files)), @@ -181,24 +206,8 @@ def hatari(read: Read, runemu: Runemu) -> list[Launcher]: source_ref=source_ref([ (RUNEMU, [table_line]), (path, [copied, passed]), (HATARI_CONFIG, lines), ]), - )] - - -def atari800(read: Read) -> list[Launcher]: - """The ROM keys of the config the atari800 core is built to read.""" - patch = Script(ATARI800_PATCH, read(ATARI800_PATCH)) - line, found = patch.find(r'DEFAULT_CFG_NAME="\\"([^"\\]+)\\""', "DEFAULT_CFG_NAME") - built = found.group(1) - if not built.endswith("/" + ATARI800_CONFIG.split("/config/", 1)[1]): - raise LauncherPatternMissing(ATARI800_PATCH, f"DEFAULT_CFG_NAME naming {ATARI800_CONFIG}") - files, lines = _bios_files(ATARI800_CONFIG, read(ATARI800_CONFIG)) - return [Launcher( - emulator="atari800", build="libretro", kind="fixed_name", - names=[n for _k, n in files], case_insensitive=False, search_dir=BIOS, - passes_to=describe_keys(posixpath.basename(ATARI800_CONFIG), tuple(k for k, _n in files)), - fails_when_missing=False, - source_ref=source_ref([(ATARI800_PATCH, [line]), (ATARI800_CONFIG, lines)]), - )] + ), script.expand(copy.group(1), copied, set()), + [f"[{s}] {k}" if s else k for (s, k), _n in files], script, name)] def yabasanshiro(read: Read, runemu: Runemu) -> list[Launcher]: @@ -279,6 +288,15 @@ def amiberry(read: Read, runemu: Runemu) -> list[Launcher]: installed = re.sub(r"^\$\{INSTALL\}", "", link.link) path, table_line = runemu.script("AMIBERRY") script = Script(path, read(path)) + # A WHDLoad archive is booted by --autoload, which builds its own setup + # over the config: the kickstart records hold for the other content. + autoload = [n for n, text in script.code() if re.search(r"amiberry .*--autoload", text)] + if not autoload: + raise script.missing("WHDLoad boot with --autoload") + content = ( + "content not booted with --autoload, a WHDLoad .lha or .zip " + f"({posixpath.basename(path)}:{', '.join(map(str, autoload))})" + ) launchers = [Launcher( emulator="AMIBERRY", build="standalone", kind="links", names=[], case_insensitive=False, search_dir=BIOS, @@ -314,19 +332,23 @@ def amiberry(read: Read, runemu: Runemu) -> list[Launcher]: else: test = _shell_test(script, condition_line) condition = test - launchers.append(Launcher( + target = re.search(r'"?(\$\{?\w+\}?)"?\s*$', line) + if target is None: + raise script.missing(f"destination of the copy at line {number}") + launchers.append(_evidence(read, Launcher( emulator="AMIBERRY", build="standalone", kind="fixed_name", slot=copied.group(1).removesuffix("-default.uae").removeprefix("Amiga"), names=[found[0].value.removeprefix("$(FILE_PATH)/")], case_insensitive=False, search_dir=BIOS, passes_to=f"{copied.group(1)} kickstart_rom_file, $(FILE_PATH) = {rom_path[0].value}", fails_when_missing=False, - depends_on_option=condition, + depends_on_option=f"{condition}, {content}", source_ref=source_ref([ (RUNEMU, [table_line]), (path, [condition_line, number]), (config, [rom_path[0].line, found[0].line]), ]), - )) + ), script.expand(target.group(1), number, set()), ["kickstart_rom_file"], + script, copied.group(1))) if len(launchers) == 1: raise script.missing("cp of a default .uae config") return launchers @@ -420,9 +442,13 @@ def easyrpg(read: Read) -> list[Launcher]: def extract_launchers(read: Read) -> list[dict[str, Any]]: """Every launcher record, read through `read(repo-relative path)`.""" runemu = Runemu(read) + # The atari800.cfg AmberELEC ships names the OS ROMs, but the core opens + # it only under its atari800_cfg option, off by default, and finds the + # ROMs by a scan of the content folder (libretro-atari800 atari.c:512-516, + # 537, libretro_core_options.h:1203): no record reads it. launchers = [ *retroarch(read), *retrorun(read), *mame(runemu), - *atari800(read), *scummvm(read), *freej2me(read), *easyrpg(read), + *scummvm(read), *freej2me(read), *easyrpg(read), *amiberry(read, runemu), *hatari(read, runemu), *pico8(read, runemu), *piemu(read, runemu), *yabasanshiro(read, runemu), ] diff --git a/scripts/scraper/configgen_launchers.py b/scripts/scraper/configgen_launchers.py index 03957145e..4f6d05442 100644 --- a/scripts/scraper/configgen_launchers.py +++ b/scripts/scraper/configgen_launchers.py @@ -39,6 +39,14 @@ class Launcher: machines: list[str] | None = None # The platform systems the record is written for, none for every one. systems: list[str] | None = None + # For a record citing a config: where the platform's code puts it + # ({path, source_ref}), whether that leaves a file already there, and + # the launch code rewriting its keys ([] when none does). + installs: dict[str, str] | None = None + kept_if_present: bool | None = None + overrides: list[str] | None = None + # The feature or option file listing the values the option written takes. + choices_from: str | None = None def entry(self) -> dict[str, Any]: """The platform YAML form, in a fixed key order, unset keys left out.""" @@ -46,7 +54,8 @@ class Launcher: "emulator", "systems", "build", "kind", "slot", "names", "expands", "case_insensitive", "search_dir", "passes_to", "fails_when_missing", "fails_scope", "depends_on_option", - "device", "machines", "source_ref", + "device", "machines", "installs", "kept_if_present", "overrides", + "choices_from", "source_ref", ) return {key: getattr(self, key) for key in order if getattr(self, key) is not None} diff --git a/scripts/scraper/emudeck_launchers.py b/scripts/scraper/emudeck_launchers.py index 2723d62d8..b8f42696f 100644 --- a/scripts/scraper/emudeck_launchers.py +++ b/scripts/scraper/emudeck_launchers.py @@ -44,6 +44,8 @@ BIOS = "${biosPath}" EMULATION_BIOS = "${emulationPath}/bios" STORAGE = "${storagePath}" FLATPAK_DATA = "${HOME}/.var/app/" +# The function every EmuScript installs its Flatpak config with. +CONFIG_EMU_FP = "functions/configEmuFP.sh" # EmuScripts file names that differ from the emulator profile they set up. # The platform and target scrapers both read them here. @@ -95,6 +97,31 @@ def _is_bios(value: str) -> bool: return any(value == root or value.startswith(root + "/") for root in (BIOS, EMULATION_BIOS)) +def with_evidence(tree: RepoTree, script: Script, record: Launcher, config: str) -> Launcher: + """A record citing a shipped config, with the steps that install it. + + configEmuFP rsyncs the repository's configs/ over the Flatpak's: + the _init call overwrites (keeping a .bak), every other call passes + --ignore-existing and leaves the user's file in place. + """ + fp = Script(CONFIG_EMU_FP, tree.read(CONFIG_EMU_FP)) + rsync_line, _ = fp.find(r"^\s*rsync .*\$emudeckBackend/configs/", "rsync of the configs") + keep_line, _ = fp.find(r'overwrite="--ignore-existing"', "--ignore-existing") + calls = {n for n, line in script.code() if re.match(r"\s*configEmuFP\s", line)} + if not calls: + raise script.missing("configEmuFP call") + variable = script.assignment_ending("/" + config) + if variable is None: + raise script.missing(f"config variable for {config}") + record.installs = { + "path": script.expand(variable.value, variable.line, set()), + "source_ref": source_ref([(script.path, calls), (fp.path, {keep_line, rsync_line})]), + } + record.kept_if_present = True + record.overrides = [] + return record + + def _repo_config(script: Script, path: str) -> str: """The repository copy of a Flatpak config EmuDeck installs.""" if not path.startswith(FLATPAK_DATA): @@ -268,7 +295,8 @@ def ares(tree: RepoTree) -> list[Launcher]: raise LauncherPatternMissing(path, f"Firmware path under {old}") for system, found in entries.items(): folder = posixpath.commonpath([posixpath.dirname(t) for _, t, _ in found]) - records.append( + records.append(with_evidence( + tree, script, Launcher( emulator="ares", build="standalone", @@ -281,16 +309,20 @@ def ares(tree: RepoTree) -> list[Launcher]: search_dir=folder, passes_to="settings.bml " + ", ".join(f"{system}/Firmware/{k}" for k, _, _ in found), - ) - ) + ), + posixpath.basename(path), + )) return records def melonds(tree: RepoTree) -> list[Launcher]: """melonDS.ini paths set by changeLine, melonDS.toml paths shipped and rewritten by sed.""" name = "emuDeckMelonDS.sh" - records = setter_records(tree, name, option_key="ExternalBIOSEnable") script = _script(tree, name) + records = [ + with_evidence(tree, script, record, str(record.passes_to or "").split(" ", 1)[0]) + for record in setter_records(tree, name, option_key="ExternalBIOSEnable") + ] # A config whose BIOS keys the setters write again keeps their values. set_by_setters = {file for file, _, _, value, _ in setters(script) if _is_bios(value)} for file, old, new, sed_lines in sed_rewrites(script, "melonDS_init"): @@ -306,22 +338,29 @@ def melonds(tree: RepoTree) -> list[Launcher]: continue folder = posixpath.commonpath([posixpath.dirname(t) for _, t in found]) config = posixpath.basename(path) - option = next((s for s in settings(tree.read(path)) if s.key == "ExternalBIOSEnable"), None) - if option is None: - raise LauncherPatternMissing(path, "ExternalBIOSEnable") + shipped = {s.key: s for s in settings(tree.read(path))} + if "ExternalBIOSEnable" not in shipped or "ConsoleType" not in shipped: + raise LauncherPatternMissing(path, "ExternalBIOSEnable and ConsoleType") + option, console = shipped["ExternalBIOSEnable"], shipped["ConsoleType"] + # The DS keys are read under ExternalBIOSEnable, the DSi keys only + # when the console is a DSi (ConsoleType 1). record = Launcher( emulator="melonds", build="standalone", kind="fixed_name", names=[posixpath.relpath(t, folder) for _, t in found], - source_ref=source_ref( - [(path, {option.line, *(s.line for s, _ in found)}), (script.path, sed_lines)] - ), + source_ref=source_ref([ + (path, {option.line, console.line, *(s.line for s, _ in found)}), + (script.path, sed_lines), + ]), search_dir=folder, passes_to=describe_keys(config, tuple((s.section, s.key) for s, _ in found)), - depends_on_option=f"ExternalBIOSEnable = {option.value} in the shipped {config}", + depends_on_option=( + f"[DS] keys: ExternalBIOSEnable = true, {option.value} in the shipped {config}; " + f"[DSi] keys: ConsoleType = 1, {console.value} in the shipped {config}" + ), ) - records.append(record) + records.append(with_evidence(tree, script, record, config)) if len(records) < 2: raise script.missing("melonDS.toml BIOS paths rewritten by sed") return records diff --git a/scripts/scraper/emuelec_launchers.py b/scripts/scraper/emuelec_launchers.py index f4aed1e60..e52a23fc9 100644 --- a/scripts/scraper/emuelec_launchers.py +++ b/scripts/scraper/emuelec_launchers.py @@ -14,7 +14,7 @@ from __future__ import annotations import posixpath import re -from collections.abc import Callable +from collections.abc import Callable, Iterable from dataclasses import dataclass, field from .configgen_launchers import Launcher @@ -22,6 +22,8 @@ from .rocknix_launchers import fixed_paths from .shell_launchers import ( LauncherPatternMissing, Link, + config_placement, + evidence_fields, RepoTree, Script, describe_keys, @@ -104,6 +106,28 @@ class Runs: return (RUN_EMU, set(self.of(name).lines)) +def _evidence( + record: Launcher, + script: Script, + target: str, + keys: list[str], + source_name: str = "", + rewrites: Iterable[int] = (), +) -> Launcher: + """A config record with the start script lines that put its file in place. + + ``rewrites`` are lines the extractor read as rewriting the record's + values without naming their keys (advmame.sh's sed of /roms/mame). + """ + placement = config_placement(script, target, keys, source_name=source_name) + placement.overrides |= set(rewrites) + fields = evidence_fields([placement]) + record.installs = fields["installs"] + record.kept_if_present = fields["kept_if_present"] + record.overrides = fields["overrides"] + return record + + def _read(tree: RepoTree, path: str) -> Script: return Script(path, tree.read(path)) @@ -317,7 +341,7 @@ def duckstation(tree: RepoTree, runs: Runs) -> list[Launcher]: name = posixpath.basename(script.path) lines = {found[k].line for k in (folder_key, *file_keys) if k in found} unset = describe_keys("", file_keys).strip() - return [ + return [_evidence( Launcher( emulator=runs.emulator(name), build="standalone", @@ -328,8 +352,11 @@ def duckstation(tree: RepoTree, runs: Runs) -> list[Launcher]: ), search_dir=found[folder_key].value, passes_to=f"settings.ini [BIOS] SearchDirectory (-settings), {unset} unset", - ) - ] + ), + script, + script.expand("${CONFIG_DIR}/settings.ini", run_line, set()), + [f"[{s}] {k}" for s, k in (folder_key, *file_keys)], + )] YABASANSHIRO_SCRIPTS = ( @@ -473,7 +500,7 @@ def hatari(tree: RepoTree, runs: Runs) -> list[Launcher]: mk = _read(tree, f"{package}/package.mk") mk_line, _ = mk.find(r"cp -R \$\{PKG_DIR\}/config/\* ", "config install") name = posixpath.basename(script.path) - return [ + return [_evidence( Launcher( emulator=runs.emulator(name), build="standalone", @@ -485,8 +512,12 @@ def hatari(tree: RepoTree, runs: Runs) -> list[Launcher]: ), search_dir=value.search_dir, passes_to=f"{describe_keys(copy.group(1), value.keys)} (--configfile)", - ) - ] + ), + script, + script.expand("${" + copy.group(2) + "}", copy_line, set()), + [f"[{s}] {k}" if s else k for s, k in value.keys], + source_name=copy.group(1), + )] _ADVMAME_SYSTEM = re.compile(r'^\s*if \[\[ "\$\{1\}" = "([\w-]+)" \]\]; then$') @@ -535,29 +566,34 @@ def advancemame(tree: RepoTree, runs: Runs) -> list[Launcher]: (script.path, {run_line, *lines}), ]) - found = [] + target = script.expand("${CONFIG_DIR}/advmame.rc", run_line, set()) + + def proved(record: Launcher, key: str) -> Launcher: + return _evidence(record, script, target, [key], rewrites={sed_line}) + + records = [] for key, folder in value: rewritten = folder.replace(sed.group(1), sed.group(2)) if rewritten != folder: # Every system but the one the script rewrites the key for, and # that system with the rewritten folder. - found.append(Launcher( + records.append(proved(Launcher( emulator=runs.emulator(name), build="standalone", kind="passes_path", names=[], source_ref=refs(test_line, sed_line), search_dir=folder, passes_to=f"advmame.rc {key}", depends_on_option=f"system != {test.group(1)}", - )) - found.append(Launcher( + ), key)) + records.append(proved(Launcher( emulator=runs.emulator(name), build="standalone", kind="passes_path", names=[], source_ref=refs(test_line, sed_line), search_dir=rewritten, passes_to=f"advmame.rc {key}", systems=[test.group(1)], - )) + ), key)) continue - found.append(Launcher( + records.append(proved(Launcher( emulator=runs.emulator(name), build="standalone", kind="passes_path", names=[], source_ref=refs(), search_dir=folder, passes_to=f"advmame.rc {key}", - )) - return found + ), key)) + return records def mame(tree: RepoTree, runs: Runs) -> list[Launcher]: @@ -594,42 +630,11 @@ def mame(tree: RepoTree, runs: Runs) -> list[Launcher]: ) if not records: raise script.missing(f"copy into {BIOS_ROOT}") - ini = next((r for r in records if r.names == ["mame*"]), None) - if ini is None: - raise script.missing("copy of mame.ini") - option_path = f"{package}/config/MAME/MAME.opt" - option = next( - (s for s in settings(tree.read(option_path)) if s.key == "mame_read_config"), None - ) - if option is None: - raise LauncherPatternMissing(option_path, "mame_read_config") - ini_path = f"{package}/config/ini/mame.ini" - # MAME reads from the folders its *path options name and writes to its - # *_directory ones. - folders = [ - (s, [p for p in s.value.split(";") if _under(p)]) - for s in settings(tree.read(ini_path), separator=" ") - if s.key.endswith("path") - ] - folders = [(s, parts) for s, parts in folders if parts] - if not folders: - raise LauncherPatternMissing(ini_path, f"path under {BIOS_ROOT}") - for setting, parts in folders: - for part in parts: - records.append( - Launcher( - emulator=emulator, - build="libretro", - kind="passes_path", - names=[], - source_ref=source_ref( - [(ini_path, {setting.line}), (option_path, {option.line})] - ) + f", {ini.source_ref}", - search_dir=part.rstrip("/"), - passes_to=f"mame.ini {setting.key}", - depends_on_option=f"mame_read_config = {option.value}", - ) - ) + # mame.ini hands the core no folder: MAME.opt turns on + # mame_mame_paths_enable, so the core passes no path option + # (libretro mame src/osd/libretro/libretro-internal/retro_init.cpp:554-555), + # and the ini MAME would read sits under a working directory no launcher + # sets (src/emu/emuopts.cpp:49). Only the copies are the launcher's. return records @@ -644,6 +649,16 @@ def scummvm(tree: RepoTree, runs: Runs) -> list[Launcher]: core_line, core = script.find(r"-L /tmp/cores/(\w+)_libretro\.so", "libretro start") arm_line, arm = script.find(r'^\s*"(\w+)"\)', "setup arm", core_line) copy_line, copy = script.find(r"^\s*cp (\S+) (\S+)$", "copy into the BIOS folder", arm_line) + launched = sorted({ + m.group(1) for _, line in runs.script.code() + if (m := re.search(rf"\b{re.escape(name)} (\w+)", line)) + }) + if not launched: + raise runs.script.missing(f"start of {name} with an action") + action = f"{name} {arm.group(1)}" + if arm.group(1) not in launched: + # The copy runs from the setup action, never from a launch. + action += f", an action no launch runs ({RUN_EMU.rsplit('/', 1)[-1]} passes {', '.join(launched)})" used = {copy_line} source = script.expand(copy.group(1), copy_line, used) target = script.expand(copy.group(2), copy_line, used) @@ -669,7 +684,7 @@ def scummvm(tree: RepoTree, runs: Runs) -> list[Launcher]: search_dir=posixpath.dirname(source), passes_to=target, fails_when_missing=False, - depends_on_option=f"{name} {arm.group(1)}", + depends_on_option=action, ), ] diff --git a/scripts/scraper/knulli_launchers.py b/scripts/scraper/knulli_launchers.py index e5a138afd..d2e464324 100644 --- a/scripts/scraper/knulli_launchers.py +++ b/scripts/scraper/knulli_launchers.py @@ -1001,6 +1001,14 @@ def boot_disks( emulator = ( ", ".join(_caller_cores(cg, spec.caller)) if spec.caller else cg.emulator(module) ) + if spec.caller and spec.feature[:2] == ("libretro", "cores"): + # The option is offered for one core of the system: es_features + # lists it under that core, the other cores the generator serves + # never see it (KNULLI's macintosh offers mame alone). + core = spec.feature[2] + if core not in emulator.split(", "): + src.fail(f"es_features offers the option for {core}, which the generator does not serve") + emulator = core found = 0 for chain in ast.walk(src.tree): if not ( @@ -1054,10 +1062,10 @@ def boot_disks( expands={option: values}, case_insensitive=False, search_dir=cg.bios, passes_to=f"command line {flag}", fails_when_missing=False, depends_on_option=f"{option} ({' and '.join(tests)})", - source_ref=", ".join([ - src.ref([*spans, src.span(statement), _lines(added)]), - f"{ES_FEATURES}:{lines[0]}-{lines[1]}" if not listed else "", - ]).rstrip(", "), + # The values the menu offers come from es_features.yml; + # the generator writing the choice is the evidence. + choices_from=None if listed else f"{ES_FEATURES}:{lines[0]}-{lines[1]}", + source_ref=src.ref([*spans, src.span(statement), _lines(added)]), )) if not found: src.fail("names no BIOS file from an option value") diff --git a/scripts/scraper/retrobat_launchers.py b/scripts/scraper/retrobat_launchers.py index 5405580c6..a49709194 100644 --- a/scripts/scraper/retrobat_launchers.py +++ b/scripts/scraper/retrobat_launchers.py @@ -14,6 +14,11 @@ import bisect import re from collections.abc import Callable, Iterator +try: + from .shell_launchers import is_feature_ref, split_ref +except ImportError: + from shell_launchers import is_feature_ref, split_ref # type: ignore[no-redef] + GENERATORS = "emulatorLauncher/Generators" FEATURES = ".emulationstation/es_features.cfg" @@ -1254,6 +1259,11 @@ def xemu(sources: dict[str, Source]) -> list[Record]: ) flash = src.find(r'isOptSet\("(xemu_flashrom)"\)', "xemu_flashrom") + # The flashrom is written outside a Chihiro launch only. + chihiro_set = src.find(r"(_chihiro) = \(([^;]+)\);", "Chihiro test") + chihiro_guard = src.find_all( + rf"if \(!{chihiro_set.group(1)}\)", "flashrom guard", end=flash.start() + )[-1] flash_default = src.find( r'ini\.WriteValue\("([\w.]+)", "(flashrom_path)", "\'" \+ Path\.Combine\(flashromPath, "([^"]+)"\)', "flashrom default", @@ -1267,7 +1277,10 @@ def xemu(sources: dict[str, Source]) -> list[Record]: "core_option", _unique([flash_default.group(3), *choices]), source_ref( - (src.path, [src.lines(flash.start(), flash_default.end())]), + (src.path, [ + src.lines(chihiro_set.start(), chihiro_set.end()), + src.lines(chihiro_guard.start(), flash_default.end()), + ]), (features.path, [choice_lines]), ), case_insensitive=True, @@ -1277,7 +1290,7 @@ def xemu(sources: dict[str, Source]) -> list[Record]: f" default {flash_default.group(3)}" ), fails_when_missing="path written without an existence check", - depends_on_option=flash.group(1), + depends_on_option=f"{flash.group(1)}, not ({chihiro_set.group(2)})", ) ) @@ -3890,4 +3903,23 @@ def extract_launchers(texts: dict[str, str]) -> list[Record]: if missing: raise LauncherPatternMissing(missing[0], "source file") sources = {path: Source(path, text) for path, text in texts.items()} - return [record for extractor in EXTRACTORS for record in extractor(sources)] + return [ + _choices_apart(record) for extractor in EXTRACTORS for record in extractor(sources) + ] + + +def _choices_apart(record: Record) -> Record: + """The es_features.cfg part of a record's source_ref, moved to choices_from. + + The feature file lists the values a menu option offers. The generator + writing the choice is the record's evidence, never the list. + """ + parts = split_ref(str(record["source_ref"])) + listed = [p for p in parts if is_feature_ref(p)] + if not listed: + return record + code = [p for p in parts if not is_feature_ref(p)] + if not code: + raise LauncherPatternMissing(listed[0], "generator code beside the option list") + moved = {k: v for k, v in record.items() if k != "source_ref"} + return {**moved, "choices_from": ", ".join(listed), "source_ref": ", ".join(code)} diff --git a/scripts/scraper/retrodeck_launchers.py b/scripts/scraper/retrodeck_launchers.py index 51b6cf06b..3d7ed0a52 100644 --- a/scripts/scraper/retrodeck_launchers.py +++ b/scripts/scraper/retrodeck_launchers.py @@ -35,6 +35,8 @@ PLACEHOLDER = "RETRODECKBIOSDIR" # gzdoom/component_prepare.sh:27 rewrites to $roms_path. ROMS_PLACEHOLDER = "RETRODECKROMSDIR" CORE_OPTIONS = "retroarch/rd_assets/rd_config/retroarch-core-options.cfg" +# XRoar ROM lists RetroDECK's xroar.conf defines that no machine looks up. +UNREAD_ROMLISTS = frozenset({"coco1", "coco1e", "coco1e_ext", "coco2", "coco2_ext", "coco2b"}) # The component that runs libretro cores. LIBRETRO_COMPONENT = "retroarch" # Values of a core option that name a file rather than a setting. @@ -301,6 +303,19 @@ class Component: if copied is None: raise LauncherPatternMissing(f"{script.path}:{number}", f"no preset copied to {target}") preset = f"{self.name}/rd_assets/rd_config/{copied[1]}" + # The reset copies the preset over the user's file, then fills its + # placeholders: that is the install, and nothing keeps an older file. + evidence: dict[str, Any] = { + "installs": { + "path": target, + "source_ref": source_ref( + [(script.path, copied[0])] + + [(script.path, line) for _v, line in substitutions.values()] + ), + }, + "kept_if_present": False, + "overrides": self.launch_rewrites(target), + } text = self.read(preset) if text is None: raise LauncherPatternMissing(preset, "preset is missing") @@ -332,10 +347,10 @@ class Component: self.record( "passes_path", [], [(preset, line_no)] + applied, search_dir=value, passes_to=f"{self.config_name(target)} {where}", - fails_when_missing=False, + fails_when_missing=False, **evidence, ) if key == "rompath": - self.romlists(preset, text, value, applied) + self.romlists(preset, text, value, applied, evidence) if not found: raise LauncherPatternMissing(preset, f"no {PLACEHOLDER} line") @@ -349,10 +364,28 @@ class Component: found[m.group(1)] = (f"${m.group(2)}", line_no) return found + def launch_rewrites(self, target: str) -> list[str]: + """The sed lines of the component launcher rewriting ``target``.""" + path = f"{self.name}/component_launcher.sh" + text = self.read(path) + if text is None: + return [] + return [ + source_ref([(path, number)]) + for number, line in enumerate(text.splitlines(), 1) + if re.search(r"\bsed\b.*\s-i\b", line) and target in line + ] + def romlists( - self, preset: str, text: str, rompath: str, applied: list[tuple[str, int]] + self, preset: str, text: str, rompath: str, applied: list[tuple[str, int]], + evidence: dict[str, Any], ) -> None: - """XRoar's `romlist NAME=a,b,@other`: the names tried for each ROM, in order.""" + """XRoar's `romlist NAME=a,b,@other`: the names tried for each ROM, in order. + + A list no XRoar machine or cartridge looks up is no read: coco1, + coco1e, coco1e_ext, coco2, coco2_ext and coco2b are defined by XRoar + (src/xroar.c:663-670) and named by nothing else. + """ lists: dict[str, tuple[int, list[str]]] = {} for line_no, line in enumerate(text.splitlines(), 1): found = re.match(r"^romlist\s+([\w-]+)=(.*)$", line.strip()) @@ -375,10 +408,12 @@ class Component: return list(dict.fromkeys(names)) for name, (line_no, _items) in lists.items(): + if name in UNREAD_ROMLISTS: + continue self.record( "names_searched", expand(name, (name,)), [(preset, line_no)] + applied, slot=name, search_dir=rompath, passes_to=f"romlist {name}", - fails_when_missing=False, + fails_when_missing=False, **evidence, ) def read_launcher(self) -> None: @@ -480,6 +515,7 @@ def core_options(read: Read) -> list[Launcher]: ] if not copied: raise LauncherPatternMissing(prepare_path, "the core options preset is never copied") + target = _words(prepare.splitlines()[copied[0] - 1].strip())[-1] records = [] for line_no, line in enumerate(text.splitlines(), 1): found = re.match(r'^([\w.-]+)\s*=\s*"([^"]*)"$', line.strip()) @@ -489,6 +525,8 @@ def core_options(read: Read) -> list[Launcher]: records.append(Launcher( emulator=LIBRETRO_COMPONENT, build="libretro", kind="core_option", names=[value], passes_to=f"core option {key}", fails_when_missing=False, + installs={"path": target, "source_ref": source_ref([(prepare_path, copied[0])])}, + kept_if_present=False, overrides=[], source_ref=source_ref([(CORE_OPTIONS, line_no), (prepare_path, copied[0])]), )) if not records: diff --git a/scripts/scraper/retropie_launchers.py b/scripts/scraper/retropie_launchers.py index 1f48b28c0..e6462323c 100644 --- a/scripts/scraper/retropie_launchers.py +++ b/scripts/scraper/retropie_launchers.py @@ -94,6 +94,11 @@ class Launcher: passes_to: str | None = None fails_when_missing: bool | str | None = None depends_on_option: str | None = None + # For a record citing a config: where the platform's code puts it, whether + # that leaves a file already there, and the launch code rewriting it. + installs: dict[str, str] | None = None + kept_if_present: bool | None = None + overrides: list[str] | None = None lines: list[tuple[str, int]] = field(default_factory=list, repr=False) def entry(self) -> dict[str, Any]: @@ -101,7 +106,8 @@ class Launcher: order = ( "emulator", "package", "repo", "systems", "build", "kind", "slot", "names", "case_insensitive", "search_dir", "passes_to", - "fails_when_missing", "depends_on_option", "source_ref", + "fails_when_missing", "depends_on_option", "installs", "kept_if_present", + "overrides", "source_ref", ) return {key: getattr(self, key) for key in order if getattr(self, key) is not None} diff --git a/scripts/scraper/rocknix_launchers.py b/scripts/scraper/rocknix_launchers.py index 303d92365..eb18cba3e 100644 --- a/scripts/scraper/rocknix_launchers.py +++ b/scripts/scraper/rocknix_launchers.py @@ -18,6 +18,7 @@ from dataclasses import dataclass try: from .configgen_launchers import Launcher + from .shell_launchers import config_placement, evidence_fields from .shell_launchers import ( LauncherPatternMissing, Link, @@ -30,6 +31,7 @@ try: ) except ImportError: from configgen_launchers import Launcher + from shell_launchers import config_placement, evidence_fields # type: ignore[no-redef] from shell_launchers import ( LauncherPatternMissing, Link, @@ -46,6 +48,9 @@ DEVICES = f"{ROCKNIX}/devices" STANDALONE = f"{ROCKNIX}/packages/emulators/standalone" RETROARCH = f"{ROCKNIX}/packages/emulators/libretro/retroarch" BIOS_ROOT = "/storage/roms/bios" +CONFIG_ROOT = "/storage/.config" +# The first-boot step copying every package's /usr/config to /storage/.config. +USERCONFIG = f"{ROCKNIX}/packages/sysutils/systemd/scripts/userconfig-setup" Lines = list[tuple[str, set[int]]] @@ -186,6 +191,38 @@ def bios_keys(tree: RepoTree, paths: list[str], root: str = BIOS_ROOT) -> list[t return keys +def with_evidence( + tree: RepoTree, + record: Launcher, + target: str, + keys: list[str], + start: Script | None = None, + writers: tuple[str, ...] = (), + source_name: str = "", +) -> Launcher: + """A config record with the steps that put its file at ``target``. + + The first boot copies /usr/config to /storage/.config, leaving a file + already there. A start script can copy or generate it again, and its + sed lines rewriting one of the record's keys are the overrides. + """ + setup = Script(USERCONFIG, tree.read(USERCONFIG)) + placements = [config_placement(setup, target, required=False, sources=("/usr/config/",))] + if start is not None: + placements.append(config_placement( + start, target, keys, writers, source_name, required=False + )) + fields = evidence_fields(placements) + record.installs = fields["installs"] + record.kept_if_present = fields["kept_if_present"] + record.overrides = fields["overrides"] + return record + + +def _keys(value: FixedPaths) -> list[str]: + return [f"[{section}] {key}" if section else key for section, key in value.keys] + + def config_records( tree: RepoTree, emulator: str, @@ -193,10 +230,17 @@ def config_records( file: str, passes_to_suffix: str = "", depends_on_option: str | None = None, + target: str = "", + start: Script | None = None, + unread: Callable[[tuple[str, str]], bool] = lambda key: False, ) -> list[Launcher]: - """fixed_name records for the bios paths of a config installed per device.""" + """fixed_name records for the bios paths of a config installed per device. + + ``unread`` drops the keys the shipped configs leave the emulator + reading no file from. + """ configs = device_configs(tree, package, file) - keys = bios_keys(tree, [c.path for c in configs]) + keys = [k for k in bios_keys(tree, [c.path for c in configs]) if not unread(k)] name = posixpath.basename(file) def read(path: str, text: str) -> tuple[object, set[int]]: @@ -206,7 +250,8 @@ def config_records( for device, value, refs in per_device(tree, configs, f"{package}/package.mk", read): assert isinstance(value, FixedPaths) described = describe_keys(name, value.keys) - records.append( + records.append(with_evidence( + tree, Launcher( emulator=emulator, build="standalone", @@ -219,8 +264,11 @@ def config_records( ), device=device, depends_on_option=depends_on_option, - ) - ) + ), + target or f"{CONFIG_ROOT}/{posixpath.basename(package)}/{name}", + _keys(value), + start, + )) return records @@ -241,7 +289,8 @@ def retroarch(tree: RepoTree) -> list[Launcher]: for device, value, refs in per_device(tree, configs, f"{RETROARCH}/package.mk", read): assert isinstance(value, tuple) values = dict(value) - records.append( + records.append(with_evidence( + tree, Launcher( emulator="retroarch", build="libretro", @@ -251,8 +300,10 @@ def retroarch(tree: RepoTree) -> list[Launcher]: search_dir=values["system_directory"], passes_to="retroarch.cfg " + ", ".join(f'{k} = "{v}"' for k, v in value), device=device, - ) - ) + ), + f"{CONFIG_ROOT}/retroarch/retroarch.cfg", + [k for k, _ in value], + )) return records @@ -275,6 +326,19 @@ def amiberry(tree: RepoTree) -> list[Launcher]: ) used: set[int] = {test_line, then_line, else_line, other_line, sed_line} root = script.expand("${" + sed.group(2) + "}", sed_line, used) + written = re.search(r'"?(\$\{?\w+\}?)"?\s*$', script.lines[then_line - 1]) + if written is None: + raise script.missing("destination of the config copy") + target = script.expand(written.group(1), then_line, set()) + # A WHDLoad archive is booted by --autoload, which builds its own setup + # (kickstart included) over the config: the record holds for floppies. + autoload = [n for n, line in script.code() if re.search(r"amiberry .*--autoload", line)] + if not autoload: + raise script.missing("WHDLoad boot with --autoload") + content = ( + "content not booted with --autoload, a WHDLoad .lha or .zip " + f"({posixpath.basename(script.path)}:{', '.join(map(str, autoload))})" + ) records = [] for config, condition in ( (then.group(1), f"game name matches {test.group(1)}"), @@ -290,7 +354,8 @@ def amiberry(tree: RepoTree) -> list[Launcher]: raise LauncherPatternMissing(path, f"key naming a file under {sed.group(1)}") value, lines = fixed_paths(found, keys, path) slot = re.fullmatch(r"Amiga(\w+)-default\.uae", config) - records.append( + records.append(with_evidence( + tree, Launcher( emulator="amiberry", build="standalone", @@ -300,9 +365,13 @@ def amiberry(tree: RepoTree) -> list[Launcher]: slot=slot.group(1) if slot else config, search_dir=value.search_dir, passes_to=f"{describe_keys(config, value.keys)} (amiberry -f)", - depends_on_option=condition, - ) - ) + depends_on_option=f"{condition}, {content}", + ), + target, + _keys(value), + script, + source_name=config, + )) mk = Script(f"{package}/package.mk", tree.read(f"{package}/package.mk")) links = mk.links(BIOS_ROOT, fixed={"INSTALL": ""}) if not links: @@ -375,7 +444,11 @@ def hatari(tree: RepoTree) -> list[Launcher]: if not keys: raise LauncherPatternMissing(path, f"key naming a file under {BIOS_ROOT}") value, lines = fixed_paths(found, keys, path) - return [ + copied = re.search(r'"?(\$\{?\w+\}?)"?\s*$', script.lines[copy_line - 1]) + if copied is None: + raise script.missing("destination of the default config copy") + return [with_evidence( + tree, Launcher( emulator="hatari", build="standalone", @@ -384,8 +457,12 @@ def hatari(tree: RepoTree) -> list[Launcher]: source_ref=source_ref([(path, lines), (script.path, {copy_line, run_line})]), search_dir=value.search_dir, passes_to=f"{describe_keys(copy.group(1), value.keys)} (--configfile)", - ) - ] + ), + script.expand(copied.group(1), copy_line, set()), + _keys(value), + script, + source_name=copy.group(1), + )] def melonds(tree: RepoTree) -> list[Launcher]: @@ -406,7 +483,22 @@ def melonds(tree: RepoTree) -> list[Launcher]: rf"^\s*{test.group(1)}=\$\(get_setting (\w+) ", f"setting read into {test.group(1)}" ) condition = f"{setting.group(1)} = {test.group(2)} sets ExternalBIOSEnable=1, otherwise 0" - records = config_records(tree, "melonds", package, "melonDS.ini", depends_on_option=condition) + configs = [c.path for c in device_configs(tree, package, "melonDS.ini")] + # melonDS opens the DSi BIOS and firmware keys only under + # DSiExternalBIOSEnable, off unless a config sets it. + dsi_external = any( + s.key == "DSiExternalBIOSEnable" and s.value not in ("", "0") + for path in configs for s in settings(tree.read(path)) + ) + + def unread(key: tuple[str, str]) -> bool: + return not dsi_external and key[1] in ("DSiBIOS9Path", "DSiBIOS7Path", "DSiFirmwarePath") + + conf_line, conf = script.find(r'^\s*CONF_DIR="([^"]+)"', "CONF_DIR") + records = config_records( + tree, "melonds", package, "melonDS.ini", depends_on_option=condition, + target=f"{conf.group(1)}/melonDS.ini", start=script, unread=unread, + ) for record in records: record.source_ref += ( f", {source_ref([(script.path, {setting_line, test_line, enable_line})])}" @@ -420,7 +512,10 @@ def dsperate(tree: RepoTree) -> list[Launcher]: f"{package}/scripts/start_dsperate.sh", tree.read(f"{package}/scripts/start_dsperate.sh") ) run_line, _ = script.find(r"/usr/bin/dsperate --config ", "dsperate --config") - records = config_records(tree, "dsperate", package, "dsperate.ini", " (--config)") + records = config_records( + tree, "dsperate", package, "dsperate.ini", " (--config)", + target=script.expand("${DSPERATE_INI}", run_line, set()), start=script, + ) for record in records: record.source_ref += f", {source_ref([(script.path, {run_line})])}" return records @@ -434,7 +529,10 @@ def xemu(tree: RepoTree) -> list[Launcher]: copy_line, _ = script.find( r'cp -r "\$\{SOURCE_DIR\}/\$\{XEMU_INI\}"', "xemu.toml copy at launch" ) - records = config_records(tree, "xemu", package, "xemu.toml", " (copied at each launch)") + records = config_records( + tree, "xemu", package, "xemu.toml", " (copied at each launch)", + target=script.expand("${CONF_DIR}/${XEMU_INI}", copy_line, set()), start=script, + ) for record in records: record.source_ref += f", {source_ref([(script.path, {copy_line})])}" return records @@ -452,7 +550,9 @@ def nanoboyadvance(tree: RepoTree) -> list[Launcher]: mk_line, _ = Script(mk_path, tree.read(mk_path)).find( r"config/config\.toml", "config.toml install" ) - return [ + start_path = f"{package}/scripts/start_nanoboyadvance.sh" + return [with_evidence( + tree, Launcher( emulator="nanoboyadvance", build="standalone", @@ -461,8 +561,14 @@ def nanoboyadvance(tree: RepoTree) -> list[Launcher]: source_ref=source_ref([(path, lines), (mk_path, {mk_line})]), search_dir=value.search_dir, passes_to=describe_keys("config.toml", value.keys), - ) - ] + # NanoBoyAdvance exits when its BIOS cannot be read + # (src/platform/sdl/main.cpp:180-185 at the build ROCKNIX ships). + fails_when_missing=True, + ), + f"{CONFIG_ROOT}/nanoboyadvance/config.toml", + _keys(value), + Script(start_path, tree.read(start_path)), + )] def mednafen(tree: RepoTree) -> list[Launcher]: @@ -486,7 +592,9 @@ def mednafen(tree: RepoTree) -> list[Launcher]: modules: dict[str, list[Setting]] = {} for setting in firmware: modules.setdefault(setting.key.split(".", 1)[0], []).append(setting) - return [ + home = script.expand("${MEDNAFEN_HOME}", gen_line, set()) + return [with_evidence( + tree, Launcher( emulator="mednafen", build="standalone", @@ -501,9 +609,12 @@ def mednafen(tree: RepoTree) -> list[Launcher]: slot=module, search_dir=folder.value, passes_to="mednafen.cfg " + ", ".join(s.key for s in group), - ) - for module, group in modules.items() - ] + ), + f"{home}/mednafen.cfg", + [s.key for s in group], + script, + writers=("mednafen_gen_config.sh",), + ) for module, group in modules.items()] def yabasanshiro(tree: RepoTree) -> list[Launcher]: @@ -549,6 +660,8 @@ def directory_records( file: str, folder_key: tuple[str, str], file_keys: tuple[tuple[str, str], ...], + target: str = "", + start: str = "", ) -> list[Launcher]: """scans_dir records: the config hands a directory and leaves the file keys empty.""" configs = device_configs(tree, package, file) @@ -568,7 +681,8 @@ def directory_records( records = [] for device, folder, refs in per_device(tree, configs, f"{package}/package.mk", read): passes = f"{name} [{folder_key[0]}] {folder_key[1]} = {folder}, {unset} unset" - records.append( + records.append(with_evidence( + tree, Launcher( emulator=emulator, build="standalone", @@ -578,8 +692,11 @@ def directory_records( search_dir=folder, passes_to=passes, device=device, - ) - ) + ), + target, + [f"[{s}] {k}" for s, k in (folder_key, *file_keys)], + Script(start, tree.read(start)) if start else None, + )) return records @@ -591,6 +708,8 @@ def duckstation(tree: RepoTree) -> list[Launcher]: "settings.ini", ("BIOS", "SearchDirectory"), (("BIOS", "PathNTSCU"), ("BIOS", "PathNTSCJ"), ("BIOS", "PathPAL")), + f"{CONFIG_ROOT}/duckstation/settings.ini", + f"{STANDALONE}/duckstation-sa/scripts/start_duckstation.sh", ) @@ -602,6 +721,8 @@ def armsx2(tree: RepoTree) -> list[Launcher]: "ARMSX2/inis/PCSX2.ini", ("Folders", "Bios"), (("Filenames", "BIOS"),), + f"{CONFIG_ROOT}/ARMSX2/inis/PCSX2.ini", + f"{STANDALONE}/armsx2-sa/scripts/start_armsx2.sh", ) diff --git a/scripts/scraper/shell_launchers.py b/scripts/scraper/shell_launchers.py index 5aa9a56bf..d847b2666 100644 --- a/scripts/scraper/shell_launchers.py +++ b/scripts/scraper/shell_launchers.py @@ -63,6 +63,48 @@ def source_ref(parts: Iterable[tuple[str, Iterable[int]]]) -> str: ) +# The files a platform ships as configuration: an emulator reads them, the +# platform's code never runs them. Batocera's .yml lists and an EmuELEC .opt +# only offer the values a menu option takes. +_CONFIG_FILE = re.compile( + r"\.(?:ini|cfg|conf|rc|rc_\w+|opt|bml|toml|uae|template|yml|yaml)$", re.IGNORECASE +) +_FEATURE_FILE = re.compile(r"(?:^|/)es_features[^/]*$|\.opt$", re.IGNORECASE) + + +def split_ref(ref: str) -> list[str]: + """The parts of a source_ref, each "path:lines", a bare line span + continuing the path before it.""" + parts: list[str] = [] + for part in (p.strip() for p in ref.split(", ")): + if not part: + continue + if re.fullmatch(r"\d+(?:-\d+)?", part) and parts: + parts[-1] += f", {part}" + else: + parts.append(part) + return parts + + +def ref_path(part: str) -> str: + return part.rsplit(":", 1)[0] if re.search(r":\d", part) else part + + +def config_ref(ref: str) -> list[str]: + """The parts of a source_ref that cite a config, option or feature file. + + Such a part proves what the file says, never that an emulator reads it: + melonDS.ini keys are written on ROCKNIX for a build that reads them only + when another key is set. + """ + return [part for part in split_ref(ref) if _CONFIG_FILE.search(ref_path(part))] + + +def is_feature_ref(part: str) -> bool: + """Whether a source_ref part cites a file that lists a menu option's values.""" + return bool(_FEATURE_FILE.search(ref_path(part))) + + @dataclass class Word: """A shell word: as written, and with quotes removed.""" @@ -394,6 +436,149 @@ def _merge_links(links: list[Link]) -> list[Link]: return [link for link in merged if id(link) not in folded] +_COPY = re.compile(r"(?:^|[\s;&|(])(cp|rsync|install|mv)\s") +_GUARD = re.compile(r"\[\[?\s*!\s+-[fde]\s+(\S+)\s*\]") + + +@dataclass +class ConfigPlacement: + """How a start script puts a config where the emulator reads it. + + ``install`` are the lines copying it there, ``kept_if_present`` whether + every such copy runs only when the file (or its folder) is absent, and + ``overrides`` the sed lines rewriting one of the record's keys in it. + """ + + script: str + path: str + install: set[int] + kept_if_present: bool + overrides: set[int] + + +def _bare_key(key: str) -> str: + return key.rsplit("] ", 1)[-1].rsplit("/", 1)[-1].strip() + + +def _guarded(script: Script, number: int, target: str) -> bool: + """Whether a line runs only when target, or a folder above it, is absent.""" + + def covers(found: re.Match[str], at: int) -> bool: + guarded = script.expand(words(found.group(1))[0].text, at, set()).rstrip("/") + return target == guarded or target.startswith(guarded + "/") + + line = script.lines[number - 1] + if any(covers(m, number) for m in _GUARD.finditer(line)): + return True + depth = 0 + for at in range(number - 1, 0, -1): + text = script.lines[at - 1].strip() + if re.match(r"fi\b", text): + depth += 1 + elif re.match(r"if\b", text): + if depth: + depth -= 1 + continue + return any(covers(m, at) for m in _GUARD.finditer(text)) + return False + + +def config_placement( + script: Script, + target: str, + keys: Iterable[str] = (), + writers: Iterable[str] = (), + source_name: str = "", + required: bool = True, + sources: tuple[str, ...] = (), +) -> ConfigPlacement: + """The lines of a start script that install ``target`` and rewrite its keys. + + A copy installs the target when its destination is the file or a folder + above it. ``writers`` are other commands that write the file (ROCKNIX + generates mednafen.cfg with mednafen_gen_config.sh). A copy guarded by + `[ ! -f X ]` or `[ ! -d X ]` on the target or a folder above it, or made + with cp -n or rsync --ignore-existing, leaves a file already there. + """ + install: set[int] = set() + kept = True + overrides: set[int] = set() + bare = {_bare_key(k) for k in keys} - {""} + writer = re.compile("|".join(re.escape(w) for w in writers)) if writers else None + for number, line in script.code(): + if (copy := _COPY.search(line)) or (writer and writer.search(line)): + if copy: + args = [] + for word in words(line[copy.start(1):])[1:]: + # The command ends at a separator or a redirection. + if word.raw in {";", "&&", "||", "|"} or re.match(r"\d*>", word.raw): + break + args.append(word.text) + operands = [a for a in args if not a.startswith("-")] + if not operands: + continue + destination = script.expand(operands[-1], number, set()).rstrip("/") + source = script.expand(operands[0], number, set()).rstrip("/") + hits = target == destination or target.startswith(destination + "/") or ( + target.startswith(f"{destination}/{source.rsplit('/', 1)[-1]}") + ) + # A copy of another file into the same place is another + # record's: amiberry copies the A500 or the A1200 setup. + named = source.rsplit("/", 1)[-1] + if not hits or (source_name and "." in named and named != source_name): + continue + # A named file copied into a folder above the target is + # another file of that folder (ARMSX2's secrets.ini). + if ( + not source_name and "." in named and "*" not in named + and destination != target and named != target.rsplit("/", 1)[-1] + ): + continue + if sources and not source.startswith(sources): + continue + skip = "-n" in args or "--ignore-existing" in args + else: + skip = False + install.add(number) + if not (skip or _guarded(script, number, target)): + kept = False + elif re.search(r"\bsed\b.*\s-i\b|\bsed -i", line) and bare: + expanded = script.expand(line, number, set()) + if target in expanded or target.rsplit("/", 1)[-1] in expanded: + if any(re.search(rf"\b{re.escape(k)}\b", expanded) for k in bare): + overrides.add(number) + if not install and required: + raise script.missing(f"install of {target}") + return ConfigPlacement(script.path, target, install, kept, overrides) + + +def evidence_fields( + placements: Iterable[ConfigPlacement], + installed: Iterable[tuple[str, Iterable[int]]] = (), +) -> dict: + """The installs, kept_if_present and overrides fields of a config record. + + ``placements`` are the steps that put the file in place, in the order + they run (a first-boot copy, then the start script). ``installed`` are + the build steps that put it where they copy it from (a package.mk copy + into /usr/config). + """ + placements = list(placements) + steps = [p for p in placements if p.install] + if not steps: + raise LauncherPatternMissing(placements[0].path if placements else "", "install") + return { + "installs": { + "path": steps[-1].path, + "source_ref": source_ref([*installed, *((p.script, p.install) for p in steps)]), + }, + "kept_if_present": all(p.kept_if_present for p in steps), + "overrides": [ + source_ref([(p.script, {line})]) for p in placements for line in sorted(p.overrides) + ], + } + + @dataclass class Setting: section: str diff --git a/scripts/site_markdown.py b/scripts/site_markdown.py index 4f99d03cd..6ce944994 100644 --- a/scripts/site_markdown.py +++ b/scripts/site_markdown.py @@ -123,7 +123,10 @@ class _Converter(HTMLParser): self._emit(f"**{' '.join(name.split())}:**") self._block() return - if self.skip or tag in SKIPPED or attr.get("aria-hidden") == "true" \ + # A `hidden` element is chrome the page's script shows (a filter + # box, the file picker, a setup's install chooser): a tab panel, + # hidden too, was read above. + if self.skip or tag in SKIPPED or attr.get("aria-hidden") == "true" or "hidden" in attr \ or classes & {"sr-only", "sl-anchor-link", "copy", "rb-anchor"}: if tag not in ("br", "img", "hr", "input", "wbr"): self.skip += 1 diff --git a/scripts/sitediagrams.py b/scripts/sitediagrams.py index 09e78ddfd..aa192d101 100644 --- a/scripts/sitediagrams.py +++ b/scripts/sitediagrams.py @@ -9,14 +9,20 @@ A page asks for a diagram with an HTML comment on a line of its own:: -``resolve_images`` replaces the comment with the figure. The SVG is inline -so its text takes the page font and its colours come from the theme -variables in ``docs_assets/extra.css``: it follows the palette toggle, which -an ```` cannot. Presentation attributes give the same drawing a -readable default when the SVG is opened on its own. +``resolve_images`` replaces the comment with the figure. Each drawing is +an SVG file shown through ````, so the page text holds its words once: +an inline SVG put every label of both layouts, its title and its desc into +what a screen reader, a copy, a text dump or a crawler reads, next to the +prose that already says them. A file reads no stylesheet of the page, so it +is written once per theme with the colours retrobios.css gives the +``rb-d-*`` classes (``THEMES``), and the stylesheet shows the one of the +current theme. Presentation attributes give the same drawing a readable +default when the SVG is opened on its own. -Every figure carries two layouts, wide and narrow, and the stylesheet shows -one: a 720-unit drawing scaled to a phone would print 9 px text. +Every figure carries two layouts, wide and narrow, and ```` picks +one: a 720-unit drawing scaled to a phone would print 9 px text. The +drawings are ``alt=""``: the figure says what they show once, in a +screen-reader line, and the caption under them. """ from __future__ import annotations @@ -296,22 +302,112 @@ def grid(boxes: list[Box], per_row: int, total: float) -> tuple[float, float, li return total, y - gap_y + 1, out -def svg(figure: Figure, layout: str, suffix: str) -> str: - """One layout of *figure* as a standalone, accessible SVG element.""" - width, height, body = (figure.wide if layout == "wide" else figure.narrow)() - base = f"rb-fig-{figure.image_id}{suffix}-{layout}" +def svg_document(width: float, height: float, title: str, desc: str, body: list[str], + base: str) -> str: + """A drawing as a standalone, accessible SVG element.""" return ( f'' - f'{escape(figure.title)}' - f'{escape(figure.desc)}' + f'aria-labelledby="{base}-t {base}-d" font-family="{FONT}">' + f'{escape(title)}' + f'{escape(desc)}' + "".join(body) + "" ) +def svg(figure: Figure, layout: str, suffix: str = "") -> str: + """One layout of *figure* as a standalone, accessible SVG element.""" + width, height, body = (figure.wide if layout == "wide" else figure.narrow)() + return svg_document(width, height, figure.title, figure.desc, body, + f"rb-fig-{figure.image_id}{suffix}-{layout}") + + +# The colours retrobios.css gives a diagram, per theme: --rb-diagram-* and +# --rb-text-secondary, then the text and background Starlight resolves +# --sl-color-text and --sl-color-bg to (props.css: gray-2 and black, whose +# values swap with the theme). An SVG shown through reads none of them. +THEMES: dict[str, dict[str, str]] = { + "dark": {"text": "#c1c3c8", "bg": "#17181c", "fill": "#252838", "stroke": "#7c82a3", + "accent": "#aebcff", "muted": "#a6adc8"}, + "light": {"text": "#353841", "bg": "#ffffff", "fill": "#f5f6fa", "stroke": "#8c92ac", + "accent": "#3b3f7a", "muted": "#546e7a"}, +} +# Where the files are served, under the site's public folder. +DIAGRAM_DIR = "assets/diagrams" +# retrobios.css shows the narrow layout below this width. +NARROW_MEDIA = "(max-width: 37.5em)" + + +def themed(document: str, theme: str) -> str: + """*document* with the theme's colours, the rules retrobios.css gives + the .rb-diagram classes on the page.""" + c = THEMES[theme] + style = ( + f"" + ) + head = document.index(">") + 1 + return document[:head] + style + document[head:] + + +def _size(document: str) -> tuple[str, str]: + match = re.match(r']*?width="([\d.]+)" height="([\d.]+)"', document) + if not match: + raise ValueError("an SVG document without its size") + return match.group(1), match.group(2) + + +def diagram_files(stem: str, layouts: dict[str, str]) -> dict[str, str]: + """The files of one drawing: *layouts* maps wide and narrow to its SVG, + each written once per theme.""" + return {f"{stem}-{layout}-{theme}.svg": themed(document, theme) + "\n" + for layout, document in layouts.items() for theme in THEMES} + + +def pictures(stem: str, layouts: dict[str, str]) -> str: + """The drawing on the page: one per theme, the narrow layout + under NARROW_MEDIA. Each image is alt="", the figure says the words.""" + (wide_w, wide_h), (narrow_w, narrow_h) = _size(layouts["wide"]), _size(layouts["narrow"]) + out = [] + for theme in THEMES: + url = markup.site_href(f"{DIAGRAM_DIR}/{stem}") + out.append( + f'' + f'' + f'' + ) + return "".join(out) + + +def _layouts(figure: Figure) -> dict[str, str]: + return {layout: svg(figure, layout) for layout in ("wide", "narrow")} + + +def figure_files() -> dict[str, str]: + """Every figure's files, by name under DIAGRAM_DIR.""" + return {name: text for image_id in IMAGE_IDS + for name, text in diagram_files(image_id, _layouts(figures()[image_id])).items()} + + +def write_diagram_files(directory: Path, files: dict[str, str]) -> None: + """*files* under *directory*, and no other SVG: a drawing renamed or + dropped leaves no file behind.""" + directory.mkdir(parents=True, exist_ok=True) + for stale in directory.glob("*.svg"): + if stale.name not in files: + stale.unlink() + for name, text in sorted(files.items()): + path = directory / name + if not path.is_file() or path.read_text(encoding="utf-8") != text: + path.write_text(text, encoding="utf-8") + + # Data @@ -667,18 +763,20 @@ _INLINE_ESCAPES = str.maketrans({"_": "_", "*": "*", "`": "`", "[": def figure_html(image_id: str, occurrence: int = 1, inline: bool = False) -> str: figure = figures()[image_id] suffix = "" if occurrence == 1 else f"-{occurrence}" - drawings = svg(figure, "wide", suffix) + svg(figure, "narrow", suffix) + drawings = pictures(image_id, _layouts(figure)) + said = f'{escape(figure.desc)}' caption = escape(figure.caption) anchor = f"rb-fig-{image_id}{suffix}" if inline: html = ( f'' - f'{drawings}{caption}' + f'{drawings} {said} {caption}' ) return html.translate(_INLINE_ESCAPES) return ( f'
\n' f"{drawings}\n" + f"{said}\n" f"
{caption}
\n" "
" ) diff --git a/scripts/siteentries.py b/scripts/siteentries.py index 7fc5dc31c..c417c74bb 100644 --- a/scripts/siteentries.py +++ b/scripts/siteentries.py @@ -47,12 +47,21 @@ def filter_placeholder(labels: list[str]) -> str: def filter_box(ident: str, heading: str, labels: list[str], rows: int, noun: str = "rows") -> str: - """The filter box rehype-stack-tables.mjs writes above a long table.""" + """The filter box rehype-stack-tables.mjs writes above a long table. + + It is `hidden` until site.ts wires it: without the script it filters + nothing, so a reader with no JavaScript, a text dump and the search + skip it while the rows stay. retrobios.css keeps its room meanwhile, + so the table does not move when it shows. The count is the input's + description, and spaces keep label, field and count apart in any text + read from the HTML.""" return ( - f'
' + f'' + f'placeholder="{html.escape(filter_placeholder(labels))}" aria-describedby="{ident}-count"> ' + f'' + f"{rows:,} {noun}
" ) diff --git a/scripts/sitemarkup.py b/scripts/sitemarkup.py index e440d5cc5..664266ff2 100644 --- a/scripts/sitemarkup.py +++ b/scripts/sitemarkup.py @@ -225,10 +225,11 @@ def _tile_mark(name: str, logo: str, lazy: bool = False) -> str: loading = ' loading="lazy"' if lazy else "" return (f'') - # The same square as a logo, drawn on white like the logos are. - return ('') + # The same square as a logo, drawn on white like the logos are. The + # letters are the stylesheet's (::before), not text of the page: the + # tile's name follows, and a copy or a text dump read "MMMyMinUI". + return (f'') # Tiles in the first row of a grid at its widest, two columns of 15rem in @@ -246,8 +247,8 @@ def platform_tiles(tiles: list[tuple[str, str, str, str]], eager: int = 0) -> li links = "".join( f'' f"{_tile_mark(name, logo, lazy=index >= eager)}" - f'{html.escape(name)}' - f'{inline_html(runs_on)}' + f'{html.escape(name)} ' + f'{inline_html(runs_on)} ' for index, (name, target, logo, runs_on) in enumerate(tiles) ) return [f'
{links}
', ""] diff --git a/scripts/siterender.py b/scripts/siterender.py index e6ce4cd0b..03173583a 100644 --- a/scripts/siterender.py +++ b/scripts/siterender.py @@ -982,7 +982,6 @@ SYSTEM_NAMES: dict[str, str] = { "heroes-of-might-and-magic-2": "Heroes of Might and Magic II", "hexen": "Hexen", "hexen2": "Hexen II", - "hppa": "HP PA-RISC", "hugo": "Hugo", "hyper-neogeo64": "SNK Hyper Neo Geo 64", "ibm-at": "IBM PC/AT", @@ -1339,6 +1338,11 @@ SYSTEM_PARENTS: dict[str, tuple[str, str]] = { # Games, filed with the game whose folder holds their data "dinothawr": ("Dinothawr", "Dinothawr"), "doom": ("Id Software", "Doom"), + # The other games of the Doom engines keep their IWADs in its folder. + "heretic": ("Id Software", "Doom"), + "hexen": ("Id Software", "Doom"), + "strife": ("Id Software", "Doom"), + "chex": ("Id Software", "Doom"), "ctf": ("Id Software", "Quake II"), "teamarena": ("Id Software", "Quake III Arena"), "enemyterritory": ("Id Software", "Wolfenstein Enemy Territory"), diff --git a/scripts/sitesteps.py b/scripts/sitesteps.py index c0c75a9dd..f79f437c5 100644 --- a/scripts/sitesteps.py +++ b/scripts/sitesteps.py @@ -3,12 +3,14 @@ Two things per tab, both drawn from data: - The steps that differ by system, opening a terminal and pasting the line, - as an inline SVG: one card per step, a pictogram and a short caption, - drawn with sitediagrams' primitives so it takes the theme's colours in - light and dark. The text steps above it (platforms/_guides.yml, - terminals) stay the accessible source. The SVG says the same in its title - and desc. The pictograms are generic shapes (a menu, a search field, a - window, keys, a mouse, the power symbol), no vendor's interface or logo. + as a drawing: one card per step, a pictogram and a short caption, drawn + with sitediagrams' primitives and shown as its SVG files, one per layout + and theme (sitediagrams.pictures). The text steps above it + (platforms/_guides.yml, terminals) are the one text source: the images + are alt="", so the page reads the steps once. The files say the same in + their title and desc, for one opened on its own. The pictograms are + generic shapes (a menu, a search field, a window, keys, a mouse, the + power symbol), no vendor's interface or logo. - The installer demo recorded for that place (scripts/make_demo.py): the full-screen interface on a handheld under "On the device", the terminal recording under the others but Windows. No Windows recording is @@ -23,7 +25,6 @@ from xml.sax.saxutils import escape import sitemarkup as markup from sitediagrams import ( - FONT, MONO_STYLE, NARROW, STROKE, @@ -35,6 +36,9 @@ from sitediagrams import ( _n, _rect, _text, + diagram_files, + pictures, + svg_document, wrap, ) @@ -92,7 +96,7 @@ def demo_variant(tab: str) -> str: def description(tab: str) -> str: - """The steps in words: the SVG's desc.""" + """The steps in words: the desc of the SVG files.""" return " ".join(f"{index}. {step.caption}." for index, step in enumerate(STEPS[tab][1], start=1)) @@ -234,25 +238,29 @@ def _narrow(steps: tuple[Step, ...]) -> tuple[float, float, list[str]]: def _svg(tab: str, layout: str) -> str: title, steps = STEPS[tab] width, height, body = (_wide if layout == "wide" else _narrow)(steps) - base = f"rb-steps-{tab}-{layout}" - return ( - f'' - f'{escape(title)}' - f'{escape(description(tab))}' - + "".join(body) + "" - ) + return svg_document(width, height, title, description(tab), body, f"rb-steps-{tab}-{layout}") + + +def _layouts(tab: str) -> dict[str, str]: + return {layout: _svg(tab, layout) for layout in ("wide", "narrow")} + + +def stem(tab: str) -> str: + return f"steps-{tab}" + + +def steps_files() -> dict[str, str]: + """Every tab's drawing files, by name under sitediagrams.DIAGRAM_DIR.""" + return {name: text for tab in STEPS for name, text in diagram_files(stem(tab), _layouts(tab)).items()} def steps_figure(tab: str) -> list[str]: - """The figure of a tab's steps, both layouts, or nothing for a tab with - no drawing.""" + """The figure of a tab's steps, both layouts in both themes, or nothing + for a tab with no drawing. The steps above it say its words.""" if tab not in STEPS: return [] return [f'
', - _svg(tab, "wide") + _svg(tab, "narrow"), "
", ""] + pictures(stem(tab), _layouts(tab)), "", ""] def tab_demo(tab: str) -> list[str]: diff --git a/scripts/sitewrite.py b/scripts/sitewrite.py index c90bf78de..6a56560b6 100644 --- a/scripts/sitewrite.py +++ b/scripts/sitewrite.py @@ -54,6 +54,21 @@ def write_decorated(path: str | Path, content: str) -> bool: _record(path) return _write_artifact(str(path), content) +# A page body is written as .md and the decoration pass, which runs after +# the sweep, gives it its final extension: .mdx when it holds components, +# the other file removed. The .mdx a previous run left is that same page. +_PAGE_SUFFIXES = (".md", ".mdx") + + +def _was_produced(path: Path) -> bool: + """Whether this run produced *path*, a page under either extension.""" + if os.path.realpath(str(path)) in _produced: + return True + return path.suffix in _PAGE_SUFFIXES and any( + os.path.realpath(str(path.with_suffix(suffix))) in _produced + for suffix in _PAGE_SUFFIXES if suffix != path.suffix) + + def _sweep_generated(docs: Path, directories: list[str]) -> int: """Delete files in the generated tree that this run did not produce.""" removed = 0 @@ -62,7 +77,7 @@ def _sweep_generated(docs: Path, directories: list[str]) -> int: if not root.is_dir(): continue for path in sorted(root.rglob("*")): - if path.is_file() and os.path.realpath(str(path)) not in _produced: + if path.is_file() and not _was_produced(path): path.unlink() removed += 1 for path in sorted(root.rglob("*"), reverse=True): @@ -81,8 +96,7 @@ def _sweep_top_pages(docs: Path) -> int: """ removed = 0 for path in sorted(docs.glob("*.md*")): - if (path.is_file() and path.suffix in (".md", ".mdx") - and os.path.realpath(str(path)) not in _produced): + if path.is_file() and path.suffix in _PAGE_SUFFIXES and not _was_produced(path): path.unlink() removed += 1 return removed diff --git a/scripts/validate_schemas.py b/scripts/validate_schemas.py index 97b40707a..dc84746b6 100644 --- a/scripts/validate_schemas.py +++ b/scripts/validate_schemas.py @@ -81,7 +81,10 @@ def _validate_yaml_directory( continue out.extend(_errors(validator, data, str(path.relative_to(ROOT)))) out.extend(_unreachable_citations(path, data)) + if schema_name == "platform.schema.json": + out.extend(_config_records_without_evidence(path, data)) if schema_name == "emulator.schema.json": + out.extend(_config_reads_without_build(path, data)) out.extend(_checks_without_values(path, data)) out.extend(_save_dir_without_library_name(path, data)) out.extend(_systems_outside_profile(path, data)) @@ -102,6 +105,59 @@ _CHECK_FIELDS = { } +def _config_records_without_evidence(path: Path, document: object) -> list[str]: + """A launcher record citing a config without the links its extractor reads. + + A config file is proof only when the code installing it and the code + reading it are shown (launchers.config_evidence). The platform's half + is the extractor's to write: a record citing a shipped config carries + installs and overrides, and a feature or option file is never a + record's source, only its choices_from. + """ + if not isinstance(document, dict): + return [] + from scraper.shell_launchers import config_ref, is_feature_ref # noqa: PLC0415 + + out: list[str] = [] + for index, record in enumerate(document.get("launchers") or []): + if not isinstance(record, dict): + continue + cited = config_ref(str(record.get("source_ref") or "")) + where = f"{path.relative_to(ROOT)}: launchers[{index}] ({record.get('emulator')})" + features = [part for part in cited if is_feature_ref(part)] + if features: + out.append(f"{where} cites {features[0]} as source, choices_from holds it") + if [part for part in cited if not is_feature_ref(part)] and not ( + record.get("installs") and "overrides" in record + ): + out.append(f"{where} cites a config without installs and overrides") + return out + + +def _config_reads_without_build(path: Path, document: object) -> list[str]: + """A config_reads entry naming a platform the profile gives no pin_build. + + Such an entry is read at the build that platform ships, and pin_build is + where that build is named. + """ + if not isinstance(document, dict): + return [] + builds = {str(b.get("platform")) for b in document.get("pin_build") or []} + out: list[str] = [] + for index, read in enumerate(document.get("config_reads") or []): + if not isinstance(read, dict): + continue + if read.get("revision"): + continue + for platform in read.get("platforms") or []: + if str(platform) not in builds: + out.append( + f"{path.relative_to(ROOT)}: config_reads[{index}] ({read.get('file')}) " + f"names {platform}, which has no pin_build" + ) + return out + + def _systems_outside_profile(path: Path, document: object) -> list[str]: """An entry's system: or systems: naming a system its profile does not list. @@ -161,34 +217,46 @@ _CODE_SUFFIXES = frozenset( "go rs lua pas pp asm s sh bash zsh ps1 bat cmd vbs swift d zig nim qml qc rb pl php " "scala ml hs dart vue ino z80 smali".split() ) -_CODE_FILE = re.compile(r"[\w+.-]\.([A-Za-z0-9+]+)\b") -_BINARY_EVIDENCE = re.compile( - r"\b0x[0-9a-fA-F]+\b|\bFUN_[0-9a-fA-F]+\b|\.(?:so|dll|exe|dylib|dex|apk|jar|elf|nro|xex)\b", +_CODE_FILE = re.compile(r"(?<=[\w+-])\.([A-Za-z0-9+]+)\b") +# A compiled image: a part that names one has to say where in it the file +# is read, an address, a decompiled function or an IL method. +# A name under a directory is a file of the tree it sits in, and a further +# extension (.dll.map) makes it another file. +_BINARY_FILE = re.compile( + r"(? bool: - """A source_ref part names a source file, or a binary with an address.""" + """A source_ref cites a source file or a place in a compiled image. + + A part naming a binary without an address, a decompiled function or an + IL method says only that the binary exists: "import directory", + "string table" and "readelf -d" are not the code that reads a file. + """ from sourceref import split_source_ref - if _BINARY_EVIDENCE.search(ref): - return True + cited = False for part in split_source_ref(ref): - for suffix in _CODE_FILE.findall(part.raw): - if suffix.lower() in _CODE_SUFFIXES: - return True - return False + located = bool(_BINARY_EVIDENCE.search(part.raw)) or any( + suffix.lower() in _CODE_SUFFIXES for suffix in _CODE_FILE.findall(part.raw) + ) + if _BINARY_FILE.search(part.raw) and not located: + return False + cited = cited or located + return cited def _data_only_source_refs(path: Path, document: object) -> list[str]: diff --git a/scripts/verify.py b/scripts/verify.py index 8c2d40e57..a3fe5fb02 100644 --- a/scripts/verify.py +++ b/scripts/verify.py @@ -100,7 +100,7 @@ from common import ( yaml = require_yaml() from exporter.candidates import BIOS, EntryCategories -from launchers import LauncherLayer, declared_destinations, held_record +from launchers import LauncherLayer, declared_destinations, held_record, launcher_unproven from cross_reference import launcher_reads_not_held from nativemode import ( SIZE_AND_ANY_HASH, @@ -1764,6 +1764,8 @@ def verify_platform( "launcher_reads_not_held": launcher_reads_not_held( {config.get("_key", platform): config}, db, profiles, data_dir_registry ), + # Records a config file does not prove: listed, never consumed. + "launcher_unproven": launcher_unproven({config.get("_key", platform): config}, profiles), "exclusion_notes": exclusions, "region_fallbacks": sorted(region_fallbacks), **({"left_out": left_out} if no_game_data else {}), @@ -2130,6 +2132,21 @@ def _print_undeclared_section(result: dict, verbose: bool) -> None: ) +def _print_launcher_unproven(result: dict, verbose: bool) -> None: + """Launcher records resting on a config file the code does not prove.""" + rows = result.get("launcher_unproven") or [] + if not rows: + return + listed = "" if verbose else " (--verbose lists them)" + print(f" Launcher records unproven: {len(rows)}{listed}") + if not verbose: + return + for row in rows: + print(f" [{row['index']}] {row['emulator']} {row['kind']}: {row['passes_to']}") + for link in row["missing"]: + print(f" missing {link}") + + def _print_launcher_reads(result: dict, verbose: bool) -> None: """Names the platform's launch code reads that the collection lacks.""" every = result.get("launcher_reads_not_held") or [] @@ -2220,6 +2237,7 @@ def print_platform_result( _print_detail_entries(result["details"], seen_details, verbose) _print_undeclared_section(result, verbose) _print_launcher_reads(result, verbose) + _print_launcher_unproven(result, verbose) # The same notes come back for every platform running these cores and # filled 985 of the 1114 lines of verify --all: counted, listed on ask. diff --git a/tests/test_data_only_refs.py b/tests/test_data_only_refs.py index 345f7d091..63eb4bd50 100644 --- a/tests/test_data_only_refs.py +++ b/tests/test_data_only_refs.py @@ -53,17 +53,39 @@ class DataOnlySourceRefs(unittest.TestCase): def test_a_binary_with_an_address_passes(self): for ref in ("libemucore.so 0x1a2b3c", "Fusion.exe 0x00401000", - "bigpemu FUN_006d8be0 (BootROM read)", "nethersx2 v2.2n classes.dex icons/star-%d.png"): + "bigpemu FUN_006d8be0 (BootROM read)", + "CSpect.exe 3.3.1.0 a.H::e() IL_00bd-IL_00c9", + "GameAssembly.dll DSP1..ctor (name and CRC32)", + "libpizzaboy-jni.so pizza.c:931-937 (path buffer)"): with self.subTest(ref=ref): self.assertEqual(self.errors(ref), []) + def test_a_binary_named_without_a_place_in_it_is_refused(self): + for ref in ("ArcadeFlashWeb v1.0.2 pepflashplayer.dll string table", + "Future Pinball.exe 1.9.1.20101231 import directory", + "Main.java:27302, libfpse.so readelf -d", + "nethersx2 v2.2n classes.dex icons/star-%d.png", + "Fusion.exe 0x00401000, PS3Eye.dll .rdata"): + with self.subTest(ref=ref): + self.assertEqual(len(self.errors(ref)), 1) + + def test_a_binary_file_of_a_source_tree_is_a_path(self): + self.assertEqual(self.errors( + "src/loader/elfLoader/elfLoader.cpp:365, libs/win32/ll-deps/zlib1.dll"), []) + self.assertEqual(self.errors( + "src/emu/kernel/src/libmanager.cpp:549-566, src/patch/ecam/group/ecam.dll.map:190-193"), []) + def test_each_build_mode_is_judged(self): self.assertEqual(len(self.errors({"standalone": "src/main.cpp:10", "libretro": "data/list.txt:3"})), 1) def test_an_excepted_profile_is_not_judged(self): - name = next(iter(validate_schemas.DATA_ONLY_REF_EXCEPTIONS)) - path = REPO_ROOT / "emulators" / f"{name}.yml" - self.assertEqual(validate_schemas._data_only_source_refs(path, _profile("history.txt:38")), []) + path = REPO_ROOT / "emulators" / "synthetic.yml" + exceptions = validate_schemas.DATA_ONLY_REF_EXCEPTIONS + exceptions["synthetic"] = "binary found nowhere" + try: + self.assertEqual(validate_schemas._data_only_source_refs(path, _profile("history.txt:38")), []) + finally: + del exceptions["synthetic"] def test_every_exception_names_a_profile_and_a_reason(self): for name, reason in validate_schemas.DATA_ONLY_REF_EXCEPTIONS.items(): diff --git a/tests/test_launcher_evidence.py b/tests/test_launcher_evidence.py new file mode 100644 index 000000000..5f01c2929 --- /dev/null +++ b/tests/test_launcher_evidence.py @@ -0,0 +1,330 @@ +"""A launcher record resting on a config file binds only when its chain holds. + +The platform's code installs the file (installs), its launch code was read +for what replaces it (overrides), and the emulator's profile says where the +build the platform ships loads the file and reads each key (config_reads). +""" + +from __future__ import annotations + +import tests # noqa: F401 offline, scratch under tmp/, the suite's own cache + +import sys +import unittest +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "scripts")) + +import yaml # noqa: E402 + +from common import load_platform_config # noqa: E402 +from launchers import ( # noqa: E402 + bound_launchers, + config_evidence, + config_target, + handed_directories, + launcher_places, + launcher_unproven, +) +from profile_sync import _check_build_refs, shipped_build_holders # noqa: E402 +from scraper.retrobat_launchers import _choices_apart # noqa: E402 +from scraper.shell_launchers import ( # noqa: E402 + LauncherPatternMissing, + Script, + config_placement, + config_ref, + is_feature_ref, +) +from validate_schemas import ( # noqa: E402 + _config_reads_without_build, + _config_records_without_evidence, +) + +REPO_ROOT = Path(__file__).resolve().parents[1] + + +def record(**fields: object) -> dict: + """A ROCKNIX-like DuckStation record citing its shipped settings.ini.""" + base = { + "emulator": "duck", "build": "standalone", "kind": "scans_dir", "names": [], + "search_dir": "/storage/roms/bios", + "passes_to": "settings.ini [BIOS] SearchDirectory = /storage/roms/bios, [BIOS] PathPAL unset", + "installs": {"path": "/storage/.config/duck/settings.ini", "source_ref": "setup.sh:13"}, + "overrides": [], + "source_ref": "duck/config/settings.ini:4, duck/package.mk:33", + } + return {**base, **fields} + + +def profile(**fields: object) -> dict: + base = { + "emulator": "Duck", "type": "standalone", "cores": ["duck"], + "standalone_directories": ["[BIOS] SearchDirectory"], + "config_reads": [{ + "file": "settings.ini", "source_ref": "src/core.cpp:10", + "keys": [ + {"key": "[BIOS] SearchDirectory", "source_ref": "src/settings.cpp:20"}, + {"key": ["[BIOS] PathPAL", "[BIOS] PathNTSCU"], "source_ref": "src/bios.cpp:30"}, + ], + }], + } + return {**base, **fields} + + +class ConfigRefs(unittest.TestCase): + def test_config_option_and_feature_files_are_cited_apart(self) -> None: + ref = "a/settings.ini:4, 6, a/start.sh:3, b/MAME.opt:19, .emulationstation/es_features.cfg:9" + self.assertEqual( + config_ref(ref), + ["a/settings.ini:4, 6", "b/MAME.opt:19", ".emulationstation/es_features.cfg:9"], + ) + self.assertEqual([is_feature_ref(p) for p in config_ref(ref)], [False, True, True]) + + def test_passes_to_names_the_file_and_its_keys(self) -> None: + cases = { + "settings.ini [BIOS] SearchDirectory (-settings), [BIOS] PathNTSCU, PathPAL unset": + ("settings.ini", ["[BIOS] SearchDirectory", "[BIOS] PathNTSCU", "[BIOS] PathPAL"]), + "melonDS.toml [DS] BIOS9Path [DSi] NANDPath, first file whose name holds the region": + ("melonDS.toml", ["[DS] BIOS9Path", "[DSi] NANDPath"]), + "settings.ini [BIOS] PathNTSCJ = PathNTSCU = ": + ("settings.ini", ["[BIOS] PathNTSCJ", "[BIOS] PathNTSCU"]), + "AmigaA500-default.uae kickstart_rom_file, $(FILE_PATH) = /storage/k/": + ("AmigaA500-default.uae", ["kickstart_rom_file", "$(FILE_PATH)"]), + "command line -rompath bios/coco": ("command line", ["-rompath"]), + "core option pcsx2_bios": ("core options", ["pcsx2_bios"]), + } + for passes_to, expected in cases.items(): + with self.subTest(passes_to=passes_to): + self.assertEqual(config_target({"passes_to": passes_to}), expected) + core = {"build": "libretro", "kind": "core_option", "passes_to": "hatarib_tos = x/"} + self.assertEqual(config_target(core), ("core options", ["hatarib_tos"])) + + def test_a_record_naming_no_file_takes_the_config_it_installs(self) -> None: + romlist = record( + passes_to="romlist coco", + installs={"path": "$xroar_config", "source_ref": "prepare.sh:13"}, + source_ref="xroar/rd_config/xroar.conf:305, xroar/prepare.sh:13", + ) + self.assertEqual(config_target(romlist), ("xroar.conf", ["romlist coco"])) + + +class Evidence(unittest.TestCase): + profiles = {"duck": profile()} + + def test_a_record_resting_on_code_holds(self) -> None: + code = {"emulator": "duck", "kind": "fixed_name", "source_ref": "start.sh:3"} + self.assertTrue(config_evidence(code, {}).proven) + + def test_the_whole_chain_holds(self) -> None: + evidence = config_evidence(record(), self.profiles, "rocknix") + self.assertTrue(evidence.proven, evidence.missing) + self.assertEqual(evidence.readers, ("duck",)) + + def test_each_missing_link_is_named(self) -> None: + bare = {k: v for k, v in record().items() if k not in ("installs", "overrides")} + missing = config_evidence(bare, self.profiles).missing + self.assertEqual(len(missing), 2) + self.assertTrue(missing[0].startswith("installs")) + self.assertTrue(missing[1].startswith("overrides")) + + def test_a_profile_that_reads_no_such_file_proves_nothing(self) -> None: + missing = config_evidence(record(), {"duck": profile(config_reads=[])}).missing + self.assertEqual(missing, ("config_reads: an emulator that loads settings.ini",)) + + def test_a_key_the_build_does_not_read_is_named(self) -> None: + unread = record(passes_to="settings.ini [BIOS] PathNTSCJ") + self.assertEqual( + config_evidence(unread, self.profiles).missing, + ("config_reads: no read of [BIOS] PathNTSCJ",), + ) + + def test_a_handle_with_its_code_ref_reads_the_key(self) -> None: + handled = profile( + config_reads=[{"file": "settings.ini", "source_ref": "src/core.cpp:10", "keys": [ + {"key": "[BIOS] PathPAL", "source_ref": "src/bios.cpp:30"}]}], + standalone_directories=[ + {"handle": "[BIOS] SearchDirectory", "source_ref": "src/settings.cpp:20"} + ], + ) + self.assertTrue(config_evidence(record(), {"duck": handled}).proven) + + def test_an_option_list_is_never_the_source(self) -> None: + listed = record(source_ref="gen.cs:3, .emulationstation/es_features.cfg:9") + self.assertIn( + "an option list cited as source, not as choices_from", + config_evidence(listed, self.profiles).missing, + ) + + def test_an_option_choice_needs_the_emulator_side_too(self) -> None: + chosen = { + "emulator": "duck", "kind": "core_option", "passes_to": "settings.ini [BIOS] PathPAL = ", + "choices_from": "es_features.cfg:9", "source_ref": "gen.cs:3", + } + self.assertTrue(config_evidence(chosen, self.profiles).proven) + self.assertFalse(config_evidence(chosen, {"duck": profile(config_reads=[])}).proven) + + def test_reads_written_for_a_shipped_build_apply_to_its_platform_only(self) -> None: + built = profile( + source_commit="a" * 40, + pin_build=[{"platform": "rocknix", "value": "b" * 40}], + config_reads=[{**profile()["config_reads"][0], "platforms": ["rocknix"]}], + ) + self.assertTrue(config_evidence(record(), {"duck": built}, "rocknix").proven) + self.assertFalse(config_evidence(record(), {"duck": built}, "emuelec").proven) + + def test_reads_at_the_pin_skip_a_platform_shipping_another_build(self) -> None: + other = profile(source_commit="a" * 40, pin_build=[{"platform": "rocknix", "value": "b" * 40}]) + self.assertFalse(config_evidence(record(), {"duck": other}, "rocknix").proven) + self.assertTrue(config_evidence(record(), {"duck": other}, "emuelec").proven) + + +class Gate(unittest.TestCase): + def config(self, *records: dict) -> dict: + return {"_key": "rocknix", "base_destination": "bios", "launchers": list(records)} + + def test_an_unproven_record_hands_no_directory(self) -> None: + proven = handed_directories(self.config(record()), {"duck": profile()}) + self.assertEqual([h.folder for h in proven], [""]) + self.assertEqual(handed_directories(self.config(record()), {"duck": profile(config_reads=[])}), []) + + def test_an_unproven_record_places_no_file(self) -> None: + named = record( + kind="fixed_name", names=["tos.img"], passes_to="settings.ini [BIOS] PathPAL", + ) + self.assertEqual(len(launcher_places(self.config(named), {"duck": profile()})), 1) + self.assertEqual(launcher_places(self.config(named), {"duck": profile(config_reads=[])}), []) + + def test_the_unproven_are_reported_with_what_they_lack(self) -> None: + config = self.config({"emulator": "x", "kind": "links", "source_ref": "a.sh:1"}, record()) + self.assertEqual(launcher_unproven({"rocknix": config}, {"duck": profile()}), []) + (row,) = launcher_unproven({"rocknix": config}, {"duck": profile(config_reads=[])}) + self.assertEqual((row["platform"], row["index"], row["emulator"]), ("rocknix", 1, "duck")) + self.assertEqual(row["config"], ["duck/config/settings.ini:4"]) + self.assertEqual(len(bound_launchers(config, {"duck": profile(config_reads=[])})), 1) + + +class StartScripts(unittest.TestCase): + SCRIPT = ( + 'CONF_DIR="/storage/.config/duck"\n' + 'CONF_FILE="${CONF_DIR}/settings.ini"\n' + '[ ! -d "${CONF_DIR}" ] && cp -r /usr/config/duck /storage/.config\n' + 'if [ ! -f "${CONF_FILE}" ]; then\n' + ' cp /usr/config/duck/settings.ini ${CONF_FILE}\n' + 'fi\n' + "sed -i '/^AspectRatio/c\\\\AspectRatio = 4:3' ${CONF_FILE}\n" + "sed -i '/^PathPAL/c\\\\PathPAL = x.bin' ${CONF_FILE}\n" + 'cp /usr/config/duck/other.ini ${CONF_DIR}/ >/dev/null 2>&1\n' + ) + + def test_a_guarded_copy_keeps_the_file_and_a_key_rewrite_is_an_override(self) -> None: + placement = config_placement( + Script("start.sh", self.SCRIPT), "/storage/.config/duck/settings.ini", ["[BIOS] PathPAL"] + ) + self.assertEqual(placement.install, {3, 5}) + self.assertTrue(placement.kept_if_present) + self.assertEqual(placement.overrides, {8}) + + def test_a_copy_at_each_launch_replaces_the_file(self) -> None: + script = Script("start.sh", 'cp /usr/config/duck/settings.ini /storage/.config/duck/settings.ini\n') + self.assertFalse(config_placement(script, "/storage/.config/duck/settings.ini").kept_if_present) + + def test_a_script_installing_nothing_raises(self) -> None: + with self.assertRaises(LauncherPatternMissing): + config_placement(Script("start.sh", "echo hi\n"), "/storage/.config/duck/settings.ini") + + def test_retrobat_moves_the_option_list_to_choices_from(self) -> None: + moved = _choices_apart({ + "emulator": "x", "passes_to": "p", + "source_ref": "Gen.cs:3-4, .emulationstation/es_features.cfg:9-12", + }) + self.assertEqual(moved["source_ref"], "Gen.cs:3-4") + self.assertEqual(moved["choices_from"], ".emulationstation/es_features.cfg:9-12") + self.assertEqual(list(moved)[-1], "source_ref") + + +class Invariants(unittest.TestCase): + def test_a_config_record_without_its_platform_links_is_an_error(self) -> None: + path = REPO_ROOT / "platforms" / "x.yml" + bare = {k: v for k, v in record().items() if k not in ("installs", "overrides")} + listed = record(source_ref="gen.cs:3, es_features.yml:9") + errors = _config_records_without_evidence(path, {"launchers": [record(), bare, listed]}) + self.assertEqual(len(errors), 2) + self.assertIn("without installs and overrides", errors[0]) + self.assertIn("choices_from holds it", errors[1]) + + def test_reads_naming_a_platform_need_its_build(self) -> None: + path = REPO_ROOT / "emulators" / "x.yml" + reads = [{"file": "a.ini", "platforms": ["rocknix"], "source_ref": "a:1", "keys": []}] + self.assertEqual(len(_config_reads_without_build(path, {"config_reads": reads})), 1) + self.assertEqual(_config_reads_without_build( + path, {"config_reads": reads, "pin_build": [{"platform": "rocknix"}]} + ), []) + pinned = [{**reads[0], "revision": "c" * 40, "revision_from": "the exe"}] + self.assertEqual(_config_reads_without_build(path, {"config_reads": pinned}), []) + + +class BuildRefs(unittest.TestCase): + def test_reads_for_a_shipped_build_are_read_at_that_build(self) -> None: + document = { + "pin_build": [{"platform": "rocknix", "value": "b" * 40}], + "config_reads": [{ + "file": "a.ini", "platforms": ["rocknix"], "source_ref": "src/a.c:2", + "keys": [{"key": "k", "source_ref": "src/a.c:9, ROCKNIX x.patch:1"}], + }], + } + held = shipped_build_holders(document) + self.assertEqual(len(held), 2) + + class View: + repo, field = "repo", "source" + + class Citation: + def __init__(self, ref: str, field: str) -> None: + self.ref, self.field = ref, field + + asked: list[tuple[str, str]] = [] + + def fetch(_repo: str, revision: str, path: str) -> list[str] | None: + asked.append((revision, path)) + return ["line"] * 5 if path == "src/a.c" else None + + rows = _check_build_refs( + document, + [(Citation("src/a.c:2", "c"), document["config_reads"][0]), + (Citation("src/a.c:9, ROCKNIX x.patch:1", "k"), document["config_reads"][0])], + [View()], fetch, + ) + self.assertEqual([r["status"] for r in rows], ["BUILD_OK", "BUILD_GONE"]) + self.assertTrue(all(revision == "b" * 40 for revision, _ in asked)) + self.assertNotIn(("b" * 40, "ROCKNIX x.patch"), asked) + + +class RepositoryRecords(unittest.TestCase): + """The placement chains the audit of 2026-11-10 found moving files.""" + + def test_the_chains_that_move_placements_still_bind(self) -> None: + platforms = REPO_ROOT / "platforms" + cases = ( + ("rocknix", "armsx2", "/storage/roms/bios/armsx2"), + ("retrodeck", "gzdoom", "$roms_path/doom"), + ("retrodeck", "xroar", "$roms_path/coco"), + ("retrobat", "xroar", "bios/coco"), + ) + for platform, emulator, directory in cases: + with self.subTest(platform=platform, emulator=emulator): + handed = handed_directories(load_platform_config(platform, str(platforms))) + self.assertIn( + directory, {h.directory for h in handed if h.emulator == emulator} + ) + + def test_every_config_record_carries_its_platform_links(self) -> None: + for path in sorted((REPO_ROOT / "platforms").glob("*.yml")): + if path.name.startswith("_"): + continue + with self.subTest(platform=path.stem): + document = yaml.safe_load(path.read_text(encoding="utf-8")) + self.assertEqual(_config_records_without_evidence(path, document), []) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_launcher_gaps.py b/tests/test_launcher_gaps.py index e1bdac934..a2e8bdbc1 100644 --- a/tests/test_launcher_gaps.py +++ b/tests/test_launcher_gaps.py @@ -33,6 +33,7 @@ import verify # noqa: E402 from common import _emulator_profiles_cache, load_emulator_profiles, load_platform_config # noqa: E402 from cross_reference import ( # noqa: E402 LAUNCHER_READS_KEY, + LAUNCHER_UNPROVEN_KEY, launcher_file_names, launcher_reads_not_held, print_launcher_reads, @@ -278,7 +279,11 @@ class LauncherGapTest(unittest.TestCase): names = {r["name"] for r in report[LAUNCHER_READS_KEY]} self.assertEqual(names, {"absent.bin", "mixed.rom", "labelled.rom", "user.sf2"}) # The emulator rows keep their own shape and counts. - self.assertEqual(set(report) - {LAUNCHER_READS_KEY}, {"aliasemu", "missemu", "setemu"}) + self.assertEqual( + set(report) - {LAUNCHER_READS_KEY, LAUNCHER_UNPROVEN_KEY}, + {"aliasemu", "missemu", "setemu"}, + ) + self.assertEqual(report[LAUNCHER_UNPROVEN_KEY], []) def test_verify_counts_and_exit_code_are_unchanged(self) -> None: """A launcher name is reported, not judged: nothing else moves.""" diff --git a/tests/test_launcher_layer.py b/tests/test_launcher_layer.py index 0e6e8fae0..7f37fef6b 100644 --- a/tests/test_launcher_layer.py +++ b/tests/test_launcher_layer.py @@ -314,9 +314,9 @@ class LauncherLayerTest(unittest.TestCase): config = {"base_destination": "bios", "launchers": [{ "emulator": "e", "build": "libretro", "kind": "fixed_name", "names": ["a.rom", "b.rom"], "search_dir": "/storage/roms/bios", - "passes_to": "e.cfg ROM_A, ROM_B", "source_ref": "e.cfg:1", + "passes_to": "e.cfg ROM_A, ROM_B", "source_ref": "launch.sh:1", }]} - places = {p.paths[0]: p.passes_to for p in launcher_places(config)} + places = {p.paths[0]: p.passes_to for p in launcher_places(config, {})} self.assertEqual(places, {"a.rom": "e.cfg ROM_A", "b.rom": "e.cfg ROM_B"}) def test_a_core_option_names_the_dump_of_a_model(self) -> None: @@ -341,12 +341,16 @@ class LauncherLayerTest(unittest.TestCase): "files": [{"name": ".bin", "path": "ps2/bios/.bin", "required": True, "min_size": 32, "max_size": 64, "validation": ["size"], "config_key": "emu_bios"}], + "config_reads": [{"file": "core options", "source_ref": "core.c:1", + "keys": [{"key": "emu_bios", "source_ref": "core.c:2"}]}], } with open(os.path.join(self.emulators_dir, "optemu.yml"), "w") as fh: yaml.dump(profile, fh) self.config["launchers"].append({ "emulator": "retroarch", "build": "libretro", "kind": "core_option", "names": ["scph10000.bin"], "passes_to": "core option emu_bios", + "installs": {"path": "retroarch-core-options.cfg", "source_ref": "prepare.sh:24"}, + "overrides": [], "source_ref": "core-options.cfg:515", }) _emulator_profiles_cache.clear() diff --git a/tests/test_launcher_placement.py b/tests/test_launcher_placement.py index f9865d360..5cf239dc5 100644 --- a/tests/test_launcher_placement.py +++ b/tests/test_launcher_placement.py @@ -964,6 +964,17 @@ class GzdoomOnRetroDECK(unittest.TestCase): self.assertFalse(any(e.get("standalone_path") for e in view["files"])) +def _reads_configs(profile: str) -> bool: + """Whether a repository profile carries config_reads.""" + path = REPO_ROOT / "emulators" / f"{profile}.yml" + return bool((yaml.safe_load(path.read_text(encoding="utf-8")) or {}).get("config_reads")) + + +# EmuELEC hands AdvanceMAME its folders through advmame.rc: the chain binds +# once the profile says where the build reads them (config_reads). +@unittest.skipUnless( + _reads_configs("advancemame"), "advancemame.yml carries no config_reads, dir_rom is unproven" +) class AdvanceMameOnEmuELEC(unittest.TestCase): """advmame.rc sets dir_rom /storage/roms/mame, /storage/roms/arcade for the arcade system (advmame.rc:11, advmame.sh:26-30).""" diff --git a/tests/test_launchers_amberelec.py b/tests/test_launchers_amberelec.py index c0ba27d36..39ce37130 100644 --- a/tests/test_launchers_amberelec.py +++ b/tests/test_launchers_amberelec.py @@ -105,22 +105,6 @@ HATARI_CFG = text( """ ) -ATARI800_CFG = text( - """ - Atari 800 Emulator, Version 3.1.0 - ROM_OS_A_NTSC= - ROM_OS_A_PAL=/storage/roms/bios/ATARIOSA.ROM - ROM_5200=/storage/roms/bios/5200.rom - """ -) - -ATARI800_PATCH = text( - """ - + LDFLAGS += -static-libgcc - + CFLAGS += -DDEFAULT_CFG_NAME="\\"/storage/.config/distribution/configs/atari800.cfg\\"" - """ -) - AMIBERRY_MK = text( """ makeinstall_target() { @@ -141,6 +125,17 @@ AMIBERRY_SH = text( cp $AMIBERRY_CONFIG_DIR/AmigaA500-default.uae "$AMIBERRY_TMP_CONFIG" fi } + amiberry -f "$AMIBERRY_TMP_CONFIG" --autoload "$1" >> $AMIBERRY_LOG 2>&1 + """ +) + +USERCONFIG = text( + """ + #!/bin/bash + if [ ! -e "/storage/.configured" ] + then + rsync -a --ignore-existing --exclude=es_systems.cfg /usr/config/* /storage/.config/ || exit 1 + fi """ ) @@ -195,8 +190,7 @@ def tree(**overrides: str) -> dict[str, str]: al.SCRIPTS["piemu"]: PIEMU, al.SCRIPTS["HATARISA"]: HATARI_SH, al.HATARI_CONFIG: HATARI_CFG, - al.ATARI800_CONFIG: ATARI800_CFG, - al.ATARI800_PATCH: ATARI800_PATCH, + al.USERCONFIG: USERCONFIG, al.AMIBERRY_PACKAGE: AMIBERRY_MK, al.SCRIPTS["AMIBERRY"]: AMIBERRY_SH, f"{al.AMIBERRY_CONFIGS}/AmigaA1200-default.uae": uae("kick40068.A1200.rom"), @@ -218,6 +212,13 @@ class Frontends(unittest.TestCase): (record,) = al.retroarch(read()) self.assertEqual(record.search_dir, "~/roms/bios") self.assertEqual(record.source_ref, f"{al.RETROARCH_CFG}:2") + # The first boot copies /usr/config and leaves a file already there. + self.assertEqual(record.installs, { + "path": "/storage/.config/retroarch/retroarch.cfg", + "source_ref": f"{al.USERCONFIG}:4", + }) + self.assertIs(record.kept_if_present, True) + self.assertEqual(record.overrides, []) def test_retrorun_directory(self): (record,) = al.retrorun(read()) @@ -266,6 +267,9 @@ class Standalone(unittest.TestCase): record.source_ref, f"{al.RUNEMU}:3, {al.SCRIPTS['HATARISA']}:3-4, {al.HATARI_CONFIG}:2", ) + # Copied over at each launch: nothing the user edits survives. + self.assertEqual(record.installs["source_ref"], f"{al.SCRIPTS['HATARISA']}:3") + self.assertIs(record.kept_if_present, False) def test_amiberry_link_and_one_kickstart_per_config(self): link, a1200, a500 = al.amiberry(read(), al.Runemu(read())) @@ -273,7 +277,11 @@ class Standalone(unittest.TestCase): self.assertEqual(link.passes_to, "/usr/config/amiberry/kickstarts is a symlink to it") self.assertEqual((a1200.slot, a1200.names), ("A1200", ["kick40068.A1200.rom"])) self.assertEqual((a500.slot, a500.names), ("A500", ["kick34005.A500.rom"])) - self.assertEqual(a500.depends_on_option, f"not ({a1200.depends_on_option})") + self.assertTrue(a500.depends_on_option.startswith("not (")) + # A WHDLoad boot replaces the setup the config gives. + self.assertIn("--autoload", a1200.depends_on_option) + self.assertEqual(a1200.installs["source_ref"], f"{al.SCRIPTS['AMIBERRY']}:5") + self.assertEqual(a500.installs["source_ref"], f"{al.SCRIPTS['AMIBERRY']}:7") def test_a_table_running_another_script_raises(self): broken = RUNEMU.replace("/usr/bin/yabasanshiro.sh", "/usr/bin/yaba.sh") @@ -287,15 +295,9 @@ class Standalone(unittest.TestCase): class Cores(unittest.TestCase): - def test_atari800_built_to_read_the_shipped_config(self): - (record,) = al.atari800(read()) - self.assertEqual(record.names, ["ATARIOSA.ROM", "5200.rom"]) - self.assertEqual(record.source_ref, f"{al.ATARI800_PATCH}:2, {al.ATARI800_CONFIG}:3-4") - - def test_atari800_built_for_another_config_raises(self): - broken = ATARI800_PATCH.replace("atari800.cfg", "other.cfg") - with self.assertRaises(LauncherShapeError): - al.atari800(read(**{al.ATARI800_PATCH: broken})) + def test_atari800_config_is_no_record(self): + # The core reads atari800.cfg only under an option that is off. + self.assertFalse(any(r["emulator"] == "atari800" for r in al.extract_launchers(read()))) def test_scummvm_paths_written_under_bios(self): theme, extra = al.scummvm(read()) @@ -319,7 +321,7 @@ class Cores(unittest.TestCase): def test_every_extractor_runs_on_the_fixture(self): records = al.extract_launchers(read()) # One easyrpg runtime in the fixture, two at the pinned commit. - self.assertEqual(len(records), 16) + self.assertEqual(len(records), 15) class PlatformFile(unittest.TestCase): diff --git a/tests/test_launchers_emudeck.py b/tests/test_launchers_emudeck.py index 1dd106f6c..acd606440 100644 --- a/tests/test_launchers_emudeck.py +++ b/tests/test_launchers_emudeck.py @@ -40,6 +40,9 @@ ARES_SH = text( UserBIOSPath='/home/deck/Emulation/bios/' sed -i "s|$UserBIOSPath|${biosPath}\\/|g" "$ares_configFile" } + ares_init(){ + configEmuFP "${ares_emuName}" "${ares_emuPath}" "true" + } """ ) @@ -87,6 +90,9 @@ MELONDS_SH = text( buttonA='Joy_A=' changeLine "$buttonA" "$buttonA""0" "${melonDS_configFile}" } + melonDS_update(){ + configEmuFP "${melonDS_emuName}" "${melonDS_emuPath}" + } """ ) @@ -103,6 +109,7 @@ MELONDS_TOML = text( LastROMFolder = "/run/media/mmcblk0p1/Emulation/roms/ds" [Emu] ExternalBIOSEnable = false + ConsoleType = 0 [DS] FirmwarePath = "/run/media/mmcblk0p1/Emulation/bios/firmware.bin" BIOS7Path = "/run/media/mmcblk0p1/Emulation/bios/bios7.bin" @@ -206,8 +213,23 @@ SHADPS4_SH = text( ) +CONFIG_EMU_FP = text( + """ + configEmuFP(){ + if [[ $overwrite == 'true' ]]; then + overwrite="--backup --suffix=.bak" + else + overwrite="--ignore-existing" + fi + rsync -avhp --mkpath "$emudeckBackend/configs/${ID}" "$HOME/.var/app/" $overwrite + } +""" +) + + def tree(**scripts: str) -> RepoTree: files = {f"{S}/{name}": body for name, body in scripts.items()} + files[el.CONFIG_EMU_FP] = CONFIG_EMU_FP files[f"{el.CONFIGS}/dev.ares.ares/data/ares/settings.bml"] = ARES_BML files[f"{el.CONFIGS}/net.kuribo64.melonDS/config/melonDS/melonDS.ini"] = MELONDS_INI files[f"{el.CONFIGS}/net.kuribo64.melonDS/config/melonDS/melonDS.toml"] = MELONDS_TOML @@ -253,8 +275,17 @@ class WrittenIntoTheConfig(unittest.TestCase): self.assertEqual( toml["passes_to"], "melonDS.toml [DS] FirmwarePath, BIOS7Path [DSi] NANDPath" ) + # The DS keys wait for ExternalBIOSEnable, the DSi keys for a DSi. self.assertEqual( - toml["depends_on_option"], "ExternalBIOSEnable = false in the shipped melonDS.toml" + toml["depends_on_option"], + "[DS] keys: ExternalBIOSEnable = true, false in the shipped melonDS.toml; " + "[DSi] keys: ConsoleType = 1, 0 in the shipped melonDS.toml", + ) + # configEmuFP's update call passes --ignore-existing. + self.assertIs(toml["kept_if_present"], True) + self.assertEqual( + toml["installs"]["path"], + "${HOME}/.var/app/net.kuribo64.melonDS/config/melonDS/melonDS.toml", ) def test_a_config_the_setters_rewrite_keeps_their_values(self): diff --git a/tests/test_launchers_emuelec.py b/tests/test_launchers_emuelec.py index ae6315c98..630547701 100644 --- a/tests/test_launchers_emuelec.py +++ b/tests/test_launchers_emuelec.py @@ -228,6 +228,9 @@ DUCKSTATION_SH = text( """ CONFIG_DIR="/emuelec/configs/duckstation" duckstation-nogui -fullscreen -settings "${CONFIG_DIR}/settings.ini" -- "${1}" + if [ ! -d "${CONFIG_DIR}" ]; then + cp -rf /usr/config/emuelec/configs/duckstation/* "${CONFIG_DIR}" + fi """ ) @@ -319,6 +322,9 @@ ADVMAME_SH = text( sed -i "s|/roms/arcade|/roms/mame|g" ${CONFIG_DIR}/advmame.rc fi SDL_AUDIODRIVER=alsa advmame ${ARG} -quiet + if [ ! -d "${CONFIG_DIR}" ]; then + cp -rf /usr/config/emuelec/configs/advmame/* "${CONFIG_DIR}/" + fi """ ) @@ -480,24 +486,12 @@ class LibretroRecords(unittest.TestCase): self.assertEqual(jar["passes_to"], "${HOME}/roms/bios") self.assertEqual(jar["depends_on_option"], "/storage/roms/bios/jdk/eeversion exists") - def test_mame_copies_its_own_files_and_reads_only_path_options(self): + def test_mame_copies_its_own_files_and_hands_no_folder(self): + # The core passes no path option and reads no mame.ini: only the + # copies are the launcher's. found = records(el.mame) - copies = [r for r in found if r["kind"] == "copies"] - self.assertEqual([r["names"] for r in copies], [["fm*"], ["mame*"]]) - folders = [(r["passes_to"], r["search_dir"]) for r in found if r["kind"] == "passes_path"] - self.assertEqual( - folders, - [ - ("mame.ini rompath", "/storage/roms/bios/mame/bios"), - ("mame.ini samplepath", "/storage/roms/bios/mame/samples"), - ], - ) - self.assertTrue(all(r["depends_on_option"] == "mame_read_config = enabled" - for r in found if r["kind"] == "passes_path")) - - def test_mame_without_the_read_config_option_raises(self): - with self.assertRaises(LauncherPatternMissing): - records(el.mame, **{f"{el.LIBRETRO}/mame/config/MAME/MAME.opt": "x = 1\n"}) + self.assertEqual([r["kind"] for r in found], ["copies", "copies"]) + self.assertEqual([r["names"] for r in found], [["fm*"], ["mame*"]]) class StandaloneRecords(unittest.TestCase): @@ -546,6 +540,12 @@ class StandaloneRecords(unittest.TestCase): (record,) = records(el.duckstation) self.assertEqual((record["kind"], record["search_dir"]), ("scans_dir", "/storage/roms/bios")) + def test_duckstation_config_is_kept_when_present(self): + (record,) = records(el.duckstation) + self.assertEqual(record["installs"]["path"], "/emuelec/configs/duckstation/settings.ini") + self.assertIs(record["kept_if_present"], True) + self.assertEqual(record["overrides"], []) + def test_duckstation_with_a_fixed_bios_path_raises(self): changed = DUCKSTATION_INI.replace("PathPAL =", "PathPAL = /storage/roms/bios/scph5502.bin") with self.assertRaises(LauncherPatternMissing): @@ -631,7 +631,8 @@ class StandaloneRecords(unittest.TestCase): def test_every_extractor_runs_on_the_fixtures(self): found = el.extract_launchers(tree()) - self.assertEqual(len(found), 28) + # The two mame.ini folders are no longer records. + self.assertEqual(len(found), 26) class Revision(unittest.TestCase): diff --git a/tests/test_launchers_knulli.py b/tests/test_launchers_knulli.py index 2657c8dd5..16500d681 100644 --- a/tests/test_launchers_knulli.py +++ b/tests/test_launchers_knulli.py @@ -598,10 +598,11 @@ class BootDisks(unittest.TestCase): self.assertEqual((hard.names, hard.passes_to), (["{bootdisk}.chd"], "command line -hard")) self.assertEqual(hard.expands, {"bootdisk": ["macos3", "mac755"]}) self.assertTrue(hard.depends_on_option.startswith("bootdisk (system.name == 'macintosh'")) - self.assertEqual( - hard.source_ref, - f"{G}/mame/mameGenerator.py:3-4, 9-10, {kl.ES_FEATURES}:8-10", - ) + # The menu's values are where the choices come from, the generator + # writing the choice is the evidence. + self.assertEqual(hard.source_ref, f"{G}/mame/mameGenerator.py:3-4, 9-10") + self.assertEqual(hard.choices_from, f"{kl.ES_FEATURES}:8-10") + self.assertIsNone(floppy.choices_from) def test_a_name_built_another_way_raises(self): broken = MAME.replace('"/userdata/bios/" + system.config["bootdisk"] + ".chd"', "disk") diff --git a/tests/test_launchers_rocknix.py b/tests/test_launchers_rocknix.py index 29d31dce7..730645c63 100644 --- a/tests/test_launchers_rocknix.py +++ b/tests/test_launchers_rocknix.py @@ -85,13 +85,14 @@ MELONDS_SH = text( sed -i '/^ExternalBIOSEnable=/c\\ExternalBIOSEnable=0' /storage/.config/melonDS/melonDS.ini fi fi + CONF_DIR="/storage/.config/melonDS" """ ) def melonds_tree() -> RepoTree: pkg = f"{SA}/melonds-sa" - return RepoTree.from_files( + return rocknix_tree( { **devices("AMD64", "H700", "RK3576", "S922X"), f"{pkg}/package.mk": MELONDS_MK, @@ -148,6 +149,7 @@ AMIBERRY_SH = text( cp -rf /usr/config/amiberry ${AMIBERRY_DIR} fi cd ${AMIBERRY_DIR} + amiberry -f "${AMIBERRY_TMP_CONFIG}" --autoload "$1" >> ${AMIBERRY_LOG} 2>&1 """ ) @@ -291,6 +293,22 @@ FLYCAST_SH = text( ) +USERCONFIG = text( + """ + #!/bin/bash + if [ ! -e "/storage/.configured" ] + then + rsync -a --ignore-existing --exclude={es_features.cfg,es_systems.cfg} /usr/config/* /storage/.config/ >/var/log/configure.log 2>&1 + fi + """ +) + + +def rocknix_tree(files: dict[str, str], links: dict[str, str] | None = None) -> RepoTree: + """A ROCKNIX tree holding the first-boot copy every config record cites.""" + return RepoTree.from_files({rl.USERCONFIG: USERCONFIG, **files}, links) + + def by(records: list[dict], emulator: str) -> list[dict]: return [r for r in records if r["emulator"] == emulator] @@ -302,23 +320,26 @@ class ConfigsPerDevice(unittest.TestCase): empty, named = records self.assertEqual(empty["names"], []) self.assertTrue(empty["passes_to"].endswith("DSiNANDPath left empty")) + # melonDS opens the DSi BIOS and firmware keys only under + # DSiExternalBIOSEnable, which no shipped config sets. self.assertEqual( - named["names"], - [ - "bios9.bin", - "bios7.bin", - "firmware.bin", - "dsi_bios9.bin", - "dsi_bios7.bin", - "dsi_firmware.bin", - "dsi_nand.bin", - ], + named["names"], ["bios9.bin", "bios7.bin", "firmware.bin", "dsi_nand.bin"] ) self.assertEqual(named["search_dir"], "/storage/roms/bios") + self.assertEqual(named["installs"]["path"], "/storage/.config/melonDS/melonDS.ini") + self.assertIs(named["kept_if_present"], True) + self.assertEqual(named["overrides"], []) + + def test_a_config_setting_the_dsi_switch_keeps_the_dsi_keys(self): + tree = melonds_tree() + path = f"{SA}/melonds-sa/config/S922X/melonDS.ini" + tree._texts[path] = tree.read(path) + "DSiExternalBIOSEnable=1\n" + named = rl.melonds(tree)[1].entry() + self.assertIn("dsi_bios9.bin", named["names"]) def test_a_linked_device_directory_reads_its_target(self): named = rl.melonds(melonds_tree())[1].entry() - self.assertIn(f"{SA}/melonds-sa/config/InputPlumber/melonDS.ini:2-8", named["source_ref"]) + self.assertIn(f"{SA}/melonds-sa/config/InputPlumber/melonDS.ini:2-4, 8", named["source_ref"]) self.assertNotIn("config/RK3576", named["source_ref"]) def test_the_external_bios_switch_is_the_option(self): @@ -330,11 +351,14 @@ class ConfigsPerDevice(unittest.TestCase): def test_identical_configs_give_one_record_without_device(self): pkg = f"{SA}/dsperate-sa" - tree = RepoTree.from_files( + tree = rocknix_tree( { **devices("H700", "RK3576", "S922X"), f"{pkg}/package.mk": DSPERATE_MK, - f"{pkg}/scripts/start_dsperate.sh": '${EMUPERF} /usr/bin/dsperate --config "${DSPERATE_INI}" "${ROM}"\n', + f"{pkg}/scripts/start_dsperate.sh": ( + '${EMUPERF} /usr/bin/dsperate --config "${DSPERATE_INI}" "${ROM}"\n' + 'DSPERATE_INI="/storage/.config/dsperate/dsperate.ini"\n' + ), f"{pkg}/config/H700/dsperate.ini": DSPERATE_INI, f"{pkg}/config/InputPlumber/dsperate.ini": DSPERATE_INI, f"{pkg}/config/S922X/dsperate.ini": DSPERATE_INI, @@ -352,10 +376,11 @@ class ConfigsPerDevice(unittest.TestCase): def test_an_absent_key_and_an_empty_one_hand_over_the_same(self): pkg = f"{SA}/duckstation-sa" - tree = RepoTree.from_files( + tree = rocknix_tree( { **devices("AMD64", "S922X"), f"{pkg}/package.mk": DUCKSTATION_MK, + f"{pkg}/scripts/start_duckstation.sh": "#!/bin/bash\n", f"{pkg}/config/AMD64/settings.ini": "[BIOS]\nSearchDirectory = /storage/roms/bios\n", f"{pkg}/config/S922X/settings.ini": text( """ @@ -375,10 +400,11 @@ class ConfigsPerDevice(unittest.TestCase): def test_a_bios_written_into_a_path_key_is_an_unknown_shape(self): pkg = f"{SA}/duckstation-sa" - tree = RepoTree.from_files( + tree = rocknix_tree( { **devices("S922X"), f"{pkg}/package.mk": DUCKSTATION_MK, + f"{pkg}/scripts/start_duckstation.sh": "#!/bin/bash\n", f"{pkg}/config/S922X/settings.ini": "[BIOS]\nSearchDirectory = /storage/roms/bios\nPathNTSCU = scph5501.bin\n", } ) @@ -387,7 +413,7 @@ class ConfigsPerDevice(unittest.TestCase): def test_a_package_without_a_device_copy_raises(self): pkg = f"{SA}/duckstation-sa" - tree = RepoTree.from_files( + tree = rocknix_tree( { **devices("S922X"), f"{pkg}/package.mk": "makeinstall_target() {\n true\n}\n", @@ -402,7 +428,7 @@ class NamesTheConfigsFix(unittest.TestCase): def test_amiberry_machine_follows_the_game_name(self): pkg = f"{SA}/amiberry" uae = "amiberry.rom_path=/storage/.config/amiberry/kickstarts/\nkickstart_rom_file=@BIOS_PATH@/{}\nkickstart_ext_rom_file=\n" - tree = RepoTree.from_files( + tree = rocknix_tree( { f"{pkg}/scripts/start_amiberry.sh": AMIBERRY_SH, f"{pkg}/package.mk": AMIBERRY_MK, @@ -412,9 +438,15 @@ class NamesTheConfigsFix(unittest.TestCase): ) a1200, a500, link, entered, copied = (r.entry() for r in rl.amiberry(tree)) self.assertEqual((a1200["slot"], a1200["names"]), ("A1200", ["kick40068.A1200.rom"])) - self.assertEqual(a1200["depends_on_option"], "game name matches AGA|CD32") + self.assertEqual( + a1200["depends_on_option"], + "game name matches AGA|CD32, content not booted with --autoload, " + "a WHDLoad .lha or .zip (start_amiberry.sh:17)", + ) + self.assertEqual(a1200["installs"]["path"], "${AMIBERRY_TMP_CONFIG}") + self.assertIs(a1200["kept_if_present"], False) self.assertEqual((a500["slot"], a500["names"]), ("A500", ["kick34005.A500.rom"])) - self.assertEqual(a500["depends_on_option"], "game name does not match AGA|CD32") + self.assertTrue(a500["depends_on_option"].startswith("game name does not match AGA|CD32")) self.assertEqual(a500["search_dir"], "/storage/roms/bios") self.assertEqual( a1200["source_ref"], @@ -443,7 +475,7 @@ class NamesTheConfigsFix(unittest.TestCase): def test_mednafen_one_record_per_module(self): pkg = f"{SA}/mednafen" - tree = RepoTree.from_files( + tree = rocknix_tree( { f"{pkg}/config/common/mednafen.template": MEDNAFEN_TEMPLATE, f"{pkg}/scripts/start_mednafen.sh": MEDNAFEN_SH, @@ -461,7 +493,7 @@ class NamesTheConfigsFix(unittest.TestCase): def test_mednafen_without_a_firmware_directory_raises(self): pkg = f"{SA}/mednafen" - tree = RepoTree.from_files( + tree = rocknix_tree( { f"{pkg}/config/common/mednafen.template": "psx.bios_eu scph5502.bin\n", f"{pkg}/scripts/start_mednafen.sh": MEDNAFEN_SH, @@ -473,7 +505,7 @@ class NamesTheConfigsFix(unittest.TestCase): class SearchedNames(unittest.TestCase): def tree(self, script: str) -> RepoTree: - return RepoTree.from_files({f"{SA}/yabasanshiro-sa/scripts/start_yabasanshiro.sh": script}) + return rocknix_tree({f"{SA}/yabasanshiro-sa/scripts/start_yabasanshiro.sh": script}) def test_yabasanshiro_tries_its_names_in_order(self): (record,) = [r.entry() for r in rl.yabasanshiro(self.tree(YABASANSHIRO_SH))] @@ -514,7 +546,7 @@ class Links(unittest.TestCase): def tree(self) -> RepoTree: scripts = self.all_scripts() - return RepoTree.from_files({p: scripts[e] for e, p in rl.LINK_SCRIPTS}) + return rocknix_tree({p: scripts[e] for e, p in rl.LINK_SCRIPTS}) def emulator(self, name: str) -> list[dict]: return by([r.entry() for r in rl.links(self.tree())], name) @@ -566,7 +598,7 @@ class Links(unittest.TestCase): def test_a_script_without_a_bios_link_raises(self): scripts = self.all_scripts() scripts["flycast"] = 'ln -sf "/storage/.config/flycast" "/storage/.local/share/flycast"\n' - tree = RepoTree.from_files({p: scripts[e] for e, p in rl.LINK_SCRIPTS}) + tree = rocknix_tree({p: scripts[e] for e, p in rl.LINK_SCRIPTS}) with self.assertRaises(LauncherPatternMissing): rl.links(tree) @@ -603,7 +635,7 @@ class ProgramsRunOutsideTheBiosFolder(unittest.TestCase): PATH = f"{SA}/pico-8/scripts/start_pico8.sh" def test_pico8_runs_its_binary_from_roms(self): - (record,) = [r.entry() for r in rl.pico8(RepoTree.from_files({self.PATH: START_PICO8}))] + (record,) = [r.entry() for r in rl.pico8(rocknix_tree({self.PATH: START_PICO8}))] self.assertEqual( (record["emulator"], record["kind"], record["names"], record["search_dir"], record["passes_to"]), @@ -615,7 +647,7 @@ class ProgramsRunOutsideTheBiosFolder(unittest.TestCase): def test_a_script_without_its_binary_choice_raises(self): broken = START_PICO8.replace('STATIC_BIN="pico8_dyn"', "STATIC_BIN=$OTHER") with self.assertRaises(LauncherPatternMissing): - rl.pico8(RepoTree.from_files({self.PATH: broken})) + rl.pico8(rocknix_tree({self.PATH: broken})) class Revision(unittest.TestCase): diff --git a/tests/test_site_components.py b/tests/test_site_components.py index a6f64c7bb..e89ddceb6 100644 --- a/tests/test_site_components.py +++ b/tests/test_site_components.py @@ -328,7 +328,7 @@ class TitleLogoOnAPlate(unittest.TestCase): # written, the tile's and the title's. import sitemarkup # noqa: PLC0415 - self.assertRegex(sitemarkup._tile_mark("MyMinUI", ""), r"]*>.*>MM") + self.assertIn('data-initials="MM" aria-hidden="true">', sitemarkup._tile_mark("MyMinUI", "")) component = _read(REPO_ROOT / "website" / "src" / "components" / "PageTitle.astro") self.assertIn("{initials(setup.name)}", component) @@ -409,7 +409,7 @@ class WideTablesStackAndFiltersAreBuilt(unittest.TestCase): def test_the_filter_box_is_in_the_html(self): html = _built("gaps-files-to-source") - boxes = re.findall(r'
(.*?)
\s*]*>(.*?)\s*Filter [^<]+') diff --git a/tests/test_site_entry.py b/tests/test_site_entry.py index cd1c1ac55..557c67f27 100644 --- a/tests/test_site_entry.py +++ b/tests/test_site_entry.py @@ -160,7 +160,7 @@ class SetupTiles(unittest.TestCase): def test_a_setup_without_a_logo_shows_its_initials(self): self.assertEqual(sitemarkup.initials("MyMinUI"), "MM") tile = "".join(sitemarkup.platform_tiles([("MyMinUI", "x.md", "", "Handhelds")])) - self.assertIn(">MM", tile) + self.assertIn('data-initials="MM"', tile) tile = "".join(sitemarkup.platform_tiles([("RomM", "x.md", "logo.png", "A server")])) self.assertIn('' + r' ' + r"25 rows\n
', text) # The Status column is empty on every row: not written. @@ -210,7 +211,7 @@ class TheWantedListIsOneFilteredTable(unittest.TestCase): self.assertIn("| Nintendo - GameCube - BIOS Images | 16 |", self.page) def test_every_dump_is_one_row_under_a_filter_box(self): - box = re.search(r'
.*?
\n]*>\n' + box = re.search(r'
]*>.*?
\n]*>\n' r"All 31 wanted dumps\n
IPL.bindolphin-emu/Sys/GC/{region}/" + self.assertIn(f"IPL.bin dolphin-emu/Sys/GC/{region}/ " 'OK', "\n".join(lines)) diff --git a/tests/test_site_nav.py b/tests/test_site_nav.py index 7dc611aff..871631ea1 100644 --- a/tests/test_site_nav.py +++ b/tests/test_site_nav.py @@ -396,7 +396,7 @@ class _Page(HTMLParser): def handle_endtag(self, tag: str) -> None: if tag == "nav" and self._crumbs: self._crumbs = 0 - if tag == "div" and self._pagination and not self.pagination: + if tag == "nav" and self._pagination and not self.pagination: self._pagination = False if self._text is not None and tag in ("a", "summary"): self.sidebar.append(" ".join("".join(self._text).split())) @@ -621,7 +621,7 @@ def _html(url: str) -> str: def _pagination(text: str) -> tuple[str | None, str | None]: - start = text.find('
", start)] diff --git a/tests/test_site_page_text.py b/tests/test_site_page_text.py new file mode 100644 index 000000000..0aa4e3b52 --- /dev/null +++ b/tests/test_site_page_text.py @@ -0,0 +1,366 @@ +"""The text a page gives to whatever reads it without looking at it. + +A crawler, a screen reader, an assistant, a text browser and a copy read +the words of the HTML, not the layout. The Steam Deck steps of Get the +files read three times there, once in the prose and once per drawn layout +glued letter to letter ("Open Konsole3Click Copy,the button bythe line"), +a filter box read "Filter Options41 rows" and the file picker an empty +"Setup Choose a setup". These tests read representative pages the way such +a reader does, skipping what is `hidden`, `aria-hidden`, scripts and +styles, and hold the page to one reading of each thing it says. +""" + +from __future__ import annotations + +import tests # noqa: F401 offline, scratch under tmp/, the suite's own cache + +import json +import re +import shutil +import subprocess +import sys +import unittest +from html.parser import HTMLParser +from pathlib import Path + +ROOT = Path(__file__).resolve().parent.parent +sys.path.insert(0, str(ROOT / "scripts")) + +import sitediagrams # noqa: E402 +import siteentries # noqa: E402 +import sitesteps # noqa: E402 +from siteguides import TERMINALS # noqa: E402 + +WEBSITE = ROOT / "website" +DOCS = WEBSITE / "src" / "content" / "docs" +DIST = WEBSITE / "dist" +PLUGIN = WEBSITE / "src" / "plugins" / "rehype-stack-tables.mjs" +SATTERI = WEBSITE / "node_modules" / "satteri" / "dist" / "index.js" + +# The pages that hold each kind: the drawn steps and the picker, the +# figures, a filter box written by the build, one by the generator above +# a file list, one above an entry table, and the stats of a setup page. +PAGES = ("which-pack", "wiki/first-install", "wiki/architecture", "wiki/what-are-bios-files", + "wiki/installer", "platforms/retrodeck", "provenance-no-intro", "explore", "index") + +BLOCKS = frozenset( + "address article aside blockquote caption dd details dialog div dl dt fieldset figcaption " + "figure footer form h1 h2 h3 h4 h5 h6 header hr li main nav ol option p pre section select " + "summary table tbody td tfoot th thead tr ul".split()) +VOID = frozenset("area base br col embed hr img input link meta source track wbr".split()) +# What the stylesheet lays out as its own box beside the text before it: +# the markup has to space it, a reader without the stylesheet sees no box. +# A
breaks a line on screen only: a copy and textContent join across +# it, so it separates nothing here. link-title is the page name of +# Starlight's previous and next links. +OWN_BOX = ("rb-tile-name", "rb-tile-runs", "rb-stat-label", "rb-badge", "rb-table-filter-count", + "link-title") + + +class PageText(HTMLParser): + """The text of a page, as a reader without the stylesheet gets it: a + block starts a line, an inline element adds nothing between words. + Skips script, style, template, `hidden` and `aria-hidden`. A tab panel, + hidden until its tab is picked, is read: it is content, not chrome.""" + + def __init__(self, article_only: bool = False) -> None: + super().__init__(convert_charrefs=True) + self.parts: list[str] = [] + self.stack: list[tuple[str, bool]] = [] + self.skipping = 0 + self.inside = not article_only + self.glued: list[str] = [] + + def _text_so_far(self) -> str: + return "".join(self.parts[-4:]) + + def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None: + attr = {key: value or "" for key, value in attrs} + classes = attr.get("class", "").split() + if not self.inside: + self.inside = "sl-markdown-content" in classes + return + if self.skipping: + if tag not in VOID: + self.stack.append((tag, False)) + return + if tag == "img": + self.parts.append(attr.get("alt", "")) + return + if tag in BLOCKS: + self.parts.append("\n") + if any(name in OWN_BOX for name in classes) or (tag == "code" and self.stack + and self.stack[-1][0] == "summary"): + before = self._text_so_far() + if before and not before[-1].isspace(): + self.glued.append(f"{before[-20:]!r} <{tag} class={' '.join(classes)!r}>") + if tag in VOID: + return + skip = (tag in ("script", "style", "template") + or ("hidden" in attr and attr.get("role") != "tabpanel") + or attr.get("aria-hidden") == "true") + self.stack.append((tag, skip)) + self.skipping += skip + + def handle_endtag(self, tag: str) -> None: + if tag in VOID or not self.inside: + return + while self.stack: + name, skip = self.stack.pop() + self.skipping -= skip + if name == tag: + break + if not self.skipping and tag in BLOCKS: + self.parts.append("\n") + + def handle_data(self, data: str) -> None: + if self.inside and not self.skipping: + self.parts.append(data) + + @property + def text(self) -> str: + return re.sub(r"\n\s*", "\n", re.sub(r"[ \t]+", " ", "".join(self.parts))).strip() + + +def read(html: str, article_only: bool = False) -> PageText: + reader = PageText(article_only) + reader.feed(html) + reader.close() + return reader + + +def _letters(text: str) -> str: + """The text without any space: the letters an SVG wrapped across text + nodes still spell, joined or not.""" + return re.sub(r"\s+", "", text.replace("**", "")) + + +def _sources() -> dict[str, str]: + found = {} + for page in PAGES: + for suffix in (".mdx", ".md"): + path = DOCS / f"{page}{suffix}" + if path.is_file(): + found[page] = path.read_text(encoding="utf-8") + return found + + +def _built() -> dict[str, str]: + found = {} + for page in PAGES: + path = DIST / ("index.html" if page == "index" else f"{page}/index.html") + if path.is_file(): + found[page] = path.read_text(encoding="utf-8") + return found + + +class PageReadsOnce: + """The assertions, on generated page sources (the HTML the generators + write, Markdown left as text) and on built pages when there are any.""" + + pages: dict[str, PageText] + + def test_the_drawn_steps_are_not_read_again(self): + checked = 0 + for name, page in self.pages.items(): + text = _letters(page.text) + for tab, (title, steps) in sitesteps.STEPS.items(): + prose = _letters(TERMINALS[tab][1]) + with self.subTest(page=name, tab=tab): + self.assertLessEqual(text.count(prose), 1) + self.assertNotIn(_letters(title), text) + self.assertNotIn(_letters(sitesteps.description(tab)), text) + # A drawn layout repeats every caption: a caption long + # enough to be told apart is read at most once, by the + # prose when it says it. + for step in steps: + caption = _letters(step.caption) + if len(caption) >= 16: + checked += 1 + self.assertLessEqual(text.count(caption), 1, step.caption) + self.assertGreater(checked, 0) + + def test_a_figure_says_its_words_once(self): + for name, page in self.pages.items(): + text = _letters(page.text) + for image_id in sitediagrams.IMAGE_IDS: + figure = sitediagrams.figures()[image_id] + with self.subTest(page=name, image=image_id): + self.assertLessEqual(text.count(_letters(figure.desc)), 1) + self.assertLessEqual(text.count(_letters(figure.caption)), 1) + + def test_no_rows_counter_glued_to_a_label(self): + for name, page in self.pages.items(): + with self.subTest(page=name): + self.assertIsNone(re.search(r"[^\s\d,(][\d,]*\d rows\b", page.text)) + self.assertIsNone(re.search(r"(?m)^Filter \S", page.text)) + + def test_no_empty_picker(self): + for name, page in self.pages.items(): + with self.subTest(page=name): + self.assertNotIn("Choose a setup", page.text) + + def test_what_sits_in_its_own_box_is_spaced(self): + for name, page in self.pages.items(): + with self.subTest(page=name): + self.assertEqual(page.glued, []) + + +class GeneratedPagesReadOnce(PageReadsOnce, unittest.TestCase): + @classmethod + def setUpClass(cls): + sources = _sources() + if "which-pack" not in sources: + raise unittest.SkipTest("no generated pages: run scripts/generate_site.py") + cls.pages = {name: read(text) for name, text in sources.items()} + + def test_the_pages_hold_what_is_checked(self): + sources = _sources() + self.assertIn("rb-steps", sources["which-pack"]) + self.assertIn('class="rb-table-filter" hidden', sources["platforms/retrodeck"]) + self.assertIn('class="rb-table-filter" hidden', sources["provenance-no-intro"]) + self.assertIn('class="rb-figure"', sources["wiki/architecture"]) + + +class BuiltPagesReadOnce(PageReadsOnce, unittest.TestCase): + @classmethod + def setUpClass(cls): + built = _built() + if "which-pack" not in built: + raise unittest.SkipTest("no built site") + cls.pages = {name: read(text, article_only=True) for name, text in built.items()} + + def test_the_build_writes_the_filter_boxes_hidden(self): + boxes = re.findall(r'
]*>', _built()["wiki/installer"]) + self.assertTrue(boxes) + for box in boxes: + self.assertIn(" hidden", box) + + +class TheTwoFilterBoxesAreOne(unittest.TestCase): + """rehype-stack-tables.mjs writes the box above a Markdown table, + siteentries.filter_box above an HTML one: the same markup, so site.ts, + the stylesheet and every reader meet one box.""" + + def test_the_build_writes_what_the_generator_writes(self): + node = shutil.which("node") + if not node or not SATTERI.is_file(): + self.skipTest("no node or no website/node_modules") + rows = "\n".join(f"| a{i} | b | c |" for i in range(22)) + script = ( + f"const {{ markdownToHtml }} = await import({json.dumps(SATTERI.as_uri())});\n" + f"const {{ default: stackTables }} = await import({json.dumps(PLUGIN.as_uri())});\n" + f"const md = {json.dumps(f'## Options{chr(10)}{chr(10)}| Flag | What | When |{chr(10)}|---|---|---|{chr(10)}{rows}{chr(10)}')};\n" + "console.log(markdownToHtml(md, { hastPlugins: [stackTables()] }).html);\n" + ) + built = subprocess.run([node, "--input-type=module", "-e", script], capture_output=True, + text=True, check=True, timeout=60).stdout + box = re.search(r'
', built, re.S) + self.assertIsNotNone(box) + self.assertEqual(box.group(0), siteentries.filter_box( + "rb-table-filter-1", "Options", ["Flag", "What", "When"], 22)) + + def test_a_box_reads_nothing_until_wired(self): + box = siteentries.filter_box("x", "files", ["File", "path"], 41) + self.assertEqual(read(box).text, "") + self.assertIn('aria-describedby="x-count"', box) + self.assertIn(' ('.rb-table-filter[hidden]')) box.hidden = false", + source) + css = (WEBSITE / "src" / "styles" / "retrobios.css").read_text(encoding="utf-8") + self.assertIn(".rb-table-filter[hidden] { visibility: hidden; }", css) + + +class PreviousAndNextAreSpaced(unittest.TestCase): + """Starlight's previous and next links read "PreviousWhat the packs do + not hold": the word and the title were split by a
only. The + override (src/components/Pagination.astro) spaces them and names each + link by its direction and its page.""" + + def test_the_override_is_registered(self): + config = (WEBSITE / "astro.config.mjs").read_text(encoding="utf-8") + self.assertIn("Pagination: './src/components/Pagination.astro',", config) + + def test_word_and_title_are_spaced_and_named(self): + source = (WEBSITE / "src" / "components" / "Pagination.astro").read_text(encoding="utf-8") + for word, rel, page in (("previousWord", "prev", "prev"), ("nextWord", "next", "next")): + with self.subTest(rel=rel): + self.assertIn(f"{{{word}}}{{' '}}\n\t\t\t\t\t
", source) + self.assertIn(f'rel="{rel}" aria-label={{`${{{word}}}: ${{{page}.label}}`}}', source) + self.assertRegex(source, r'
') + page = read(html, article_only=True) + self.assertEqual(page.glued, []) + self.assertEqual(page.text, "Previous A Next B") + self.assertTrue(read(html.replace("Previous
", "Previous
"), article_only=True).glued) + + +class ThePickerWaitsForItsScript(unittest.TestCase): + def test_hidden_until_the_setups_are_listed(self): + source = (WEBSITE / "src" / "components" / "FilePicker.astro").read_text(encoding="utf-8") + self.assertRegex(source, r'