Contributing - RetroBIOS¶
Add a BIOS file¶
- Fork this repository
- Place the file in
bios/Manufacturer/Console/filename - Variants (alternate hashes for the same file): place in
bios/Manufacturer/Console/.variants/ - Create a Pull Request - hashes are verified automatically
Add a platform¶
- Create a scraper in
scripts/scraper/(inheritBaseScraper) - Read the platform's upstream source code to understand its BIOS check logic
- Add entry to
platforms/_registry.yml - Generate the platform YAML config
- Test:
python scripts/verify.py --platform <name>
Add an emulator profile¶
- Clone the emulator's source code
- Search for BIOS/firmware loading (grep for
bios,rom,firmware,fopen) - Document every file the emulator loads with source code references
- Write YAML to
emulators/<name>.yml - Test:
python scripts/cross_reference.py --emulator <name>
File conventions¶
bios/Manufacturer/Console/filenamefor canonical filesbios/Manufacturer/Console/.variants/filename.sha1prefixfor alternate versions- Files >50 MB go in GitHub release assets (
large-filesrelease) - RPG Maker and ScummVM directories are excluded from deduplication
PR validation¶
The CI automatically: - Computes SHA1/MD5/CRC32 of new files - Checks against known hashes in platform configs - Reports coverage impact