Skip to content

Document .recomp.json for game projects in the README #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ran-j merged 2 commits into from
Sep 30, 2026
Merged

Document .recomp.json for game projects in the README #256

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c14f587
Document .recomp.json for game projects in the README
neurocontrarian Sep 29, 2026
d7c0a03
State that .recomp.json is optional and unrelated to PS2Recomp
neurocontrarian Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,33 @@ Use Game Override modules when:
5. Move per-game hacks into game overrides keyed by ELF metadata.
6. Re-test from cold boot after each batch.

### Describing Your Game Project

@ran-j ran-j Sep 29, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put a disclaimer sayng that this is optional and the ps2recomp dev has no tied to this project

@neurocontrarian neurocontrarian Sep 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in d7c0a03: a note right under the intro says the file is optional, PS2Recomp does not read it, and its developers have no ties to .recomp.json or recomp.board.


A game project built with PS2Recomp can describe itself in a `.recomp.json` file at the root of its repository. Lists of recomp and decomp projects, such as [recomp.board](https://recomp.fyi), read that file instead of guessing the game, system and status from the README.

> [!NOTE]
> This file is optional: PS2Recomp does not read it and works the same without it. `.recomp.json` and recomp.board are third-party projects; the PS2Recomp developers have no ties to them.

Starter file:

```json
{
"$schema": "https://recomp.fyi/schema/v1.json",
"game": "<title as it shipped>",
"system": "PS2",
"type": "recomp",
"toolchain": "PS2Recomp",
"status": "in-progress",
"original": { "region": "USA", "serial": "SLUS-20312" }
}
```

* `original` is the release a user must own. On retail discs the ELF is named after the serial (`SLUS_203.12` is `SLUS-20312`), and the prefix gives the region: `SLUS`/`SCUS` USA, `SLES`/`SCES` Europe, `SLPS`/`SLPM`/`SCPS` Japan.
* `status` is one of `exploring`, `in-progress`, `playable`, `released`, `complete`, `paused`. Edit it when the project moves on: a stale status is worse than none.
* Never put a game file, or a link to one, in the file.

Other fields (Wikidata item, target platforms, maintainers, links, what help is wanted) and the JSON Schema are in the [specification](https://recomp.fyi/spec).

### Limitations

* Performance is very bad for VU and GS
Expand Down
Loading