Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sm64js/sm64js
A Super Mario 64 Native Javascript Port
https://github.com/sm64js/sm64js
Last synced: 18 days ago
JSON representation
A Super Mario 64 Native Javascript Port
- Host: GitHub
- URL: https://github.com/sm64js/sm64js
- Owner: sm64js
- License: wtfpl
- Created: 2020-06-25T04:30:29.000Z (over 4 years ago)
- Default Branch: vanilla
- Last Pushed: 2024-04-29T00:57:44.000Z (7 months ago)
- Last Synced: 2024-08-01T00:47:30.477Z (3 months ago)
- Language: JavaScript
- Size: 32.1 MB
- Stars: 244
- Watchers: 26
- Forks: 98
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sm64js
### Links
[Main Website: sm64js.com](https://sm64js.com)
[Discord Server](https://discord.gg/7UaDnJt)
## What is this?
This is an ongoing work-in-progress port of the decompilation of original Nintendo game, Super Mario 64, to native Javascript (no emulation or web assembly). The project involved creating a Javascript WebGL port of N64 Fast 3D Renderer, originally implemented with OpenGL in C. This project also includes the development of online mass multiplayer versions of sm64js and other custom multiplayer game modes.
## Build instructions - Windows, Mac, or Linux
### Prerequisites
* Node.js
### Run these commands
```bash
# Clone the source code
git clone https://github.com/sm64js/sm64js.git && cd sm64js
# Install node packages
npm install
# Launch wepback dev server
npm run start
```
### To update your project
```bash
# update folder (be inside sm64js)
git pull
# Launch server
npm run start
```
You should now be able to access the website with the game from a web browser by typing "localhost" into the address bar.
## Build instructions With Docker - Windows, Mac, or Linux
### First install Docker
* Windows - [Install Instructions](https://docs.docker.com/docker-for-windows/install-windows-home/)
* Mac - [Install Instructions](https://docs.docker.com/docker-for-mac/install/)
* Linux - [Install Instructions](https://docs.docker.com/engine/install/#server)
### Run these commands
```bash
# Create and start lightweight docker container with NodeJs
docker run --name mySm64JsServer -dp 80:80 node:13 tail -f /dev/null
# Connect to the docker container's shell
docker exec -it mySm64JsServer /bin/sh
# Install additional prerequisites
apk update && apk add git
# Clone the source code
git clone https://github.com/sm64js/sm64js.git && cd sm64js
# Install node packages, build, and serve
npm run build
npm run serve
```
You should now be able to access the website with the game from a web browser by typing "localhost" into the address bar.
## Neat gLinker commands you can run in the console
Because of a good portion of the game existing under the gLinker object within the window object, you can manipulate these portions of code to make certain things happen.
Drain the Castle Grounds moat:
```js
const gEnvironmentRegions = gLinker.ObjectListProcessor.gEnvironmentRegions
gEnvironmentRegions[6] = -800
gEnvironmentRegions[12] = -800
```
Access Mario's state:
```js
gLinker.LevelUpdate.gMarioState.key = value
```
With this, you can make Mario fly, go fast, and a lot of other things.
### Related Projects
[Super Mario 64 Decomp](https://github.com/n64decomp/sm64)
- Team that decompiled the original Super Mario 64 ROMs into C source code
[Super Mario 64 PC Port](https://github.com/sm64-port/sm64-port)
- Team that ported the decompiled project to PC
[N64 Fast 3D Renderer](https://github.com/Emill/n64-fast3d-engine)
- OpenGL Implementation of a 3D renderer for the Nintendo 64's graphics
(For this project, it was re-implemented in Javascript and WebGL)