Document .recomp.json for game projects in the README - #256
Merged
Merged
Conversation
ran-j
requested changes
Sep 29, 2026
| 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 |
Owner
There was a problem hiding this comment.
Please put a disclaimer sayng that this is optional and the ps2recomp dev has no tied to this project
Contributor
Author
There was a problem hiding this comment.
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.
ran-j
approved these changes
Sep 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #255.
Adds a "Describing Your Game Project" section to the README, before Limitations: what
.recomp.jsonis for, a starter file for a PS2Recomp game, how to read the serial and region from the retail ELF name, the status values, and a link to the full spec.The wiki can't take a pull request, so it isn't touched here. If you want the same text on a wiki page, feel free to copy the section as is.