mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-24 04:39:06 -05:00
Abdessamad Derraz
6353ee53df
Five tabs from Start here to Contribute, a level on every page, a device picker on Get your files that lists every registered platform, and platform pages that open on where the files go, the command, the pack and how to check. FAQ and troubleshooting keep the questions asked before installing, the technical ones move to their own page, and getting started points to the pages that took its content.
60 lines
3.0 KiB
Markdown
60 lines
3.0 KiB
Markdown
---
|
|
level: reference
|
|
---
|
|
|
|
# Reference
|
|
|
|
These pages describe how the files are checked, what the data holds and how the
|
|
toolchain works. To set up BIOS files on a device, start with
|
|
[Get your files](../which-pack.md).
|
|
|
|
## How the files are checked
|
|
|
|
- **[How each platform checks files](verification-modes.md)** - existence, MD5 and SHA1 modes, severity matrix, resolution chain, reading `verify.py` output
|
|
- **[What the packs do not hold](../gaps.md)** - files emulators load that no pack can carry yet, by platform and by emulator
|
|
- **[Cross-reference](../cross-reference.md)** - files the emulators of a platform load and its own list does not name
|
|
- **[Dump provenance](../provenance.md)** - how the collection lines up against the No-Intro, Redump and TOSEC catalogs
|
|
- **[Updated platform files](../exports.md)** - each platform's own file, with the changes the emulator source supports
|
|
- **[Technical questions](technical-faq.md)** - multiple hashes, MAME versions, UNTESTED, dump verification
|
|
|
|
## Data
|
|
|
|
- **[Data and API](../data.md)** - JSON, CSV and SQLite exports with their checksums
|
|
- **[Find a file by its SHA1](../files/index.md)** - the permanent address of a file by its contents
|
|
- **[Data model](data-model.md)** - database.json structure, indexes, file resolution order, YAML formats
|
|
|
|
## The toolchain
|
|
|
|
- **[Architecture](architecture.md)** - directory structure, data flow, platform inheritance, pack grouping, security, edge cases, CI workflows
|
|
- **[Build your own packs](advanced-usage.md)** - custom packs, region filtering, one file per slot, target filtering, truth generation, emulator verification, offline workflow
|
|
- **[Command-line tools](tools.md)** - every script, pipeline usage, scrapers
|
|
- **[Projects using this data](community-tools.md)** - projects built on RetroBIOS data
|
|
|
|
## Methodology
|
|
|
|
Platform lists are checked against emulator source code, file by file where a
|
|
profile exists. Documentation and metadata can differ from what a program does
|
|
at run time, so the source is the primary reference:
|
|
|
|
1. **Upstream emulator source**: what the original project loads (Dolphin,
|
|
PCSX2, Mednafen and others)
|
|
2. **Libretro core source**: the RetroArch port, which may adapt paths or add
|
|
files
|
|
3. **`.info` declarations**: metadata that platforms rely on, checked against
|
|
the two above
|
|
|
|
## For contributors
|
|
|
|
- **[Profiling an emulator](profiling.md)** - create an emulator profile from source code, YAML field reference
|
|
- **[Adding a platform](adding-a-platform.md)** - scraper, registry, YAML config, exporter, target scraper, install detection
|
|
- **[Adding a scraper](adding-a-scraper.md)** - plugin architecture, BaseScraper, parsers, target scrapers
|
|
- **[Testing](testing-guide.md)** - run tests, fixture pattern, how to add tests, CI integration
|
|
- **[Release process](release-process.md)** - CI workflows, large files, manual release
|
|
|
|
See [contributing](../contributing.md) for submission guidelines.
|
|
|
|
## Glossary
|
|
|
|
The words these pages use, from BIOS to provenance, are in the
|
|
[glossary](glossary.md).
|