Skip to content

[Feature] A .recomp.json describing the port #263

Description

@neurocontrarian

Before you continue

  • I searched the existing issues and nobody has suggested this yet.
  • This is about WiiCompiled itself, not WheelWizard or Retro Rewind content.

What would you like to see?

I run recomp.board (https://recomp.fyi), a table of recomps and decomps in progress, so people can see who is working on what before they start a game. WiiCompiled is on it, and so is ral1009/NSMBWiicompiled. The board reads each row from what the repository says about itself, so it can't tell yet that WiiCompiled has public releases, or which disc it needs.

I'm proposing a small open file, .recomp.json, at the root of a game repository: game, system, status, the release the project needs, whether it wants help. Spec: https://recomp.fyi/spec. JSON Schema: https://recomp.fyi/schema/v1.json (both CC BY 4.0). The board reads it every day, and any other list or tool can read the same file.

For WiiCompiled it could be:

{
  "$schema": "https://recomp.fyi/schema/v1.json",
  "game": "Mario Kart Wii",
  "system": "Wii",
  "type": "recomp",
  "project": "WiiCompiled",
  "status": "released",
  "targets": ["Windows", "Linux", "macOS"],
  "original": { "region": "Europe", "serial": "RMCP01" }
}

released is my reading of your releases page; change it if it's wrong. The file is meant to follow the project: when the status changes, editing it updates every list that reads it. A stale file is worse than none.

Workarounds you've tried

None: without the file, lists guess from the README.

neurocontrarian

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions