Init repo with dummy data

This commit is contained in:
Tim Jochen Kicker
2026-02-21 13:55:21 +01:00
parent 82cb47b284
commit 3f75cff8ee
3 changed files with 162 additions and 0 deletions

75
README.md Normal file
View File

@@ -0,0 +1,75 @@
# Wii U Mod Store — Repository Template
This is the official template for hosting mods on the **Wii U Mod Store** app.
## How to use
1. Fork this repository
2. Edit `repo.json` with your repo name and author
3. Add your games under `games/[game-id]/game.json`
4. Host your mod ZIPs anywhere (GitHub Releases, direct links, etc.)
5. Add your raw `repo.json` URL to the Mod Store app
## Repository URL format
After forking, your repo index URL will look like:
```
https://raw.githubusercontent.com/YOUR-USERNAME/YOUR-REPO/main/repo.json
```
Add this to `sd:/wiiu/apps/modstore/config.json` on your Wii U SD card:
```json
{
"repos": [
"https://raw.githubusercontent.com/YOUR-USERNAME/YOUR-REPO/main/repo.json"
]
}
```
## Folder structure
```
repo/
├── repo.json ← Repo index (required)
└── games/
└── [game-id]/
├── game.json ← Game info + mod list
└── assets/
└── cover.png ← Game cover image (optional)
```
## Mod types
- `mod` — A single standalone mod
- `modpack` — A bundle of multiple mods installed together
## game.json fields
| Field | Required | Description |
|-------|----------|-------------|
| `name` | yes | Display name of the game |
| `cover` | no | Relative path to cover image |
| `title_ids` | yes | Array of Wii U Title IDs (all regions) |
| `mods` | yes | Array of mod objects |
## Mod fields
| Field | Required | Description |
|-------|----------|-------------|
| `id` | yes | Unique identifier (no spaces) |
| `name` | yes | Display name |
| `type` | yes | `mod` or `modpack` |
| `version` | yes | Semantic version string |
| `author` | yes | Author name |
| `description` | yes | Description text |
| `thumbnail` | no | URL to thumbnail image (400x225 recommended) |
| `screenshots` | no | Array of screenshot URLs |
| `download` | yes | Direct URL to ZIP file |
| `modpack_path` | yes | SDCafiine path (`content/` or `aoc/`) |
| `includes` | modpack only | Array of mod IDs included in bundle |
## Notes
- Title IDs can be found at [wiiubrew.org/wiki/Title_list](https://wiiubrew.org/wiki/Title_list)
- Mod ZIPs must match the SDCafiine folder structure (`content/` at root of ZIP)
- The app does **not** verify mod safety — only distribute mods you trust