It is strongly recommended to use the online generator on the website instead of using the download or source code versions of the randomizer. Simply go to https://ootrandomizer.com and click on the Play Now button. The video tutorial can walk you through using the website. The Readme is available if you need to find out what the different options do. You can also check out the Changelog to see what changes have happened between randomizer versions. A recent Dev version is also available on the website.
Ocarina of Time Randomizer is compatible with Nintendo 64 hardware through use of a flash cart such as the Everdrive 64. It is also compatible with the Wii Virtual Console via the use of Homebrew and WAD injection including Wii U vWii.
Some of the base files (ROMs, Wii common key, etc.) that are needed to play Ocarina of Time Randomizer are copyrighted and will not be provided by the community nor staff.
If you want to run the standalone download version of the randomizer, you should skip to installing Python.
If you want to run the release source code or Dev source code version of randomizer, you should skip to installing Node.js.
Video Tutorial
TreZc0_ recorded a setup video that will cover most questions when using the online generator.
Once you have viewed the video and generated a randomizer ROM file, head to playing the randomizer.
Windows Setup
The online generator will work on a variety of devices and is the recommended option. The randomizer itself will work on Windows, macOS, and Linux. The ROM will work on any device that has a Nintendo 64 emulator available. However, the following setup steps focus on getting the randomizer working on the Windows operating system.
Install Node.js
As of version 4.14 of the randomizer, the source code versions of the randomizer require Node.js to be installed.
Open the Node.js website and click on the LTS button on their home page.1 Save the msi installer file then, locate it in your Downloads folder, or wherever you saved it. Launch the installer by double-clicking it. Click Next until you get to the Tools for Native Modules screen. Make sure the Automatically install the necessary tools. [...] checkbox is not checked.2 Click Next once you have made sure of this. Next click the Install button, then once that is completed, click the Finish button.
-
1. Choose the LTS version which was 12.16.2 here, but may be different for you. So long as it is v14.x or lower it will be compatible with OoTR. Do not click the Current version button, as that version isn't currently compatible. -
2. Make sure the checkbox is unchecked before clicking Next.
Install Python
To run the randomizer on your computer you will need to install Python. This is not needed when using the online generator but in all other cases you must have Python installed. The randomizer requires at least Python 3.6.0 installed, however we recommend installing the latest stable version of Python available when you install it.
Go to the Python website and hover your mouse over the Downloads tab. A little dialog will appear and should have a Download for Windows section displayed. Click on the button labeled Python with a version number next to it.1 Save the exe installer file, then locate it in your Downloads folder, or wherever you saved it. Launch the installer by double-clicking it. Click Install Now on the installer.2
-
1. Click this button. In this case the latest version was 3.8.2 but the version displayed for you is the one you want. -
2. Choose to Install Now.
Downloading the Randomizer
It is strongly recommended to use the online generator instead of using the download or source code versions of the randomizer. If you are sure that you want to use a downloaded version, you can follow the instructions for the standalone download version or the source code and Dev version of the randomizer.
Standalone Download
You can choose to download the standalone download version of the randomzier by going to the downloads page on the website and choosing the appropriate download for your operating system. The provided installers should install the randomizer to the appropriate place for your operating system and you should be able to launch the randomizer from your operating system's application launcher—Start Menu in Windows, Applications folder in macOS, and whichever application launcher you prefer for Linux. You must have Python 3.6 or higher installed for the standalone download randomizer to work.
Once you have generated a randomizer ROM file, head to playing the randomizer.
Windows Troubleshooting
Often when a new version of the randomizer is released the standalone download is not trusted by the Windows operating system. When you try to run the installer it will pop up a Windows Smartscreen window. All you have to do is click More info and then the Run anyway button. The installer will then launch and install the randomizer.
Source Code
You can download either the release source code, or the development (Dev) branch source code to run the randomizer. Most users will want to use the standalone download for the release version, so this section will focus on running the latest development version from source code. You must have the latest Node.js LTS version and Python 3.6 or higher installed for the source code version of the randomizer to work.
Head to the website and in the navigation bar at the top, click on Resources and then choose the Dev Github option.1 Next click on the releases button to reach the page with all of the randomizer releases.2 Click on the zip button for the latest development version of the randomizer to download it.3 The Dev branch of the randomizer is known to be unstable. The latest version may not work properly. If you run into issues you may want to join the Discord server and ask which Dev version of the randomizer you should download.
Locate the zip file you just downloaded in your Downloads folder, or wherever you saved it. Right-click the file and click Extract All... and extract the files from the zip archive.4 A new folder should appear which may contain another folder inside. Open the folders until you see a folder with many folders and files inside. Locate the Gui.py file inside and Double-click it to launch the randomizer.5 The first time you run the randomizer many files need to be downloaded from the internet. Wait patiently as they download.6 This process will be faster every time you run the randomizer after this since it will only have to download the files once. Even if you download a new version it will be slightly faster as most of the files will be located in the Node.js cache and most will simply be used from there.
The randomizer will launch once the initial installation has finished. Once you have generated a randomizer ROM file, head to playing the randomizer.
-
1. Open the Dev Github link to open the GitHub page for the main fork of the randomizer. -
2. The releases button will display all of the different randomizer versions. -
3. A zip button should appear on the top release that you can click on. -
4. On Windows, choose to Extract All... from the zip file. -
5. Run the Gui.py Python script. -
6. Wait patiently as Node.js downloads the randomizer's dependencies.
Alternative Source Code Download Method
You can alternatively use Git to download the source code. This is the easiest way to keep up to date with the latest changes. We have a guide on using GitKraken, a GUI for git that many of the developers use if you want to try to download the source code this way. You still need to install the other software mentioned above.
Playing the Randomizer
Emulators
The Ocarina of Time Randomizer can be played on PC via an emulator. Given the emulation quality difference between emulators, not every emulator can be recommended.
The emulators we support are:
Bizhawk (Windows) is considered resource-intensive, but easy to setup. Bizhawk is also required if you wish to participate in a Multiworld.
Project64 (Windows) is the least resource-intensive emulator and easy to set up. However, it is important that versions 2.4+ are used since these are the only ones that provide a stable game experience. Furthermore, as racing is a large focus for the community, please be aware the rules of the racing websites prohibit use of Project64 v2.0 thru v2.3. Project64 v2.4+ is race legal, though.
RetroArch (Windows, macOS, Linux, and more) isn't as resource-intensive as Bizhawk. However, setting up certain controllers in RetroArch can be a frustrating experience.
EverDrive
The Ocarina of Time Randomizer can be played on a N64 by using the EverDrive
Patch Files
If someone shares a ZPF or ZPFZ file with you, these are Patch Files. They are a copyright-free method to share randomizer seeds with people. The patch files page will explain what to do with them.