# Documentation

[← Back to the project](../README.md)

> [!IMPORTANT]
> **Experimental project: expect bugs.** Our CPU recompiler and native renderer diverge from
> bbport and can be less stable. For the dedicated macOS port of bbport, see
> [bmy/bbport-mac](https://github.com/bmy/bbport-mac).

## Playing

1. [Installation](guide/installation.md): download, first start, where your data lives.
2. [Game files](guide/game-files.md): preparing your dump, supported editions, The Old Hunters.
3. [Settings](guide/settings.md): the launcher, the in-game menu, recommended settings,
   languages, controllers.
4. [Profiles and saves](guide/saves.md): profiles, backups, trophies.
5. [Mods and patches](guide/mods-and-patches.md)
6. [Performance](guide/performance.md)
7. [Troubleshooting](guide/troubleshooting.md): common problems, known issues, what was fixed.
8. [Updates](guide/updates.md)

[Release notes](releases/)

## Developing

- [Architecture](ARCHITECTURE.md): the four repositories, the app, a launch, where it is going.
- [Building and releasing](BUILDING.md)
- [Status and where to continue](STATUS.md)
- [Roadmap](ROADMAP.md): the plan as a checklist.
- Each part's own docs: [runtime](https://github.com/bloodborne-native/bloodborne-runtime/tree/main/docs),
  [recompiler](https://github.com/bloodborne-native/bloodborne-recomp/tree/main/docs),
  [launcher](https://github.com/bloodborne-native/bloodborne-launcher/tree/main/docs).

## Project

- [Credits and licenses](CREDITS.md)