CoffeeShop Repo Template

This is the official template for hosting mods on CoffeeShop, a mod manager for the Wii U.

Easiest way: use the Builder

The CoffeeShop Repo Builder is a browser tool that creates this whole structure for you. No JSON editing, no command line. Drop a mod ZIP and it computes the SHA-256 plus file size automatically. You can also import an existing repo.json URL and edit it.

The rest of this README documents the schema for anyone who wants to author the JSON by hand.

Quick Start (manual)

1. Fork this repository
2. Edit repo.json (name, author)
3. Add your game folders under games/
4. Add your mod ZIPs as GitHub Release assets
5. Share your repo.json URL with users

Structure

repo.json                        ← repo index
games/
  mario-kart-8/
    game.json                    ← game + mod definitions
  your-game/
    game.json

repo.json

{
  "formatVersion": 1,
  "name": "My Mod Repo",
  "description": "...",
  "author": "your-name",
  "version": "1",
  "games": [
    { "path": "games/mario-kart-8/game.json" }
  ]
}

game.json

{
  "name": "Mario Kart 8",
  "icon": "https://...",
  "titleIds": [
    "000500001010EB00",
    "000500001010EC00",
    "000500001010ED00"
  ],
  "mods": [ ... ]
}

Mod Fields

Field	Required	Description
id	✅	Unique ID, only a-z 0-9 - _
name	✅	Display name
author	✅	Author name
version	✅	Version string e.g. 1.0.0
description	✅	Short description
download	✅	Direct HTTPS URL to .zip file
type	✅	"mod" or "modpack"
thumbnail	☑️	Preview image URL (400x225)
screenshots	☑️	List of screenshot URLs (800x450)
includes	☑️	For modpacks: list of mod IDs
releaseDate	☑️	e.g. "2024-03-15"
license	☑️	e.g. "CC BY-NC"
tags	☑️	e.g. ["skin", "music", "course"]
fileSize	☑️	ZIP size in bytes
sha256	☑️	64-char lowercase hex hash of the ZIP. CoffeeShop verifies it post-download and rejects on mismatch.
requirements	☑️	List of required mods/patches
changelog	☑️	Free text changelog

Download URLs must be HTTPS. CoffeeShop blocks HTTP because the binary travels unauthenticated and a MITM could swap both the ZIP and the published sha256.

Validation

python3 validate.py              # check structure
python3 validate.py --check-urls # also verify download URLs

Validation runs automatically on every PR via GitHub Actions.

Mod ZIP Structure

Your ZIP must extract to a folder matching the SDCafiine layout:

your-mod.zip
└── content/
    └── ...game files...

CoffeeShop installs to: SD:/wiiu/sdcafiine/<titleId>/<modId>/