Libsm64 project offers Super Mario 64 movement and rendering as a reusable library

Project Overview

The Libsm64 project has released a shared library that extracts and packages the movement and rendering code from the Super Mario 64 decompilation project. This library is designed to allow developers to easily incorporate Mario's in-game mechanics into external game engines or other software systems. The core functionality is provided through a clean interface defined in libsm64.h.

Asset Handling and Dependencies

To function, Libsm64 requires an official Super Mario 64 ROM. The library loads this ROM at runtime to extract necessary assets such as textures and animation data. This approach means that any project utilizing Libsm64 must prompt its users to supply a valid SM64 ROM for asset extraction, ensuring compliance with copyright by not distributing proprietary assets.

Integration and Bindings

The project supports integration with various development environments through a range of bindings and add-ons. These include Rust bindings, Odin bindings, C# bindings, a Unity plugin, a Blender add-on, a Godot add-on, a Game Maker 8 extension, and Unity MelonLoader and BepInEx mods. A minimal example project is also available to demonstrate library usage.

Build and Setup Instructions

Building the library involves standard make commands, with specific instructions provided for different operating systems and environments like MSYS2 MinGW 64 and WebAssembly. For testing, users need to place a US region SM64 ROM named baserom.us.z64 in the repository's root directory. The project also outlines dependencies for building the test program, such as SDL2 and GLEW libraries.