Repository navigation
Documentation Index
Start with installation and first boot and your first game. The website provides searchable task guides; the wiki offers the same guides in GitHub. Use the references below for implementation details, exact limits and contributor workflows.
| Task | Reference |
|---|---|
| Choose a release, SDK flavour or package | Release reference |
| Test a PR artifact or collect freeze diagnostics | Test builds |
| Understand defaults and saved settings | Fresh-start defaults |
| Diagnose setup or a failed launch | Setup questions · Troubleshooting |
| Recover a failed VMC creation | VMC creation and recovery |
| Diagnose an APA disk without formatting it | APA safety · Recovery tool |
| Topic | Reference |
|---|---|
| USB, MX4SIO and iLink | Device setup · MX4SIO launch notes |
| MMCE | MMCE setup |
| Internal HDD | APA/exFAT guide · exFAT and APA-Jail |
| SMB / UDPFS / UDPBD | SMB · Network boot |
| HTTP | HTTP profile and limits · Host conformance tools |
| Neutrino | Installation, core selection, arguments, cheats and VMC |
| PS1 | POPSTARTER and Ember, including POPS UDPFS and device/core restrictions |
| RetroAchievements | RA setup and runtime limits; requires its separate kit |
| Experimental hardware | PC CARD CF · PSX DESR DVR |
- Controls, in-game reset, GSM video and PADEMU.
- Interface, folders and audio, theme authoring, languages and Unicode game titles.
- Per-game parental locks and autolaunch/global settings.
- SIO2MAN compatibility for contributors investigating VMC/pad hooks.
Maintenance explains which source owns each surface, how to validate changes, and how to regenerate search and wiki content. The October audit records the reviewed revisions, corrections, link evidence and remaining validation limits.
Integration plans, dated audits, community-report handoffs and docs/superpowers/ are engineering
history. Their old DONE/pending states, branches and package names describe that baseline;
they are not current installation instructions. Start with the current reference above.
Historical records remain available for provenance: gap ledger,
community reports, contributor roadmap,
VMC audit, Ember plan,
HTTP plan, RA plan and
legacy changelog.
Source: docs/README.md @ 02ddafcfa212.
Start here
Storage and networking
- USB, MX4SIO and iLink
- MMCE
- Internal HDD: APA and exFAT
- PSX DESR DVR (experimental)
- PC CARD CompactFlash (experimental)
- SMB shares
- Network boot: UDPFS and UDPBD
- HTTP
- NBD server
Games and features
- Neutrino core
- PS1: POPStarter and Ember
- Per-game settings
- Virtual memory cards
- GSM video modes
- In-game reset
- Cheats
- PADEMU
- RetroAchievements
- Apps
Interface and customization
- Settings reference
- Controls
- Coverflow
- Favorites
- Theme engine
- Languages
- Japanese / Unicode game titles
Help and reference
- Troubleshooting
- ZSO format
- Backward-compatible PS3
- Credits and sources
- Features in other forks
- Project overview
Detailed references
- Documentation index
- Test builds and diagnostics
- VMC creation and recovery
- PC CARD CF implementation reference
- DESR DVR implementation reference
- Per-game parental lock
- SIO2MAN hook compatibility
- Fresh-start defaults and saved settings
- APA hard disk safety and code 402
- Autolaunch and global settings
- Folders, parental lock and audio
- Language maintenance
- HTTP server conformance tools
- APA recovery tool