From 1c0c502258a32487b94013b05c4e886eb86bd634 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Fri, 3 Apr 2026 13:33:21 +0200 Subject: [PATCH] docs: add community tools section Reference BIOS Preservation Tool by monster-penguin in README, wiki, and site nav. --- README.md | 4 ++++ mkdocs.yml | 1 + scripts/generate_site.py | 1 + wiki/community-tools.md | 21 +++++++++++++++++++++ wiki/index.md | 4 ++++ 5 files changed, 31 insertions(+) create mode 100644 wiki/community-tools.md diff --git a/README.md b/README.md index 8984aa7e..b776480c 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,10 @@ To keep packs accurate, each file is checked against the emulator's source code. 3. **Build packs** - include baseline files plus what each platform's cores need 4. **Verify** - run platform-native checks and emulator-level validation +## Community tools + +- [BIOS Preservation Tool](https://github.com/monster-penguin/BIOS-Preservation-Tool) by [monster-penguin](https://github.com/monster-penguin) - scan, verify, and stage your own BIOS collection using RetroBIOS hash metadata + ## Contributors diff --git a/mkdocs.yml b/mkdocs.yml index cad80f5f..9ed856c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -481,4 +481,5 @@ nav: - Adding a scraper: wiki/adding-a-scraper.md - Testing guide: wiki/testing-guide.md - Release process: wiki/release-process.md + - Community tools: wiki/community-tools.md - Contributing: contributing.md diff --git a/scripts/generate_site.py b/scripts/generate_site.py index dc485848..d096087b 100644 --- a/scripts/generate_site.py +++ b/scripts/generate_site.py @@ -2211,6 +2211,7 @@ def generate_mkdocs_nav( {"Adding a scraper": "wiki/adding-a-scraper.md"}, {"Testing guide": "wiki/testing-guide.md"}, {"Release process": "wiki/release-process.md"}, + {"Community tools": "wiki/community-tools.md"}, ] return [ diff --git a/wiki/community-tools.md b/wiki/community-tools.md new file mode 100644 index 00000000..4411b86b --- /dev/null +++ b/wiki/community-tools.md @@ -0,0 +1,21 @@ +# Community tools + +Projects built on RetroBIOS data. + +--- + +## BIOS Preservation Tool + +**Author:** [monster-penguin](https://github.com/monster-penguin) +**Repository:** [github.com/monster-penguin/BIOS-Preservation-Tool](https://github.com/monster-penguin/BIOS-Preservation-Tool) +**License:** MIT + +A local tool for managing your own BIOS collection. Point it at your files, it verifies them against RetroBIOS platform YAMLs, stores them in a deduplicated database, and produces ready-to-use directories for each platform. Supports scanning directories, archives, and URLs. + +See the project's [README](https://github.com/monster-penguin/BIOS-Preservation-Tool#readme) for setup and usage. + +--- + +!!! note "Add your project" + + Open an issue with a link to your repository. diff --git a/wiki/index.md b/wiki/index.md index 5872c1ec..a78c3b62 100644 --- a/wiki/index.md +++ b/wiki/index.md @@ -28,6 +28,10 @@ If you just want to download BIOS packs, see the [home page](../index.md). See [contributing](../contributing.md) for submission guidelines. +## Community + +- **[Community tools](community-tools.md)** - projects built on RetroBIOS data + ## Glossary - **BIOS** - firmware burned into console hardware, needed by emulators that rely on original boot code