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
35 commits 2 branches 0 tags 1.3 MiB
C 99.3%
C++ 0.3%
Python 0.2%
Makefile 0.2%
Find a file
jaburns 80d96f0241 New interface note
2020-10-20 13:29:43 -06:00
src New interface note 2020-10-20 13:29:43 -06:00
test Clean up makefile so build lib doesnt build test 2020-10-19 22:58:32 -06:00
.gitignore Remove test binary 2020-10-19 22:21:12 -06:00
import-mario-geo.py Makefile reimports when import script changes 2020-10-19 17:17:28 -06:00
import-test-collision.py Use specific commit for collision import 2020-10-19 23:05:07 -06:00
Makefile Clean up makefile so build lib doesnt build test 2020-10-19 22:58:32 -06:00
README.md Update README.md 2020-10-19 23:01:14 -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.

Building

Currently only linux is supported. Windows support coming soon. Requires python3 to build the library, and SDL2 + GLEW for the test program.

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

To run the test program you'll need a SM64 US ROM in the root of the repository with the name baserom.us.z64.