Guide

Testing your mod

Run it in Dolphin, check it, and keep a history of your work.

Run in Dolphin

Revolution Editor launches your own copy of Dolphin (a separate, free emulator). If it isn't found, choose it in Settings > Emulator. In the Run menu, Standard Boot runs a disc, folder or WAD. Force Stop in the toolbar quits Dolphin if it hangs.

Settings > Emulator also sets how Dolphin is launched: video backend (Metal, Vulkan, OpenGL or software), internal resolution, fullscreen, emulation speed, CPU clock, dual-core, pausing when Dolphin loses focus, muting audio and dumping textures. Leave an option on Dolphin's setting to keep whatever Dolphin itself uses. Extra launch options are added to Dolphin's command line as written.

Hot Swap

Skip rebuilding an ISO. Right-click a file and choose Mark for Hot Swap, pick what it replaces (for Mario Kart Wii, a track slot), then press Run. Only marked files are swapped onto your base disc, which is never changed.

Before Dolphin starts, every marked track and arena is checked and the results are listed as Errors, Warnings and Suggestions. Errors are things likely to crash the game (a missing file, a broken path link, an arena on a race track slot, the wrong base disc), and the mod won't run until they're fixed. Building a .wbz or .wlz refuses a track with errors too. Warnings and suggestions don't stop you playing. Each one says what happens in-game and how to fix it, and many have an Auto Correct button that fixes the marked file for you (copying a missing itembox.brres from your disc, renaming a misnamed model, repairing path links, clearing broken route links...) and checks again. Copy Report copies the list as text. To test something on purpose that the checks would stop, turn off Safeguards in Settings > Emulator. For a step-by-step walkthrough see the custom track tutorial. On GameCube, the app makes a patched copy of the disc that boots in Dolphin or Nintendont.

Review Crash Logs

If the game freezes or Dolphin closes, choose Help > Review Crash Logs (or the button in Settings > Emulator). The app reads Dolphin's log, explains what went wrong in plain English with ideas for fixing it, and names the last files the game loaded. Switch to Crash Section to read just the lines around the crash. Dolphin only writes a log if Write to File is on in its View > Show Log Configuration.

Homebrew projects

Hot Swap isn't used for homebrew apps. The Run button builds and runs the app in Dolphin, and its menu offers Run via Homebrew Channel, which installs the app on Dolphin's SD card and boots the Homebrew Channel. See Wii Homebrew.

Before a real Wii

Switch Build for to Hardware-compatible in Settings > Games, rebuild, and run Check Laps and Verify Archive. Test early; a crash is easier to find the fewer changes you've made.

Source Control

The toolbar's Source Control is a built-in Git panel: start a repository, see changed files, commit, pull and push. It's optional and uses the Git on your Mac.