New Super Mario Bros. Wii for Linux - version 0.2.1
https://github.com/WitherBlitz/NSMB-Wii-Multiplayer-Recompilation

Made by WitherBlitz with WiiCompiled's code. Entirely coded by Claude Opus 5.5.

This download contains NO game files. It runs your own copy of New Super Mario Bros. Wii
(USA, SMNE01, revision 1), extracted with Dolphin.


GETTING THE GAME FILES (ONCE)

1. Open Dolphin (on this or any computer) and find New Super Mario Bros. Wii in the game list.
2. Right-click it, choose Properties, then the Filesystem tab.
3. Right-click the disc at the top and choose Extract Entire Disc, then pick an empty folder.
4. Start ./NSMBW and choose that folder when it asks (it uses zenity or kdialog to ask; without
   either, it tells you where to put the folder).
   Or name the folder "game" and put it next to NSMBW; then it doesn't ask.

Keep the folder: the game reads it every time it runs.
Dolphin shows the game's revision under Properties > Info. Only the USA disc, revision 1
works: other regions and revisions put the game's code at other addresses.


CONTROLS (a Wii Remote held sideways)

  Arrow keys        Move (D-pad)
  X or Space        2 (jump). Space in the air spins (Space Smart Spin QoL)
  Z or Left Shift   1 (run, fireball)
  C or Ctrl         Shake (spin, pick up)
  Q / E             Tilt left / right
  B                 A
  Enter or Esc      + (pause; on the world map, its menu)
  Minus or Tab      -
  F10               Settings bar (resolution, display, audio and more)
  F11               Fullscreen on / off

Every key can be changed: on the save file screen, press Up and pick the gear at the top
right (or Settings in the world map's + menu, or Settings in a level's pause window), then the
Keybinds tab. Choose a control and press the new key.

A game controller also works as a sideways Wii Remote. On the game's menus (title screen,
save files, world map buttons, pause and + menus, Save windows) you can also just click what you
want with the mouse.

The Audio tab has Master, Music and Sound Effects sliders: drag one with the mouse, or move it
5% at a time with left and right.

Space Smart Spin QoL (Keybinds tab, on by default): Space pressed while Mario is in the air spins
him, like shaking the remote, instead of pressing 2. Wall jumps, swimming and Yoshi keep 2, and
pressed within about a small Mario's height of the ground it is the next jump.

The Language tab switches the game's text between English, Espanol and Francais (Nintendo's own
translations on the USA disc). Restart the game after changing it.


RESOLUTION AND ULTRAWIDE

The gear on the save file screen also has the Video tab. Match Screen Resolution renders at
your monitor's own resolution and fills the whole screen, ultrawide included: you see more
of the level to the sides, nothing is stretched. Otherwise pick a multiplier: "1x (480p)" and
the like keep the original 16:9 picture (black bars on an ultrawide), "1x Ultrawide" and the
like fill the screen. LAN games always play in 16:9 so every device sees the same.


LAN AND TAILSCALE PLAY

On the save file screen, press Up to reach the Couch button at the top right and switch it to
LAN, then choose Create Room or Join. Every player needs their own
extracted game.

- Same Wi-Fi: PCs and phones find each other's rooms by themselves.
- Over the internet with Tailscale (https://tailscale.com). It works, but is unstable: a slow or
  far-away connection can stall the game. Install it on every device and sign
  in to the same tailnet (or share devices with friends). This PC finds every Tailscale device
  that runs the game, and its rooms show up on the phones by themselves. Devices that have
  played together find each other again later, from anywhere.
- F10 > LAN Play shows this PC's addresses and the devices it asks for rooms; type a device's
  Tailscale name (e.g. s26-ultra) or address there to add it by hand.

If this PC runs a firewall (ufw, firewalld), allow the game's UDP traffic on the local network,
or others can't find your room.


FILES

Settings (including where your game files are), saves, caches and logs live in
~/.local/share/WiiCompiled ($XDG_DATA_HOME/WiiCompiled if that is set), so a new version,
extracted anywhere, keeps them. To start over with a new game folder, delete the dvd_root line in
~/.local/share/WiiCompiled/Config.toml.

Saves are kept per game. To play another game as well (a mod, say), extract a second copy of this
download and put that game's extracted folder next to its NSMBW, named "game". That copy
plays it with saves of its own; this one keeps playing the original.


OLDER PROCESSORS

NSMBW needs a processor with AVX2 and FMA (Intel Haswell, 2013, or AMD Excavator, 2015, and
newer). On an older one it starts compat/NSMBW-compat instead, by itself: the same game,
built for older processors, with its math done exactly the same way, so it still plays LAN games
with everyone else. Keep the compat folder next to NSMBW.


REQUIREMENTS

A 64-bit x86 PC with a Vulkan driver (Mesa or NVIDIA) and glibc 2.35 or newer: Fedora 36 or
newer, Ubuntu 22.04 or newer, Debian 12 or newer, Arch, SteamOS and the like. X11 and Wayland both
work. Fedora Workstation, KDE and Ubuntu desktops already have everything it needs. If the game
says it found no Vulkan driver, install one:

  Fedora           sudo dnf install mesa-vulkan-drivers vulkan-loader
  Ubuntu, Debian   sudo apt install mesa-vulkan-drivers libvulkan1
  NVIDIA           the NVIDIA driver includes it (on Fedora, RPM Fusion's akmod-nvidia)


LICENSE

The program is free software under the GNU General Public License v3 (LICENSE.txt).
THIRD-PARTY-NOTICES.md lists the libraries it uses and their licenses. New Super Mario Bros.
Wii and Nintendo's code and assets belong to Nintendo; this is not affiliated with or
endorsed by Nintendo.
