From e684d5793a7908cf9e4ef23864ed0e35611d3f7c Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 08:23:47 +0100 Subject: [PATCH] docs: mark emulator-written files unsourceable Font caches synthesised from host fonts, battery images and backup RAM the emulator creates when absent, user symbol maps, the BAM presets list and the BOOT -bios image slot have no canonical copy. --- emulators/cxbx-reloaded.yml | 1 + emulators/dolphin-mmjr.yml | 1 + emulators/dolphin-mmjr2.yml | 1 + emulators/dosbox-x.yml | 1 + emulators/future-pinball-fploader.yml | 1 + emulators/px68k-sdl.yml | 2 ++ emulators/px68k.yml | 1 + emulators/teknoparrot.yml | 1 + emulators/x1-box.yml | 1 + emulators/xm6pro68k.yml | 1 + emulators/xm6typeg.yml | 5 +++++ 11 files changed, 16 insertions(+) diff --git a/emulators/cxbx-reloaded.yml b/emulators/cxbx-reloaded.yml index e7716e748..33a7a1179 100644 --- a/emulators/cxbx-reloaded.yml +++ b/emulators/cxbx-reloaded.yml @@ -141,6 +141,7 @@ files: path: "EmuMediaBoard/Chihiro/backup_ram.bin" system: sega-chihiro required: false + unsourceable: "written by the emulator as 128 KB of zeros, no canonical file" has_builtin: true size_note: "Created as 128 KB of zeros when absent, then memory mapped" description: "Base board backup memory" diff --git a/emulators/dolphin-mmjr.yml b/emulators/dolphin-mmjr.yml index 932b85f63..9c522bcc1 100644 --- a/emulators/dolphin-mmjr.yml +++ b/emulators/dolphin-mmjr.yml @@ -241,6 +241,7 @@ files: - name: mios-ipl.map path: Maps/mios-ipl.map required: false + unsourceable: "user authored symbol map, no canonical file" description: "MIOS symbol map" note: "Read from Maps/ in the user directory when MIOS starts, and a successful load re-applies the HLE function patches against the symbols it names." source_ref: "source Source/Core/Core/IOS/MIOS.cpp:47, source Source/Core/Core/IOS/MIOS.cpp:55-66" diff --git a/emulators/dolphin-mmjr2.yml b/emulators/dolphin-mmjr2.yml index 16f2e81ea..82a32331b 100644 --- a/emulators/dolphin-mmjr2.yml +++ b/emulators/dolphin-mmjr2.yml @@ -438,6 +438,7 @@ files: - name: mios-ipl.map path: Maps/mios-ipl.map required: false + unsourceable: "user authored symbol map, no canonical file" description: "MIOS symbol map" note: "Read from Maps/ in the user directory when MIOS starts, and a successful load re-applies the HLE function patches against the symbols it names." source_ref: "source Source/Core/Core/IOS/MIOS.cpp:67-72" diff --git a/emulators/dosbox-x.yml b/emulators/dosbox-x.yml index 74dae2715..c0558259e 100644 --- a/emulators/dosbox-x.yml +++ b/emulators/dosbox-x.yml @@ -568,6 +568,7 @@ files: - name: "System BIOS image" description: "PC/AT or PC-98 BIOS ROM image booted by BOOT -bios" required: false + unsourceable: "any BIOS image the user names with BOOT -bios, no canonical file" note: > loaded at the top of the first megabyte, rounded up to a paragraph and truncated to 128 KB, or to 96 KB on PC-98, and a larger image is clamped diff --git a/emulators/future-pinball-fploader.yml b/emulators/future-pinball-fploader.yml index 21b5a035f..6e141e1c1 100644 --- a/emulators/future-pinball-fploader.yml +++ b/emulators/future-pinball-fploader.yml @@ -245,6 +245,7 @@ files: - name: XML_Presets.txt system: fpinball required: false + unsourceable: "written by BAM as presets are added, no canonical file" description: "List of physics documents offered in the presets menu" source_ref: "BAM.dll 1.5-408 .text:0x100fba6a-0x100fbd8a" note: >- diff --git a/emulators/px68k-sdl.yml b/emulators/px68k-sdl.yml index 36c3714bf..c618d3473 100644 --- a/emulators/px68k-sdl.yml +++ b/emulators/px68k-sdl.yml @@ -105,6 +105,7 @@ files: path: "cgrom30.tmp" priority: 2 required: false + unsourceable: "rendered from TrueType fonts by the font generator, no canonical file" size: 786432 source_ref: "SDL/SDL2/winx68k.cpp:280-282,317-331" note: "Substitute X68030 font, read when cgrom30.dat is absent." @@ -123,6 +124,7 @@ files: path: "cgrom.tmp" priority: 4 required: false + unsourceable: "rendered from TrueType fonts by the font generator, no canonical file" size: 786432 source_ref: "SDL/SDL2/winx68k.cpp:280-282,317-331, SDL/tool/create_cgrom.c:20" note: > diff --git a/emulators/px68k.yml b/emulators/px68k.yml index 5d73c2efe..c3b4ec4b3 100644 --- a/emulators/px68k.yml +++ b/emulators/px68k.yml @@ -104,6 +104,7 @@ files: path: "keropi/cgrom.tmp" size: 786432 required: false + unsourceable: "generated by WinX68k from the host fonts, no canonical file" note: > Alternative font file, used as fallback when cgrom.dat is absent. Typically a font cache generated by the emulator itself on other platforms. diff --git a/emulators/teknoparrot.yml b/emulators/teknoparrot.yml index 8b6ed2cf4..9e1508c3a 100644 --- a/emulators/teknoparrot.yml +++ b/emulators/teknoparrot.yml @@ -272,6 +272,7 @@ files: path: "EmuMediaBoard/Chihiro/backup_ram.bin" system: sega-chihiro required: false + 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)." diff --git a/emulators/x1-box.yml b/emulators/x1-box.yml index 17220ac2c..28cfa8f1a 100644 --- a/emulators/x1-box.yml +++ b/emulators/x1-box.yml @@ -203,6 +203,7 @@ files: - name: eeprom_chihiro.bin system: sega-chihiro required: false + unsourceable: "generated by the emulator with the debug key, no canonical file" path: "x1box/eeprom_chihiro.bin" size: 256 validation: [size] diff --git a/emulators/xm6pro68k.yml b/emulators/xm6pro68k.yml index 4d847f341..74d1a5d26 100644 --- a/emulators/xm6pro68k.yml +++ b/emulators/xm6pro68k.yml @@ -188,6 +188,7 @@ files: - name: CGROM.TMP system: sharp-x68000 required: false + unsourceable: "synthesised from the fonts installed on the host, no canonical file" min_size: 786432 validation: [size] description: "Synthesised font ROM, fallback when CGROM.DAT is absent" diff --git a/emulators/xm6typeg.yml b/emulators/xm6typeg.yml index 666cf9834..1e14b8d27 100644 --- a/emulators/xm6typeg.yml +++ b/emulators/xm6typeg.yml @@ -232,6 +232,7 @@ files: - name: CGROM.TMP system: sharp-x68000 required: false + unsourceable: "synthesised from the fonts installed on the host, no canonical file" min_size: 786432 validation: [size] description: "Synthesised font ROM, fallback when no CG ROM is present" @@ -289,6 +290,7 @@ files: - name: SRAMXVI.DAT system: sharp-x68000 required: false + 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" @@ -299,6 +301,7 @@ files: - name: SRAMCMP.DAT system: sharp-x68000 required: false + 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" @@ -308,6 +311,7 @@ files: - name: SRAM030.DAT system: sharp-x68000 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" @@ -318,6 +322,7 @@ files: - name: RTC.DAT system: sharp-x68000 required: false + unsourceable: "written by the emulator on exit, no canonical file" description: "RTC alarm settings for timer start" source_ref: "xm6g.pdf p.18, xm6g.exe:0x140592350 index 18" note: >-