Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 3.27 KB

README.md

File metadata and controls

102 lines (72 loc) · 3.27 KB
Raw

Wafel

Wafel is a TASing tool for Super Mario 64. It provides the ability to move backward and forward through a TAS without using save states, and displays relevant in-game data variables.

Wafel is not an emulator, but it does require a vanilla SM64 ROM to operate.

Thanks to sticks-stuff for contributing the Wafel logo.

Game versions

The following SM64 game versions are supported:

  • JP: the original Japanese release
  • US: the original US release
  • EU: aka PAL (experimental, known crashes)
  • SH: Shindou (experimental)

If you would like to use Wafel on an SM64 source hack, reach out and we can try to set it up.

Downloading

Currently Windows is the only supported platform (but support for other platforms in the future is likely).

You can download the latest version from the Releases page.

Bugs and feature requests

Please log bugs and feature requests on Github here. (For my own sanity and to avoid issues getting lost, please don't send them to me on discord.)

Wafel as a library

Wafel exposes a mid-level SM64 API that is intended to be useful for scripting / brute forcing. This API is still fairly basic, but it can be extended with more useful features over time.

import wafel

game = wafel.Game("libsm64/sm64_us.dll")

power_on = game.save_state()

game.advance_n(1500)
assert game.read("gCurrLevelNum") == game.constant("LEVEL_BOWSER_1")

game.load_state(power_on)
assert game.frame() == 0

for frame in range(0, 1000):
    if frame % 2 == 1:
        game.write("gControllerPads[0].button", game.constant("START_BUTTON"))
    game.advance()

game.advance_n(500)
assert game.read("gCurrLevelNum") == game.constant("LEVEL_CASTLE_GROUNDS")

Installing:

  • For Python 3.7-3.9, download the latest Wafel release, and run pip install --find-links=bindings/python wafel --upgrade.
  • For Rust, include the dependency wafel_api = { git = "https://github.com/branpk/wafel" }.

Rust documentation is available here.

Python documentation and types are available here, and your IDE should automatically display them. You may sometimes need to refer to the more detailed Rust documentation.

If you want to build more complex things using Wafel's infrastructure, most of Wafel's code is split up into Rust crates that can be imported into your project. Documentation is above, and feel free to reach out to me with questions.

Building

To build from source, you'll need the following installed (be sure to use 64 bit versions):

Setup:

git clone git@github.com:branpk/wafel.git
cd wafel
pipenv --python "path\to\python.exe"
pipenv install --dev

Building:

pipenv run python build.py

Running (dev mode or non-dev mode):

pipenv run python run.py
pipenv run python run.py --nodev

Building an executable:

pipenv run python run.py dist