SuperTux (Wii)

<p align="center"> <img src="https://raw.githubusercontent.com/DeltaResero/SuperTux-Wii/master/data/images/title/logo.png" alt="SuperTux-Wii"> </p>

<br><br>

Wii port of the free open source game SuperTux Classic (Milestone 1)

Ported by: scanff & Arikado
Updated by: DeltaResero
Type: Platform game
Version: 0.1.4-wii-d.07
Software license: GPLv3+

<!-- Link Definitions --> <br>

About Repository

This is a continuation fork of the original Wii port by scanff and Arikado, available at Google Code archive, of SuperTux Classic (Milestone 1). Originally built with SDL 1.2, this port has been modernized to use SDL2 for Wii. It is designed for use through the Homebrew Channel with OpenGL (via OpenGX) support.

The original SuperTux repository has been migrated from Google Code to GitHub. The source code for Classic SuperTux Milestone 1 can now be found in the milestone 1 branch of the SuperTux GitHub repository. For more information about SuperTux, please visit the official website at supertux.org.

<br>

About SuperTux

SuperTux is a jump'n'run game with strong inspiration from the Super Mario Bros. games for various Nintendo platforms.

Run and jump through multiple worlds, fighting off enemies by jumping on them, bumping them from below, or tossing objects at them, while grabbing power-ups and other collectibles along the way.

<br>

Setup Guide for devkitPro PowerPC Build System

To set up the devkitPro devkitPPC PowerPC build system, follow the instructions on the official devkitPro wiki:

• Getting Started with devkitPro
• devkitPro Pacman

After setting up devkitPPC including environment variables, use (dkp-)pacman to install the following dependencies:

Build Tools (Required):

devkitPPC (C++23 compatible compiler)
wii-cmake
wii-pkg-config

Core Libraries (Required):

libogc
libfat-ogc
wii-sdl2
wii-sdl2_image
wii-sdl2_mixer

Graphics & Compression:

ppc-libpng
ppc-libjpeg-turbo
ppc-freetype
ppc-zlib

Audio Codecs (Required for Audio):

wii-libmodplug
ppc-libvorbis
ppc-libogg
ppc-libmad

OpenGL/OpenGX Backend (Optional but Recommended):

wii-freeglut
wii-glu
wii-opengx

<br>

Build Configuration

You can configure the build by passing flags to cmake. For example, to disable OpenGL support, append the following flag to your cmake command: -DENABLE_OPENGL=OFF

Option	Description	Default
CMAKE_BUILD_TYPE	Build type (Debug or Release)	Release
ENABLE_OPENGL	Build with OpenGL support	ON
WARNINGS	Set Extra compiler warnings (-Wall -Wextra)	ON

<br>

How to Build: Wii Homebrew Build

1. Create a build directory:

   mkdir build
   cd build
   

2. Configure using CMake and the included Wii Toolchain file:

   cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/Wii.cmake ..
   

3. Build the game:

   make -j$(nproc)
   

   This will generate boot.dol in the build directory.

<br>

Installing SuperTux on Wii (Homebrew Channel)

1. Create a supertux folder under apps/ on your SD or USB device.

2. Copy in the built boot.dol, the data folder from the source tree, and the icon and metadata from packaging/wii/:

   SD:/apps/supertux/boot.dol
   SD:/apps/supertux/data/
   SD:/apps/supertux/icon.png
   SD:/apps/supertux/meta.xml
   

3. Launch SuperTux from the Homebrew Channel. The game will create a config file and save folder on the first run.

<br>

How to Build: Desktop Linux (Testing/Unsupported)

1. Install Dependencies: You will need the following build tools. For the libraries listed below, ensure you install the development headers (often ending in -dev or -devel).

   Build Tools:

   C++23 Compiler (GCC 11.1+ or Clang 13+)
   CMake 3.20+
   

   SDL 2 Framework:

   SDL2 (or sdl2-compat)
   SDL2_image
   SDL2_mixer
   

   Core Libraries:

   libpng
   libjpeg
   zlib
   

   Graphics (Optional):

   OpenGL
   

2. Create a build directory:

   mkdir build_linux
   cd build_linux
   

3. Configure for desktop:

   cmake ..
   

4. Build:

   make -j$(nproc)
   

5. Run it straight from the build directory. It finds the data folder in the source tree:

   ./supertux-wii
   

   To make a portable copy, put the supertux-wii binary and the data folder side by side in any folder. Saves and settings go to ~/.local/share/supertux-wii either way.

Important Note on Installation: While sudo make install is supported by CMake, it is not recommended for this project. Installing files directly to your system directories this way without using a package manager makes them very difficult to uninstall cleanly later. We strongly recommend running from the build directory or a portable copy instead.

Note on Other Operating Systems: Support for other platforms (Windows, macOS, BSD) is currently outside the scope of this repository, as the primary focus is the Wii hardware. Given the standard CMake infrastructure, adapting the build system for other platforms should be fairly trivial. <br>

License

This program is distributed under the terms of the GNU General Public License version 3 (or later). You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Please see the LICENSE file for the full text.

Disclaimer

This is an unofficial port of SuperTux that runs on the Wii via the Homebrew Channel. It is not affiliated with, endorsed by, nor sponsored by the creators of the Wii console nor the Homebrew Channel. All trademarks and copyrights are the property of their respective owners.

This project is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.