Repository navigation
Contributing
Contributions of code, tests, documentation, compatibility evidence, and reproducible bug reports are welcome.
- Read the Code of Conduct.
- Search issues and discussions.
- For a large change, open a discussion or issue first.
- Never include BIOS ROMs, game images, or extracted copyrighted assets.
git clone https://github.com/purelogiccode/5DO.git
cd 5DO
dotnet build 5DO.sln
dotnet test 5DO.sln
dotnet format 5DO.sln --verify-no-changesFor emulation changes, include frame/audio/state hashes and update the relevant compatibility or test-corpus evidence. See the Test strategy.
For documentation changes:
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -r requirements-docs.txt
mkdocs build --strictUse the pull request template, keep the change focused, add tests and documentation, and keep required CI checks green. See the full contributing guide and developer guide.
Do not open a public issue for a vulnerability. Use GitHub's private vulnerability reporting as described in the security policy.
5DO is donationware: non-commercial, source-available software under the FreeDO modified GNU LGPL. No BIOS ROMs or game images are distributed. "3DO" and "Panasonic" are trademarks of their respective owners; 5DO is not affiliated with or endorsed by them.