Repository navigation
docs: READMEs, CONTRIBUTING and format references - #49
Merged
Merged
Conversation
The README says which repositories this one replaces, fixes the layout table, and adds getting started and wheels. CONTRIBUTING covers setup, the hooks, tests with and without game data, commit style, the no-game-data rule and licences. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Each says what it is, how to install or build it from a clone, a short example, its status and its licence. modkit-testing gets one; mhfu lists the abi and live stage commands; the remote-debugger menu path follows PPSSPP 1.20.4. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Provenance and session narration give way to the fact and its limit ("unverified in game").
The hitzone note now agrees with the studio: grid writes take effect, hit-volume edits are
unverified.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…stages Layout tables checked against mhp-formats, mhfu-port, mhfu and the studio, with an index and the conventions they share. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Docs for going public.
modkit-testinggets its first. Root README: a layout table that matches the tree, and a Getting started section. Nothing is prebuilt; each README says how to build its part.docs/formats/: references for DATA.BIN, PAC, PMO, TMH, skeleton and animation, and stages. Each one names the class that reads it, and every table was checked against the code.Tested: pre-commit on all files; pytest with game data, 1913 passed. Every command the READMEs name was run, except the Blender build,
studio/docker/run.sh,mhfu startandmhp-formats extract, which were checked against their code only.🤖 Generated with Claude Code