Brawmario / libsm64-godot

libsm64-godot

Addon that binds the libsm64 to godot via GDExtention, allowing to integrate mario into any Godot 4 project.

Current Godot Compatibility

Currently compatible with Godot 4.2.x, with binaries compiled for Windows and Linux (untested) 64 bits. Check the releases for the files.

How to

This add-on consists of two main components:

• SM64Global: Singleton that exposes the init() and terminate() functions of the libsm64 library.
• SM64Mario: Extends Node3D; can have multiple in any scene.

It also adds two helper nodes:

• SM64StaticSurfaceHandler: Extends Node; provides helper functions to load all the meshes under the libsm64_static_surfaces group into the libsm64 world.
• SM64SurfaceObjectsHandler: Extends Node; provides helper functions to load and update all the meshes under the libsm64_surface_objects group into the libsm64 world.

This add-on requires a Super Mario 64 (USA) ROM file (for legal reasons, steps to get a ROM will not be disclosed). Make sure the ROM file has the following SHA256 hash:

17ce077343c6133f8c9f2d6d6d9a4ab62c8cd2aa57c40aea1f490b4c8bb21d91

If the SHA256 doesn't match, it will be rejected and the addon will fail to initialize.

Simple steps for basic use

When creating the scene:

1. Add a SM64StaticSurfaceHandler node to the scene.
2. Add the meshes that compose the world to the libsm64_static_surfaces group (NOTICE: use simple, low-polycount meshes for best results).
3. Add a SM64Mario node (or as many as you want) and set its camera property with an Camera3D node.
4. Create the action names that are in the SM64Mario node's Input Actions export group in the project's Input Map and bind them to the appropriate axes/buttons/keys.

Then do the following on the scene's main script:

1. Feed the SM64Global singleton the file path to the Super Mario 64 ROM file (SM64Global.rom_filepath = "path/to/rom/file").
2. Configure the SM64.Global.scale_factor property if necessary (try default value first).
3. Call the SM64Global.global_init() function.
4. Call StaticSurfaceHandler.load_static_surfaces() on your instanced SM64StaticSurfaceHandler node.
5. Call SM64Mario.create() on your instanced SM64Mario node(s).

For more detailed instructions refer to the manual.