Skip to content

Add .recomp.json describing the port - #415

Merged
patchzyy merged 1 commit into
patchzyy:mainfrom
mitsa-ng:recomp-json
Nov 17, 2026
Merged

patchzyy merged 1 commit into
patchzyy:mainfrom
mitsa-ng:recomp-json

Conversation

@mitsa-ng

@mitsa-ng mitsa-ng commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #263.

Adds the .recomp.json self-description file from the recomp.fyi v1 spec at the repo root, validated against https://recomp.fyi/schema/v1.json.

Two deliberate differences from the draft in the issue:

  • original lists all three accepted releases (RMCP01, RMCE01, RMCJ01), not just PAL, since NTSC-U and NTSC-J have been supported since v0.9.0.
  • wikidata is set to Q838707 (verified against Wikidata: "2008 racing video game by Nintendo") so lists can match the game without title comparison.

Other fields come straight from the README: status: released (v0.9.4 is on the Releases page), targets Windows/Linux/macOS, and the approach line mirrors the no-emulator-at-runtime wording. Every field is optional per the spec, so trim or reword anything you disagree with; the file is meant to be edited when the project's status changes.

Content is metadata only: no game files, no links to any.

Summary by CodeRabbit

  • Documentation
    • Project information now identifies WiiCompiled as a released version of Mario Kart Wii for Windows, Linux, and macOS.
    • The metadata also lists the Wii platform, regional game identifiers, and a link to available releases.

Machine-readable self-description for the recomp.fyi spec (v1): game,
system, type, status, build targets, the three accepted disc serials,
and an approach line. The board and other lists read this file daily
instead of guessing from the README.

Fixes patchzyy#263
@coderabbitai

coderabbitai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Adds .recomp.json metadata identifying WiiCompiled as a released static recompilation of Mario Kart Wii for Windows, Linux, and macOS. The file records project and game identifiers, original regional serials, and a Releases URL.

Changes: Project metadata

Layer / File(s) Summary
Project metadata declaration
.recomp.json
Adds metadata for the Wii platform, project and game identifiers, released status, supported targets, static recompilation approach, original regional serials, and Releases URL.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to d6935

This change adds repository metadata that describes the port for external tools. It does not change runtime behavior, so merging it carries no meaningful risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Add .recomp.json describing the port" names the main change: a new root-level .recomp.json metadata file for the WiiCompiled port. The changeset adds exactly this file, and the linked issue…
Linked Issues check Passed Issue #263 asks for a root-level .recomp.json that identifies the game, system, project, status, targets, and required original release. The head commit adds .recomp.json at the repository root. I…
Out of Scope Changes check Passed The whole-PR change set consists of one added file, .recomp.json, with 19 added lines. Every field in the file maps to the issue #263 request or to the README-derived values described in the PR. The…
Full details: Title check

Explanation

The title "Add .recomp.json describing the port" names the main change: a new root-level .recomp.json metadata file for the WiiCompiled port. The changeset adds exactly this file, and the linked issue requests it. The title is specific and concise, and it is not vague.

Full details: Linked Issues check

Explanation

Issue #263 asks for a root-level .recomp.json that identifies the game, system, project, status, targets, and required original release. The head commit adds .recomp.json at the repository root. It sets game "Mario Kart Wii", system "Wii", type "recomp", project "WiiCompiled", status "released", and targets Windows, Linux, and macOS. The $schema value matches the URL in the issue. The original field lists Europe/RMCP01 (the issue's example), USA/RMCE01, and Japan/RMCJ01. The PR description states these deliberate differences from the issue example: all three releases are listed, and wikidata is set to Q838707. The issue example uses an object for original, while the file uses an array. The PR does not explain this shape change. The recomp.fyi v1 schema is not in the repository, so the array shape could not be checked against it. The PR reports validation against the schema, and the issue marks the example as a proposal ("could be"). The core requirements are met. Schema conformance of the array shape is unverified (see resolution). The issue's non-coding requirement to keep the status current is maintenance guidance and is not a coding requirement.

Full details: Out of Scope Changes check

Explanation

The whole-PR change set consists of one added file, .recomp.json, with 19 added lines. Every field in the file maps to the issue #263 request or to the README-derived values described in the PR. The file contains metadata only, with no game files or game-asset links. No unrelated code, configuration, or documentation changes were found in the summary. No out-of-scope change was identified.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 797ab9de-02e9-4c1a-b05f-50eeceb357fe
Commits

Reviewing files that changed from the base of the PR and between ffbde83 and d693515.

Files selected for processing: 1

  • .recomp.json

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.

@patchzyy
patchzyy merged commit 03151e0 into patchzyy:main Nov 17, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] A .recomp.json describing the port

2 participants