- Installs Required Packages (build tools & dependencies)
- Installs latest version of itself to user path
- Clones (downloads) sm64 source repository from Github
- Extract Assets from ROM and prepares for use
- Optionally applies community sourced upscale modifications
- Makes (compiles and links) into binary
- Creates Menu Entry & Desktop Shortcut
- Launches Super Mario 64 on your Personal Computer or Android Device!
...and! you can use it again later to quickly rebuild and sync to the latest updates from github.
Paste either of the following into a terminal then press Enter (whichever works for your OS):
bash -c "$(curl -fsSL https://raw.githubusercontent.com/enigma9o7/smlinux/master/smlinux)"
-OR-
wget https://raw.githubusercontent.com/enigma9o7/smlinux/master/smlinux;bash smlinux;rm smlinux
That's all you have to do for mac and debian/ubuntu based linux. You will be prompted to:
(1) provide password to install build tools (2) specify your romfile (3) approve (or change) build options.
smlinux will then run unattended and before the time you finish reading the FAQ you will hear "It's me, Mario!".
Do not run smlinux as root; you will be prompted for password if needed.
You must provide your own legally backed up Super Mario 64 ROM file.
Click here for Linux distributions that are not debian based.
smlinux will be installed in the first directory in your path, usually ~/bin. After initial installation, just entersmlinuxinto a new terminal and you will be presented with a menu (as shown in next screenshot) or use command line options (as shown in previous screenshot) to skip menu.
If for some reason the process freezes during compilation, perhaps on pc with low memory, then set MAXJOBS=1. When undefined, smlinux will allow make multiple jobs which speeds up the build process on PCs with multiple cores and plenty of memory, but occasionally causes issues on under-powered systems (that can still run the game just fine).
Click here for Frequenty Asked Questions
macOS notes sm64nx and android builds are not working yet. DOS builds will not be supported. If you do not already have homebrew and/or apple xcode command line tools installed, smlinux will install homebrew and homebrew will install the xcode tools, but you may have to enter your password twice and it can take quite a while. sm64ex,r96ex,sm64ex-coop and cheaterex all confirmed working with Intel based macOS 10.12 Sierra and newer.
- How to download and install?
- What preset/repo/branch should I use?
- What does the InstallHD option do?
- What does the InstallR96 option do?
- What does the FPS60 option do?
- What about other branches?
- When to use RENDER_API=GL_LEGACY?
- How to update, rebuild, or change build options later?
- How do I build a different version?
- How to I configure options like controllers, camera, rumble, etc?
- Where are my configuration files and saved games stored?
- Are there any cheats?
- How do I apply external data such as textures?
- How to apply a patch?
- How to remove a patch?
- What about distros other than Ubuntu?
- How do I create my rom file?
- How do I remove everything smlinux created during install?
- How do I tell smlinux to download sm64 repositories to a folder other than home?
If you want to build for PC, the source repository from the team who decompiled the rom, sm64-port, offers the cleanest code and duplication of N64, with currently very few add-ons available. The unofficial forks, sm64ex and sm64nx, include enhancements and support for many add-ons (which are optional on sm64ex). sm64ex offers the most flexibility, but you are encouraged to build more than one and try for yourself. Further forks of sm64ex offer additional enhancements, such as render96ex with added Luigi Keys, sm64ex-coop for a 2 player network mode, or cheaterex for all the latest experimental add-ons. For android or web, presets are available based on sm64-port or sm64ex, while for for dos sm64-port based forks are used.
This will apply HD Mario (Old School V2) and HD Bowser character models and the 3D Coin Patch to most forks except dos and render96ex.
On sm64pc/sm64ex based forks upscaled textures will aslo be added to your build from the Cleaner Aesthetics github repo, and hq sounds from MapAnon's github release. On the render96ex fork, Render96's HD rextures will be used instead, which are over 500MB so require additional download time, as well as more than 2GB of free memory and additional time to precache before game launches.
On the sm64nx fork, Arredondo's HD Mario & Bowser and Cleaner Aesthetics textures are set as defaults, along with a few other small add-on paks which can be enabled from the in-game mod selection menu, including an HD Luigi model replacement.
Some of these addons require files remaining available in discord or github, so not gauranteed to work. What is included with this option may periodically change as new mods are released.
For the render96ex preset, this will apply Render96's SGI model pack version 1.42. On sm64ex-coop a co-op specific version that includes Luigi is used, while for sm64ex based forks, version 1.3 is used. For r96alpha and r96proto presets, the latest 2.0 modelpack is used.
For sm64nx, this option will add paks for Render96's SGI Models (version 1.3) and Render96's HD textures and set them as defaults. Be aware this model pak for sm64nx has minor visual problems and is no longer mainained.
On repositories that provide a 60fps patch (currently sm64-port, render96ex, and sm64ex-nightly) it will be applied when this option set to 1, and reverse applied when set to 0. Note that some forks (such as sm64ex-coop, cheaterex, and sm64nx) are already 60fps without a patch and this setting will have no effect. The currently available patch for sm64ex uses interpolation and may require adjustments to in-game vsync setting for smooth performance, and may not work correctly on displays that aren't 60Hz and may not perform well on older computers.
If you chose one of the presets from the smlinux preset table above, the appropriate branch is used automatically. For example with PRESET=sm6ex the nightly branch is used; if you would like the master branch instead use PRESET=sm64pc. If sm64ex nightly works for you, it is reccommend it as it has the latest features and fixes, but if a recent change causes build failure or other problems, use the more stable sm64pc master. For advanced users, branches other than those defined by preset can be built by setting PRESET to any undefined name, in which case smlinux will use the the user specified GIT and BRANCHsettings.
only applies to sm64pc/sm64ex based forks
For old video cards that support OpenGL 1.1 but not 2.1 (from year 200X). Check your OpenGL version with the following command:
glxinfo | grep "OpenGL version"
If 1.1-2.0, you must use the legacy renderer. For 2.1 or greater, standard GL renderer is reccommended, although some old computers that do support 2.1 may perform better with the legacy renderer.
smlinux update <options>
For example:
smlinux update
or
smlinux update --hd
or
smlinux update --config
or
smlinux update --sgi
Updates existing install to latest from github while retaining custom textures and addons. If updated source fails to build, restores previous build.
You can also use this option to rebuild after you apply patches or edit your source or source assets like actors manually.
Note --config is only needed if CONFIG=0 in your config file, otherwise it will come up automatically.
Note --hd only needs to be applied if UpdateHD=0 in smlinux configuration, and what was initally installed withInstallHD=1 has changed/updated since you last built, or if you wish to add HD add-ons to an existing build that was made with InstallHD=0.
Note smlinux automatically saves one previous build by adding the suffix .old to its foldername (and restores it if your update fails to build). If you want prevent it from being erased during the next update, rename it (anything) before running smlinux, for example:
mv ~/sm64pc/build/us_pc.old ~/sm64pc/build/firstbuild
smlinux build --config
Change your preset to another version and it will be installed in its own folder with its own seperate menu entry. You can build as many versions as you like. If you wish to build a version other than a predefined preset, leave preset blank or make your own name (which will be used for its foldername), and set GIT and BRANCH.
Note --config is only necessary if CONFIG=0and/or you havent edited your smlinuxcfg.txt before build.
dont not apply to sm64-port repository
Pause then press R with controller or R_Shift with keyboard. For the controller settings, it is recommended to keep the first column for keyboard controls and using the middle for controller. Use the third column if you want additional keys/buttons assigned to the same function, or for mouse buttons. Be sure to map something to L for use with the camera or cheats. I personally enable mouse control for camera increase center aggression significantly.
You can also just edit the configuration file with any text editor.
~/.local/share/sm64pc smlinux and sm64pc/ex master
~/.local/share/sm64ex sm64ex nightly
~/.local/share/render96ex render96ex only if launched with shortcut
~/.local/share/sm64ex-coop sm64ex-coop
~/.local/share/cheaterex cheaterex only if launched with shortcut
~/.local/share/sm64-port sm64-port only if launched with shortcut
~/.local/share/sm64nx sm64nx smlinux creates links in game dir
On all forks besides sm64-port, some cheats are built in and enabled automatically if launched from shortcut and available in options menu. On compatible sm64ex based forks additional cheats are applied with
Texture and sound packs can be added to the appropriate resource folder after build.
sm64pc/sm64ex:
Put the zipfile (or gfx or sound folder) directly into build/us_pc/res and the next time you run the game it'll use it automatically. The zip file must contain a "gfx" and/or "sound" folder. Do not move or remove base.zip, it should remain in "res" as fallback.
sm64nx:
Create a subdirectory in build/us_pc/romfs for each pak and place the pak file inside, and the next time you run the game it'll load that pak automatically. If you would prefer it to start disabled, use ~ at the beginning of the folder name. Do not move or remove !!base.pak, it should remain in "romfs" as fallback.
change path from sm64pc to sm64-port or sm64ex for newer repos
Put the patch file into ~/sm64pc/enhancements (or specify the path differently when applying):
cd ~/sm64pc
git apply enhancements/filename.patch
smlinux update
If the patch errors when you try to apply it, and you want to use it anyway, you can force it to apply with:
git apply --reject enhancements/filename.patch
change path from sm64pc to sm64-port or sm64ex for newer repos
cd ~/sm64pc
git apply -R enhancements/filename.patch
smlinux update
Tested on Bodhi 5.1,32 & 64-bit, so should work as-is on recent Ubuntu/debian. Arch and Fedora also confirmed working by users.
Change your Linux= command string during first install to one that works with your distro such as those listed below, or paste the command directly into a terminal first the run smlinux with Linux="" (or just ignore the one-time apt error). smlinux only installs dependendencies automatically during the very first installation; if you wish to force reinstallation run smlinux depends or add --depends to next smlinux update or smlinux build.
If your distribution needs additional dependencies not listed here, please let me know their names so I can add them. The Ubuntu list is confirmed compatible with WSL, Debian 9 and Ubuntu 18/20 but other versions also likely work. Some build targets depend on additional packages not listed below, for example Android builds require android-sdk, web targets emscriptem sdk, dos targets djgpp, which smlinux will only install when needed. If gcc --version does not report 8 or newer when building sm64nx, smlinux will attempt first to install gcc-9 then if unsuccesful gcc-8; users of distros without apt wanting to build sm64nx will need to do this manually.
Arch:
sudo pacman -S base-devel python audiofile sdl2 glew python-zstandard python-pip zstd zenity
Debian / Ubuntu:
sudo apt install -y build-essential bsdmainutils binutils wget git python3 libaudiofile-dev libglew-dev libsdl2-dev libusb-1.0-0-dev libzstd-dev python3-pip zenity mplayer zip unzip unrar p7zip
Fedora / Red Hat:
sudo dnf install make gcc python3 audiofile-devel glew-devel SDL2-devel zstd zenity g++
openSuSE:
sudo zypper in gcc make python3 glew-devel libSDL2-devel zenity libzstd-devel audiofile-devel
Solus:
sudo eopkg install make gcc python3 audiofile-devel glew-devel sdl2-devel zenity
Void:
sudo xbps-install -S base-devel python3 audiofile-devel SDL2-devel glew-devel zstd zenity
Alpine:
sudo apk add build-base python3 audiofile-dev sdl2-dev glew-dev zenity
Slax: must be done from command line - not script - then leaveLinux= as debian default
apt install sudo
macOS:
brew install libxdg-basedir coreutils git wget nano mingw-w64 gcc@9 sdl2 pkg-config glew glfw3 libusb audiofile unzip unrar newt go python3
MinGW64:
pacman -S mingw-w64-x86_64-glew mingw-w64-x86_64-SDL2 python3 git make mingw-w64-x86_64-gcc unzip zip unrar p7zip
MinGW32:
pacman -S mingw-w64-i686-glew mingw-w64-i686-SDL2 python3 git make mingw-w64-x86_i686-gcc unzip zip unrar p7zip
Backup N64 cartridge with a dumper such as Retrode2 or Mr. Backup, from Wii with vcromclaim, or buy for Wii U Virtual Console and extract with title dumper or other homebrew tools.
Dragonbox Store Stoneage Gamer
Nintendo Wii U Store WiiU Title Dumper Wii Virtual Console ROM Claim
Note that 3D All-Stars contains the Shindou version of the ROM which isn't fully supported by PC port.
smlinux purge
This erases everything created using smlinux presets including automatically created game saves and config files. This does not remove any packages installed as build tools or dependencies; remove those with your package manager. (Development libraries can always safely be removed if you don't plan to build again, and binaries will still run.) This also does not restore or remove any prior sm64 folders backed up if you ran full install more that once (versus update) or any user-defined repositories; delete those folders manually from any file manager.
smlinux config
Set BASEPATH= to any existing path that you have permission to write to.