Update README.md

This commit is contained in:
Max 2022-10-15 00:53:55 -05:00 committed by GitHub
parent 534bbb2194
commit 36bc252e61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,5 +1,15 @@
# sm64-roblox
Partial source/tools to an unpublished port of SM64's movement code into Roblox.<br/>
Based on the decompilation project hosted at: https://github.com/n64decomp/sm64
I wanted to make this public as a curiousity for anyone who wanted to know how I pulled it off. I do want to bring this back online at some point, but I need to commission someone to remake the animations so I don't have to rip them from the SM64 ROM.
A port of Super Mario 64's movement code into Roblox Luau (in `--!strict` mode), hosted as a [rojo](https://rojo.space) project.<br/>
Based on the SM64 decompilation project hosted at: https://github.com/n64decomp/sm64
I wanted to make this public as a curiousity for anyone who wanted to know how I pulled it off. It **does not include any animations, sounds, or assets from Nintendo**. I do provide some of the scripts I used when I originally ported animations from the SM64 ROM into R15 Roblox avatars, but any future public version of this project from me will use commissioned assets that I have permission to use.
Original game is hosted here:<br/>
https://www.roblox.com/games/10238956318/funny-64-bit-platformer
## Terms of Use
You *may* use this in your game **as long as you provide credit** to me and the SM64 Decompilation Project. I would **NOT** advise using it as a foundation for a platformer since it's very rigidly tied to the 30hz physics simulation code of Super Mario 64. It's weirdly programmed and not very intuitive to build off of.
No animations or sounds are provided by default, so you'll have to substitute those appropriately. It's not a trivial task.