/SuperTux-Wii

Wii port of SuperTux Classic

Primary LanguageC++GNU General Public License v2.0GPL-2.0

SuperTux-Wii

 

 

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

Ported by: scanff & Arikado
Updated by: DeltaResero
Type: Platform game
Version: 1.4
Software license: GPLv2

Github All Releases License Codacy Badge

 

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). It is designed for use through the Homebrew Channel using SDL Wii. More information can be found on the Wiki at SuperTux Wii on WiiBrew.

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.

 

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.

 

How to Build: Wii Homebrew Build

If you don't have the devkitPPC toolchain set up yet, see the section "devkitPro PowerPC Build System Setup Guide" first. Once devkitPPC is set up with all the required ported libraries and libogc, run the following to build the game:

  1. Run autogen.sh (uses Configure to generate the Wii makefile for building):

    ./autogen.sh --enable-wii --prefix="${DEVKITPRO}/portlibs/ppc" --host=powerpc-eabi --target=powerpc-eabi --disable-opengl
    
  2. Use make to cross-compile the game executable:

    make -f Wii
    

For configure help:

./autogen.sh --help

Installing SuperTux on Wii (Homebrew Channel)

  1. Create a folder called supertux inside the apps folder on your SD/USB device:

    apps/supertux
    
  2. Copy the compiled .dol file into the apps/supertux folder and rename it to boot.dol.

    apps/supertux/boot.dol
    
  3. Copy the icon.png and meta.xml files from the hbc/apps/supertux/ directory in the repository to your SD/USB device:

    apps/supertux/icon.png
    apps/supertux/meta.xml
    
  4. Copy the data folder from the repository into the apps/supertux folder of your SD/USB device.

    apps/supertux/data
    
  5. Launch SuperTux from the Homebrew Channel. The game will create a config file and save folder on the first run.

 

Setup Guide for devkitPro PowerPC Build System

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

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

libogc
libfat-ogc
ppc-vorbisidec
ppc-zlib
wii-sdl
wii-sdl_image
wii-sdl_mixer

For the incomplete WIP OpenGL/OpenGX backend, the following are also required:

wii-freeglut
wii-glu
wii-opengx

 

How to Build: Unsupported Standard Build (mostly for testing)

Run autogen.sh:

./autogen.sh

Use make to compile the game executable:

make -C build

Note: Installation is untested and not supported nor recommended unsupport standard builds. To test-run, copy the data folder to a safe place, then add the build/supertux executable and extras/supertux.png image alongside it. A template .desktop entry file has been included in the extras directory as supertux.desktop.

 

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 port is distributed under the terms of the GNU General Public License version 2 (GPLv2). You can redistribute it and/or modify it under the terms of GPLv2 as published by the Free Software Foundation.

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.