https://github.com/Retro64Mod/libsm64-retro64

https://github.com/Retro64Mod/libsm64-retro64

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Retro64Mod/libsm64-retro64
• Owner: Retro64Mod
• Created: 2021-12-30T16:50:10.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T18:23:02.000Z (over 1 year ago)
• Last Synced: 2024-05-28T11:11:56.686Z (5 months ago)
• Language: C
• Size: 1.64 MB
• Stars: 23
• Watchers: 1
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-libsm64 - libsm64 fork

README

        
# libsm64-retro64 - Super Mario 64 as a library, for Retro64 Minecraft Mod

This is a fork of [libsm64](https://github.com/libsm64/libsm64) intended for use with the Retro64 Minecraft mod.

Main changes include Audio support (from [sm64-port](https://github.com/sm64-port/sm64-port)), functions for affecting Mario (changing powerup, damage, teleport, water level, etc), extending the code to work with coordinates > 32768, and other misc. changes for the mod.

If you want to use this for a project, I suggest you look at the original (linked above) as this is intended for a very specific use-case, and is very hacked together & un-documented (especially audio support!)

## 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)

- [Follow steps 1-4 for setting up MSYS2 MinGW 64 here](https://github.com/sm64-port/sm64-port#windows), but replace the repository URL with `https://github.com/Retro64Mod/libsm64-retro64.git`

- Run `make` to build

## Building on macOS (test program not supported)

- Open up terminal and clone the macOS repository with `git clone https://github.com/Retro64Mod/libsm64-retro64`

- Cd to libsm64-retro64 with `cd libsm64-retro64`

- Install homebrew at https://brew.sh

- Run `brew install make mingw-w64 gcc sdl2 pkg-config glew glfw libusb audiofile coreutils`

- Run `gmake -j`

## 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. (does not run on macOS)

- `make run`: Build and run the SDL+OpenGL test program.