# Mario Kart Wii for PS5

**English** · [Français](README_FR.md)

A native PlayStation 5 port of **Mario Kart Wii PAL (RMCP01)**, based on [WiiCompiled](https://github.com/patchzyy/Wiicompiled).

- Launches as **Kart PS5** from the PS5 home screen.
- Statically recompiles the Wii game and renders through the PS5 GPU using AGC.
- Uses DualSense controls mapped to a GameCube controller.

> Bring your own Mario Kart Wii PAL disc data. Other regions are not supported by this executable.
>
> Compatible with **PS5 and PS5 Pro** (jailbroken consoles).

> Another repo with Retro Rewind coming soon x)

---

## Features

| Feature | Status |
| --- | --- |
| Native GPU rendering | AGC backend |
| Frame rate | 60 FPS reported on PS5 Pro after kstuff is paused |
| Controller | DualSense, GameCube button mapping |
| Saves | Local NAND in `UserData/NAND` |
| Game region | PAL, RMCP01 |
| Title ID | `PPSA99611` |
| Online play | Unavailable |

The game is capped at 60 FPS because its logic depends on that timing. The first seconds after launch run more slowly while kstuff is still active.

### Known limitations

- The 2D mini-map during races does not display correctly.
- Firmware-specific packages are not a compatibility test. See [firmware notes](docs/FIRMWARE.md).

## Requirements

- A jailbroken PS5, an FTP server and an ELF loader.
- kstuff; the release documentation lists EchoStretch v1.6.7.
- ShadowMountPlus 1.6beta16; the tested 1.7alpha versions rejected the title information.
- Your own Mario Kart Wii PAL extraction, with `DATA/sys/main.dol` and `DATA/files/rel/StaticR.rel`.
- Approximately 3 GB of available console storage.

## Download and personal game files

[Download the recompiled application and firmware overlays](https://github.com/Phi1ow/mkwii-ps5/releases/tag/v1.0.0-rc1).

The recompiled executables are included. Separate disc images (ISO/RVZ/WBFS), extracted `main.dol` / `StaticR.rel` files and the extracted game DATA tree are **not** supplied. Extract your own PAL RMCP01 copy using the [installation guide](docs/INSTALL_EN.md). Supply a firmware-compatible signed `libc.prx` at `PPSA99611/sce_module/libc.prx` (see [how to get it from your own console](docs/LIBC_EXTRACTION.md)); Sony libraries and personal saves are not included.

The executable is a static recompilation and retains embedded game-derived code/data. Excluding separate ROM files does not remove that content; this is not a claim that the binary contains no game data. The public FW 9.40 variant reached the menu on a PS5 Pro after adding `portable.txt`; other variants still need testing.

Do not upload disc images, extracted files, Sony libraries or personal NANDs in issues or pull requests.

## Installing

Follow the [English installation guide](docs/INSTALL_EN.md) or [French installation guide](docs/INSTALL_FR.md).

1. Unzip `Kart-PS5.zip` and locate `Kart-PS5-candidate/PPSA99611/`. The application folder is `PPSA99611`, not `Kart-PS5-candidate`.
2. Unzip `Backport.zip`, choose `Backport-candidate/FW_<your firmware>/PPSA99611/` (for example `FW_11.60`), and **replace the application's `eboot.bin` and `sce_sys/param.json`** with those two files. The firmware variant alone is not a complete application.
3. Extract your own PAL disc's data partition with Dolphin into `DATA`, then place `DATA` and your own signed `libc.prx` at the locations shown in the guide. Check that `PPSA99611/portable.txt` exists (create an empty file if missing): the original `v1.0.0-rc1` archive omitted it, and the game stays on a black screen without this marker.
4. Copy **the `PPSA99611` folder** into `/data/` using FTP. Check that `/data/PPSA99611/eboot.bin` exists directly, with no extra directory level.
5. Send `Outils/droits-kart-ps5.elf` to the ELF loader to set executable permissions.
6. Add `/data/PPSA99611` on its own line in `/data/shadowmount/manual.lst` (preserve any existing lines). ShadowMountPlus 1.6beta16 does not scan `/data` directly by default.
7. Configure ShadowMountPlus to pause kstuff after launch, then launch **Kart PS5** from the home screen.

The tested delay setting, in `/data/shadowmount/config.ini`, is:

```ini
kstuff_delay=PPSA99611:5
```

The full guide explains auto-toggle settings and recovery if ShadowMountPlus increases that delay after a crash.

## Controls (DualSense)

Default controls: the port uses Mario Kart Wii's GameCube controller mode. No Wii Remote motion gestures are needed.

| DualSense button | Action in Mario Kart Wii |
| --- | --- |
| Left stick | Steer; navigate menus |
| Cross (✕) | Accelerate; confirm menu selections |
| Circle (○) or R2 | Brake / reverse; hop and drift in manual mode. Circle also goes back in menus |
| Triangle (△) or L2 | Use an item; hold to trail items that support it |
| Square (□) or R1 | Look behind |
| D-pad, as you leave a jump | Perform a trick |
| D-pad up, while riding a bike | Start a wheelie |
| D-pad down, while riding a bike | End a wheelie |
| Options | Open the pause menu |

For manual drifting, hold Cross to accelerate, press R2 or Circle and steer with the left stick. Release the drift button once sparks have charged to trigger a mini-turbo. Automatic drift does not provide manual mini-turbos.

Mappings were checked against the port's input code and the [Nintendo Mario Kart Wii manual, GameCube controls and driving techniques](https://www.mariomayhem.com/downloads/mario_instruction_booklets/Mario_Kart_Wii-WII.pdf). This is a source/documentation check, not a new console test. Custom button bindings may change these controls.
## Application layout

```text
PPSA99611/
├── eboot.bin
├── DATA/                  Your extracted PAL disc data
├── sce_module/libc.prx    Firmware-dependent runtime library
├── sce_sys/               Title metadata and icon
├── shaders/               AGC shaders
├── runtime/               Runtime assets
├── wii_bootstrap/         First-run Wii bootstrap
└── UserData/
    ├── Config.toml
    ├── NAND/              Saves; preserve when updating
    └── Logs/              Created at runtime
```

## Reporting issues

Include console model, firmware, package variant, track and steps to reproduce. Logs are under `/data/PPSA99611/UserData/Logs/base_<date>_pid<N>/`. Review logs before sharing them and do not attach disc data or your full NAND.

## Credits

- [WiiCompiled](https://github.com/patchzyy/Wiicompiled): static recompilation and game runtime.
- [ps5link-sdk](https://github.com/Rufidj/ps5link-sdk): PS5 linking and AGC foundation.
- [SharpProspero](https://github.com/SvenGDK/SharpProspero): signing tools and shader containers.
- Dolphin contributors: disc extraction tooling and the referenced Wii bootstrap layout.
- kstuff, ShadowMountPlus and their contributors: console launch environment.

## Repository status

The PS5 source code and pinned dependency modifications are included. See [build notes](docs/BUILDING.md), [release notes](docs/RELEASE-NOTES.md) and [license notices](THIRD-PARTY-NOTICES.md). A clean build has not been verified.