From 638bc563e38c4b791372cbb894197ebe71adceef Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Sun, 4 Oct 2026 16:50:39 +0200 Subject: [PATCH] docs: plain punctuation in ten engine profiles --- emulators/abuse.yml | 2 +- emulators/catacombgl.yml | 4 ++-- emulators/cdogs.yml | 20 ++++++++++---------- emulators/cgenius.yml | 2 +- emulators/fba2x.yml | 10 +++++----- emulators/hcl.yml | 10 +++++----- emulators/pyxel.yml | 8 ++++---- emulators/taradino.yml | 2 +- emulators/xash3d_fwgs.yml | 2 +- emulators/yquake2.yml | 6 +++--- 10 files changed, 33 insertions(+), 33 deletions(-) diff --git a/emulators/abuse.yml b/emulators/abuse.yml index 94f03787..cc36cad7 100644 --- a/emulators/abuse.yml +++ b/emulators/abuse.yml @@ -21,7 +21,7 @@ notes: | is set in src/sdlport/setup.cpp: 1. -datadir CLI argument (setup.cpp:327-332) 2. datadir= in abuse.cfg (setup.cpp:182) - 3. ASSETDIR compile-time constant, filled by CMakeLists.txt:45-54 — "." on + 3. ASSETDIR compile-time constant, filled by CMakeLists.txt:45-54, "." on Windows, abuse.app/Contents/Resources/data on macOS, share/games/abuse on Linux (setup.cpp:441-474) Loader1 reads abuse.lsp via lisp (loader2.cpp:284), which chain-loads diff --git a/emulators/catacombgl.yml b/emulators/catacombgl.yml index 88794695..3eb5b3f0 100644 --- a/emulators/catacombgl.yml +++ b/emulators/catacombgl.yml @@ -14,7 +14,7 @@ verification: existence notes: | OpenGL source port by Arno Ansems of id Software's Catacomb Adventure series: - Catacomb 3-D: The Descent (.C3D) - - Catacomb Abyss (.ABS) — three releases v1.12 / v1.13 / v1.24 + - Catacomb Abyss (.ABS), three releases v1.12 / v1.13 / v1.24 - Catacomb Armageddon (.ARM) - Catacomb Apocalypse (.APC) @@ -32,7 +32,7 @@ notes: | Each supported game sits in its own directory, picked by the user through the game selection menu (src/Engine/GameSelection.cpp). No separate BIOS is - needed — the retail / shareware DOS data files are the only requirement. + needed: the retail / shareware DOS data files are the only requirement. The Catacomb Adventure Series releases (Abyss shareware, Armageddon, Apocalypse) were made freeware by Flat Rock Software and are distributed by diff --git a/emulators/cdogs.yml b/emulators/cdogs.yml index 783278fb..24e457ca 100644 --- a/emulators/cdogs.yml +++ b/emulators/cdogs.yml @@ -24,16 +24,16 @@ notes: | Top-level sub-trees the game pulls files from (every path is relative to CDOGS_DATA_DIR, resolved through GetDataFilePath): - data/ — ammo.json, bullets.json, guns.json, pickups.json, - map_objects.json, character_classes.json, particles.json, - gamecontrollerdb.txt, prefixes.txt (configuration data) - graphics/ — sprites, font, icons; grafx.c:92 (cdogs_icon.bmp), - grafx.c:156 (font.png + font.json) - missions/ — single-player campaigns, mission packs (JSON) - music/ — menu, briefing, game, end, lose, victory tracks - (music.c:45-50 LoadMusic calls) - sounds/ — sfx wavs - dogfights/ — deathmatch arenas + data/: ammo.json, bullets.json, guns.json, pickups.json, + map_objects.json, character_classes.json, particles.json, + gamecontrollerdb.txt, prefixes.txt (configuration data) + graphics/: sprites, font, icons; grafx.c:92 (cdogs_icon.bmp), + grafx.c:156 (font.png + font.json) + missions/: single-player campaigns, mission packs (JSON) + music/: menu, briefing, game, end, lose, victory tracks + (music.c:45-50 LoadMusic calls) + sounds/: sfx wavs + dogfights/: deathmatch arenas All open-source content (GPL-2.0). No separate BIOS or retail data required. diff --git a/emulators/cgenius.yml b/emulators/cgenius.yml index 381913cb..957d3622 100644 --- a/emulators/cgenius.yml +++ b/emulators/cgenius.yml @@ -43,7 +43,7 @@ notes: | 8497b5696c92b13ede4f5ad01dfb577b208404cb by cgenius.mk). Game directories are searched under the user's roms root. The engine then - loads from vfsroot/global/ at startup — fonts, trophy UI, generic sounds — + loads from vfsroot/global/ at startup (fonts, trophy UI, generic sounds), which is bundled with the install, not with the Keen data. files: diff --git a/emulators/fba2x.yml b/emulators/fba2x.yml index 7fda8878..aa9b26a5 100644 --- a/emulators/fba2x.yml +++ b/emulators/fba2x.yml @@ -24,20 +24,20 @@ notes: | Recalbox's standalone ARM port of Final Burn Alpha, lineage pifba (originally by Franxis / Oopsware for the GP2X, modernised to SDL2 by Recalbox). The binary is installed as fba2x and runs with a ZIP path on the command line - (rpi/main.cpp:187 — "Usage: fba2x .zip"). + (rpi/main.cpp:187, "Usage: fba2x .zip"). BIOS and ROM archives are resolved relative to szAppRomPath, hardcoded to "roms/" in rpi/bzip.cpp:4 and overridden only through the rom path argument. BzipOpen (rpi/bzip.cpp:355-394) iterates BurnDrvGetZipName(z) for every - BIOS/parent slot and opens "" directly — no fallback + BIOS/parent slot and opens "" directly: no fallback directory walking. Shared BIOS ROM sets flagged BDF_BOARDROM in the driver source: - - neogeo (burn/neogeo/d_neogeo.cpp) — SNK Neo Geo system BIOS - - pgm (burn/pgm/d_pgm.cpp) — IGS PGM board BIOS + - neogeo (burn/neogeo/d_neogeo.cpp), SNK Neo Geo system BIOS + - pgm (burn/pgm/d_pgm.cpp), IGS PGM board BIOS CPS1 and CPS2 titles embed their program/encryption ROMs directly in each - game archive — no CPS board BIOS zip. CPS3 (burn/cps3/d_cps3.cpp) carries + game archive: no CPS board BIOS zip. CPS3 (burn/cps3/d_cps3.cpp) carries the SH-2 BIOS as a BRF_BIOS member of each game's archive (red-earth, jojo, sfiii, etc.), so there is no shared cps3.zip here either. diff --git a/emulators/hcl.yml b/emulators/hcl.yml index b0f63cb0..fa26013a 100644 --- a/emulators/hcl.yml +++ b/emulators/hcl.yml @@ -18,11 +18,11 @@ notes: | The engine opens every data file from a relative "data/" prefix hard-coded in the sources: - - qda.c:19 — strcpy(fullPath, "data/") before appending qda chunk names - - hero.c:202 — fopen("data/save.tmp", "rb") - - sdl2/audio.c:30 — strcpy(buff, "data/") before midi/wav loads - - sdl2/graphics.c, sdl3/graphics.c — fopen("data/bmp.qda", "rb") - - game.h:184 — savename macro = "data/save.tmp" + - qda.c:19, strcpy(fullPath, "data/") before appending qda chunk names + - hero.c:202, fopen("data/save.tmp", "rb") + - sdl2/audio.c:30, strcpy(buff, "data/") before midi/wav loads + - sdl2/graphics.c, sdl3/graphics.c: fopen("data/bmp.qda", "rb") + - game.h:184, savename macro = "data/save.tmp" Save files are rewritten in that same relative data/ tree, so the game must be launched from a working directory that contains data/ (batocera copies the shipped data/ beside the binary). diff --git a/emulators/pyxel.yml b/emulators/pyxel.yml index 4fbe1394..ca93770e 100644 --- a/emulators/pyxel.yml +++ b/emulators/pyxel.yml @@ -19,10 +19,10 @@ notes: | There is no external BIOS, firmware, or retail data to collect. Everything the engine needs ships inside the Python wheel: - python/pyxel/ — Python API, fonts, shader, examples - crates/pyxel-core/ — Rust engine (compiled as pyxel_extension) - crates/pyxel-platform/ — SDL2 wrapper - crates/pyxel-wrapper/ — Python ↔ Rust glue (PyO3) + python/pyxel/: Python API, fonts, shader, examples + crates/pyxel-core/: Rust engine (compiled as pyxel_extension) + crates/pyxel-platform/: SDL2 wrapper + crates/pyxel-wrapper/: Python to Rust glue (PyO3) Batocera's packaging (package/batocera/emulators/python-pyxel/python-pyxel.mk) installs the wheel into site-packages, drops the examples, and provides a diff --git a/emulators/taradino.yml b/emulators/taradino.yml index 8b62c78f..8fc2ef04 100644 --- a/emulators/taradino.yml +++ b/emulators/taradino.yml @@ -38,7 +38,7 @@ notes: | REMOTE1.RTS carries the "Remote Ridicule" speech bank; its absence is silently tolerated (rott/rt_main.c:830-834). - No hash is validated — the loader relies on WAD lump names and the + No hash is validated: the loader relies on WAD lump names and the SHAREWARE_TAG magic number inside the RTL (rott/rt_ted.c:1432). files: diff --git a/emulators/xash3d_fwgs.yml b/emulators/xash3d_fwgs.yml index 19ab65b4..46791b1c 100644 --- a/emulators/xash3d_fwgs.yml +++ b/emulators/xash3d_fwgs.yml @@ -41,7 +41,7 @@ notes: | files: # ================================================================ - # Half-Life (valve/) — base game, chained parent of every HL1 mod + # Half-Life (valve/), base game, chained parent of every HL1 mod # ================================================================ - name: "liblist.gam" diff --git a/emulators/yquake2.yml b/emulators/yquake2.yml index 2feaa483..8049c67a 100644 --- a/emulators/yquake2.yml +++ b/emulators/yquake2.yml @@ -65,7 +65,7 @@ files: note: "Added by community re-releases and the KMQuake2 content pack." # ================================================================ - # The Reckoning (xatrix/) — official Mission Pack 1 + # The Reckoning (xatrix/), official Mission Pack 1 # Separate yquake2 game library repo: yquake2/xatrix. # ================================================================ @@ -78,7 +78,7 @@ files: note: "The Reckoning data. Loaded when `+set game xatrix` is passed." # ================================================================ - # Ground Zero (rogue/) — official Mission Pack 2 + # Ground Zero (rogue/), official Mission Pack 2 # Separate yquake2 game library repo: yquake2/rogue. # ================================================================ @@ -91,7 +91,7 @@ files: note: "Ground Zero data. Loaded when `+set game rogue` is passed." # ================================================================ - # Three Wave Capture The Flag (ctf/) — official free addon + # Three Wave Capture The Flag (ctf/), official free addon # Separate yquake2 game library repo: yquake2/ctf. # ================================================================