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.
This commit is contained in:
Abdessamad Derraz committed 2026-11-09 08:23:47 +01:00
1 parent 78e22851dd
commit e684d5793a
11 files changed
+16

No files matched your search

+1
View File
@@ -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"
+1
View File
@@ -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"
+1
View File
@@ -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"
+1
View File
@@ -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
+1
View File
@@ -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: >-
+2
View File
@@ -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: >
+1
View File
@@ -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.
+1
View File
@@ -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)."
+1
View File
@@ -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]
+1
View File
@@ -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"
+5
View File
@@ -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: >-