Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,12 @@

# Patch files must stay LF: git apply matches context bytes against LF upstream sources
*.patch -text

# Generated region tables and headers: reproduced byte-for-byte by the tools in
# tools/region/ (see its README). The NTSC-U data_addresses.txt is hand-built and not marked.
projects/mkwii-ntsc-*/MAP.txt linguist-generated=true
projects/mkwii-ntsc-*/MAP_REPORT.md linguist-generated=true
projects/mkwii-ntsc-*/region_port.json linguist-generated=true
projects/mkwii-ntsc-j/data_addresses.txt linguist-generated=true
projects/mkwii-ntsc-k/data_addresses.txt linguist-generated=true
runtime/include/region/rmc*.h linguist-generated=true
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ project.lock.json
/.vs/
/.vscode/
/.idea/
/tools/
/tools/*
!/tools/region/
__pycache__/
/TEMP/
/tmp/
/test_output/
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ and then throw a C++ compiler at the result. It's a **one-time cost** on your ma
**Which game version works?**
Clean PAL `RMCP01`. Other regions and modified executables are **rejected**. Translating
them against the wrong manifest would give you a subtly broken game that's miserable to debug for us.
(The translator and runtime also carry validated projects for the NTSC-U `RMCE01`, NTSC-J `RMCJ01`
and NTSC-K `RMCK01` discs - `projects/mkwii-ntsc-*`, see `tools/region/README.md` - but setup
does not offer them yet.)

**Can I recompile other GameCube/Wii games with it?**
The translator itself handles DOLs and RELs generically, see
Expand Down
22 changes: 22 additions & 0 deletions THIRD-PARTY-NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,28 @@ Aurora itself vendors:
> Upstream aurora ships `assets/screenshot.png`, a rendered frame from a different Nintendo
> title. It is intentionally omitted from this repository.

### mkw-sp region port tables - MIT

Copyright (c) 2021-2023 Pablo Stebler.
Source: <https://github.com/mkw-sp/mkw-sp> - the PAL->NTSC-U/NTSC-J/NTSC-K code chunk tables and
the per-region section layouts from its `port.py` are vendored, as data, in
`tools/region/port_map.py`, and repeated in each `projects/mkwii-ntsc-*/region_port.json`.

> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
> associated documentation files (the "Software"), to deal in the Software without restriction,
> including without limitation the rights to use, copy, modify, merge, publish, distribute,
> sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or
> substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
> NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
> DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
> OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

### Dolphin Emulator data files - GPL-2.0-or-later

Copyright (c) 2003+ Dolphin Emulator Project.
Expand Down
Loading