sm64-mirrors/libsm64
1
0
Fork 0
mirror of https://github.com/libsm64/libsm64.git synced 2025-01-22 15:43:11 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mario 64 as a library for use in external game engines
67 commits 2 branches 0 tags 1.3 MiB
C 99.3%
C++ 0.3%
Python 0.2%
Makefile 0.2%
Find a file
jaburns e108c03608 Filter out surfaces with bad tris, use 32 bit ints for collision surfaces
2021-08-16 15:01:57 -06:00
src Filter out surfaces with bad tris, use 32 bit ints for collision surfaces 2021-08-16 15:01:57 -06:00
test Update api to support multiple marios 2020-10-27 22:01:58 -06:00
.gitignore Dont leak memory when calling load surfaces multiple times 2021-07-19 17:49:14 -06:00
import-mario-geo.py Massive refactor 2020-10-27 11:07:42 -06:00
import-test-collision.py Using floor-based terrain instead of area-based 2020-10-27 21:01:44 -06:00
Makefile Free remaining global allocs 2020-10-27 15:51:04 -06:00
README.md Update README, add rust bindings and plugin links 2021-07-26 17:23:44 -06:00

README.md

libsm64 - Super Mario 64 as a library

The purpose of this project is to provide a clean interface to the movement and rendering code which was reversed from SM64 by the SM64 decompilation project, so that Mario can be dropped in to existing game engines or other systems with minimal effort. This project produces a shared library file containing mostly code from the decompilation project, and loads an official SM64 ROM at runtime to get Mario's texture and animation data, so any project which makes use of this library must ask the user to provide a ROM for asset extraction.

Bindings and plugins

Building on Linux

  • Ensure python3 is installed.
  • Ensure the SDL2 and GLEW libraries are installed if you're building the test program (on Ubuntu: libsdl2-dev, libglew-dev)
  • Run make to build
  • To run the test program you'll need a SM64 US ROM in the root of the repository with the name baserom.us.z64.

Building on Windows (test program not supported)

Make targets (all platforms)

  • make lib: (Default) Build the dist directory, containing the shared object or DLL and public-facing header.
  • make test: Builds the library dist directory as well as the test program.
  • make run: Build and run the SDL+OpenGL test program.