Skip to content

Unofficial port of Super Mario 64 to StarfallEx

Notifications You must be signed in to change notification settings

x4fx77x4f/sm64sf

Repository files navigation

SM64SF

This project is defunct as of 2023-10-27.

This was an unofficial port of Nintendo's Super Mario 64 to StarfallEx. Almost everything had been translated manually. It was extremely early in development and did not do anything exciting.

Screenshot

Roadmap

  • Execute until end of intro
  • Display copyright info
  • Display 3D logo
  • Display Mario head background
  • Display Mario head
  • Properly light Mario head
  • Handle controller input
  • Start new game
  • Spawn in level
  • Move around level
  • ...
  • 100% complete one day? (Oh, how foolish I was)

Usage

  1. git clone https://github.com/x4fx77x4f/sm64sf.git sm64sf
  2. git clone https://github.com/n64decomp/sm64.git sm64
  3. Place an unmodified Super Mario 64 (only tested with U.S. version) ROM file in sm64/baserom.us.z64.
  4. cd sm64 && ./extract_assets.py us && cd ..
  5. ./sm64sf/copy_assets.sh sm64 sm64sf
  6. ln -s "$PWD/sm64sf" ~/.steam/steam/steamapps/common/GarrysMod/garrysmod/data/starfall/sm64sf
  7. ln -s "$PWD/sm64sf" ~/.steam/steam/steamapps/common/GarrysMod/garrysmod/data/sf_filedata/sm64sf
  8. Flash sm64sf/init.lua to a chip and connect a screen to it.

License

This project was primarily derived from sm64js and n64decomp/sm64. Those projects and this project were all originally derived from Nintendo's proprietary Super Mario 64. The overwhelming majority of the content in these repositories was non-free for this reason, regardless of any license they may have been claimed to be released under.

While this project was without a doubt non-free, an effort had been made to reduce the amount of Nintendo-owned content in this repository. Most non-code assets such as textures, models, and sounds were not included and had to have been extracted from a ROM file. Absolutely nothing in this repository was based on the leaked source code for Super Mario 64 to my knowledge.

This project may have included a small amount of entirely original code, for which I would be willing to package separately under a free license if requested.