OoT Randomizer Wiki - User contributions [en]

Mido's House Multiworld installer

2026-02-11T15:59:00Z

Fenhl: added screenshots

This article documents the behavior of the installer for [[Mido's House Multiworld]]. It can be downloaded from [https://midos.house/mw the Mido's House Multiworld website].

The installer is only available for Windows and Linux. See [https://midos.house/mw/install/macos install instructions for macOS].

== Console/emulator selection ==

[[File:Mhmw-installer-SelectEmulator.png|thumb]]

On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].

* For EverDrive, the installer will display a warning since EverDrive support is currently experimental and requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. Progress on stabilizing EverDrive support is tracked in [https://github.com/midoshouse/ootr-multiworld/issues/23 this Mido's House Multiworld issue] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2042 this randomizer issue].
* For emulators, the installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

On Linux, installing [[BizHawk]] requires root permissions. The installer will use [https://en.wikipedia.org/wiki/Zenity Zenity] to prompt for your password in order to use [https://en.wikipedia.org/wiki/APT_(software) APT] to install [https://en.wikipedia.org/wiki/Mono_(software) Mono]. If Zenity and/or APT are not available, the installer will skip this step and you should install Mono manually.

== Emulator location ==

[[File:Mhmw-installer-LocateEmulator.png|thumb]]

This step is skipped for EverDrive.

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for EverDrive and Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''DO NOT close or click OK on the error message!''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

[[File:Mhmw-installer-InstallEmulator.png|thumb]]

This step is completely automated for Project64. It is skipped for EverDrive.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session (though the multiworld app will have a button to launch Project64).

On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

On Windows, there is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

== Summary ==

[[File:Mhmw-installer-AskLaunch.png|thumb]]

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''EverDrive:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the multiworld app and the emulator (if any) right now.

File:Mhmw-installer-AskLaunch.png

2026-02-11T15:58:28Z

Fenhl:

File:Mhmw-installer-InstallEmulator.png

2026-02-11T15:58:07Z

Fenhl:

File:Mhmw-installer-LocateEmulator.png

2026-02-11T15:57:39Z

Fenhl:

Mido's House Multiworld

2026-01-11T02:50:45Z

Fenhl: added FAQ for releasing items

'''Mido's House Multiworld''' is one of the plugins that can be used to play [[multiworld]].

To install, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For more details on how the installer works, read the [[Mido's House Multiworld installer]] article.

If you need help, please ask in [https://discord.gg/BGRrKKn #setup-support on the OoTR Discord] (feel free to ping @fenhl) or [https://github.com/midoshouse/ootr-multiworld/issues/new open an issue].

== Frequently asked questions ==

=== Our room is gone, what can I do? ===

Rooms are automatically deleted after 7 days of inactivity. This can be increased to 90 days in the room options. If your room was deleted for inactivity or if you accidentally deleted your room, there is currently no way to restore the game progress. A [https://github.com/midoshouse/ootr-multiworld/issues/5 backup system] is planned to be added in a future version of Mido's House Multiworld.

=== How do I see other players in my game? ===

This is not possible with Mido's House Multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== I'm on Linux, how do I run the installer? (Unknown file type) ===

Make sure the installer is set to executable.

* In most graphical file system apps, right-click the installer file, select Properties, enable “allow executing as program” or similar. You should then be able to run the installer by double-clicking it.
* Or on the command line, run <code>chmod +x multiworld-installer-linux</code>, then run <code>./multiworld-installer-linux</code>.

=== I defeated Ganon, why didn't my items get released? ===

Mido's House Multiworld does not automatically release items when you beat the game. If you have the [[Glossary#Spoiler Log|spoiler log]], you can go to the room options and use the “send all items from world” section to release your items.

Multiworld

2025-12-15T00:57:58Z

Fenhl: /* Feature comparison */ updated BizHawk version supported by MH MW

The aim of this page is to help the reader set up '''Multiworld'''. Multiworld is a co-op mod for the OoT Randomizer. Players have their own inventory and their own world. Also, player-specific items are mixed between the worlds. For example, if you obtain an item in your world, it could either stay with you or get sent to another player. Everyone participating will be playing different intermingled seeds.

As an example, there could be a scenario where Player 1 can only advance in their own world based on something Player 2 does. Once Player 2 finds the Megaton Hammer belonging to Player 1, Player 1 will automatically receive it. Every world is linked together.

In order to link everyone's worlds together, players will need a plugin like ''bizhawk-co-op'' or [[Mido's House Multiworld]]. For Mido's House Multiworld, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For setting up bizhawk-co-op, see the [[Multiworld#Installing Multiworld and Bizhawk|Installing Multiworld and Bizhawk]] section below. If you're not sure which plugin to use, see the [[Multiworld#Feature comparison|Feature comparison]] section.

These plugins are currently only compatible with [[Project64]] (Mido's House Multiworld only) and [[Bizhawk]] (both plugins). Mido's House Multiworld also has experimental support for [[EverDrive]], which currently requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. However, the ModLoader64 devs have made their own plugin which is compatible with their emulator and the OoT Online pak, allowing players to see each other's character in the game. (Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

This section applies regardless of which plugin you use, but if you're using ModLoader64, please note that it is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer] and not with newer releases or Dev builds of OoTR.

=== Using the Webpatcher ===

Start off by going to the [https://ootrandomizer.com/generator Webpatcher] and set up the settings you want for the seed. On the <code>Rom Options</code> tab change the <code>Player Count</code> to however many people will be playing. Once you're done, generate the seed.

[[File:mwromgen.png|560x315px]]

After you have generated the seed, share the URL with your partners and have everyone choose a different <code>Player ID</code>. Then continue patching the rom as you would normally (don't forget cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgen2.png|560x315px]]

=== Using the Offline Version ===

Generating a ROM using an offline build works a little differently. After choosing the settings you wish to play with, go to the <code>ROM Options</code> tab and set <code>Generate New Seed</code> (<code>Generate From Seed</code> in previous versions). Choose <code>Patch File</code> as your <code>Output Type</code> and change the <code>Player Count</code> to however many people will be playing. Then hit <code>Generate!</code>.

[[File:mwromgendev1.png|560x315px]]

Send the patch file (.zpfz) to your partners and have them set <code>Generate From File</code>. The <code>Output Type</code> should be <code>Compressed [Stable]</code> now, and everyone should choose a different <code>Player ID</code>. Select the patch file and hit <code>Generate!</code> (don't forget to set cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgendev3.png|560x315px]]

Note: if your partners don't have the offline build they can also patch the rom using the website. Make sure to set <code>Generate From File</code> and select your patch file (.zpfz).

There are several reasons why someone might want to generate a ROM using an offline build. For example, some builds might have features that are not available on the website build (yet), like [https://github.com/Roman971/OoT-Randomizer additional Entrance Randomizer settings]. Generating from an offline build also lets you play with your own custom patches.

== Installing Multiworld and Bizhawk ==

This section and the sections below apply only to the bizhawk-co-op plugin. For Mido's House Multiworld, please download and run the installer from [https://midos.house/mw its website]. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== The Recommended Method ===

Press '''Windows+R''' to open the '''Run''' dialog box, and then type "'''powershell'''" in the text box. Once you have your PowerShell window open, copy-paste this in:

'''<pre>cd $env:userprofile\downloads;
Set-ExecutionPolicy Bypass -Scope Process -Force;
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/TestRunnerSRL/bizhawk-co-op/master/bizhawk-co-op.ps1'))</pre>'''

From here, the PowerShell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install in your downloads folder and place everything for you. Say '''yes''' when PowerShell prompts you to install the <code>bizhawk_prereqs.exe</code> file. Once PowerShell is done, you can move the Bizhawk 2.7 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>.

=== The Alternate Method ===

==== Download the Custom Bizhawk Installer ====

First, you must download the Multiworld script from [https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip TestRunner's GitHub page]. When you download this, extract its contents to ''its own folder'' - it will be creating a new Bizhawk install for you to use, so you must keep it separate. ''Note: Whenever there is an update to the Multiworld script, everybody playing must update to the latest version.''

==== Running the Custom Bizhawk Installer ====

Once you have the contents extracted to its own folder, locate the <code>bizhawk-co-op.ps1</code> file. Right Click and select Run with PowerShell.

[[File:MWG1.png|610x149px|Run with PowerShell]]

If Powershell prompts you for permissions, say yes to all. From here, the Powershell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.7 folder that was created. These files are no longer needed and only add confusion.''

==== Powershell Permissions ====

You may need to enable executing Powershell scripts without requiring the script to be digitally signed. Open Powershell from the Start Menu by right clicking it and selecting "Run as Admin". Click the "Yes" button to allow Powershell to run as Administrator. Type <code>Set-ExecutionPolicy Unrestricted</code> and press <code>Enter</code> once, type <code>Y</code> then press <code>Enter</code> again. The Powershell script should now run.

== Configuring Bizhawk for Multiworld ==

=== Bizhawk Settings ===

There are a few things you need to do once you've got the emulator running. The very first thing is go to <code>Config -> Customize</code> and navigate to the Advanced tab. At the bottom, there is an option for Lua Core; select <code>Lua+LuaInterface</code> and hit OK. While on the Advanced tab, you should also check the box for <code>AutoSaveRAM</code> and set it to a reasonable time, such as 60-180 seconds (keep in mind that setting this too low could increase lag and decrease overall emulator performance). This will allow Bizhawk to write your in-game save to your drive. This is '''NOT''' a form of save state - it simply periodically creates/updates a file on your hard drive with your in-game save data, and is wonderful for mitigating the effects of crashes. '''In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save file follow the instructions over [[Multiworld#Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen!|here]].

[[File:bizhawkautosave.png|420x487px|Advanced Customization]]

In the General tab of the Customize menu, tick the boxes for "Accept background input" and "Run in background" – this will allow Bizhawk to keep accepting controller inputs when you tab over to your tracker or notes and prevent the emulation from pausing (which will disconnect you). Clear your hotkeys by going to Config -> Hotkeys, and at the bottom click Misc and Clear All.

=== Controller Settings ===

The next step is to set your controller up. Your controller configuration will vary based on what controller you are using; for Bizhawk to enable the Controller menu, you must have a ROM loaded. For a smooth controller experience, you must unbind the first 4 binds in Config -> Controller such that it looks like this:

[[File:MWG3.png|320x207px|Normal Controls]]

You'll then have to bind your analog stick in the Analog tab of your controller config and adjust your sensitivity and deadzones to your preference. ''Additional info on controller setup can be found in Step 6 of the [[Bizhawk|Bizhawk Guide]].''

=== Video Settings ===

You can fix how your game looks by going to Config -> Cores -> N64 Video Plugin Settings. In here, change your resolution so that it runs smooth. Multiworld will drop your performance, so keep that in mind. The recommended video plugin is GLideN64. ''(This is not the same plugin as Glide64!)''

== Starting the Multiworld Session ==

=== Opening the Lua Console ===

Once you have your emulator set up to run how you are comfortable with, its time to move to the Lua console. Go to Tools -> Lua Console, and a separate window will open up. ''This window must remain open at all times during a Multiworld.'' In the Lua Console, go to Settings and checkmark the Disable Scripts on loads.

[[File:MWG4.png|586x379px|Disable Scripts on Load]]

This is the last of the settings changes you have to do. If you want Bizhawk to retain these settings changes for the next time, go to Config -> Save Config. Once you have these steps done, '''you MUST close your emulator and reopen it for this change to take effect'''. Close out of Bizhawk, and then reopen it and the Lua Console. Sometimes this will not be enough and you will still get an error trying to load the Lua file. In that case reboot your entire computer.

'''If for some reason you do not have your Multiworld ROM open, you must do so now.'''

From here in the Lua Console, Open Script and locate the <code>bizhawk co-op.lua</code> file in the Bizhawk 2.7 folder. Once you have that done, a red square will appear in the console; double click it and a new window will open up.

[[File:MWG5 2.png|Bizhawk co-op]]

This window must ''also'' stay open at all times.

=== Rooms ===

The Lua Console Script is where you set up a room and join rooms.

If you are the Host: You must port forward. How you do this varies on what brand your router is. Instructions on how to do this can be found by Googling your brand/model of router. You'll want to use a port between 49152 and 65535. We highly recommend using the default port, 50000. You'll also want to ensure you're forwarding the TCP protocol as that is the protocol Multiworld uses. Most other games you have port forwarded in the past likely were using the UDP protocol.

Once that is done, in the Bizhawk Co-op window the Host must set their name, password, and the port that was forwarded, along with setting the game script to Ocarina of Time. Don't set the IP address. Hit Create Room and tell the people joining the Room Name (= your name), password, and port. ''(It is not recommended to use your own personal password here, as it is shared with the group. Use something that will prevent random people from joining your room, but not something that will compromise your own security.)''

If you are Joining and the Host has set up the room: hit Refresh in the Bizhawk Co-op window and select the Host's Room from the dropdown bar. When you input your username, keep in mind the game will use this to display who got what item for everyone playing. It will max out at 8 characters, even if you input more. Fill in the password and port number the Host gave you and select the Ocarina of Time Game Script and hit Join Room.

You can also select a player number when both hosting and joining a room. This is non-mandatory, and player numbers will be automatically selected if non are entered. This also does not need to match the world number chosen when patching your ROM file. If you do select a player number, and that number is already filled in that room, you will be unable to join.

=== Play Some Multiworld! ===

Go and have fun with new or old friends! If you are part of the {{discord}}, you can assign the Multiworld role to yourself by going to the {{discord|role-assignment}} channel and clicking the 3 emote - this will allow you to receive pings in the server where there are announcements from the Devs or folks are looking for players. You can also visit {{discord|multiworld-planning}} to look for additional players. It is ''highly'' recommended that you use one of the [[Trackers]] so that you don't accidentally leave those new friends out to dry if you miss a check. Map Trackers such as 2deep4real's Web Tracker or Hamsda's Map and Item Tracker package for EmoTracker are highly recommended.

== Troubleshooting ==

=== Installation Issues (Applies to both the Recommended and Alternate Methods) ===

==== Anti-Virus ====

Another issue that can occur while running the Powershell script is your anti-virus deleting the files it downloads. The BizHawk Prerequisites often gets marked as suspicious due to it being an installer that runs more installers. We can't give a detailed guide on how to exclude a folder in every anti-virus software, but search Google with a query like <code>Exclude Folder <your_anti-virus_name></code> and you should find a guide on their official site explaining how to do so. Exclude the folder that has the Powershell script in it and now you should be able to run it without the downloaded files getting deleted.

=== Common Error Messages ===
These are the most common errors that pop up that have known solutions. If none of these solve the problem, try rebooting your computer again afterwards to ensure any new configurations are fully loaded.

==== NullHawk Does Not Implement Memory Domains ====
You must load the ROM before activating the Lua scripts.

If doing so does not fix the issue, open the Lua Console and look at <code>Settings -> Autoload</code>. This setting should be '''disabled'''. Save the settings and completely close out of Bizhawk. Reopen, load the rom, and only after the rom is loaded open the Lua Console.

==== Error 401 ====
This generally means that either the password entered was incorrect, or that the room name already exists. Also, avoid special characters like spaces in the room name. We recommend using letters (no accents) and numbers only.

==== This ROM is not compatible with this version of the co-op script. ====
[https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip Update your scripts].

==== Unable To Find Domain: CARTROM ====
You are using the A Link to the Past LUA script. Choose Ocarina of Time in the dropdown instead.

==== Dynamic Libraries Not Enabled ====
You did not set the Lua Core setting properly. Remember to restart Bizhawk after changing it.

==== Unprotected Error in Call to LUA API ====
This is a general error that pops up randomly. You need to ensure all copies of Bizhawk are closed properly. The easiest way to ensure this is by rebooting your computer.

If you consistently get it when trying to start up the script, make sure the script is located in the Bizhawk root folder. This error will come up if you run the script from any other folder.

==== Connection Failed: Timeout ====
There are several reasons this can happen, all of them being various methods of misconfiguration.

First, the host must have the [[Multiworld#Rooms|port being used forwarded]] if not using Hamachi. Your private IP address that you forward the port to can change for various reasons. Always ensure that the router is pointing to the right computer with the port forwarding options. The host must also not have pings blocked in their router settings. This setting can be found under many names depending on the router.

Everyone playing must have the Bizhawk emulator allowed through their firewall.

The above [[Multiworld#Configuring Bizhawk for Multiworld|Bizhawk configuration options]] are not optional. If you do not configure the emulator properly you will be unable to stay connected to each other.

==== Invalid Arguments to Method Call ====
You'll get this error if files are in the wrong place. This can happen if you move any of the files manually, or if the Powershell script exits early.

The easiest way to fix this is to remove the Bizhawk folder and re-run the Powershell script. If your bizhawk-co-op.lua file is in the Lua folder, you can try moving it to the root folder where EmuHawk.exe is instead and see if that works too.

==== Attempt to concatenate local 'err' ====
This error occurs when some part that was downloaded was corrupt. The easiest way to fix this is to delete the Bizhawk folder the Powershell script downloaded and run it again.

=== Miscellaneous Issues ===

==== A Specific Item Failed to Transfer ====

Items can be retrieved by having the receiving player enter a line of code into the Lua console, though it is best to avoid this situation entirely if possible. This frequently occurs if a player continues while one or more other players are disconnected from the room. To prevent this, always ensure everyone is connected before collecting any item.

Go to [https://pidgezero.one/zootr/mwlua.html this website] (made by pidgezero_one) and select option 2. Locate the code for the missing item and follow the instructions there to retrieve the item. If the layout looks wrong, press ctrl+F5 to fix it.

==== Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen! ====

First of all, '''DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save files follow these instructions.

# In your Bizhawk folder navigate to <code>\N64\SaveRAM</code>.
# Identify the <code>SaveRAM</code> and <code>AutoSaveRAM</code> files corresponding to your seed. Sorting by date may help. Note that the <code>AutoSaveRAM</code> files will only exist if you've [[Multiworld#Bizhawk Settings|enabled that]] beforehand.
# Optional: manually make a backup of these files somewhere on your pc.
# Delete the <code>SaveRAM</code> file and rename <code>AutoSaveRAM</code> to take the place of the <code>SaveRAM</code> file you've just deleted.
# Now you can safely load your seed again and continue playing.

==== A Player Forfeits without Finishing ====

If a player forfeits their world, the game can continue without them by entering code lines into the Lua console to retrieve the lost items for the remaining players. Upload the multiworld spoiler log on [https://pidgezero.one/zootr/mwlua.html this site] (made by pidgezero_one) and follow the instructions there. If the layout looks wrong, press ctrl+F5 to fix it.

==== LUA Console Window Too Small ====

If your window for the LUA connection console is too small and the elements are overlapping, you need to change your DPI settings. Right click EmuHawk -> Properties -> Compatability -> High DPI scaling override, change to "System (Enhanced)".

[[File:DPISettings.png|326x407px|EmuHawk High DPI Settings]]

=== I can't see the other players in my game ===

This is not possible with multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

== Multiworld Without Port-Forwarding or Bizhawk ==

=== Hamachi ===

If nobody in your multiworld group can port-forward for whatever reason, and you cannot get someone who can to join, then there is a program you can use: Hamachi. Let me preface this by saying that Hamachi basically 'tricks' your computers to believe that you are all connected via LAN.

To start, download Hamchi [[https://www.vpn.net/ here]] and install it. Create an account, and go to System > Preferences > Settings to make sure that 'Encryption' is enabled. Then, click on the power button to go online.

==== Hosting ====
If you're hosting, then click Network > Create a new network. Give it a unique name and password, making sure that nobody other than the people you're playing with find out this information. After this, you'll see it pop onscreen:

[[File:Guide.JPG|RTENOTITLE]]

To join an existing network, click Network > Join an existing network. Type in your friend's network ID and the network's password.

Once you're all connected in the network, you can start the multiworld.

Right click on the address above your nickname, and click 'Copy IPv4 address' and share it with the people joining you:

[[File:Guide2.JPG|RTENOTITLE]]

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)', Set your Username and Password as usual, and the game script to Ocarina of Time.

==== Joining ====

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)' and paste the IPv4 the host gave you into the 'Host IP' bar. Set your Username and Password as usual, and the game script to Ocarina of Time.

Now you should be ready to start. As usual, if you have any more problems, seek advice within the {{discord}}.

==== Security Awareness ====
'''Be careful with who you give permission to join your network to.''' Using Hamachi is like letting everyone using it with you use a computer on the same network as yours.

==== Hamachi Request Timed Out ====
[https://help.logmein.com/articles/en_US/FAQ/Resolving-Hamachi-Request-Timed-Out Follow these steps to ensure Hamachi is allowed through your firewall]. Both the Host and the clients connecting to the host should do this.

=== Playing over LAN ===

If you're playing over a LAN network, then all you need to do is set the 'room' to (Custom IP), type the LAN's Ipv4 into the 'host IP' field, and give yourself a username. Leave the password field blank.

=== Play Without Bizhawk ===

While Bizhawk is the officially supported emulator for multiworld, it is known to be a resource-intensive emulator in addition to being Windows only.

If port forwarding/using Hamachi is impossible for any reason, try [https://midos.house/mw Mido's House Multiworld]. It is compatible with Bizhawk and Project64 and can have players on different emulators at the same time. This method for multiworld was created by Fenhl and is the newest way to play multiworld. Issues with this can be brought up in the #setup-support channel of the OoTR discord, but it's unlikely anyone except Fenhl will be able to provide meaningful assistance so do not expect quick replies.

If using Bizhawk is impossible for any reason, try the emulator ModLoader64 (Windows and Linux compatible), as DemoXin has modified the multiworld script to work with it. This method does not require a host. Modloader64 is also the only way to play Ocarina of Time Online, which allows players to see each other in the world, and also supports other various features. As we do not officially support this emulator or any of their paks, we kindly refer you to [https://discord.gg/mWDztG their Discord] for all issues and support.

==== Feature comparison ====

{| class="wikitable"
|-
! Feature
! [https://github.com/TestRunnerSRL/bizhawk-co-op bizhawk-co-op]
! [https://midos.house/mw Mido's House Multiworld]
|-
| [[EverDrive]] support
|
| ✓ (experimental, requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's randomizer branch])
|-
| [[Project64]] support
|
| ✓
|-
| [[Bizhawk|BizHawk]] support
| 2.3–2.8 (no support for newer versions)
| 2.11 only (no support for older versions)
|-
| no port forwarding or Hamachi required
|
| ✓
|-
| can be used via LAN without an internet connection
| ✓
| [https://github.com/midoshouse/ootr-multiworld/issues/3 planned]
|-
| async support: players don't need to be connected at the same time
|
| ✓
|-
| easier setup: player name and world number are read from the game
|
| ✓
|-
| prevents players from accidentally using the same world number
|
| ✓
|-
| support for some other games
| ✓
|
|-
| automatically updates itself
|
| ✓
|-
| send all remaining items from a world using a spoiler log
| using [https://pidgezero.one/zootr/mwlua.html an external service]
| built in
|-
| choose individual items to give to a player
| using [https://pidgezero.one/zootr/mwlua.html an external service]
|
|-
| rooms are automatically deleted after a period of inactivity
|
| ✓ (defaults to 7 days, configurable)
|}

Dev team calls

2025-10-22T07:24:33Z

Fenhl: updated next call info for hiatus

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on hiatus.

== August 25, 2025 ==

Participants: Fenhl, RealRob, ShadowShine57

# reviewed some PRs including [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2441 #2441 RE: The setting to change the Language of the game to Any language] and tested some PRs
# it's been a while since we've had quorum to go over issues/PRs under consideration in a call, bring back the Discord polls/threads to help catch up on them

== August 10, 2025 ==

Participants: Fenhl, TestRunner

# translation support infrastructure:
#* Discord: translator role (or one per language)?, translation channel(s)?
#* subcommand to check missing text for a language, web frontend for easy overview?
# can we give more people the ability to give an “official” PR review (green checkmark rather than gray) and to request reviews from them? → TreZ

== July 28, 2025 ==

Participants: Fenhl, RealRob

# worked on getting [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2423 #2423] ready to be merged
# investigated a bug with the unit tests, see [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2440 #2440] for the result

== July 13, 2025 ==

Participants: Fenhl, Kirox, RealRob

# fast-path merging: should typically not bypass testing, consider the state of the existing code being affected as well, maybe ask other maintainers/dev team what they think of the PR
# discussed ER test failues with advanced logic, may be caused by ER algorithm but may also be a logic bug, need to investigate further
# discussed some issues/PRs under consideration
#* For [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2363 #2363 Child D-Pad Items], ask for public feedback?

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-08-26T00:06:49Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on September 7, 2025 at 17:00 CEST (15:00 UTC).

== August 25, 2025 ==

Participants: Fenhl, RealRob, ShadowShine57

# reviewed some PRs including [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2441 #2441 RE: The setting to change the Language of the game to Any language] and tested some PRs
# it's been a while since we've had quorum to go over issues/PRs under consideration in a call, bring back the Discord polls/threads to help catch up on them

== August 10, 2025 ==

Participants: Fenhl, TestRunner

# translation support infrastructure:
#* Discord: translator role (or one per language)?, translation channel(s)?
#* subcommand to check missing text for a language, web frontend for easy overview?
# can we give more people the ability to give an “official” PR review (green checkmark rather than gray) and to request reviews from them? → TreZ

== July 28, 2025 ==

Participants: Fenhl, RealRob

# worked on getting [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2423 #2423] ready to be merged
# investigated a bug with the unit tests, see [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2440 #2440] for the result

== July 13, 2025 ==

Participants: Fenhl, Kirox, RealRob

# fast-path merging: should typically not bypass testing, consider the state of the existing code being affected as well, maybe ask other maintainers/dev team what they think of the PR
# discussed ER test failues with advanced logic, may be caused by ER algorithm but may also be a logic bug, need to investigate further
# discussed some issues/PRs under consideration
#* For [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2363 #2363 Child D-Pad Items], ask for public feedback?

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Racing

2025-08-17T12:52:42Z

Fenhl: converted external link to internal

'''by LostThePirate'''

This guide will help you get set up for your first race. 

Community races and many privately organized races use [[Racing#racetime.gg|racetime.gg]]. Previously [https://speedrunslive.com SpeedRunsLive] was used, and some people still organize races there, but the community has largely transitioned away from it.

Races can be joined using [[Racing#LiveSplit|LiveSplit]] or through the racetime website. If using LiveSplit, make sure you can log into racetime quickly should LiveSplit fail to load a race channel or crash in the middle of a race.

''We have compiled [[Common Softlocks And Crashes|a list of known softlocks and crashes]] (WIP). It is recommended to read it through to potentially save you from frustration later.''

{{TOClimit|3}}
== Before You Ready Up ==

Please read the [[Racing#Racing Rules| Rules]] and be familiar with the allowed and banned techniques for the particular ruleset of the race beforehand.

If you are joining a community race it is best to set everything up nice and early. Community race rooms are opened 1 hour ahead of time so you have plenty of time to get everything set up before they start. You'll certainly run into issues and it is easier to help you long before the race starts rather than struggling to hurry to fix everything just 5 minutes before everyone has to ready up.

If you are just playing a pickup race in one of the race planning channels ({{discord|standard-race-planning}}, {{discord|ddr-race-planning}}, {{discord|rsl-race-planning}}, {{discord|bq-race}}, or {{discord|other-racing-formats}}) the people you are racing with should be patient and be able to help you anywhere you get stuck as there is no set starting time there.

Ensure everything is working before you ready up in the race channel. Get your [[Setup#Emulators|emulator]] or console behaving; get your controller/key bindings set; get your [[Trackers|tracker]] of choice downloaded or installed and learn how to use it. Get everything ready so that you can play all by yourself without outside help.

'''Note''': [https://wiki.ootrandomizer.com/index.php?title=Project64 Project64 v3.0+], [[Retroarch]] and [[Bizhawk]] are the recommended emulators for Ocarina of Time Randomizer. In regards to race participation, Project64 v2.0, v2.1, v2.2, and v2.3 as well as ModLoader64 are '''not allowed''' for official racing. Use of all cheats is also prohibited. If you need to use a cheat code to address pause lag in Project64 v1.7 or v1.6, you '''cannot''' join an official race as long as that cheat is active. Use of texture packs to modify the game's appearance is also prohibited by the Ocarina of Time Randomizer community for official races.

Get acquainted with your streaming software; get your broadcast settings ready; get your scene layouts the way you want; get your [https://twitch.tv Twitch] channel how you'd like it. You can add Randomizer, Competitive, and/or Speedrun to your Twitch tags on your dashboard to let viewers know what kind of OoT you'll be playing.

'''Note''': Unless you are a Twitch partner or having ensured quality options, especially in restreamed races it can be detrimental to stream at resolutions and bitrates that will cause lags on your end or for volunteers, so streaming at 1080p or at a bitrate over 4000 kbps is not recommended. We recommend a resolution of 720p (1280x720), and a framerate of 30 frames per second. If you want to go higher, please do not exceed a bitrate of 3500 kbps. For a normal stream of 720p30, 2400 kbps is more than enough for streaming OoTR.

== racetime.gg ==
[https://racetime.gg racetime.gg] is a modern, sleek and user-friendly system that lets anyone and everyone race video games online, and is an open source, community driven site.

=== Create an account ===
Head to the rt.gg website. In the top right corner of the page you should see a <samp>Log in / Create account</samp> button. {{kbd|Left Click}} that button. On the right side is the log in form. You'll use that to log in to your account in the future, after you create it. On the left side is the <samp>Create an account</samp> form. You'll see a link to the [https://racetime.gg/about/faq rt.gg FAQ] and fields for your <samp>Email</samp>, <samp>Name</samp>, and <samp>Password</samp> and its confirmation.

Fill out these fields. The email address will need to be valid so that you can confirm the account. The name field should be the username you like to go by. Ensure you type the same password into both password fields. At the bottom of both forms is a reCAPTCHA you'll need to interact with to prove you're human. Usually, you can just click the checkbox and that is enough.

Once you have filled out the form and proven you're not a robot, click {{kbd|Create account}}. You should get an email shortly with a link to click to validate your account.

=== Connect with Twitch ===
Once you are logged into your rt.gg account, head to the top right of the screen again. {{kbd|Left Click}} the <samp>Settings</samp> button. On this page, select the {{kbd|Twitch & connections}} tab, then on the following page press the {{kbd|Connect your Twitch.tv account}} button. You'll log into your Twitch account if you're not already, then {{kbd|Authorize}} the connection. Your racetime.gg account and your Twitch account are now linked together. You're now ready to join Ocarina of Time Randomizer races.

=== Joining a Race ===
Generally a race room will be provided in one of the announcements channels ({{discord|racing-announcements}}, {{discord|freaky-friday-races}}, {{discord|standard-announcements}}, {{discord|league-announcements}}, {{discord|ddr-announcements}}, {{discord|rsl-announcements}}, {{discord|bq-announcements}}) for official races, or one of the other race planning channels ({{discord|standard-race-planning}}, {{discord|ddr-race-planning}}, {{discord|rsl-race-planning}}, {{discord|bq-race}}, or {{discord|other-racing-formats}}) for pick-up games and you can just click on that link to be dropped right into the correct room on the website. You can also see active races and races currently waiting for participants in the {{discord|current-races}} channel or on the [https://racetime.gg/ootr Ocarina of Time Randomizer] page on racetime.gg You'll probably see <samp>Current races</samp> above a bunch of <samp>Past races</samp>. You can generally join any race that is accepting entrants, so click on the one you're interested in joining.

On the race page, you'll see details of the race, including the goal, a link to the seed page if one has been generated already, and the entrants to the left, and you'll see chat and a timer to the right. Above the timer is a <samp>Join</samp> button. {{kbd|Left Click}} that button to join the race. It will then split into two buttons. <samp>Ready</samp>, which you should click once you have your seed, emulator, and stream set up, and <samp>Quit</samp> which you can click if you decide you don't wish to race. Once you've readied up, a <samp>Not ready</samp> button will appear if you actually aren't ready yet.

Once the race has been started, the timer will begin to countdown. Once it reaches 0, begin to race. During an active race you have two buttons again. <samp>Done</samp>, which you will press once you finish the seed, and <samp>Forfeit</samp> which you may need to press if you find yourself no longer able to complete the race. Both of these actions can be undone if needed, so don't worry if you accidentally hit one. Just make sure by the end of the race you aren't "Done" when you haven't finished, or that you haven't "Forfeit" if you have actually finished. The very last action you can do after having done one of these is <samp>Add comment</samp> on the race. This will be displayed in a tooltip next to your name and in the chat and is viewable by everyone. Be sure not to leave any spoilers in the comment.

== LiveSplit ==

[[File:Livesplit-race-view.png|thumb|Ensure you are using the latest version of LiveSplit for the best experience. If being in a race does not look like this screenshot, be sure to update.]]

LiveSplit is a convenient Timer program that has racetime.gg integration (as of version 1.8.8). It can be downloaded from [http://livesplit.github.io/downloads/ LiveSplit's GitHub page].

The instruction video linked there is ''very helpful'' and I recommend you check it out to learn a lot more about LiveSplit.

=== Join a Race ===

With LiveSplit open, right-click within the Timer, select racetime.gg Races, and choose from the available races that are currently accepting Entrants. On racetime.gg, the Ocarina of Time Randomizer has its own category, so you shouldn't have any confusion.

Upon selecting a race to participate in, you will be prompted to log into the website for racetime.gg races.

[[File:Livesplit-oauth.png|frameless]]

== Entering and Readying ==

To actually enter a race you'd like to participate in, [[Racing#LiveSplit|Join a Race via LiveSplit]] or [[Racing#Joining a Race|Join a Race on the website if racing on racetime]]. Then, click Enter Race or type {{kbd|.enter}} to join the race.

Click the link in the header below the ruleset name for a link to the seed to be used in the race. Note: This is not set too early before a race's start time, to prevent cheating. During Weeklies, for example, the seed is generated (and the link posted) approximately 15 minutes before the scheduled start time of the race.

Race participation requires streaming your run. Be sure to start your broadcast at least 5 minutes before the expected start time of the race. A bot will verify if you are live, and it can take up to 5 minutes for the fact that you are live streaming to become available to that bot. Budget your time accordingly.

Once you have ''everything'' ready to begin your run, select Ready or type {{kbd|.ready}}. Only do this after you have downloaded the seed, set your file name, had your final bathroom break before the race, gotten your cup of water, etc. Ready means '''ready''', and once everyone has indicated that they are ready, there is a 15 second countdown on racetime.

Once the countdown reaches 0, your LiveSplit timer will start automatically, if linked. '''Do not''' start your game file (and load into your house in the forest) before the Timer starts! Do not attempt to Pause your timer during a race, either - LiveSplit will interpret a Pause as completion of the race.

== Finishing A Race ==

When you are finished with a race depends on whether the goal is to ''Defeat Ganon'', ''Collect All Triforce Pieces'' in Triforce Hunt, or in casual races some other goal. The timing of finishing for defeating Ganon is the start of cutscene after you press B for the final swing. For Triforce Hunt in the Random Settings League it is once the screen is completely black, and in general Ocarina of Time racing is finished either at the last input or once the item you collected is above your head.

Once you achieve your goal, stop your timer using whatever keybinding you have set for it, click Done or type {{kbd|.done}} to complete the race. You can look in the race room to see who has finished and with what times.

If something comes up, you can click Forfeit or type {{kbd|.forfeit}} to forfeit a race. You will lose points and standing on racetime, but sometimes it can't be avoided. Be aware of the penalties for forfeiting, and try to budget plenty of time for a race.

If you think you have to quit, click Forfeit, then realize you were mistaken, you can resume the race (including all the time that has elapsed) by clicking Undo Finish or typing {{kbd|.undone}} – the race timer will continue and will include the time you thought you were out of the race.

== Racing Rules ==
{{race rule|These are several of the most important rules you must follow while racing.}}
# You must follow the [[Rules]] the current race has chosen to follow. The most common ruleset is [[Standard]], however this is not used for all races. Always confirm which ruleset a race is using if it is not in the race goal.
# You can play on [[Everdrive|the Nintendo 64 with a flash cart]], [[Wii Virtual Console]], or [[Setup#Emulators|Emulators]]. Project64 v2.x, ModLoader64, and Dolphin versions older than Beta 5.0-13963 are not allowed for racing. Note that [https://www.pj64-emu.com/public-releases Project64 v3.0+] is race-legal.
#* If playing on emulator, you must also follow the [[Racing#Emulator Settings Requirements|Emulator Settings Requirements]].
# You may not modify the ROM in any way outside of patching it on the [https://ootrandomizer.com Randomizer website] or the Ocarina of Time Randomizer software on your computer.
#* This means changing cosmetics using the randomizer is fine. Adding stuff like models or changing textures is not. Editing RAM is also not allowed.
# Generally there are no rules for streaming except that you must do so, however Tournament races often have additional requirements.
# Spoilers should only be discussed in the relevant "results" channels on the Discord. Do not discuss them in other Discord channels or the race chat channel, and do not put them in race comments.

''The restreaming team also requests that if you use custom music, you try to keep it to only Zelda tracks if they ask you if you want to be restreamed''.

== Emulator Settings Requirements ==
{{race rule|These settings are either useful for identifying a cheater, or preventing an emulator from exceeding the capabilities of the actual Nintendo 64}}
Playing on an emulator for races requires a little bit more setup. Namely, you need to enable an FPS display. If you cannot provide this, you are required to capture the entire emulator window. '''Texture packs are not allowed during races'''.

Some options may not be available unless you are currently running an [[Setup|Ocarina of Time Randomizer ROM]].

=== BizHawk ===
To enable the FPS display, go to {{kbd|View|Display FPS}}. You can configure it further in {{kbd|Config|Messages}}.

=== Project64 ===

To enable the FPS Display (shown as DL/s), launch Project64 and load your ROM. Next, navigate to {{kbd|Options|Settings...}} or press {{kbd|Ctrl+T}} to open the Settings menu.

In the Settings menu, expand the <samp>Options</samp> list on the left-hand side and look for an <samp>Advanced</samp> section. If the <samp>Advanced</samp> section isn't showing, click <samp>Options</samp> and untick <samp>Hide advanced settings</samp>. Afterwards, click <samp>Advanced</samp> and tick the <samp>Speed Display</samp>. The <samp>Speed Display</samp> box must show <samp>VI/s & DL/s</samp>. Click <samp>Apply</samp>.

'''Lowering the VI refresh rate to 1490 is also required for racing with Project64.'''

While in the Settings menu, look for a <samp>Defaults</samp> section. If the <samp>Defaults</samp> section isn't showing, click {{kbd|Options}} and untick {{kbd|Hide advanced settings}}. Afterwards, click {{kbd|Defaults}} and change the <samp>VI refresh rate</samp> from <samp>1500</samp> to {{kbd|1490}}. Click {{kbd|Apply}}.

Finally, in the Settings menu, click on {{kbd|Config: The Legend of Zelda - Ocarina of Time (U) (Randomizer).}} Your <samp>VI refresh rate</samp> should display <samp>1490</samp>. If not, change it accordingly and click {{kbd|Apply}}

Keep in mind that you ''should'' show your VI Refresh Rate in both the Defaults section and the Config: The Legend of Zelda - Ocarina of Time (U) (Randomizer) section before the race starts. If you do not show settings before the race, we ask that you make a note in your Racetime comment at roughly what time you show settings. This should be done before you close your emulator at the end of the race.

==== Allowed Versions ====
{{race rule|Older versions of Project 64 have problematic settings, either overclocking by default or just don't work right with Ocarina of Time Randomizer}}

The allowed versions of Project 64 are version 3.0 and newer stable versions.

=== RetroArch ===
To enable the FPS display, go to {{kbd|Settings|On-Screen Display|On-Screen Notifications}} and switch <samp>On-Screen Notifications</samp> to {{kbd|ON}} if it is not already. Then, change <samp>Display Framerate</samp> to {{kbd|ON}}.

You must also show that you are using the <samp>Framerate</samp> option {{kbd|original}}, as well as having the <samp>VI Refresh (Overclock)</samp> option set to {{kbd|auto}}, ''ideally'' before a race starts. To do this, press {{kbd|F1}} to open the <samp>Quick Menu</samp> and choose {{kbd|Options}} and scroll down to the <samp>Framerate</samp> option. This is required for the Mupen64plus Next core and the ParaLLEl core. If you are using the old mupen64plus core, this option will not appear and the text in the bottom left that displays what core you are using will be proof that you are following this rule. If you do not show these settings before the start of the race, they must be shown before closing your emulator. We also ask that you make a note in your Racetime comment at roughly what time the settings were shown.

=== Dolphin ===
To enable the frame display, go the settings under {{kbd|Options|Graphics Settings|General}} and check the box which says Show FPS.
Refer to the [[Dolphin]] for setup help to make sure your settings are race legal.
Be aware that you need to show your settings menu to prove that your {{kbd|Speed Limit}} setting is set to 100% and that your {{kbd|Clock Override}} setting is disabled. This should happen before the race starts. If settings are shown after the race starts, it must be done before the emulator is closed at the end of the race and we ask that you leave a Racetime comment at roughly what time your settings are shown.

==== Allowed Versions ====
{{race rule|Older versions of Dolphin did not emulate loading the ROM from the WAD properly and skipped the Classic Controller text}}

The allowed versions of Dolphin are Beta 5.0-13963 and newer. The newest beta is almost always recommended.

[[Category:Racing Rules]]

Racing

2025-08-17T12:52:01Z

Fenhl: fixed categorization

'''by LostThePirate'''

This guide will help you get set up for your first race. 

Community races and many privately organized races use [[Racing#racetime.gg|racetime.gg]]. Previously [https://speedrunslive.com SpeedRunsLive] was used, and some people still organize races there, but the community has largely transitioned away from it.

Races can be joined using [[Racing#LiveSplit|LiveSplit]] or through the racetime website. If using LiveSplit, make sure you can log into racetime quickly should LiveSplit fail to load a race channel or crash in the middle of a race.

''We have compiled [https://wiki.ootrandomizer.com/index.php?title=Common_Softlocks_And_Crashes a list of known softlocks and crashes] (WIP). It is recommended to read it through to potentially save you from frustration later.''

{{TOClimit|3}}
== Before You Ready Up ==

Please read the [[Racing#Racing Rules| Rules]] and be familiar with the allowed and banned techniques for the particular ruleset of the race beforehand.

If you are joining a community race it is best to set everything up nice and early. Community race rooms are opened 1 hour ahead of time so you have plenty of time to get everything set up before they start. You'll certainly run into issues and it is easier to help you long before the race starts rather than struggling to hurry to fix everything just 5 minutes before everyone has to ready up.

If you are just playing a pickup race in one of the race planning channels ({{discord|standard-race-planning}}, {{discord|ddr-race-planning}}, {{discord|rsl-race-planning}}, {{discord|bq-race}}, or {{discord|other-racing-formats}}) the people you are racing with should be patient and be able to help you anywhere you get stuck as there is no set starting time there.

Ensure everything is working before you ready up in the race channel. Get your [[Setup#Emulators|emulator]] or console behaving; get your controller/key bindings set; get your [[Trackers|tracker]] of choice downloaded or installed and learn how to use it. Get everything ready so that you can play all by yourself without outside help.

'''Note''': [https://wiki.ootrandomizer.com/index.php?title=Project64 Project64 v3.0+], [[Retroarch]] and [[Bizhawk]] are the recommended emulators for Ocarina of Time Randomizer. In regards to race participation, Project64 v2.0, v2.1, v2.2, and v2.3 as well as ModLoader64 are '''not allowed''' for official racing. Use of all cheats is also prohibited. If you need to use a cheat code to address pause lag in Project64 v1.7 or v1.6, you '''cannot''' join an official race as long as that cheat is active. Use of texture packs to modify the game's appearance is also prohibited by the Ocarina of Time Randomizer community for official races.

Get acquainted with your streaming software; get your broadcast settings ready; get your scene layouts the way you want; get your [https://twitch.tv Twitch] channel how you'd like it. You can add Randomizer, Competitive, and/or Speedrun to your Twitch tags on your dashboard to let viewers know what kind of OoT you'll be playing.

'''Note''': Unless you are a Twitch partner or having ensured quality options, especially in restreamed races it can be detrimental to stream at resolutions and bitrates that will cause lags on your end or for volunteers, so streaming at 1080p or at a bitrate over 4000 kbps is not recommended. We recommend a resolution of 720p (1280x720), and a framerate of 30 frames per second. If you want to go higher, please do not exceed a bitrate of 3500 kbps. For a normal stream of 720p30, 2400 kbps is more than enough for streaming OoTR.

== racetime.gg ==
[https://racetime.gg racetime.gg] is a modern, sleek and user-friendly system that lets anyone and everyone race video games online, and is an open source, community driven site.

=== Create an account ===
Head to the rt.gg website. In the top right corner of the page you should see a <samp>Log in / Create account</samp> button. {{kbd|Left Click}} that button. On the right side is the log in form. You'll use that to log in to your account in the future, after you create it. On the left side is the <samp>Create an account</samp> form. You'll see a link to the [https://racetime.gg/about/faq rt.gg FAQ] and fields for your <samp>Email</samp>, <samp>Name</samp>, and <samp>Password</samp> and its confirmation.

Fill out these fields. The email address will need to be valid so that you can confirm the account. The name field should be the username you like to go by. Ensure you type the same password into both password fields. At the bottom of both forms is a reCAPTCHA you'll need to interact with to prove you're human. Usually, you can just click the checkbox and that is enough.

Once you have filled out the form and proven you're not a robot, click {{kbd|Create account}}. You should get an email shortly with a link to click to validate your account.

=== Connect with Twitch ===
Once you are logged into your rt.gg account, head to the top right of the screen again. {{kbd|Left Click}} the <samp>Settings</samp> button. On this page, select the {{kbd|Twitch & connections}} tab, then on the following page press the {{kbd|Connect your Twitch.tv account}} button. You'll log into your Twitch account if you're not already, then {{kbd|Authorize}} the connection. Your racetime.gg account and your Twitch account are now linked together. You're now ready to join Ocarina of Time Randomizer races.

=== Joining a Race ===
Generally a race room will be provided in one of the announcements channels ({{discord|racing-announcements}}, {{discord|freaky-friday-races}}, {{discord|standard-announcements}}, {{discord|league-announcements}}, {{discord|ddr-announcements}}, {{discord|rsl-announcements}}, {{discord|bq-announcements}}) for official races, or one of the other race planning channels ({{discord|standard-race-planning}}, {{discord|ddr-race-planning}}, {{discord|rsl-race-planning}}, {{discord|bq-race}}, or {{discord|other-racing-formats}}) for pick-up games and you can just click on that link to be dropped right into the correct room on the website. You can also see active races and races currently waiting for participants in the {{discord|current-races}} channel or on the [https://racetime.gg/ootr Ocarina of Time Randomizer] page on racetime.gg You'll probably see <samp>Current races</samp> above a bunch of <samp>Past races</samp>. You can generally join any race that is accepting entrants, so click on the one you're interested in joining.

On the race page, you'll see details of the race, including the goal, a link to the seed page if one has been generated already, and the entrants to the left, and you'll see chat and a timer to the right. Above the timer is a <samp>Join</samp> button. {{kbd|Left Click}} that button to join the race. It will then split into two buttons. <samp>Ready</samp>, which you should click once you have your seed, emulator, and stream set up, and <samp>Quit</samp> which you can click if you decide you don't wish to race. Once you've readied up, a <samp>Not ready</samp> button will appear if you actually aren't ready yet.

Once the race has been started, the timer will begin to countdown. Once it reaches 0, begin to race. During an active race you have two buttons again. <samp>Done</samp>, which you will press once you finish the seed, and <samp>Forfeit</samp> which you may need to press if you find yourself no longer able to complete the race. Both of these actions can be undone if needed, so don't worry if you accidentally hit one. Just make sure by the end of the race you aren't "Done" when you haven't finished, or that you haven't "Forfeit" if you have actually finished. The very last action you can do after having done one of these is <samp>Add comment</samp> on the race. This will be displayed in a tooltip next to your name and in the chat and is viewable by everyone. Be sure not to leave any spoilers in the comment.

== LiveSplit ==

[[File:Livesplit-race-view.png|thumb|Ensure you are using the latest version of LiveSplit for the best experience. If being in a race does not look like this screenshot, be sure to update.]]

LiveSplit is a convenient Timer program that has racetime.gg integration (as of version 1.8.8). It can be downloaded from [http://livesplit.github.io/downloads/ LiveSplit's GitHub page].

The instruction video linked there is ''very helpful'' and I recommend you check it out to learn a lot more about LiveSplit.

=== Join a Race ===

With LiveSplit open, right-click within the Timer, select racetime.gg Races, and choose from the available races that are currently accepting Entrants. On racetime.gg, the Ocarina of Time Randomizer has its own category, so you shouldn't have any confusion.

Upon selecting a race to participate in, you will be prompted to log into the website for racetime.gg races.

[[File:Livesplit-oauth.png|frameless]]

== Entering and Readying ==

To actually enter a race you'd like to participate in, [[Racing#LiveSplit|Join a Race via LiveSplit]] or [[Racing#Joining a Race|Join a Race on the website if racing on racetime]]. Then, click Enter Race or type {{kbd|.enter}} to join the race.

Click the link in the header below the ruleset name for a link to the seed to be used in the race. Note: This is not set too early before a race's start time, to prevent cheating. During Weeklies, for example, the seed is generated (and the link posted) approximately 15 minutes before the scheduled start time of the race.

Race participation requires streaming your run. Be sure to start your broadcast at least 5 minutes before the expected start time of the race. A bot will verify if you are live, and it can take up to 5 minutes for the fact that you are live streaming to become available to that bot. Budget your time accordingly.

Once you have ''everything'' ready to begin your run, select Ready or type {{kbd|.ready}}. Only do this after you have downloaded the seed, set your file name, had your final bathroom break before the race, gotten your cup of water, etc. Ready means '''ready''', and once everyone has indicated that they are ready, there is a 15 second countdown on racetime.

Once the countdown reaches 0, your LiveSplit timer will start automatically, if linked. '''Do not''' start your game file (and load into your house in the forest) before the Timer starts! Do not attempt to Pause your timer during a race, either - LiveSplit will interpret a Pause as completion of the race.

== Finishing A Race ==

When you are finished with a race depends on whether the goal is to ''Defeat Ganon'', ''Collect All Triforce Pieces'' in Triforce Hunt, or in casual races some other goal. The timing of finishing for defeating Ganon is the start of cutscene after you press B for the final swing. For Triforce Hunt in the Random Settings League it is once the screen is completely black, and in general Ocarina of Time racing is finished either at the last input or once the item you collected is above your head.

Once you achieve your goal, stop your timer using whatever keybinding you have set for it, click Done or type {{kbd|.done}} to complete the race. You can look in the race room to see who has finished and with what times.

If something comes up, you can click Forfeit or type {{kbd|.forfeit}} to forfeit a race. You will lose points and standing on racetime, but sometimes it can't be avoided. Be aware of the penalties for forfeiting, and try to budget plenty of time for a race.

If you think you have to quit, click Forfeit, then realize you were mistaken, you can resume the race (including all the time that has elapsed) by clicking Undo Finish or typing {{kbd|.undone}} – the race timer will continue and will include the time you thought you were out of the race.

== Racing Rules ==
{{race rule|These are several of the most important rules you must follow while racing.}}
# You must follow the [[Rules]] the current race has chosen to follow. The most common ruleset is [[Standard]], however this is not used for all races. Always confirm which ruleset a race is using if it is not in the race goal.
# You can play on [[Everdrive|the Nintendo 64 with a flash cart]], [[Wii Virtual Console]], or [[Setup#Emulators|Emulators]]. Project64 v2.x, ModLoader64, and Dolphin versions older than Beta 5.0-13963 are not allowed for racing. Note that [https://www.pj64-emu.com/public-releases Project64 v3.0+] is race-legal.
#* If playing on emulator, you must also follow the [[Racing#Emulator Settings Requirements|Emulator Settings Requirements]].
# You may not modify the ROM in any way outside of patching it on the [https://ootrandomizer.com Randomizer website] or the Ocarina of Time Randomizer software on your computer.
#* This means changing cosmetics using the randomizer is fine. Adding stuff like models or changing textures is not. Editing RAM is also not allowed.
# Generally there are no rules for streaming except that you must do so, however Tournament races often have additional requirements.
# Spoilers should only be discussed in the relevant "results" channels on the Discord. Do not discuss them in other Discord channels or the race chat channel, and do not put them in race comments.

''The restreaming team also requests that if you use custom music, you try to keep it to only Zelda tracks if they ask you if you want to be restreamed''.

== Emulator Settings Requirements ==
{{race rule|These settings are either useful for identifying a cheater, or preventing an emulator from exceeding the capabilities of the actual Nintendo 64}}
Playing on an emulator for races requires a little bit more setup. Namely, you need to enable an FPS display. If you cannot provide this, you are required to capture the entire emulator window. '''Texture packs are not allowed during races'''.

Some options may not be available unless you are currently running an [[Setup|Ocarina of Time Randomizer ROM]].

=== BizHawk ===
To enable the FPS display, go to {{kbd|View|Display FPS}}. You can configure it further in {{kbd|Config|Messages}}.

=== Project64 ===

To enable the FPS Display (shown as DL/s), launch Project64 and load your ROM. Next, navigate to {{kbd|Options|Settings...}} or press {{kbd|Ctrl+T}} to open the Settings menu.

In the Settings menu, expand the <samp>Options</samp> list on the left-hand side and look for an <samp>Advanced</samp> section. If the <samp>Advanced</samp> section isn't showing, click <samp>Options</samp> and untick <samp>Hide advanced settings</samp>. Afterwards, click <samp>Advanced</samp> and tick the <samp>Speed Display</samp>. The <samp>Speed Display</samp> box must show <samp>VI/s & DL/s</samp>. Click <samp>Apply</samp>.

'''Lowering the VI refresh rate to 1490 is also required for racing with Project64.'''

While in the Settings menu, look for a <samp>Defaults</samp> section. If the <samp>Defaults</samp> section isn't showing, click {{kbd|Options}} and untick {{kbd|Hide advanced settings}}. Afterwards, click {{kbd|Defaults}} and change the <samp>VI refresh rate</samp> from <samp>1500</samp> to {{kbd|1490}}. Click {{kbd|Apply}}.

Finally, in the Settings menu, click on {{kbd|Config: The Legend of Zelda - Ocarina of Time (U) (Randomizer).}} Your <samp>VI refresh rate</samp> should display <samp>1490</samp>. If not, change it accordingly and click {{kbd|Apply}}

Keep in mind that you ''should'' show your VI Refresh Rate in both the Defaults section and the Config: The Legend of Zelda - Ocarina of Time (U) (Randomizer) section before the race starts. If you do not show settings before the race, we ask that you make a note in your Racetime comment at roughly what time you show settings. This should be done before you close your emulator at the end of the race.

==== Allowed Versions ====
{{race rule|Older versions of Project 64 have problematic settings, either overclocking by default or just don't work right with Ocarina of Time Randomizer}}

The allowed versions of Project 64 are version 3.0 and newer stable versions.

=== RetroArch ===
To enable the FPS display, go to {{kbd|Settings|On-Screen Display|On-Screen Notifications}} and switch <samp>On-Screen Notifications</samp> to {{kbd|ON}} if it is not already. Then, change <samp>Display Framerate</samp> to {{kbd|ON}}.

You must also show that you are using the <samp>Framerate</samp> option {{kbd|original}}, as well as having the <samp>VI Refresh (Overclock)</samp> option set to {{kbd|auto}}, ''ideally'' before a race starts. To do this, press {{kbd|F1}} to open the <samp>Quick Menu</samp> and choose {{kbd|Options}} and scroll down to the <samp>Framerate</samp> option. This is required for the Mupen64plus Next core and the ParaLLEl core. If you are using the old mupen64plus core, this option will not appear and the text in the bottom left that displays what core you are using will be proof that you are following this rule. If you do not show these settings before the start of the race, they must be shown before closing your emulator. We also ask that you make a note in your Racetime comment at roughly what time the settings were shown.

=== Dolphin ===
To enable the frame display, go the settings under {{kbd|Options|Graphics Settings|General}} and check the box which says Show FPS.
Refer to the [[Dolphin]] for setup help to make sure your settings are race legal.
Be aware that you need to show your settings menu to prove that your {{kbd|Speed Limit}} setting is set to 100% and that your {{kbd|Clock Override}} setting is disabled. This should happen before the race starts. If settings are shown after the race starts, it must be done before the emulator is closed at the end of the race and we ask that you leave a Racetime comment at roughly what time your settings are shown.

==== Allowed Versions ====
{{race rule|Older versions of Dolphin did not emulate loading the ROM from the WAD properly and skipped the Classic Controller text}}

The allowed versions of Dolphin are Beta 5.0-13963 and newer. The newest beta is almost always recommended.

[[Category:Racing Rules]]

Dev team calls

2025-08-10T15:54:10Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on August 25, 2025 at 18:00 EDT (22:00 UTC).

== August 10, 2025 ==

Participants: Fenhl, TestRunner

# translation support infrastructure:
#* Discord: translator role (or one per language)?, translation channel(s)?
#* subcommand to check missing text for a language, web frontend for easy overview?
# can we give more people the ability to give an “official” PR review (green checkmark rather than gray) and to request reviews from them? → TreZ

next call: <t:1756159200:F>

== July 28, 2025 ==

Participants: Fenhl, RealRob

# worked on getting [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2423 #2423] ready to be merged
# investigated a bug with the unit tests, see [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2440 #2440] for the result

== July 13, 2025 ==

Participants: Fenhl, Kirox, RealRob

# fast-path merging: should typically not bypass testing, consider the state of the existing code being affected as well, maybe ask other maintainers/dev team what they think of the PR
# discussed ER test failues with advanced logic, may be caused by ER algorithm but may also be a logic bug, need to investigate further
# discussed some issues/PRs under consideration
#* For [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2363 #2363 Child D-Pad Items], ask for public feedback?

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-07-29T00:28:26Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on August 10, 2025 at 17:00 CEST (15:00 UTC).

== July 28, 2025 ==

Participants: Fenhl, RealRob

# worked on getting [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2423 #2423] ready to be merged
# investigated a bug with the unit tests, see [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2440 #2440] for the result

== July 13, 2025 ==

Participants: Fenhl, Kirox, RealRob

# fast-path merging: should typically not bypass testing, consider the state of the existing code being affected as well, maybe ask other maintainers/dev team what they think of the PR
# discussed ER test failues with advanced logic, may be caused by ER algorithm but may also be a logic bug, need to investigate further
# discussed some issues/PRs under consideration
#* For [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2363 #2363 Child D-Pad Items], ask for public feedback?

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-07-13T17:17:16Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on July 28, 2025 at 18:00 EDT (22:00 UTC).

== July 13, 2025 ==

Participants: Fenhl, Kirox, RealRob

# fast-path merging: should typically not bypass testing, consider the state of the existing code being affected as well, maybe ask other maintainers/dev team what they think of the PR
# discussed ER test failues with advanced logic, may be caused by ER algorithm but may also be a logic bug, need to investigate further
# discussed some issues/PRs under consideration
#* For [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2363 #2363 Child D-Pad Items], ask for public feedback?

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-07-01T00:09:45Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on July 13, 2025 at 17:00 CEST (15:00 UTC).

== June 30, 2025 ==

Participants: Fenhl, RealRob, TestRunner

# discussed Gloom Mode: Rob's branch has it, it has some quirks with some things dealing damage multiple times, logic would have to account for potentially being on 1 heart (heat timers), change double defence and/or Nayru's to behave differently?
# should set up a web branch for [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → TreZ
# try replacing the zpf patcher with native code to check how much it speeds up [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332] → Fenhl
# discussed feature requests from tourney orgs (see #dev-tourny-orgs-private-talk)

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-06-17T13:18:00Z

Fenhl: last call was cancelled, updated date of next call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on June 30, 2025 at 18:00 EDT (22:00 UTC).

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-06-03T01:24:28Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on June 15, 2025 at 17:00 CEST (15:00 UTC).

== June 2, 2025 ==

Participants: Fenhl, ShadowShine57, RealRob, TreZ

# set up GitHub Actions workflow to create the release download (and possibly more of the release process) → TreZ
# asked Rebbacus about helping out with multiworld on Wii VC
# SummerCart64 support → ask flagrama to write documentation? Multiworld support doesn't appear to need randomizer code changes since it has memory read/write commands
# allow stick/nut/magic upgrade smoke colors to be customized in cosmetics
# split off “already hinted” and color changes from [https://github.com/ootrandomizer/OoT-Randomizer/pull/1875 #1875 Redefine important_check hints for consistency with barren] into individual PRs → Fenhl

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-05-18T17:17:35Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on June 2, 2025 at 18:00 EDT (22:00 UTC).

== May 18, 2025 ==

Participants: Fenhl, Kirox, RealRob

# how to proceed with the release? → discuss in text
# tracking issues for Dev-Rob features → Rob will open them (or PRs, for features that are ready for that)
# Rob gave a quick asm hacks crash course

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Branch identifiers

2025-05-18T04:34:06Z

Fenhl:

This is a list of known '''branch identifiers''', i.e. values of [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/version.py#L8 the variable <code>branch_identifier</code> in version.py].

{| class="wikitable"
|-
! ID
! Branch
|-
| <code>0x00</code>
| main releases and release candidates
|-
| <code>0x01</code>
| [https://github.com/OoTRandomizer/OoT-Randomizer Dev (OoTRandomizer)]
|-
| <code>0x43</code>
| [https://github.com/Cuphat/OoT-Randomizer/tree/Dev-C Dev-C (Cuphat)]
|-
| <code>0x45</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/Dev-Rob Dev-Rob (rrealmuto)]
|-
| <code>0x46</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/enemy_shuffle enemy_shuffle (rrealmuto)]
|-
| <code>0x52</code>
| [https://github.com/Roman971/OoT-Randomizer Dev-R (Roman971)]
|-
| <code>0x57</code>
| reserved by [https://github.com/cjohnson57/OoT-Randomizer cjohnson57]
|-
| <code>0x69</code>
| [https://github.com/Elagatua/OoT-Randomizer blitz (Elagatua)]
|-
| <code>0x99</code>
| [https://github.com/mracsys/OoT-Randomizer Dev-M (mracsys)]
|-
| <code>0x9c</code>
| [https://github.com/trezc0/OoT-Randomizer trez-test]
|-
| <code>0xae</code>
| [https://github.com/fenhl/OoT-Randomizer/tree/riir riir (fenhl)]
|-
| <code>0xfe</code>
| [https://github.com/fenhl/OoT-Randomizer dev-fenhl]
|-
| <code>0xff</code>
| reserved for private use
|}

Branch identifiers

2025-05-18T04:33:48Z

Fenhl: added riir branch

This is a list of known '''branch identifiers''', i.e. values of [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/version.py#L8 the variable <code>branch_identifier</code> in version.py].

{| class="wikitable"
|-
! ID
! Branch
|-
| <code>0x00</code>
| main releases and release candidates
|-
| <code>0x01</code>
| [https://github.com/OoTRandomizer/OoT-Randomizer Dev (OoTRandomizer)]
|-
| <code>0x43</code>
| [https://github.com/Cuphat/OoT-Randomizer/tree/Dev-C Dev-C (Cuphat)]
|-
| <code>0x45</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/Dev-Rob Dev-Rob (rrealmuto)]
|-
| <code>0x46</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/enemy_shuffle enemy_shuffle (rrealmuto)]
|-
| <code>0x52</code>
| [https://github.com/Roman971/OoT-Randomizer Dev-R (Roman971)]
|-
| <code>0x57</code>
| reserved by [https://github.com/cjohnson57/OoT-Randomizer cjohnson57]
|-
| <code>0x69</code>
| [https://github.com/Elagatua/OoT-Randomizer blitz (Elagatua)]
|-
| <code>0x99</code>
| [https://github.com/mracsys/OoT-Randomizer Dev-M (mracsys)]
|-
| <code>0x9c</code>
| [https://github.com/trezc0/OoT-Randomizer trez-test]
|-
| <code>0xae</code>
| [https://github.com/fenhl/OoT-Randomizer/tree/riir riir]
|-
| <code>0xfe</code>
| [https://github.com/fenhl/OoT-Randomizer dev-fenhl]
|-
| <code>0xff</code>
| reserved for private use
|}

Patch Files

2025-05-06T00:32:19Z

Fenhl: updated GitHub link

As of version 3.7.7 of the Ocarina of Time Randomizer it is possible to create and apply patch files to the base ROM which can be shared between people who want to play on the same exact seed without distributing copyright material.

''For more technical information view the [https://github.com/OoTRandomizer/OoT-Randomizer/blob/Dev/Notes/ZPFZ%20patch%20format.txt ZPF patch format Documentation on GitHub].''

== Advantages of Using Patches ==
First and foremost, patch files allow you to legally share randomizer seeds, as the patch files do not contain any copyrighted content.

Patch files are the best way to conduct a race where only the organizer or a third party individual has access to the spoiler log. Simply have the person who should have spoiler log access create the patch file, then share that patch file with racers to use on the website. This way you can have a race without fearing someone cheating by reading the spoiler log, but you can still look back on the spoiler log later, which would not be available with a race seed created on the website.

Patch files also currently work no matter the version of the randomizer used. A patch file created on 3.7.7 will work on the latest generator. A version 5.1 patch file will work on the 3.7.7 generator; ''however it is not recommended to do that due to a bug related to cosmetics that was fixed prior to version 4.0.'' '''This also means you can generate a randomizer patch on the Dev branch, a Pull Request, or a an entirely different fork of the randomizer and use it on the website and it will just work!'''

== Disadvantages of Using Patch Files ==
There are not many, but some issues can occur when using patch files.

=== Cannot Override Some Cosmetics Using A Patch From Newer Versions on Older Versions ===
If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you might not be able to override some of the cosmetics already existing in the patch file when using an older version to apply it.

The cosmetics that you will not be able to change in this case include:
*D-Pad HUD Display
*Sword Trails
*Heart Colors
*Magic Colors
*Button Colors

You may be able to use the [https://ootrandomizer.com/latestDev latest Dev version on the website] to work around this issue.

== Create Patch Files ==
Generating a patch file for a normal seed will create a ZPF file. A [[Multiworld]] seed will create a ZPFZ file.

=== Website ===
The website only creates patch files, which you then apply to your ROM after generation. The patch file can be downloaded from the seed page. We will use the [https://ootrandomizer.com/seed/vanilla Vanilla plando seed] as an example. At the very bottom of the page, below the "Patch ROM" button, is a link ''Save unmodified Patch File''. Clicking this link will download the patch file to your computer.

[[File:PatchFiles_Website.png|center]]

You can then send this to people by uploading it to a file sharing site or on Discord.

=== Bundled Release ===
The bundled release is the downloadable, offline program for the randomizer. This applies to both the <code>.exe</code> version and github zip files. Under the "ROM Options" tab there is an "Output Type" section. You want to choose "Patch File" instead of "Compressed [Stable]". This will only create the patch file. If you also want a ROM for yourself, you'll need to [[#Apply Patch Files|apply the patch file]].

[[File:PatchFiles_Offline.png|center]]

You can then send this to people by uploading it to a file sharing site or on Discord.

== Apply Patch Files ==
* It is recommended to use the [[#Website 2|website method]]. It is also much easier to create a <code>.wad</code> file this way.
* When applying a [[Multiworld]] seed make sure to select the ZPFZ file and set your Player ID to the correct value.

=== Website ===
At the bottom of the [https://ootrandomizer.com/generator Generator page], above the "Generate Seed!" and "Generate Race Seed!" buttons is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change the Player ID, if applicable. You can scroll up to choose between creating a <code>.z64</code> file or a <code>.wad</code> file or to change the Cosmetic and SFX options. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click "Patch ROM!" button and your ROM will be generated.

[[File:PatchFiles_Website2.png|center]]

=== Bundled Release ===
The bundled release is the downloadable, offline program for the randomizer. This applies to both the <code>.exe</code> version and github zip files. Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change your Player ID, if applicable. You can scroll up to change the Cosmetic and SFX options, if desired. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click the "Generate!" button and your ROM will be generated.

[[File:PatchFiles_Offline2.png|center]]

Dev team calls

2025-05-05T22:19:20Z

Fenhl: no call today, updated date of next call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on May 18, 2025 at 17:00 CEST (15:00 UTC).

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-04-20T18:11:27Z

Fenhl: updated with notes from today's call

Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically.

The calls are currently on an alternating schedule. The next call will be held on May 5, 2025 at 18:00 EDT (22:00 UTC).

== April 20, 2025 ==

Participants: Fenhl, Kirox, RealRob

# magic model:
#* RealRob is doing final fixes and testing
#* rotate the model so it faces the player when displayed in a shop → should probably be done by Maple in the model file itself
# accepted [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2403 #2403] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2404 #2404]
# reviewed some PRs

== April 7, 2025 ==

Participants: Fenhl, ShadowShine57

# open tracking issues for PRs closed due to inactivity? (post in #dev-private-talk for feedback first)
# open tracking issues for items from call notes that still need work
# for moving Python files into a subfolder:
#* keep entry points (CI.py, Gui.py, OoTRandomizer.py, Unittest.py, version.py?) at root
#* make sure it works with the addition of Python dependencies RealRob is working on
#* go through other open PRs to offer help with rebasing etc
# compressor/decompressor update:
#* is [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2389 #2389] independent of the new version?
#* Rust port (https://github.com/fenhl/OoT_Decompressor) for easier builds and better portability (no dynamic linking, fixes running on NixOS) — combine with Rust crash course?
# magic meter model: if the vote is a draw, ShadowShine57 as the project lead will be the tiebreaker

== March 23, 2025 ==

Participants: Fenhl, Kirox, RealRob, TreZ

# changelog PR: rebase and incorporate flagrama's suggestion, then merge
# new magic model: test scroll with smoke, otherwise go with jar with rainbow smoke, merge stick/nut upgrades with smoke as well before release
# merge Dev-R changes into main Dev:
#* mixed pools changes blocked on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2332 #2332]
#* investigate what [https://github.com/Roman971/OoT-Randomizer/blob/35b93e4c65757a62aeb4bb6151fb87d4324e896c/ASM/src/hacks.asm#L1864-L1872 this fishing change] does and whether it's still wanted
#* extra cosmetics can probably just be PR'd
#* fast skulltula text should probably be a setting (included in glitched logic 3.0 PR, needs to be separated out)
#* GUI tweaks → some of it seems like a good idea, compromise on Fenhl's branch to be PR'd and discussed
# allow unequipping swords/shields? Ask for feedback

== February 24, 2025 ==

Participants: Fenhl, Kirox

# went through some open issues and PRs for review/testing
# do we want to advertise [https://github.com/OoTRandomizer/OoT-Randomizer/issues?q=state%3Aopen%20label%3A%22Status%3A%20Good%20First%20Issue%22 the list of good first issues] more? (e.g. a pin in #dev-public-talk or a post in #dev-resources)
# new schedule for these calls → rotating schedule?

== February 10, 2025 ==

Participants: Fenhl, Kirox, RealRob, ShadowShine57, TestRunner

# mentoring program: ASM/C hacking guide will be published as a written document, Rust crash course as a call if TreZ is still interested
# added [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2369 #2369] to the blocking issues for the next release
# went through most of the open issues under consideration, continue next time
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/851 #851]: reconsider integrating [https://github.com/matthewkirby/plando-random-settings RSL script] into randomizer in some form, talk to RSL organizers
# regarding [https://github.com/OoTRandomizer/OoT-Randomizer/issues/1647 #1647]: RealRob will ask owl is not a cat whether this makes sense to attempt

== January 27, 2025 ==

Participants: Fenhl, TestRunner, TreZ

# followed up on release blocking issues: re-requested review on [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2345 #2345] from RealRob, options for making the magic meter model more distinct from prescription on VC (increasing opacity of the bottle, changing paper color to be more distinct) → asked Kirox to try implementing distance-based opacity, if not easily doable, make a fallback PR that just increases the opacity
# ice trap model ([https://discord.com/channels/274180765816848384/512048482677424138/1333429599744561265 #dev-public-talk post]): looks good, how would it interact with possible future trap types? → new trap types don't have to come with a model since it's only displayed when picked up
# set up automation for releases, see [https://discord.com/channels/274180765816848384/512048482677424138/1315736143416918036 #dev-public-talk post]
# new macOS icon made, TreZ will PR along with new Windows icon
# new dev team member RealRob
# integrate [https://oot.flagrama.com/ oot.flagrama.com] downpatcher into the randomizer? → TreZ will look into it regarding the web patcher, flagrama doesn't think it's a good idea
# new contributing guidelines document that will go in the repo (CONTRIBUTING.md) and replace [https://discord.com/channels/274180765816848384/512048482677424138/708078686670422046 an outdated #dev-public-talk pin that still mentioned Trello] → Fenhl will write a draft and post in #dev-private-talk for review before PRing

== January 13, 2025 ==

Participants: Fenhl, Kirox, ShadowShine57

# setting to add specific dungeon reward requirements for the rainbow bridge (e.g. Light medallion + Forest medallion + Goron ruby)
# move relevant Trello tasks to GitHub issues
# went through all PRs under consideration
# use the settings migration feature also to avoid breakage when settings types change?
# ask Roman about the status of the extra cosmetics on Dev-R

== December 16, 2024 ==

Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick

# legal implications of using decomp code → TreZ thinks it's fine
# update compressor/decompressor to MIT-licensed versions?
# remove binaries from git repo and generate Dev versions in CI?
# optimization — [https://mypyc.readthedocs.io/en/stable/introduction.html mypyc], rewriting performance-critical parts in C/Rust? (see [https://pyo3.rs/ PyO3])
# check why the fuzzer is disabled, potentially reenable
# mentoring issues e.g. [https://github.com/ootrandomizer/OoT-Randomizer/issues/2106 #2106] for decomp-based fixes
# publish these notes on the OoTR wiki
# offline releases: new icon (new macOS icon shape), automation, Universal binary for macOS
# release numbering: previously based on whether there were big features added — now that we have a release schedule, use major version bumps for scheduled releases and minor version bumps for hotfixes and preset backports?
# postpone the feature freeze by a week to allow people to work on features for this release during holidays? → ask in #dev-public-talk
# <s>next call on January 6 due to holidays</s> postponed to January 13

== December 5, 2024 ==
[[File:Magic_meter_scroll_sketch.png|thumb|Sketch of the proposed magic meter model]]

Participants: Fenhl, ShadowShine57, TestRunner, TreZ

# considering moving the Python files from the root of the repo to a subfolder to clean things up a bit, not sure if it's worth the extra work for PR authors
# idea to allow individual options of dropdown/multiselect settings to have separate tooltips → does the UI framework support this?
# new magic meter model: making it a cosmetic setting would be bad for watching other runners, new idea see image, Maple will look into it
# approved some nominated PRs, left comments on others, [https://discord.com/channels/274180765816848384/879057051014271057/1314362590926868560 asked race mods][private link] about [https://github.com/OoTRandomizer/OoT-Randomizer/pull/2302 #2302]
# to encourage work on features we want to see (e.g. stats screen), we could put up bounties, open tracking issues, and/or create feature branches directly on the OoTRandomizer fork
# <code>triforce-pog-rework</code> branch can probably be deleted, it only exists because the repo was still TestRunner's personal fork when it was created
# we can assign PRs to ShadowShine57 for review
# separate Discord channel for nominations? → not necessary
# next call on the 16th (Mondays work better for TestRunner), maybe start an hour earlier if that makes it possible for Kirox to join? (though ShadowShine57 would most likely have to join late then)

Dev team calls

2025-04-07T23:25:11Z

Fenhl: updated with notes from today's call, clarified schedule

Dev team calls

2025-03-23T18:57:11Z

Fenhl: adjusted time of next call

Dev team calls

2025-03-23T18:27:19Z

Fenhl: updated with notes from today's call

Dev team calls

2025-03-21T23:50:09Z

Fenhl: added time of next call

Branch identifiers

2025-03-15T09:36:54Z

Fenhl: added release candidates

This is a list of known '''branch identifiers''', i.e. values of [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/version.py#L8 the variable <code>branch_identifier</code> in version.py].

{| class="wikitable"
|-
! ID
! Branch
|-
| <code>0x00</code>
| main releases and release candidates
|-
| <code>0x01</code>
| [https://github.com/OoTRandomizer/OoT-Randomizer Dev (OoTRandomizer)]
|-
| <code>0x43</code>
| [https://github.com/Cuphat/OoT-Randomizer/tree/Dev-C Dev-C (Cuphat)]
|-
| <code>0x45</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/Dev-Rob Dev-Rob (rrealmuto)]
|-
| <code>0x46</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/enemy_shuffle enemy_shuffle (rrealmuto)]
|-
| <code>0x52</code>
| [https://github.com/Roman971/OoT-Randomizer Dev-R (Roman971)]
|-
| <code>0x57</code>
| reserved by [https://github.com/cjohnson57/OoT-Randomizer cjohnson57]
|-
| <code>0x69</code>
| [https://github.com/Elagatua/OoT-Randomizer blitz (Elagatua)]
|-
| <code>0x99</code>
| [https://github.com/mracsys/OoT-Randomizer Dev-M (mracsys)]
|-
| <code>0x9c</code>
| [https://github.com/trezc0/OoT-Randomizer trez-test]
|-
| <code>0xfe</code>
| [https://github.com/fenhl/OoT-Randomizer dev-fenhl]
|-
| <code>0xff</code>
| reserved for private use
|}

Dev team calls

2025-02-24T22:22:14Z

Fenhl: updated with notes from today's call

Mido's House Multiworld

2025-02-23T07:31:43Z

Fenhl: /* I'm on Linux, how do I run the installer? (Unknown file type) */ clarified that you don't need to do both

Dev team calls

2025-02-10T23:19:55Z

Fenhl: updated with notes from today's call

Dev team calls

2025-01-27T22:57:12Z

Fenhl: updated with notes from today's call

Dev team calls

2025-01-13T23:44:03Z

Fenhl: updated with notes from today's call

Dev team calls

2025-01-10T07:40:27Z

Fenhl: postponed next call

Multiworld

2025-01-08T05:48:09Z

Fenhl: /* Feature comparison */ updated BizHawk version supported by MH MW

The aim of this page is to help the reader set up '''Multiworld'''. Multiworld is a co-op mod for the OoT Randomizer. Players have their own inventory and their own world. Also, player-specific items are mixed between the worlds. For example, if you obtain an item in your world, it could either stay with you or get sent to another player. Everyone participating will be playing different intermingled seeds.

As an example, there could be a scenario where Player 1 can only advance in their own world based on something Player 2 does. Once Player 2 finds the Megaton Hammer belonging to Player 1, Player 1 will automatically receive it. Every world is linked together.

In order to link everyone's worlds together, players will need a plugin like ''bizhawk-co-op'' or [[Mido's House Multiworld]]. For Mido's House Multiworld, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For setting up bizhawk-co-op, see the [[Multiworld#Installing Multiworld and Bizhawk|Installing Multiworld and Bizhawk]] section below. If you're not sure which plugin to use, see the [[Multiworld#Feature comparison|Feature comparison]] section.

These plugins are currently only compatible with [[Project64]] (Mido's House Multiworld only) and [[Bizhawk]] (both plugins). Mido's House Multiworld also has experimental support for [[EverDrive]], which currently requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. However, the ModLoader64 devs have made their own plugin which is compatible with their emulator and the OoT Online pak, allowing players to see each other's character in the game. (Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

This section applies regardless of which plugin you use, but if you're using ModLoader64, please note that it is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer] and not with newer releases or Dev builds of OoTR.

=== Using the Webpatcher ===

Start off by going to the [https://ootrandomizer.com/generator Webpatcher] and set up the settings you want for the seed. On the <code>Rom Options</code> tab change the <code>Player Count</code> to however many people will be playing. Once you're done, generate the seed.

[[File:mwromgen.png|560x315px]]

After you have generated the seed, share the URL with your partners and have everyone choose a different <code>Player ID</code>. Then continue patching the rom as you would normally (don't forget cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgen2.png|560x315px]]

=== Using the Offline Version ===

Generating a ROM using an offline build works a little differently. After choosing the settings you wish to play with, go to the <code>ROM Options</code> tab and set <code>Generate New Seed</code> (<code>Generate From Seed</code> in previous versions). Choose <code>Patch File</code> as your <code>Output Type</code> and change the <code>Player Count</code> to however many people will be playing. Then hit <code>Generate!</code>.

[[File:mwromgendev1.png|560x315px]]

Send the patch file (.zpfz) to your partners and have them set <code>Generate From File</code>. The <code>Output Type</code> should be <code>Compressed [Stable]</code> now, and everyone should choose a different <code>Player ID</code>. Select the patch file and hit <code>Generate!</code> (don't forget to set cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgendev3.png|560x315px]]

Note: if your partners don't have the offline build they can also patch the rom using the website. Make sure to set <code>Generate From File</code> and select your patch file (.zpfz).

There are several reasons why someone might want to generate a ROM using an offline build. For example, some builds might have features that are not available on the website build (yet), like [https://github.com/Roman971/OoT-Randomizer additional Entrance Randomizer settings]. Generating from an offline build also lets you play with your own custom patches.

== Installing Multiworld and Bizhawk ==

This section and the sections below apply only to the bizhawk-co-op plugin. For Mido's House Multiworld, please download and run the installer from [https://midos.house/mw its website]. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== The Recommended Method ===

Press '''Windows+R''' to open the '''Run''' dialog box, and then type "'''powershell'''" in the text box. Once you have your PowerShell window open, copy-paste this in:

'''<pre>cd $env:userprofile\downloads;
Set-ExecutionPolicy Bypass -Scope Process -Force;
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/TestRunnerSRL/bizhawk-co-op/master/bizhawk-co-op.ps1'))</pre>'''

From here, the PowerShell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install in your downloads folder and place everything for you. Say '''yes''' when PowerShell prompts you to install the <code>bizhawk_prereqs.exe</code> file. Once PowerShell is done, you can move the Bizhawk 2.7 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>.

=== The Alternate Method ===

==== Download the Custom Bizhawk Installer ====

First, you must download the Multiworld script from [https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip TestRunner's GitHub page]. When you download this, extract its contents to ''its own folder'' - it will be creating a new Bizhawk install for you to use, so you must keep it separate. ''Note: Whenever there is an update to the Multiworld script, everybody playing must update to the latest version.''

==== Running the Custom Bizhawk Installer ====

Once you have the contents extracted to its own folder, locate the <code>bizhawk-co-op.ps1</code> file. Right Click and select Run with PowerShell.

[[File:MWG1.png|610x149px|Run with PowerShell]]

If Powershell prompts you for permissions, say yes to all. From here, the Powershell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.7 folder that was created. These files are no longer needed and only add confusion.''

==== Powershell Permissions ====

You may need to enable executing Powershell scripts without requiring the script to be digitally signed. Open Powershell from the Start Menu by right clicking it and selecting "Run as Admin". Click the "Yes" button to allow Powershell to run as Administrator. Type <code>Set-ExecutionPolicy Unrestricted</code> and press <code>Enter</code> once, type <code>Y</code> then press <code>Enter</code> again. The Powershell script should now run.

== Configuring Bizhawk for Multiworld ==

=== Bizhawk Settings ===

There are a few things you need to do once you've got the emulator running. The very first thing is go to <code>Config -> Customize</code> and navigate to the Advanced tab. At the bottom, there is an option for Lua Core; select <code>Lua+LuaInterface</code> and hit OK. While on the Advanced tab, you should also check the box for <code>AutoSaveRAM</code> and set it to a reasonable time, such as 60-180 seconds (keep in mind that setting this too low could increase lag and decrease overall emulator performance). This will allow Bizhawk to write your in-game save to your drive. This is '''NOT''' a form of save state - it simply periodically creates/updates a file on your hard drive with your in-game save data, and is wonderful for mitigating the effects of crashes. '''In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save file follow the instructions over [[Multiworld#Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen!|here]].

[[File:bizhawkautosave.png|420x487px|Advanced Customization]]

In the General tab of the Customize menu, tick the boxes for "Accept background input" and "Run in background" – this will allow Bizhawk to keep accepting controller inputs when you tab over to your tracker or notes and prevent the emulation from pausing (which will disconnect you). Clear your hotkeys by going to Config -> Hotkeys, and at the bottom click Misc and Clear All.

=== Controller Settings ===

The next step is to set your controller up. Your controller configuration will vary based on what controller you are using; for Bizhawk to enable the Controller menu, you must have a ROM loaded. For a smooth controller experience, you must unbind the first 4 binds in Config -> Controller such that it looks like this:

[[File:MWG3.png|320x207px|Normal Controls]]

You'll then have to bind your analog stick in the Analog tab of your controller config and adjust your sensitivity and deadzones to your preference. ''Additional info on controller setup can be found in Step 6 of the [[Bizhawk|Bizhawk Guide]].''

=== Video Settings ===

You can fix how your game looks by going to Config -> Cores -> N64 Video Plugin Settings. In here, change your resolution so that it runs smooth. Multiworld will drop your performance, so keep that in mind. The recommended video plugin is GLideN64. ''(This is not the same plugin as Glide64!)''

== Starting the Multiworld Session ==

=== Opening the Lua Console ===

Once you have your emulator set up to run how you are comfortable with, its time to move to the Lua console. Go to Tools -> Lua Console, and a separate window will open up. ''This window must remain open at all times during a Multiworld.'' In the Lua Console, go to Settings and checkmark the Disable Scripts on loads.

[[File:MWG4.png|586x379px|Disable Scripts on Load]]

This is the last of the settings changes you have to do. If you want Bizhawk to retain these settings changes for the next time, go to Config -> Save Config. Once you have these steps done, '''you MUST close your emulator and reopen it for this change to take effect'''. Close out of Bizhawk, and then reopen it and the Lua Console. Sometimes this will not be enough and you will still get an error trying to load the Lua file. In that case reboot your entire computer.

'''If for some reason you do not have your Multiworld ROM open, you must do so now.'''

From here in the Lua Console, Open Script and locate the <code>bizhawk co-op.lua</code> file in the Bizhawk 2.7 folder. Once you have that done, a red square will appear in the console; double click it and a new window will open up.

[[File:MWG5 2.png|Bizhawk co-op]]

This window must ''also'' stay open at all times.

=== Rooms ===

The Lua Console Script is where you set up a room and join rooms.

If you are the Host: You must port forward. How you do this varies on what brand your router is. Instructions on how to do this can be found by Googling your brand/model of router. You'll want to use a port between 49152 and 65535. We highly recommend using the default port, 50000. You'll also want to ensure you're forwarding the TCP protocol as that is the protocol Multiworld uses. Most other games you have port forwarded in the past likely were using the UDP protocol.

Once that is done, in the Bizhawk Co-op window the Host must set their name, password, and the port that was forwarded, along with setting the game script to Ocarina of Time. Don't set the IP address. Hit Create Room and tell the people joining the Room Name (= your name), password, and port. ''(It is not recommended to use your own personal password here, as it is shared with the group. Use something that will prevent random people from joining your room, but not something that will compromise your own security.)''

If you are Joining and the Host has set up the room: hit Refresh in the Bizhawk Co-op window and select the Host's Room from the dropdown bar. When you input your username, keep in mind the game will use this to display who got what item for everyone playing. It will max out at 8 characters, even if you input more. Fill in the password and port number the Host gave you and select the Ocarina of Time Game Script and hit Join Room.

You can also select a player number when both hosting and joining a room. This is non-mandatory, and player numbers will be automatically selected if non are entered. This also does not need to match the world number chosen when patching your ROM file. If you do select a player number, and that number is already filled in that room, you will be unable to join.

=== Play Some Multiworld! ===

Go and have fun with new or old friends! If you are part of the {{discord}}, you can assign the Multiworld role to yourself by going to the {{discord|role-assignment}} channel and clicking the 3 emote - this will allow you to receive pings in the server where there are announcements from the Devs or folks are looking for players. You can also visit {{discord|multiworld-planning}} to look for additional players. It is ''highly'' recommended that you use one of the [[Trackers]] so that you don't accidentally leave those new friends out to dry if you miss a check. Map Trackers such as 2deep4real's Web Tracker or Hamsda's Map and Item Tracker package for EmoTracker are highly recommended.

== Troubleshooting ==

=== Installation Issues (Applies to both the Recommended and Alternate Methods) ===

==== Anti-Virus ====

Another issue that can occur while running the Powershell script is your anti-virus deleting the files it downloads. The BizHawk Prerequisites often gets marked as suspicious due to it being an installer that runs more installers. We can't give a detailed guide on how to exclude a folder in every anti-virus software, but search Google with a query like <code>Exclude Folder <your_anti-virus_name></code> and you should find a guide on their official site explaining how to do so. Exclude the folder that has the Powershell script in it and now you should be able to run it without the downloaded files getting deleted.

=== Common Error Messages ===
These are the most common errors that pop up that have known solutions. If none of these solve the problem, try rebooting your computer again afterwards to ensure any new configurations are fully loaded.

==== NullHawk Does Not Implement Memory Domains ====
You must load the ROM before activating the Lua scripts.

If doing so does not fix the issue, open the Lua Console and look at <code>Settings -> Autoload</code>. This setting should be '''disabled'''. Save the settings and completely close out of Bizhawk. Reopen, load the rom, and only after the rom is loaded open the Lua Console.

==== Error 401 ====
This generally means that either the password entered was incorrect, or that the room name already exists. Also, avoid special characters like spaces in the room name. We recommend using letters (no accents) and numbers only.

==== This ROM is not compatible with this version of the co-op script. ====
[https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip Update your scripts].

==== Unable To Find Domain: CARTROM ====
You are using the A Link to the Past LUA script. Choose Ocarina of Time in the dropdown instead.

==== Dynamic Libraries Not Enabled ====
You did not set the Lua Core setting properly. Remember to restart Bizhawk after changing it.

==== Unprotected Error in Call to LUA API ====
This is a general error that pops up randomly. You need to ensure all copies of Bizhawk are closed properly. The easiest way to ensure this is by rebooting your computer.

If you consistently get it when trying to start up the script, make sure the script is located in the Bizhawk root folder. This error will come up if you run the script from any other folder.

==== Connection Failed: Timeout ====
There are several reasons this can happen, all of them being various methods of misconfiguration.

First, the host must have the [[Multiworld#Rooms|port being used forwarded]] if not using Hamachi. Your private IP address that you forward the port to can change for various reasons. Always ensure that the router is pointing to the right computer with the port forwarding options. The host must also not have pings blocked in their router settings. This setting can be found under many names depending on the router.

Everyone playing must have the Bizhawk emulator allowed through their firewall.

The above [[Multiworld#Configuring Bizhawk for Multiworld|Bizhawk configuration options]] are not optional. If you do not configure the emulator properly you will be unable to stay connected to each other.

==== Invalid Arguments to Method Call ====
You'll get this error if files are in the wrong place. This can happen if you move any of the files manually, or if the Powershell script exits early.

The easiest way to fix this is to remove the Bizhawk folder and re-run the Powershell script. If your bizhawk-co-op.lua file is in the Lua folder, you can try moving it to the root folder where EmuHawk.exe is instead and see if that works too.

==== Attempt to concatenate local 'err' ====
This error occurs when some part that was downloaded was corrupt. The easiest way to fix this is to delete the Bizhawk folder the Powershell script downloaded and run it again.

=== Miscellaneous Issues ===

==== A Specific Item Failed to Transfer ====

Items can be retrieved by having the receiving player enter a line of code into the Lua console, though it is best to avoid this situation entirely if possible. This frequently occurs if a player continues while one or more other players are disconnected from the room. To prevent this, always ensure everyone is connected before collecting any item.

Go to [https://pidgezero.one/zootr/mwlua.html this website] (made by pidgezero_one) and select option 2. Locate the code for the missing item and follow the instructions there to retrieve the item. If the layout looks wrong, press ctrl+F5 to fix it.

==== Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen! ====

First of all, '''DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save files follow these instructions.

# In your Bizhawk folder navigate to <code>\N64\SaveRAM</code>.
# Identify the <code>SaveRAM</code> and <code>AutoSaveRAM</code> files corresponding to your seed. Sorting by date may help. Note that the <code>AutoSaveRAM</code> files will only exist if you've [[Multiworld#Bizhawk Settings|enabled that]] beforehand.
# Optional: manually make a backup of these files somewhere on your pc.
# Delete the <code>SaveRAM</code> file and rename <code>AutoSaveRAM</code> to take the place of the <code>SaveRAM</code> file you've just deleted.
# Now you can safely load your seed again and continue playing.

==== A Player Forfeits without Finishing ====

If a player forfeits their world, the game can continue without them by entering code lines into the Lua console to retrieve the lost items for the remaining players. Upload the multiworld spoiler log on [https://pidgezero.one/zootr/mwlua.html this site] (made by pidgezero_one) and follow the instructions there. If the layout looks wrong, press ctrl+F5 to fix it.

==== LUA Console Window Too Small ====

If your window for the LUA connection console is too small and the elements are overlapping, you need to change your DPI settings. Right click EmuHawk -> Properties -> Compatability -> High DPI scaling override, change to "System (Enhanced)".

[[File:DPISettings.png|326x407px|EmuHawk High DPI Settings]]

=== I can't see the other players in my game ===

This is not possible with multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

== Multiworld Without Port-Forwarding or Bizhawk ==

=== Hamachi ===

If nobody in your multiworld group can port-forward for whatever reason, and you cannot get someone who can to join, then there is a program you can use: Hamachi. Let me preface this by saying that Hamachi basically 'tricks' your computers to believe that you are all connected via LAN.

To start, download Hamchi [[https://www.vpn.net/ here]] and install it. Create an account, and go to System > Preferences > Settings to make sure that 'Encryption' is enabled. Then, click on the power button to go online.

==== Hosting ====
If you're hosting, then click Network > Create a new network. Give it a unique name and password, making sure that nobody other than the people you're playing with find out this information. After this, you'll see it pop onscreen:

[[File:Guide.JPG|RTENOTITLE]]

To join an existing network, click Network > Join an existing network. Type in your friend's network ID and the network's password.

Once you're all connected in the network, you can start the multiworld.

Right click on the address above your nickname, and click 'Copy IPv4 address' and share it with the people joining you:

[[File:Guide2.JPG|RTENOTITLE]]

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)', Set your Username and Password as usual, and the game script to Ocarina of Time.

==== Joining ====

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)' and paste the IPv4 the host gave you into the 'Host IP' bar. Set your Username and Password as usual, and the game script to Ocarina of Time.

Now you should be ready to start. As usual, if you have any more problems, seek advice within the {{discord}}.

==== Security Awareness ====
'''Be careful with who you give permission to join your network to.''' Using Hamachi is like letting everyone using it with you use a computer on the same network as yours.

==== Hamachi Request Timed Out ====
[https://help.logmein.com/articles/en_US/FAQ/Resolving-Hamachi-Request-Timed-Out Follow these steps to ensure Hamachi is allowed through your firewall]. Both the Host and the clients connecting to the host should do this.

=== Playing over LAN ===

If you're playing over a LAN network, then all you need to do is set the 'room' to (Custom IP), type the LAN's Ipv4 into the 'host IP' field, and give yourself a username. Leave the password field blank.

=== Play Without Bizhawk ===

While Bizhawk is the officially supported emulator for multiworld, it is known to be a resource-intensive emulator in addition to being Windows only.

If port forwarding/using Hamachi is impossible for any reason, try [https://midos.house/mw Mido's House Multiworld]. It is compatible with Bizhawk and Project64 and can have players on different emulators at the same time. This method for multiworld was created by Fenhl and is the newest way to play multiworld. Issues with this can be brought up in the #setup-support channel of the OoTR discord, but it's unlikely anyone except Fenhl will be able to provide meaningful assistance so do not expect quick replies.

If using Bizhawk is impossible for any reason, try the emulator ModLoader64 (Windows and Linux compatible), as DemoXin has modified the multiworld script to work with it. This method does not require a host. Modloader64 is also the only way to play Ocarina of Time Online, which allows players to see each other in the world, and also supports other various features. As we do not officially support this emulator or any of their paks, we kindly refer you to [https://discord.gg/mWDztG their Discord] for all issues and support.

==== Feature comparison ====

{| class="wikitable"
|-
! Feature
! [https://github.com/TestRunnerSRL/bizhawk-co-op bizhawk-co-op]
! [https://midos.house/mw Mido's House Multiworld]
|-
| [[EverDrive]] support
|
| ✓ (experimental, requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's randomizer branch])
|-
| [[Project64]] support
|
| ✓
|-
| [[Bizhawk|BizHawk]] support
| 2.3–2.8 (no support for newer versions)
| 2.10 only (no support for older versions)
|-
| no port forwarding or Hamachi required
|
| ✓
|-
| can be used via LAN without an internet connection
| ✓
| [https://github.com/midoshouse/ootr-multiworld/issues/3 planned]
|-
| async support: players don't need to be connected at the same time
|
| ✓
|-
| easier setup: player name and world number are read from the game
|
| ✓
|-
| prevents players from accidentally using the same world number
|
| ✓
|-
| support for some other games
| ✓
|
|-
| automatically updates itself
|
| ✓
|-
| send all remaining items from a world using a spoiler log
| using [https://pidgezero.one/zootr/mwlua.html an external service]
| built in
|-
| choose individual items to give to a player
| using [https://pidgezero.one/zootr/mwlua.html an external service]
|
|-
| rooms are automatically deleted after a period of inactivity
|
| ✓ (defaults to 7 days, configurable)
|}

Branch identifiers

2024-12-18T09:00:35Z

Fenhl: added enemizer branch

This is a list of known '''branch identifiers''', i.e. values of [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/version.py#L8 the variable <code>branch_identifier</code> in version.py].

{| class="wikitable"
|-
! ID
! Branch
|-
| <code>0x00</code>
| main releases
|-
| <code>0x01</code>
| [https://github.com/OoTRandomizer/OoT-Randomizer Dev (OoTRandomizer)]
|-
| <code>0x43</code>
| [https://github.com/Cuphat/OoT-Randomizer/tree/Dev-C Dev-C (Cuphat)]
|-
| <code>0x45</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/Dev-Rob Dev-Rob (rrealmuto)]
|-
| <code>0x46</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/enemy_shuffle enemy_shuffle (rrealmuto)]
|-
| <code>0x52</code>
| [https://github.com/Roman971/OoT-Randomizer Dev-R (Roman971)]
|-
| <code>0x57</code>
| reserved by [https://github.com/cjohnson57/OoT-Randomizer cjohnson57]
|-
| <code>0x69</code>
| [https://github.com/Elagatua/OoT-Randomizer blitz (Elagatua)]
|-
| <code>0x99</code>
| [https://github.com/mracsys/OoT-Randomizer Dev-M (mracsys)]
|-
| <code>0x9c</code>
| [https://github.com/trezc0/OoT-Randomizer trez-test]
|-
| <code>0xfe</code>
| [https://github.com/fenhl/OoT-Randomizer dev-fenhl]
|-
| <code>0xff</code>
| reserved for private use
|}

Dev team calls

2024-12-17T01:01:46Z

Fenhl: Created page with "Since December of 2024, the dev team has been holding a Discord call every 2 weeks to make decisions on whether to approve new features and to talk about a variety of other topics related to OoTR development. This article is an archive of summaries of each call, ordered reverse-chronologically. The next call will be held on January 6, 2025 at 21:00 UTC. == December 16, 2024 == Participants: Fenhl, Kirox, TestRunner, TreZ, Zannick # legal implications of using decomp..."

File:Magic meter scroll sketch.png

2024-12-17T00:38:51Z

Fenhl:

Multiworld

2024-11-20T09:46:11Z

Fenhl: updated for MH MW EverDrive support

The aim of this page is to help the reader set up '''Multiworld'''. Multiworld is a co-op mod for the OoT Randomizer. Players have their own inventory and their own world. Also, player-specific items are mixed between the worlds. For example, if you obtain an item in your world, it could either stay with you or get sent to another player. Everyone participating will be playing different intermingled seeds.

As an example, there could be a scenario where Player 1 can only advance in their own world based on something Player 2 does. Once Player 2 finds the Megaton Hammer belonging to Player 1, Player 1 will automatically receive it. Every world is linked together.

In order to link everyone's worlds together, players will need a plugin like ''bizhawk-co-op'' or [[Mido's House Multiworld]]. For Mido's House Multiworld, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For setting up bizhawk-co-op, see the [[Multiworld#Installing Multiworld and Bizhawk|Installing Multiworld and Bizhawk]] section below. If you're not sure which plugin to use, see the [[Multiworld#Feature comparison|Feature comparison]] section.

These plugins are currently only compatible with [[Project64]] (Mido's House Multiworld only) and [[Bizhawk]] (both plugins). Mido's House Multiworld also has experimental support for [[EverDrive]], which currently requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. However, the ModLoader64 devs have made their own plugin which is compatible with their emulator and the OoT Online pak, allowing players to see each other's character in the game. (Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

This section applies regardless of which plugin you use, but if you're using ModLoader64, please note that it is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer] and not with newer releases or Dev builds of OoTR.

=== Using the Webpatcher ===

Start off by going to the [https://ootrandomizer.com/generator Webpatcher] and set up the settings you want for the seed. On the <code>Rom Options</code> tab change the <code>Player Count</code> to however many people will be playing. Once you're done, generate the seed.

[[File:mwromgen.png|560x315px]]

After you have generated the seed, share the URL with your partners and have everyone choose a different <code>Player ID</code>. Then continue patching the rom as you would normally (don't forget cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgen2.png|560x315px]]

=== Using the Offline Version ===

Generating a ROM using an offline build works a little differently. After choosing the settings you wish to play with, go to the <code>ROM Options</code> tab and set <code>Generate New Seed</code> (<code>Generate From Seed</code> in previous versions). Choose <code>Patch File</code> as your <code>Output Type</code> and change the <code>Player Count</code> to however many people will be playing. Then hit <code>Generate!</code>.

[[File:mwromgendev1.png|560x315px]]

Send the patch file (.zpfz) to your partners and have them set <code>Generate From File</code>. The <code>Output Type</code> should be <code>Compressed [Stable]</code> now, and everyone should choose a different <code>Player ID</code>. Select the patch file and hit <code>Generate!</code> (don't forget to set cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgendev3.png|560x315px]]

Note: if your partners don't have the offline build they can also patch the rom using the website. Make sure to set <code>Generate From File</code> and select your patch file (.zpfz).

There are several reasons why someone might want to generate a ROM using an offline build. For example, some builds might have features that are not available on the website build (yet), like [https://github.com/Roman971/OoT-Randomizer additional Entrance Randomizer settings]. Generating from an offline build also lets you play with your own custom patches.

== Installing Multiworld and Bizhawk ==

This section and the sections below apply only to the bizhawk-co-op plugin. For Mido's House Multiworld, please download and run the installer from [https://midos.house/mw its website]. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== The Recommended Method ===

Press '''Windows+R''' to open the '''Run''' dialog box, and then type "'''powershell'''" in the text box. Once you have your PowerShell window open, copy-paste this in:

'''<pre>cd $env:userprofile\downloads;
Set-ExecutionPolicy Bypass -Scope Process -Force;
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/TestRunnerSRL/bizhawk-co-op/master/bizhawk-co-op.ps1'))</pre>'''

From here, the PowerShell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install in your downloads folder and place everything for you. Say '''yes''' when PowerShell prompts you to install the <code>bizhawk_prereqs.exe</code> file. Once PowerShell is done, you can move the Bizhawk 2.7 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>.

=== The Alternate Method ===

==== Download the Custom Bizhawk Installer ====

First, you must download the Multiworld script from [https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip TestRunner's GitHub page]. When you download this, extract its contents to ''its own folder'' - it will be creating a new Bizhawk install for you to use, so you must keep it separate. ''Note: Whenever there is an update to the Multiworld script, everybody playing must update to the latest version.''

==== Running the Custom Bizhawk Installer ====

Once you have the contents extracted to its own folder, locate the <code>bizhawk-co-op.ps1</code> file. Right Click and select Run with PowerShell.

[[File:MWG1.png|610x149px|Run with PowerShell]]

If Powershell prompts you for permissions, say yes to all. From here, the Powershell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.7 folder that was created. These files are no longer needed and only add confusion.''

==== Powershell Permissions ====

You may need to enable executing Powershell scripts without requiring the script to be digitally signed. Open Powershell from the Start Menu by right clicking it and selecting "Run as Admin". Click the "Yes" button to allow Powershell to run as Administrator. Type <code>Set-ExecutionPolicy Unrestricted</code> and press <code>Enter</code> once, type <code>Y</code> then press <code>Enter</code> again. The Powershell script should now run.

== Configuring Bizhawk for Multiworld ==

=== Bizhawk Settings ===

There are a few things you need to do once you've got the emulator running. The very first thing is go to <code>Config -> Customize</code> and navigate to the Advanced tab. At the bottom, there is an option for Lua Core; select <code>Lua+LuaInterface</code> and hit OK. While on the Advanced tab, you should also check the box for <code>AutoSaveRAM</code> and set it to a reasonable time, such as 60-180 seconds (keep in mind that setting this too low could increase lag and decrease overall emulator performance). This will allow Bizhawk to write your in-game save to your drive. This is '''NOT''' a form of save state - it simply periodically creates/updates a file on your hard drive with your in-game save data, and is wonderful for mitigating the effects of crashes. '''In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save file follow the instructions over [[Multiworld#Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen!|here]].

[[File:bizhawkautosave.png|420x487px|Advanced Customization]]

In the General tab of the Customize menu, tick the boxes for "Accept background input" and "Run in background" – this will allow Bizhawk to keep accepting controller inputs when you tab over to your tracker or notes and prevent the emulation from pausing (which will disconnect you). Clear your hotkeys by going to Config -> Hotkeys, and at the bottom click Misc and Clear All.

=== Controller Settings ===

The next step is to set your controller up. Your controller configuration will vary based on what controller you are using; for Bizhawk to enable the Controller menu, you must have a ROM loaded. For a smooth controller experience, you must unbind the first 4 binds in Config -> Controller such that it looks like this:

[[File:MWG3.png|320x207px|Normal Controls]]

You'll then have to bind your analog stick in the Analog tab of your controller config and adjust your sensitivity and deadzones to your preference. ''Additional info on controller setup can be found in Step 6 of the [[Bizhawk|Bizhawk Guide]].''

=== Video Settings ===

You can fix how your game looks by going to Config -> Cores -> N64 Video Plugin Settings. In here, change your resolution so that it runs smooth. Multiworld will drop your performance, so keep that in mind. The recommended video plugin is GLideN64. ''(This is not the same plugin as Glide64!)''

== Starting the Multiworld Session ==

=== Opening the Lua Console ===

Once you have your emulator set up to run how you are comfortable with, its time to move to the Lua console. Go to Tools -> Lua Console, and a separate window will open up. ''This window must remain open at all times during a Multiworld.'' In the Lua Console, go to Settings and checkmark the Disable Scripts on loads.

[[File:MWG4.png|586x379px|Disable Scripts on Load]]

This is the last of the settings changes you have to do. If you want Bizhawk to retain these settings changes for the next time, go to Config -> Save Config. Once you have these steps done, '''you MUST close your emulator and reopen it for this change to take effect'''. Close out of Bizhawk, and then reopen it and the Lua Console. Sometimes this will not be enough and you will still get an error trying to load the Lua file. In that case reboot your entire computer.

'''If for some reason you do not have your Multiworld ROM open, you must do so now.'''

From here in the Lua Console, Open Script and locate the <code>bizhawk co-op.lua</code> file in the Bizhawk 2.7 folder. Once you have that done, a red square will appear in the console; double click it and a new window will open up.

[[File:MWG5 2.png|Bizhawk co-op]]

This window must ''also'' stay open at all times.

=== Rooms ===

The Lua Console Script is where you set up a room and join rooms.

If you are the Host: You must port forward. How you do this varies on what brand your router is. Instructions on how to do this can be found by Googling your brand/model of router. You'll want to use a port between 49152 and 65535. We highly recommend using the default port, 50000. You'll also want to ensure you're forwarding the TCP protocol as that is the protocol Multiworld uses. Most other games you have port forwarded in the past likely were using the UDP protocol.

Once that is done, in the Bizhawk Co-op window the Host must set their name, password, and the port that was forwarded, along with setting the game script to Ocarina of Time. Don't set the IP address. Hit Create Room and tell the people joining the Room Name (= your name), password, and port. ''(It is not recommended to use your own personal password here, as it is shared with the group. Use something that will prevent random people from joining your room, but not something that will compromise your own security.)''

If you are Joining and the Host has set up the room: hit Refresh in the Bizhawk Co-op window and select the Host's Room from the dropdown bar. When you input your username, keep in mind the game will use this to display who got what item for everyone playing. It will max out at 8 characters, even if you input more. Fill in the password and port number the Host gave you and select the Ocarina of Time Game Script and hit Join Room.

You can also select a player number when both hosting and joining a room. This is non-mandatory, and player numbers will be automatically selected if non are entered. This also does not need to match the world number chosen when patching your ROM file. If you do select a player number, and that number is already filled in that room, you will be unable to join.

=== Play Some Multiworld! ===

Go and have fun with new or old friends! If you are part of the {{discord}}, you can assign the Multiworld role to yourself by going to the {{discord|role-assignment}} channel and clicking the 3 emote - this will allow you to receive pings in the server where there are announcements from the Devs or folks are looking for players. You can also visit {{discord|multiworld-planning}} to look for additional players. It is ''highly'' recommended that you use one of the [[Trackers]] so that you don't accidentally leave those new friends out to dry if you miss a check. Map Trackers such as 2deep4real's Web Tracker or Hamsda's Map and Item Tracker package for EmoTracker are highly recommended.

== Troubleshooting ==

=== Installation Issues (Applies to both the Recommended and Alternate Methods) ===

==== Anti-Virus ====

Another issue that can occur while running the Powershell script is your anti-virus deleting the files it downloads. The BizHawk Prerequisites often gets marked as suspicious due to it being an installer that runs more installers. We can't give a detailed guide on how to exclude a folder in every anti-virus software, but search Google with a query like <code>Exclude Folder <your_anti-virus_name></code> and you should find a guide on their official site explaining how to do so. Exclude the folder that has the Powershell script in it and now you should be able to run it without the downloaded files getting deleted.

=== Common Error Messages ===
These are the most common errors that pop up that have known solutions. If none of these solve the problem, try rebooting your computer again afterwards to ensure any new configurations are fully loaded.

==== NullHawk Does Not Implement Memory Domains ====
You must load the ROM before activating the Lua scripts.

If doing so does not fix the issue, open the Lua Console and look at <code>Settings -> Autoload</code>. This setting should be '''disabled'''. Save the settings and completely close out of Bizhawk. Reopen, load the rom, and only after the rom is loaded open the Lua Console.

==== Error 401 ====
This generally means that either the password entered was incorrect, or that the room name already exists. Also, avoid special characters like spaces in the room name. We recommend using letters (no accents) and numbers only.

==== This ROM is not compatible with this version of the co-op script. ====
[https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip Update your scripts].

==== Unable To Find Domain: CARTROM ====
You are using the A Link to the Past LUA script. Choose Ocarina of Time in the dropdown instead.

==== Dynamic Libraries Not Enabled ====
You did not set the Lua Core setting properly. Remember to restart Bizhawk after changing it.

==== Unprotected Error in Call to LUA API ====
This is a general error that pops up randomly. You need to ensure all copies of Bizhawk are closed properly. The easiest way to ensure this is by rebooting your computer.

If you consistently get it when trying to start up the script, make sure the script is located in the Bizhawk root folder. This error will come up if you run the script from any other folder.

==== Connection Failed: Timeout ====
There are several reasons this can happen, all of them being various methods of misconfiguration.

First, the host must have the [[Multiworld#Rooms|port being used forwarded]] if not using Hamachi. Your private IP address that you forward the port to can change for various reasons. Always ensure that the router is pointing to the right computer with the port forwarding options. The host must also not have pings blocked in their router settings. This setting can be found under many names depending on the router.

Everyone playing must have the Bizhawk emulator allowed through their firewall.

The above [[Multiworld#Configuring Bizhawk for Multiworld|Bizhawk configuration options]] are not optional. If you do not configure the emulator properly you will be unable to stay connected to each other.

==== Invalid Arguments to Method Call ====
You'll get this error if files are in the wrong place. This can happen if you move any of the files manually, or if the Powershell script exits early.

The easiest way to fix this is to remove the Bizhawk folder and re-run the Powershell script. If your bizhawk-co-op.lua file is in the Lua folder, you can try moving it to the root folder where EmuHawk.exe is instead and see if that works too.

==== Attempt to concatenate local 'err' ====
This error occurs when some part that was downloaded was corrupt. The easiest way to fix this is to delete the Bizhawk folder the Powershell script downloaded and run it again.

=== Miscellaneous Issues ===

==== A Specific Item Failed to Transfer ====

Items can be retrieved by having the receiving player enter a line of code into the Lua console, though it is best to avoid this situation entirely if possible. This frequently occurs if a player continues while one or more other players are disconnected from the room. To prevent this, always ensure everyone is connected before collecting any item.

Go to [https://pidgezero.one/zootr/mwlua.html this website] (made by pidgezero_one) and select option 2. Locate the code for the missing item and follow the instructions there to retrieve the item. If the layout looks wrong, press ctrl+F5 to fix it.

==== Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen! ====

First of all, '''DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save files follow these instructions.

# In your Bizhawk folder navigate to <code>\N64\SaveRAM</code>.
# Identify the <code>SaveRAM</code> and <code>AutoSaveRAM</code> files corresponding to your seed. Sorting by date may help. Note that the <code>AutoSaveRAM</code> files will only exist if you've [[Multiworld#Bizhawk Settings|enabled that]] beforehand.
# Optional: manually make a backup of these files somewhere on your pc.
# Delete the <code>SaveRAM</code> file and rename <code>AutoSaveRAM</code> to take the place of the <code>SaveRAM</code> file you've just deleted.
# Now you can safely load your seed again and continue playing.

==== A Player Forfeits without Finishing ====

If a player forfeits their world, the game can continue without them by entering code lines into the Lua console to retrieve the lost items for the remaining players. Upload the multiworld spoiler log on [https://pidgezero.one/zootr/mwlua.html this site] (made by pidgezero_one) and follow the instructions there. If the layout looks wrong, press ctrl+F5 to fix it.

==== LUA Console Window Too Small ====

If your window for the LUA connection console is too small and the elements are overlapping, you need to change your DPI settings. Right click EmuHawk -> Properties -> Compatability -> High DPI scaling override, change to "System (Enhanced)".

[[File:DPISettings.png|326x407px|EmuHawk High DPI Settings]]

=== I can't see the other players in my game ===

This is not possible with multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

== Multiworld Without Port-Forwarding or Bizhawk ==

=== Hamachi ===

If nobody in your multiworld group can port-forward for whatever reason, and you cannot get someone who can to join, then there is a program you can use: Hamachi. Let me preface this by saying that Hamachi basically 'tricks' your computers to believe that you are all connected via LAN.

To start, download Hamchi [[https://www.vpn.net/ here]] and install it. Create an account, and go to System > Preferences > Settings to make sure that 'Encryption' is enabled. Then, click on the power button to go online.

==== Hosting ====
If you're hosting, then click Network > Create a new network. Give it a unique name and password, making sure that nobody other than the people you're playing with find out this information. After this, you'll see it pop onscreen:

[[File:Guide.JPG|RTENOTITLE]]

To join an existing network, click Network > Join an existing network. Type in your friend's network ID and the network's password.

Once you're all connected in the network, you can start the multiworld.

Right click on the address above your nickname, and click 'Copy IPv4 address' and share it with the people joining you:

[[File:Guide2.JPG|RTENOTITLE]]

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)', Set your Username and Password as usual, and the game script to Ocarina of Time.

==== Joining ====

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)' and paste the IPv4 the host gave you into the 'Host IP' bar. Set your Username and Password as usual, and the game script to Ocarina of Time.

Now you should be ready to start. As usual, if you have any more problems, seek advice within the {{discord}}.

==== Security Awareness ====
'''Be careful with who you give permission to join your network to.''' Using Hamachi is like letting everyone using it with you use a computer on the same network as yours.

==== Hamachi Request Timed Out ====
[https://help.logmein.com/articles/en_US/FAQ/Resolving-Hamachi-Request-Timed-Out Follow these steps to ensure Hamachi is allowed through your firewall]. Both the Host and the clients connecting to the host should do this.

=== Playing over LAN ===

If you're playing over a LAN network, then all you need to do is set the 'room' to (Custom IP), type the LAN's Ipv4 into the 'host IP' field, and give yourself a username. Leave the password field blank.

=== Play Without Bizhawk ===

While Bizhawk is the officially supported emulator for multiworld, it is known to be a resource-intensive emulator in addition to being Windows only.

If port forwarding/using Hamachi is impossible for any reason, try [https://midos.house/mw Mido's House Multiworld]. It is compatible with Bizhawk and Project64 and can have players on different emulators at the same time. This method for multiworld was created by Fenhl and is the newest way to play multiworld. Issues with this can be brought up in the #setup-support channel of the OoTR discord, but it's unlikely anyone except Fenhl will be able to provide meaningful assistance so do not expect quick replies.

If using Bizhawk is impossible for any reason, try the emulator ModLoader64 (Windows and Linux compatible), as DemoXin has modified the multiworld script to work with it. This method does not require a host. Modloader64 is also the only way to play Ocarina of Time Online, which allows players to see each other in the world, and also supports other various features. As we do not officially support this emulator or any of their paks, we kindly refer you to [https://discord.gg/mWDztG their Discord] for all issues and support.

==== Feature comparison ====

{| class="wikitable"
|-
! Feature
! [https://github.com/TestRunnerSRL/bizhawk-co-op bizhawk-co-op]
! [https://midos.house/mw Mido's House Multiworld]
|-
| [[EverDrive]] support
|
| ✓ (experimental, requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's randomizer branch])
|-
| [[Project64]] support
|
| ✓
|-
| [[Bizhawk|BizHawk]] support
| 2.3–2.8 (no support for the current version)
| 2.9.1 only (no support for older versions)
|-
| no port forwarding or Hamachi required
|
| ✓
|-
| can be used via LAN without an internet connection
| ✓
| [https://github.com/midoshouse/ootr-multiworld/issues/3 planned]
|-
| async support: players don't need to be connected at the same time
|
| ✓
|-
| easier setup: player name and world number are read from the game
|
| ✓
|-
| prevents players from accidentally using the same world number
|
| ✓
|-
| support for some other games
| ✓
|
|-
| automatically updates itself
|
| ✓
|-
| send all remaining items from a world using a spoiler log
| using [https://pidgezero.one/zootr/mwlua.html an external service]
| built in
|-
| choose individual items to give to a player
| using [https://pidgezero.one/zootr/mwlua.html an external service]
|
|-
| rooms are automatically deleted after a period of inactivity
|
| ✓ (defaults to 7 days, configurable)
|}

Mido's House Multiworld installer

2024-11-20T09:33:56Z

Fenhl: added link to macOS install instructions

This article documents the behavior of the installer for [[Mido's House Multiworld]]. It can be downloaded from [https://midos.house/mw the Mido's House Multiworld website].

The installer is only available for Windows and Linux. See [https://midos.house/mw/install/macos install instructions for macOS].

== Console/emulator selection ==

On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].

* For EverDrive, the installer will display a warning since EverDrive support is currently experimental and requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. Progress on stabilizing EverDrive support is tracked in [https://github.com/midoshouse/ootr-multiworld/issues/23 this Mido's House Multiworld issue] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2042 this randomizer issue].
* For emulators, the installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

On Linux, installing [[BizHawk]] requires root permissions. The installer will use [https://en.wikipedia.org/wiki/Zenity Zenity] to prompt for your password in order to use [https://en.wikipedia.org/wiki/APT_(software) APT] to install [https://en.wikipedia.org/wiki/Mono_(software) Mono]. If Zenity and/or APT are not available, the installer will skip this step and you should install Mono manually.

== Emulator location ==

This step is skipped for EverDrive.

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for EverDrive and Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''DO NOT close or click OK on the error message!''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

This step is completely automated for Project64. It is skipped for EverDrive.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session (though the multiworld app will have a button to launch Project64).

On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

On Windows, there is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

== Summary ==

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''EverDrive:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the multiworld app and the emulator (if any) right now.

Mido's House Multiworld installer

2024-11-11T01:08:41Z

Fenhl: /* Multiworld location */ updated for emulator launch button feature

This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.

== Console/emulator selection ==

On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].

* For EverDrive, the installer will display a warning since EverDrive support is currently experimental and requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. Progress on stabilizing EverDrive support is tracked in [https://github.com/midoshouse/ootr-multiworld/issues/23 this Mido's House Multiworld issue] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2042 this randomizer issue].
* For emulators, the installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

On Linux, installing [[BizHawk]] requires root permissions. The installer will use [https://en.wikipedia.org/wiki/Zenity Zenity] to prompt for your password in order to use [https://en.wikipedia.org/wiki/APT_(software) APT] to install [https://en.wikipedia.org/wiki/Mono_(software) Mono]. If Zenity and/or APT are not available, the installer will skip this step and you should install Mono manually.

== Emulator location ==

This step is skipped for EverDrive.

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for EverDrive and Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''DO NOT close or click OK on the error message!''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

This step is completely automated for Project64. It is skipped for EverDrive.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session (though the multiworld app will have a button to launch Project64).

On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

On Windows, there is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

== Summary ==

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''EverDrive:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the multiworld app and the emulator (if any) right now.

Trackers

2024-07-07T04:00:20Z

Fenhl: /* TOoTR ER Tracker */ updated link

Going through and finishing an OoTR seed can be quite a challenge. There is a long list of settings that can be used to mess with item locations, available places and logic. To keep close tabs on your progress and your remaining options, using a tracker program can be of great use. '''Item Trackers''' help keep track of which items you have found in your playthrough so far. '''Map Trackers''' include a map portion that shows which item locations are available to you. '''Entrance Trackers''' help you keep track of all the shuffled entrances when playing Entrance Randomizer. For beginners we strongly recommend the use of a ''Map Tracker''. Feel free to browse through the different solutions provided by some of our community members.

{{race rule|rule=You may not use auto-trackers or logic trackers during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

If you would like to see a Tracker added to the list, please submit a request in the {{discord|dev-item-tracker}} channel on the {{discord}}.

{{TOClimit|1}}

= Web Trackers =



=== '''Ben Plays Potsanity Checklist''' ===

[https://docs.google.com/spreadsheets/d/1FvCg4i6_atfeNG_1k-RuJBWEaAYFAvS0JDrH5OAEbgc/edit?usp=sharing Link]

'''Tracker type''': Checklist '''Browser Support''': All (Google Sheet) '''Features''':

*Checklist compatible with potsanity

*Vanilla and MQ compatible.

*You will need to make a copy to use it.

[[File:Benplays_checklist.png|800x450px|Benplays_checklist.png]]

=== '''bfrie's ER Tracker''' ===

[https://docs.google.com/spreadsheets/d/13tn7SoDV4KXWwoazQjiEmU1bkWV4MxlWlkIv1G8ggug/edit?usp=sharing Link]

'''Tracker type''': Entrance Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*A simple, color-coded spreadsheet that can be used locally.

[[File:Bfrie.png|800x450px|Bfrie.png]]

=== '''brakkum's ER Tracker''' ===

[https://tracker.brakke.dev/ Link]

'''Tracker type''': Entrance Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*Simple interface for inputting entrances.

*Built-in routing: just input your current location and your destination and it will show you a path.

*Presets of vanilla entrances for when not every ER setting is turned on.

[[File:Brakkum.png|800x450px|Brakkum.png]]

=== '''Hashfrog Tracker''' ===

[https://hashfrog-tracker.com/ Link]

'''Tracker type''': Item + Hints + Checklist (with logic) '''Browser Support (confirmed)''': Microsoft Edge '''Features''':

*A web-based [https://wiki.ootrandomizer.com/index.php?title=Trackers#Gossip_Stones_Item_Tracker Gossip Stone-like tracker].

*Check/Location tracking based on the randomizer generator logic.

*Supports the settings of various tournament/competitive presets

*Layout automatically made based on your selected preset.

*Layout customization, UI editor, custom elements/icons and more.

*Store and share layout configuration in JSON files.

[[File:hashfrog2.png|300x169px|hashfrog2.png]][[File:hashfrog.png|300x350px|hashfrog.png]]

=== '''MisoSoup's Spoilizer Checklist''' ===

[https://spoilizer.com/ Link]

'''Tracker type''': Checklist '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*Creates a checklist from your spoiler log.

*Marking checks as completed shows the item they had.

*Option to show all spoilers.

*Option to share a link to your spoiler log checklist. Useful for support. ;)

*Auto-saves your progress.

[[File:Spoilizer.png|695x380px|Spoilizer.png]][[File:Spoilizer2.png|800x450px|Spoilizer2.png]]

=== '''Soli's Circus Tracker''' ===

[https://soilflux.github.io/tracker/ Link]

'''Tracker type''': Item/Checklist Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*An item tracker.

*Shows available checks in list format.

*Space for writing down hints.

*Key counts.

*Shows how many checks remain.

*Shows required/useful items for clearing adult dungeons.

*Click the small <code>halp</code> button in the column next to the patch notes for more info.

*Note that in its current state, this tracker '''is''' race-legal.

[[File:soli1.png|544x306px|soli1.png]][[File:soli2.png|544x306px|soli2.png]]

=== '''TOoTR ER Tracker''' ===

[https://tootr.mracsys.com/ Link]

'''Tracker type''': Entrance/Location Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome, iOS '''Features''':

*Configurable Entrance Randomizer options from full ER to individual settings

*Interior locations listed under their corresponding shuffled entrance

*Vanilla/MQ dungeon checklists

*Supports Dev-R branch-exclusive mixed entrance pools and decoupled entrances

*Auto-saves your progress.

[[File:Mracsysoverworld.png|560x315px|mracsysoverworld.png]][[File:Tootrdungeons.png|560x315px|tootrdungeons.png]]

=== '''Track-OoT Tracker''' ===

[https://track-oot.net/ Link] || [https://dev.track-oot.net/ beta / in-development version] || [https://discord.com/invite/wgFVtuv Discord]

'''Tracker type''': Map Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*Colored squares/circles indicating the '''logical''' availability of checks: green means all checks can be gotten with the current items, yellow means some but not all can be gotten, and red means no items can be gotten.

*All "sanity" settings are supported.

*Automatic configuration of the tracker is supported, simply import a Spoiler Log via the Extras menu. You can choose what you want it to automatically configure (choose how much is spoiled):
**Settings
**Starting Items
**Entrances (Entrance Randomizer)
**Shop Contents
**Mark areas Barren/Way of the Hero
**Indicate required Ganon Trials
**Indicate which dungeons are Vanilla or Master Quest
**Reveal all item locations
**And more...

*Save and load your progress.
*A tab for taking notes (e.g. hints).
*Shop contents for Shopsanity.
*Songsanity configuration
*Way of the Hero & Barren indicators
*Network/Multiplayer mode, multiple people can manage the tracker.

[[File:2deep4real.png|544x306px|2deep4real.png]][[File:2deep4realshops.png|560x315px|2deep4realshops.png]][[File:2deep4realsettings1.png|560x315px|2deep4realsettings1.png]][[File:2deep4realsettings2.png|560x315px|2deep4realsettings2.png]][[File:2Deep4Real Spoiler Log Import UI.png|560x480px|2Deep4Real Spoiler Log Import UI.png]]

=== '''Vado's Checklist''' ===

[http://vadorando.com/ Link]

'''Tracker type''': Checklist '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*A simple checklist for keeping track of which checks you've gotten.

*Supports MQ, tokensanity and scrubsanity, but not cowsanity, bean shuffle or keysanity.

*Filter out checks you've done.

[[File:Vadorando1.png|800x450px|Vadorando1.png]][[File:Vadorando2.png|800x450px|Vadorando2.png]]

=== '''Xopar's Tracker''' ===

[https://ootr-random-settings-tracker.web.app/ Link]

'''Tracker type''': Item Tracker '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome '''Features''':

*A simple Item Tracker.

*An offline version of this tracker is available as an [https://wiki.ootrandomizer.com/index.php?title=Trackers#Xopar.27s_Package Emotracker package].

[[File:TrackerXoparWebTrackerDimmed.jpg|600x388px|TrackerXoparWebTrackerDimmed.jpg]] [[File:TrackerXoparWebTrackerLit.jpg|600x388px|TrackerXoparWebTrackerLit.jpg]]

= Downloadable Trackers =



=== '''Barinade's Item Tracker''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

[https://drive.google.com/open?id=1LePVZX1WfgsHmVhRWRDE14rwULJQXpws Link]

'''Tracker type''': Item Tracker  '''Emulator Support (confirmed)''': Project64, Bizhawk, Retroarch '''Features''':

*A simple Item Tracker.

*Supports auto-tracking on Project 64, Bizhawk and RetroArch.

*Customizable colors, item icons and more.

*Supports MMR.

[[File:Barinade.png|650x366px|Barinade.png]][[File:Barinade2.png|650x366px|Barinade2.png]]

=== '''Countdhoun's Map Tracker''' ===

[https://countdhoun.itch.io/countdhouns-item-tracker Link]

'''Tracker type''': Map Tracker  '''Features''':

*A Map Tracker without logic.

*Supports keysanity and random song notes.

*Save load up to 6 trackers.

*Customizable layout and background.

[[File:Countdhoun_Tracker.jpg|800×388px|Countdhoun_Tracker.jpg]]

=== '''Cuyler's Item Tracker''' ===

[https://goo.gl/nbmBqn Link]

'''Tracker type''': Item Tracker  '''Features''':

*A simple Item Tracker.

*Automatically adjusts the layout upon resizing of window.

[[File:Cuyler.png|560x315px|Cuyler.png]] 

=== '''Fenhl's Tracker''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

[https://github.com/fenhl/oottracker#readme Link] 

'''Tracker type''': Item Tracker '''Features''':

*Supports manual tracking on macOS 10.9+ and Windows systems
*Supports auto-tracking with Bizhawk 2.6+, Project64 3.0.0+, and RetroArch 1.8.5+
*Can connect to the networked trackers [https://oot-tracker.web.app/ https://oot-tracker.web.app/], [https://ootr-tracker.web.app/ https://ootr-tracker.web.app/] and [https://ootr-random-settings-tracker.web.app/ https://ootr-random-settings-tracker.web.app/]

[[File:Fenhl Tracker Mactintosh.png|276x367px]][[File:Fenhl Tracker - Windows.png|276x367px]]

=== '''Gossip Stones Item Tracker''' ===

[https://github.com/Draeko/ootr_gst/tree/ladder_version/Latest Link]

'''Tracker type''': Item Tracker  '''Features''':

*A simple Item Tracker with space for hints and a built-in timer.

*Customizable layout. The default layout suits standard weeklies, and a layout for the Scrub Tournament preset can be found in their own Discord. Read the readme for instructions on how to change layouts.

*Drag 'n Drop items/songs to mark song locations and hints.

*Supports both N64 and 3DS item icons.

[[File:Gossipstones.png|650x366px|Gossipstones.png]]

=== '''Gossip Stones Tracker HD''' ===

[https://github.com/HapaxL/GSTHD#readme Link]

'''Tracker type''': Item Tracker '''Features''':

All features from Drekorig's original Gossip Stones tracker, with many additional changes (see Readme for more details):

*Simple tracker features, including management of medallions and hints (including Goal Hints and Last WotH support)

*Drag & Drop elements (items/songs/medallions/bottles/etc.) onto "Gossip Stones" to mark song locations and hints, and drag them around from Gossip Stone to Gossip Stone

*Fully customizable layout with many features (dungeon names, default icon sets, colors, labels, textboxes, bulk-adding Gossip Stones, Majora's Mask icons...)

*Numerous control scheme features and options

*Menu bar for quick access to some settings

*Actively maintained, with many user-made layouts available online

[[File:TrackerHapaxGossipStonesTrackerHDV1.png|650x366px|TrackerHapaxGossipStonesTrackerHDV1.png]]

=== '''HoodTracker''' ===

[https://github.com/hoodedpaladin/HoodTracker#readme Link]

'''Tracker type''': Item/Location/Entrance Tracker '''Features''':

*Handles Entrance Shuffle
*Uses the Randomizer logic directly

[[File:TrackerHoodTrackerV1.png|641x499px|TrackerHoodTrackerV1.png]]

=== '''Ivan Item Tracker''' ===

[https://github.com/L-P/Ivan Link]

'''Tracker type''': Item Tracker  '''Features''':

*A simple Item Tracker with a timer and space for noting hints. The hints section uses the hint distribution of the weeklies.

*The tracker can be operated thru keyboard or mouse. Read the readme carefully to learn how to use it.

*Built-in input viewer.

[[File:Ivan.png|650x366px|Ivan.png]]

=== '''Lobsterzelda's Entrance Tracker''' ===

[https://github.com/Lobsterzelda/OOT_Randomizer_Entrance_Tracker#readme Link]

'''Tracker type''': Entrance Randomizer Tracker '''Features''':

*Users can set/view/delete connections between entrances
*Users can set warp song destinations
*Users can set Link's spawn point after save-warping as adult & child
*Users can set reminders
*Users can view the shortest path between two entrances (and can also exclude certain entrances from being included in this path)

[[File:TrackerLobsterTrackerV1.png|800x463px|TrackerLobsterTrackerV1.png]]



=== '''rattus128's Entrance Tracker''' ===

[https://github.com/rattus128/Rattrack/blob/0.1/README Link]

'''Tracker type''': Entrance Tracker  '''Features''':

*A graphical Entrance Tracker.

*Connect regions by drawing lines. Read the readme to learn how to use this tracker.

*Lots of screen space is strongly recommended.

[[File:Rattrack.png|800x450px|Rattrack.png]]

=== '''Riptide's Auto Tracker''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

[https://github.com/RiptideSage/OoT-CompletedChecks#readme Link]

'''Tracker type''': Location Tracker '''Features''':

*Supports auto-tracking with Bizhawk 2.3
*Every time you run this tracker, it gives you a list of locations you haven't checked (it doesn't run continously)

[[File:TrackerRiptideTrackerV1.png|310x599px|TrackerRiptideTrackerV1.png]]

=== '''Tracker of Time''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

[https://github.com/Selene-T/Tracker-of-Time/releases/ Link]

'''Tracker type''': Item/Location Tracker 
'''Features''':

*Supports auto-tracking with:
'''<pre>
x64:
BizHawk v2.7 and up
ModLoader v3.01
m64p July 13, 2021 and up
RetroArch 1.9.0 and up
RMG v0.1.3 and up
Ship of Harkinian v3.0.0 to v3.0.1

x86:
Project 64 v3.0.0 and up
m64py 0.2.5
</pre>'''
*Works with both Archipelago and OoTRandomizer games
*Displays item quantity, bottle contents, heart pieces, player's name, and more!
*Logic tracking!
*Mark what dungeons your stones or medallions are in
*Gold Skulltula, Scrub Shuffle, Cow Shuffle, and Shopsanity support!
*Multiple themes
*View what checks you are missing, have already found, and even force some to count as checked!

[[File:TrackerOfTimeV6.jpg|576x911px|TrackerOfTimeV6.jpg]]

=== '''Tyrus's Green Rupee Tracker''' ===

[https://goo.gl/YJxHan Link]

'''Tracker type''': Green Rupee Tracker  '''Features''':

*A Green Rupee Tracker.

*Doesn't support MQ.

*Crashes if you toggle it too many times.

[[File:Tyrus.png|560x315px|Tyrus.png]]

=== '''Zarby's & Numberplay's Item Tracker''' ===

[http://www.mediafire.com/file/1w5yi11ikmkkpne/HudZeldaOoT.zip/file Link]

'''Tracker type''': Item Tracker  '''Features''':

*A simple Item Tracker.

*Option to force it to always be the topmost window.

*Freely swap the item layout and change the background color.

*See stats of when items have been marked.

*Doubles as an Item Tracker for alttpr

[[File:Zarbynumberplay.png|650x366px|Zarbynumberplay.png]]

= '''LinSoraK's Item Tracker''' =

[https://discord.gg/n7AzcMpwXf Discord]

'''Tracker type''': Item Tracker  '''Features''':

*A simple Item Tracker.
*A beta version including keys can be found in LinSoraK's Discord server.
*Supports custom layouts. Additional layouts can be found in LinSoraK's Discord server.

[[File:Linso.png|560x315px|Linso.png]]

=== BusinessAlex's Layout ===
[https://drive.google.com/drive/folders/173G9T5Y4HYKECLeJMiBPlMugZvnZqqK-?usp=drive_link Link]

'''Tracker type''': Item Tracker '''Features''':

* A simple item tracker.
* Supports Trade Quest Shuffle, Ocarina Note Shuffle, Silver Rupee Shuffle, and Keysanity.
* Tracks completion of mini-dungeons.
* Layouts available for: OoTR, MMR & OoTMM.
* Alternate Downloads availabe in LinSoraK's Discord server.

[[File:BusinessAlex.jpg|425x425px|BusinessAlex.jpg]]

= EmoTracker = 

[https://emotracker.net/ EmoTracker] is a framework for item, map and entrance trackers for many different randomizers. There are several packages for OoTR, including elaborate map trackers.

[[File:Emotrackerpackages.png|800x450px|Emotrackerpackages.png]]

=== '''coavins' Package''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races.|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

'''Tracker type''': Item, Map and Entrance Trackers '''Features''':

*A fork of [https://wiki.ootrandomizer.com/index.php?title=Trackers#Hamsda.27s_Package Hamsda's Package] that added auto-tracker support.

*Shares all the other features of Hamsda's Package. The packages can be distinguished by the auto-tracker robot icon in the item tracker portion.

*The package and setup instructions can be found on [https://github.com/coavins/EmoTrackerPacks the github page].

[[File:coavins.png|800x450px|coavins.png]]

=== '''Fouton's PugHUD Package''' ===
{{race rule|rule=You may not use this tracker during a Racetime or SpeedRunsLive race except for some [[Dungeon Door Requirement|DDR]] races|This gives an unfair advantage to users able to use them since there are currently no auto trackers for console players and they are also contentious in general for randomizers}}

'''Tracker type''': Item Tracker '''Features''':

*A simple Item Tracker.

*Has an option to track the number of chests opened in each of the main dungeons.

[[File:Pughud.png|560x315px|Pughud.png]]

=== '''Hamsda's Package''' ===

'''Tracker type''': Item, Map and Entrance Trackers '''Features''':

*Contains Item, Map and Entrance Trackers.

*Supports all sanities and settings.

*Map trackers have colored squares indicating the logical availability of checks: green means all checks can be gotten with the current items, orange means some but not all can be gotten, blue means items can be peeked, and yellow means items can be gotten with logical tricks or glitches.

*Can mark off Gossip Stones that have been read.

*[https://github.com/Hamsda/OoTRMapTracker/blob/master/README.md Readme]

[[File:Hamsdapackages.png|300x169px|Hamsdapackages.png]] [[File:Hamsda1.png|800x450px|Hamsda1.png]]

=== '''JRJathome's Package''' ===

'''Tracker type''': Item Tracker '''Features''':

*A simple Item Tracker.

*Supports keysanity.

[[File:JRJathome.png|560x315px|JRJathome.png]]

=== '''Raikaru's & atz's Package''' ===

'''Tracker type''': Item Tracker '''Features''':

*A simple Item Tracker.

*Supports keysanity.

[[File:Raikaruatz.png|560x315px|Raikaruatz.png]]

=== '''Xopar's Package''' ===

'''Tracker type''': Item Tracker '''Features''':

*A simple Item Tracker.

*Supports keysanity.

*Not updated.

[[File:Xopar.png|600x388px|Xopar.png]]

=== '''Darkened5ky's & Spleebie's Package''' ===

'''NOTE: This package no longer includes map tracking.'''

'''Tracker type''': Item Tracker '''Features''':

[[File:Darkened5kyspleebie.png|800x450px|Darkened5kyspleebie.png]]

File:Mhmw-installer-SelectEmulator.png

2024-05-11T02:02:38Z

Fenhl:

Setup

2024-05-08T18:34:04Z

Fenhl: Undo revision 3297 by Flagrama (talk) Partial undo: lack of support for Python 3.8 turned out to be a bug specific to a fork

It is usually recommended to use the online generator on the website instead of the download or source code versions of the randomizer. The [[#Video Tutorial|video tutorial]] is also available as a walk through for the website. The [[Readme]] explains what the different options do. You can also check out the [[Changelog]] to see what changes have happened between randomizer versions. Recent [https://ootrandomizer.com/generatorDev Dev] and [https://ootrandomizer.com/generatorDev?version=devR_ Dev-R] versions are also available on the website.

Ocarina of Time Randomizer is compatible with emulators, Wii Virtual Console, and original Nintendo 64 hardware. Learn more about these options in the [[#Playing the Randomizer|Playing the Randomizer]] section.

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 [https://ootrandomizer.com/downloads standalone download] version of the randomizer, you should skip to [[#Install Python|installing Python]].''

''If you want to run the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master release source code] or [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev Dev source code] version of randomizer, you should skip to [[#Install Node.js|installing Node.js]].''

''We have compiled [https://wiki.ootrandomizer.com/index.php?title=Common_Softlocks_And_Crashes a list of known softlocks and crashes]. It is recommended to read it through to potentially save you from frustration later.''

{{TOClimit|3}}

== Online Generator ==

This section contains information similar to what is presented in the video by TreZc0, but does not go into as much detail regarding randomization options or emulator setup. The [[Readme]] and [[Setup#Emulators|emulator]] pages available to help with those details. The video is highly recommended, especially since it will provide visuals to aid in setup.

=== Video Tutorial ===
<youtube dimensions="480x270">https://www.youtube.com/watch?v=7X0Le98C5Yc</youtube>

Once you have viewed the video, generated a seed, and patched a randomizer ROM file, head to [[#Playing the Randomizer|Playing the Randomizer]].

=== Generating a Seed ===
The online randomizer does not require any downloads except for the final randomized rom, however you will be required to have one or more base files to create the randomized rom. Some of these are copyrighted files that you will need to have prior to receiving any help with setup in the {{discord|text=randomizer discord}}. Please read all rules of the discord and peruse the resources channel before requesting assistance there.
* '''Always Required'''
** OoT v1.0 NTSC-U/NTSC-J ROM - Copyrighted file
** A device with a multicore CPU & at least 2GB of available ram
*** Even most modern mobile devices (i.e. 2019 or newer) meet these requirements
** A modern browser (2020 or later): Chrome, Firefox, Edge, Safari, or Opera
** A method to play the game, which is covered later in the [[#Playing the Randomizer|Playing the Randomizer]] section.
* '''Only Required for WiiVC/vWii/Dolphin'''
** OoT v1.2 NTSC WAD - Copyrighted file
** Wii Common Key - Copyrighted file

Once prepared, go to https://ootrandomizer.com and click on the <samp><kbd>Play Now</kbd></samp> button for the latest stable version.
[[File:Setup-Website-PlayNow.jpeg|none|thumb|Click the <samp>Play Now</samp> button on the website to open the online generator.]]

Just below the "Ocarina of Time Item Randomizer v6.2" title is the button <samp><kbd>INSTRUCTIONS/HELP</kbd></samp> which effectively repeats the information available here and in the video at a quick glance.

Detailed explanations of the settings can be found on the [[Readme]] page and quick tooltips can be seen by hovering over any setting in the generator.

'''For a first seed, we recommend using either the Default/Beginner or Easy presets available on the "ROM Options" tab of the generator.''' The Default/Beginner preset is aimed at those familiar with vanilla who desire a similar progression. It uses base glitchless logic with no added tricks and no additional timesavers enabled (see the tab "Other" in the GUI). The world begins closed. Expect a long playthrough. The Easy Preset is aimed at those who have perhaps seen a few Randomizer runs previously and/or wish to dive right in. It uses base glitchless logic with no added tricks, but it does use additional timesavers (see the tab "Other" in the GUI). The world is more open after leaving Kokiri Forest.

Once a preset is selected from the dropdown, click <samp><kbd>LOAD</kbd></samp> and all settings shown in the generator, except Cosmetics and SFX, will change to match the preset. Feel free to look at the other tabs to see which settings are enabled by each preset before deciding which to use.

[[File:Presets.png|none|thumb|Presets location on the ROM Options tab of the generator.]]

If you're feeling a little more bold, settings may still be changed from those loaded by the preset to any you desire. '''However''', on the first tab of the randomizer, ROM Options, please never disable "'''Create Spoiler Log'''." The Spoiler Log is a file containing all the item locations, settings, and entrances when applicable of the randomized seed. Though you may never look at it, it is vital for those helping in the randomizer discord to be able to check this log if you require help at any point in the seed.

Once the settings are prepared, there are two options to generate the seed, <samp><kbd>GENERATE SEED!</kbd></samp> and <samp><kbd>GENERATE RACE SEED!</kbd></samp>. For most purposes, '''we highly recommend to only use the first option'''. Race seeds are encrypted and lock away the spoiler log even if it is generated. These locked logs will not be unlocked except for community races organized by the race mods.

Seed generation takes, on average, 15 seconds but may be longer depending on the current workload of the website. Now you will be on the seed page. The URL follows the naming convention of "https://ootrandomizer.com/seed/get?id=680574" where the 6 digit ID at the end is unique to your seed. This is particularly useful for sharing seeds with friends or sharing the spoiler log when asking for help. (Note that the seed ID at the end of the URL is also present in the default file name of randomized roms. We recommend not changing rom names to keep this piece of information always with the seed.)

Now it is time to direct the website to your base rom (OoT v1.0 NTSC-U/NTSC-J). The version is important, Rev A/B and MQ roms will not work. However, you can convert those ROMs to the proper one with the [https://oot.flagrama.com Ocarina of Time Downgrader and Converter]. For a normal N64 seed for use on everdrive or most emulators, leave the Output type toggle on <samp>.z64 (N64/Emulator)</samp> and browse to your rom file. For WiiVC/vWii/Dolphin, swap to <samp>WAD (WiiVC)</samp> and in addition to the Base Rom, also browse to your 1.2 WAD and Wii Common Key files. You can only patch a randomizer seed if you have the correct files given, so this is very important.

This page also offers the option to change the cosmetics and SFX from those generated with the seed. Please be aware that if you set your desired cosmetics and SFX previously, the option "Override Original Cosmetics" should be disabled before patching the rom as it is enabled by default.

[[File:Override_Cosmetics.PNG|none|thumb|Disable if cosmetics were previously set, enable if cosmetics are set on this page.]]

Once everything is set, simply click <samp>PATCH ROM!</samp> The patching process uses your device's CPU, so how long this takes is dependent on your hardware. Once the process is complete, a download will begin. Save this new rom file separately from the original rom, and now it's time to proceed to the [[#Playing the Randomizer|Playing the Randomizer]] section.

== Windows Setup ==
If you desire for any reason to use the offline randomizer program instead, you will need one or two other programs first. 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 [https://nodejs.org/en/ Node.js] to be installed. (Please skip this step for the executable version of the randomizer found on [https://ootrandomizer.com/downloads the website's download page].)

Open the [https://nodejs.org/en/ Node.js website] and click on the <samp><kbd>LTS</kbd></samp> button on their home page.1 Save the <samp>msi</samp> installer file then, locate it in your <samp>Downloads</samp> folder, or wherever you saved it. Launch the installer by double-clicking it. Click <samp><kbd>Next</kbd></samp> until you get to the <samp>Tools for Native Modules</samp> screen. Make sure the <samp>Automatically install the necessary tools. [...]</samp> checkbox is '''not''' checked.2 Click <samp><kbd>Next</kbd></samp> once you have made sure of this. Next click the <samp><kbd>Install</kbd></samp> button, then once that is completed, click the <samp><kbd>Finish</kbd></samp> button.

<gallery>
File:Setup-NodeJs-LTSButton.jpeg|1. Choose the <samp>LTS</samp> version which was <samp>12.16.2</samp> here, but may be different for you.
File:Setup-NodeJs-NativeModulesUnchecked.jpeg|2. Make sure the checkbox is unchecked before clicking <samp>Next</samp>.
</gallery>

=== Install Python ===
To run the randomizer on your computer you will need to install [https://www.python.org Python]. This is not needed when using the [https://ootrandomizer.com online generator] but in all other cases you '''must''' have Python installed. The randomizer requires at least <samp>Python 3.8.0</samp> installed, however we recommend installing the latest stable version of Python available when you install it.

Go to the [https://www.python.org Python website] and hover your mouse over the <samp>Downloads</samp> tab. A little dialog will appear and should have a <samp>Download for Windows</samp> section displayed. Click on the button labeled <samp>Python</samp> with a version number next to it.1 Save the <samp>exe</samp> installer file, then locate it in your <samp>Downloads</samp> folder, or wherever you saved it. Launch the installer by double-clicking it. Click <samp><kbd>Install Now</kbd></samp> on the installer.2

<gallery>
File:Setup-Python-DownloadPythonButton.jpeg|1. Click this button. In this case the latest version was <samp>3.8.2</samp> but the version displayed for you is the one you want.
File:Setup-Python-InstallNow.jpeg|2. Choose to <samp>Install Now</samp>.
</gallery>

== Downloading the Randomizer ==
Please ensure Node and/or Python are properly installed per the instructions above before downloading the randomizer. Once your computer is prepared, you can follow the instructions for the [[#Standalone Download|standalone download]] version or the [[#Source Code|source code and Dev]] version of the randomizer.

=== Standalone Download ===
Download the current standalone download version of the randomzier by going to the [https://ootrandomizer.com/downloads downloads page on the website] and select 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 [[#Install Python|Python 3.8 or higher]] installed for the standalone download randomizer to work''.

Once you have generated a randomizer ROM file, head to [[#Playing the Randomizer|playing the randomizer]].

==== Windows Troubleshooting ====
[[File:Setup-Standalone-WindowsSmartScreen.jpeg|none|thumb|Click <samp>More info</samp> then <samp>Run anyway</samp> to run the installer.]]

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 <samp><kbd>More info</kbd></samp> and then the <samp><kbd>Run anyway</kbd></samp> 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|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 [[#Install Node.js|Node.js LTS version]] and [[#Install Python|Python 3.8 or higher]] installed for the source code version of the randomizer to work''.

Head to the [https://ootrandomizer.com website] and in the navigation bar at the top, click on <samp><kbd>Resources</kbd></samp> and then choose the <samp><kbd>Dev Github</kbd></samp> option.1 Next click on the <samp><kbd>releases</kbd></samp> button to reach the page with all of the randomizer releases.2 Click on the <samp><kbd>zip</kbd></samp> 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|text=Discord server}} and ask which Dev version of the randomizer you should download''.

Locate the <samp>zip</samp> file you just downloaded in your <samp>Downloads</samp> folder, or wherever you saved it. <kbd>Right-click</kbd> the file and click <samp><kbd>Extract All...</kbd></samp> 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 <samp>Gui.py</samp> file inside and <kbd>Double-click</kbd> 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|playing the randomizer]].

<gallery>
File:Setup-SourceCode-GitHubLink.jpeg|1. Open the <samp>Dev Github</samp> link to open the GitHub page for the main fork of the randomizer.
File:Setup-SourceCode-GitHubReleases.jpeg|2. The <samp>releases</samp> button will display all of the different randomizer versions.
File:Setup-SourceCode-GitHubZip.jpeg|3. A <samp>zip</samp> button should appear on the top release that you can click on.
File:Setup-SourceCode-WindowsExtract.jpeg|4. On Windows, choose to <samp>Extract All...</samp> from the zip file.
File:Setup-SourceCode-Gui-py.jpeg|5. Run the <samp>Gui.py</samp> Python script.
File:Setup-SourceCode-InitialInstall.jpeg|6. Wait patiently as Node.js downloads the randomizer's dependencies.
</gallery>

==== Alternative Source Code Download Method ====
You can alternatively use [https://git-scm.com/ 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 [[#Source Code|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 available for free and have been extensively tested to work well with OoTR, assuming proper setup.

[https://wiki.ootrandomizer.com/index.php?title=Project64 Project64 v3.0+] (Windows) is the least resource-intensive emulator and the easiest to setup. However, it is important that versions 3.0+ are used since these are currently the only ones that provide a stable game experience. Furthermore, '''please keep in mind that using Project64 v2.x for racing is against our community's racing rules'''.

[[Bizhawk]] (Windows) is the most resource-intensive, but easier to setup than RetroArch. Bizhawk is also the only race-legal emulator to support [[Multiworld]] currently.

[[Retroarch]] (Windows, macOS, Linux, and more) isn't as resource-intensive as Bizhawk. However, setting up RetroArch can be a frustrating experience, and especially so for certain controllers.

[[Dolphin]] (Windows, macOS, and possibly Linux and Android) is capable of running OoTR through emulating Wii Virtual Console. As a result, it also has the Wii VC advantage of having less lag when opening the item menu. Other advantages include being lightweight and being easy to set up, especially with Gamecube controllers and either the official Nintendo or the Mayflash adapter. Downsides include random Wii VC crashes, having to inject the OoTR ROM into a WAD for every seed and additional lag in some areas (e.g. Market) due to shortcomings in how Wii VC is emulated.

=== Wii Virtual Console ===

The Ocarina of Time Randomizer can be played on a [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console Wii] (or [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Playing_On_The_Wii_U.27s_Virtual_Wii Wii U]). The advantages are fast load times, less lag and improved graphics compared to the other options available. Some also prefer the stick sensitivity and deadzone settings of the Wii VC over that of pc emulators. The downsides are random (but extremely rare) crashes, installing new seeds is a longer process than on pc emulators, and potentially additional costs if you don't already own a Wii and/or compatible controllers or if you wish to stream your gameplay.

=== EverDrive ===

The Ocarina of Time Randomizer can be played on a N64 by using the [https://wiki.ootrandomizer.com/index.php?title=Everdrive EverDrive]. Keep in mind that EverDrives are expensive and that the N64 is very laggy. The randomizer also requires the memory pak, even though base Ocarina of Time does not.

== 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|patch files]] page will explain what to do with them.

Main Page

2024-04-29T06:24:15Z

Fenhl: replaced external links to wiki articles with internal ones

[[File:Ocarina-of-time-randomizer-logo light-oot xl.png|400x400px|Logo_new.png]]

Welcome to the Ocarina of Time Randomizer Wiki!
Below you will find information the community has gathered to provide a knowledge database for all your OoTR needs.
Want to contribute? Message TreZc0_ on Discord!

<div class="boxWrapper">
<div class="frontBox leftBox">
<div style="padding:5px 10px">'''General OoTR Info'''</div>
[[Readme]] | [[Changelog|Release Notes]] 
[[Frequently Asked Questions]] 
[[Glossary]] 
 
[[Setup|Randomizer Setup]] 
[[Setup#Emulators|Emulator Setup]] 
[[Wii Virtual Console|Wii VC/vWii Setup]] 
[[Everdrive|N64/EverDrive Setup]] 
[[Controller Setup|Controller Setup]] 
[[Multiworld|Multiworld Setup]] 
 
[[Racing|Racing Setup]] 
[[Rules|Racing Rulesets]] 
[[Triforce Blitz]] 
 
[[Trackers|Item Trackers]] 
{{discord|text=Discord Server}}
</div>

<div class="frontBox rightBox">
<div style="padding:5px 10px">'''Miscellaneous'''</div>
[[Logic|Glitchless Logic Info]] 
[[Glitch Logic|Glitch Logic Info]] 
[[Entrance Randomizer|Entrance Randomizer Logic]] 
[[Hints]] 
 
[[Vanilla Dungeon Requirements]] 
[[Master Quest Dungeon Requirements]] 
 
[[Grottos|Grotto Locations]] 
[[Scrubs|Business Scrub Locations]] 
[[Cows|Cow Locations]] 
[[Bugs and fish|Bug & Fish Locations]] 
[[Freestanding Rupee and Heart Locations]] 
[[Pot and Crate Locations]]
[[Silver Rupees]] 
[[Wonderitem Locations]] 
[[Major Items]] 
[[Rupee Farming]] 
 
[[Plandomizer]] 
[[Common Softlocks And Crashes]]
</div>
</div>

Multiworld

2024-04-29T06:16:42Z

Fenhl: added link to Mido's House Multiworld article

The aim of this page is to help the reader set up '''Multiworld'''. Multiworld is a co-op mod for the OoT Randomizer. Players have their own inventory and their own world. Also, player-specific items are mixed between the worlds. For example, if you obtain an item in your world, it could either stay with you or get sent to another player. Everyone participating will be playing different intermingled seeds.

As an example, there could be a scenario where Player 1 can only advance in their own world based on something Player 2 does. Once Player 2 finds the Megaton Hammer belonging to Player 1, Player 1 will automatically receive it. Every world is linked together.

In order to link everyone's worlds together, players will need a plugin like ''bizhawk-co-op'' or [[Mido's House Multiworld]]. For Mido's House Multiworld, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For setting up bizhawk-co-op, see the [[Multiworld#Installing Multiworld and Bizhawk|Installing Multiworld and Bizhawk]] section below. If you're not sure which plugin to use, see the [[Multiworld#Feature comparison|Feature comparison]] section.

These plugins are currently only compatible with [[Project64]] (Mido's House Multiworld only) and [[Bizhawk]] (both plugins). However, the ModLoader64 devs have made their own plugin which is compatible with their emulator and the OoT Online pak, allowing players to see each other's character in the game. (Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

This section applies regardless of which plugin you use, but if you're using ModLoader64, please note that it is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer] and not with newer releases or Dev builds of OoTR.

=== Using the Webpatcher ===

Start off by going to the [https://ootrandomizer.com/generator Webpatcher] and set up the settings you want for the seed. On the <code>Rom Options</code> tab change the <code>Player Count</code> to however many people will be playing. Once you're done, generate the seed.

[[File:mwromgen.png|560x315px]]

After you have generated the seed, share the URL with your partners and have everyone choose a different <code>Player ID</code>. Then continue patching the rom as you would normally (don't forget cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgen2.png|560x315px]]

=== Using the Offline Version ===

Generating a ROM using an offline build works a little differently. After choosing the settings you wish to play with, go to the <code>ROM Options</code> tab and set <code>Generate New Seed</code> (<code>Generate From Seed</code> in previous versions). Choose <code>Patch File</code> as your <code>Output Type</code> and change the <code>Player Count</code> to however many people will be playing. Then hit <code>Generate!</code>.

[[File:mwromgendev1.png|560x315px]]

Send the patch file (.zpfz) to your partners and have them set <code>Generate From File</code>. The <code>Output Type</code> should be <code>Compressed [Stable]</code> now, and everyone should choose a different <code>Player ID</code>. Select the patch file and hit <code>Generate!</code> (don't forget to set cosmetics and sfx). Each player should have their own Randomizer ROM, with the formula <code>OoT_SeedID_SettingsHash_W0P0</code> with the W0 and P0 being world count and player ID respectively.

[[File:mwromgendev3.png|560x315px]]

Note: if your partners don't have the offline build they can also patch the rom using the website. Make sure to set <code>Generate From File</code> and select your patch file (.zpfz).

There are several reasons why someone might want to generate a ROM using an offline build. For example, some builds might have features that are not available on the website build (yet), like [https://github.com/Roman971/OoT-Randomizer additional Entrance Randomizer settings]. Generating from an offline build also lets you play with your own custom patches.

== Installing Multiworld and Bizhawk ==

This section and the sections below apply only to the bizhawk-co-op plugin. For Mido's House Multiworld, please download and run the installer from [https://midos.house/mw its website]. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== The Recommended Method ===

Press '''Windows+R''' to open the '''Run''' dialog box, and then type "'''powershell'''" in the text box. Once you have your PowerShell window open, copy-paste this in:

'''<pre>cd $env:userprofile\downloads;
Set-ExecutionPolicy Bypass -Scope Process -Force;
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/TestRunnerSRL/bizhawk-co-op/master/bizhawk-co-op.ps1'))</pre>'''

From here, the PowerShell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install in your downloads folder and place everything for you. Say '''yes''' when PowerShell prompts you to install the <code>bizhawk_prereqs.exe</code> file. Once PowerShell is done, you can move the Bizhawk 2.7 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>.

=== The Alternate Method ===

==== Download the Custom Bizhawk Installer ====

First, you must download the Multiworld script from [https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip TestRunner's GitHub page]. When you download this, extract its contents to ''its own folder'' - it will be creating a new Bizhawk install for you to use, so you must keep it separate. ''Note: Whenever there is an update to the Multiworld script, everybody playing must update to the latest version.''

==== Running the Custom Bizhawk Installer ====

Once you have the contents extracted to its own folder, locate the <code>bizhawk-co-op.ps1</code> file. Right Click and select Run with PowerShell.

[[File:MWG1.png|610x149px|Run with PowerShell]]

If Powershell prompts you for permissions, say yes to all. From here, the Powershell is getting you 99% of the way done: it will create a new Bizhawk 2.7 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.7 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.7 folder that was created. These files are no longer needed and only add confusion.''

==== Powershell Permissions ====

You may need to enable executing Powershell scripts without requiring the script to be digitally signed. Open Powershell from the Start Menu by right clicking it and selecting "Run as Admin". Click the "Yes" button to allow Powershell to run as Administrator. Type <code>Set-ExecutionPolicy Unrestricted</code> and press <code>Enter</code> once, type <code>Y</code> then press <code>Enter</code> again. The Powershell script should now run.

== Configuring Bizhawk for Multiworld ==

=== Bizhawk Settings ===

There are a few things you need to do once you've got the emulator running. The very first thing is go to <code>Config -> Customize</code> and navigate to the Advanced tab. At the bottom, there is an option for Lua Core; select <code>Lua+LuaInterface</code> and hit OK. While on the Advanced tab, you should also check the box for <code>AutoSaveRAM</code> and set it to a reasonable time, such as 60-180 seconds (keep in mind that setting this too low could increase lag and decrease overall emulator performance). This will allow Bizhawk to write your in-game save to your drive. This is '''NOT''' a form of save state - it simply periodically creates/updates a file on your hard drive with your in-game save data, and is wonderful for mitigating the effects of crashes. '''In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save file follow the instructions over [[Multiworld#Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen!|here]].

[[File:bizhawkautosave.png|420x487px|Advanced Customization]]

In the General tab of the Customize menu, tick the boxes for "Accept background input" and "Run in background" – this will allow Bizhawk to keep accepting controller inputs when you tab over to your tracker or notes and prevent the emulation from pausing (which will disconnect you). Clear your hotkeys by going to Config -> Hotkeys, and at the bottom click Misc and Clear All.

=== Controller Settings ===

The next step is to set your controller up. Your controller configuration will vary based on what controller you are using; for Bizhawk to enable the Controller menu, you must have a ROM loaded. For a smooth controller experience, you must unbind the first 4 binds in Config -> Controller such that it looks like this:

[[File:MWG3.png|320x207px|Normal Controls]]

You'll then have to bind your analog stick in the Analog tab of your controller config and adjust your sensitivity and deadzones to your preference. ''Additional info on controller setup can be found in Step 6 of the [[Bizhawk|Bizhawk Guide]].''

=== Video Settings ===

You can fix how your game looks by going to Config -> Cores -> N64 Video Plugin Settings. In here, change your resolution so that it runs smooth. Multiworld will drop your performance, so keep that in mind. The recommended video plugin is GLideN64. ''(This is not the same plugin as Glide64!)''

== Starting the Multiworld Session ==

=== Opening the Lua Console ===

Once you have your emulator set up to run how you are comfortable with, its time to move to the Lua console. Go to Tools -> Lua Console, and a separate window will open up. ''This window must remain open at all times during a Multiworld.'' In the Lua Console, go to Settings and checkmark the Disable Scripts on loads.

[[File:MWG4.png|586x379px|Disable Scripts on Load]]

This is the last of the settings changes you have to do. If you want Bizhawk to retain these settings changes for the next time, go to Config -> Save Config. Once you have these steps done, '''you MUST close your emulator and reopen it for this change to take effect'''. Close out of Bizhawk, and then reopen it and the Lua Console. Sometimes this will not be enough and you will still get an error trying to load the Lua file. In that case reboot your entire computer.

'''If for some reason you do not have your Multiworld ROM open, you must do so now.'''

From here in the Lua Console, Open Script and locate the <code>bizhawk co-op.lua</code> file in the Bizhawk 2.7 folder. Once you have that done, a red square will appear in the console; double click it and a new window will open up.

[[File:MWG5 2.png|Bizhawk co-op]]

This window must ''also'' stay open at all times.

=== Rooms ===

The Lua Console Script is where you set up a room and join rooms.

If you are the Host: You must port forward. How you do this varies on what brand your router is. Instructions on how to do this can be found by Googling your brand/model of router. You'll want to use a port between 49152 and 65535. We highly recommend using the default port, 50000. You'll also want to ensure you're forwarding the TCP protocol as that is the protocol Multiworld uses. Most other games you have port forwarded in the past likely were using the UDP protocol.

Once that is done, in the Bizhawk Co-op window the Host must set their name, password, and the port that was forwarded, along with setting the game script to Ocarina of Time. Don't set the IP address. Hit Create Room and tell the people joining the Room Name (= your name), password, and port. ''(It is not recommended to use your own personal password here, as it is shared with the group. Use something that will prevent random people from joining your room, but not something that will compromise your own security.)''

If you are Joining and the Host has set up the room: hit Refresh in the Bizhawk Co-op window and select the Host's Room from the dropdown bar. When you input your username, keep in mind the game will use this to display who got what item for everyone playing. It will max out at 8 characters, even if you input more. Fill in the password and port number the Host gave you and select the Ocarina of Time Game Script and hit Join Room.

You can also select a player number when both hosting and joining a room. This is non-mandatory, and player numbers will be automatically selected if non are entered. This also does not need to match the world number chosen when patching your ROM file. If you do select a player number, and that number is already filled in that room, you will be unable to join.

=== Play Some Multiworld! ===

Go and have fun with new or old friends! If you are part of the {{discord}}, you can assign the Multiworld role to yourself by going to the {{discord|role-assignment}} channel and clicking the 3 emote - this will allow you to receive pings in the server where there are announcements from the Devs or folks are looking for players. You can also visit {{discord|multiworld-planning}} to look for additional players. It is ''highly'' recommended that you use one of the [[Trackers]] so that you don't accidentally leave those new friends out to dry if you miss a check. Map Trackers such as 2deep4real's Web Tracker or Hamsda's Map and Item Tracker package for EmoTracker are highly recommended.

== Troubleshooting ==

=== Installation Issues (Applies to both the Recommended and Alternate Methods) ===

==== Anti-Virus ====

Another issue that can occur while running the Powershell script is your anti-virus deleting the files it downloads. The BizHawk Prerequisites often gets marked as suspicious due to it being an installer that runs more installers. We can't give a detailed guide on how to exclude a folder in every anti-virus software, but search Google with a query like <code>Exclude Folder <your_anti-virus_name></code> and you should find a guide on their official site explaining how to do so. Exclude the folder that has the Powershell script in it and now you should be able to run it without the downloaded files getting deleted.

=== Common Error Messages ===
These are the most common errors that pop up that have known solutions. If none of these solve the problem, try rebooting your computer again afterwards to ensure any new configurations are fully loaded.

==== NullHawk Does Not Implement Memory Domains ====
You must load the ROM before activating the Lua scripts.

If doing so does not fix the issue, open the Lua Console and look at <code>Settings -> Autoload</code>. This setting should be '''disabled'''. Save the settings and completely close out of Bizhawk. Reopen, load the rom, and only after the rom is loaded open the Lua Console.

==== Error 401 ====
This generally means that either the password entered was incorrect, or that the room name already exists. Also, avoid special characters like spaces in the room name. We recommend using letters (no accents) and numbers only.

==== This ROM is not compatible with this version of the co-op script. ====
[https://github.com/TestRunnerSRL/bizhawk-co-op/archive/master.zip Update your scripts].

==== Unable To Find Domain: CARTROM ====
You are using the A Link to the Past LUA script. Choose Ocarina of Time in the dropdown instead.

==== Dynamic Libraries Not Enabled ====
You did not set the Lua Core setting properly. Remember to restart Bizhawk after changing it.

==== Unprotected Error in Call to LUA API ====
This is a general error that pops up randomly. You need to ensure all copies of Bizhawk are closed properly. The easiest way to ensure this is by rebooting your computer.

If you consistently get it when trying to start up the script, make sure the script is located in the Bizhawk root folder. This error will come up if you run the script from any other folder.

==== Connection Failed: Timeout ====
There are several reasons this can happen, all of them being various methods of misconfiguration.

First, the host must have the [[Multiworld#Rooms|port being used forwarded]] if not using Hamachi. Your private IP address that you forward the port to can change for various reasons. Always ensure that the router is pointing to the right computer with the port forwarding options. The host must also not have pings blocked in their router settings. This setting can be found under many names depending on the router.

Everyone playing must have the Bizhawk emulator allowed through their firewall.

The above [[Multiworld#Configuring Bizhawk for Multiworld|Bizhawk configuration options]] are not optional. If you do not configure the emulator properly you will be unable to stay connected to each other.

==== Invalid Arguments to Method Call ====
You'll get this error if files are in the wrong place. This can happen if you move any of the files manually, or if the Powershell script exits early.

The easiest way to fix this is to remove the Bizhawk folder and re-run the Powershell script. If your bizhawk-co-op.lua file is in the Lua folder, you can try moving it to the root folder where EmuHawk.exe is instead and see if that works too.

==== Attempt to concatenate local 'err' ====
This error occurs when some part that was downloaded was corrupt. The easiest way to fix this is to delete the Bizhawk folder the Powershell script downloaded and run it again.

=== Miscellaneous Issues ===

==== A Specific Item Failed to Transfer ====

Items can be retrieved by having the receiving player enter a line of code into the Lua console, though it is best to avoid this situation entirely if possible. This frequently occurs if a player continues while one or more other players are disconnected from the room. To prevent this, always ensure everyone is connected before collecting any item.

Go to [https://pidgezero.one/zootr/mwlua.html this website] (made by pidgezero_one) and select option 2. Locate the code for the missing item and follow the instructions there to retrieve the item. If the layout looks wrong, press ctrl+F5 to fix it.

==== Help! My emulator crashed!/I accidentally opened TAStudio and got a black screen! ====

First of all, '''DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!''' Doing so will overwrite your backups, meaning that your save files will be gone. To recover your save files follow these instructions.

# In your Bizhawk folder navigate to <code>\N64\SaveRAM</code>.
# Identify the <code>SaveRAM</code> and <code>AutoSaveRAM</code> files corresponding to your seed. Sorting by date may help. Note that the <code>AutoSaveRAM</code> files will only exist if you've [[Multiworld#Bizhawk Settings|enabled that]] beforehand.
# Optional: manually make a backup of these files somewhere on your pc.
# Delete the <code>SaveRAM</code> file and rename <code>AutoSaveRAM</code> to take the place of the <code>SaveRAM</code> file you've just deleted.
# Now you can safely load your seed again and continue playing.

==== A Player Forfeits without Finishing ====

If a player forfeits their world, the game can continue without them by entering code lines into the Lua console to retrieve the lost items for the remaining players. Upload the multiworld spoiler log on [https://pidgezero.one/zootr/mwlua.html this site] (made by pidgezero_one) and follow the instructions there. If the layout looks wrong, press ctrl+F5 to fix it.

==== LUA Console Window Too Small ====

If your window for the LUA connection console is too small and the elements are overlapping, you need to change your DPI settings. Right click EmuHawk -> Properties -> Compatability -> High DPI scaling override, change to "System (Enhanced)".

[[File:DPISettings.png|326x407px|EmuHawk High DPI Settings]]

=== I can't see the other players in my game ===

This is not possible with multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

== Multiworld Without Port-Forwarding or Bizhawk ==

=== Hamachi ===

If nobody in your multiworld group can port-forward for whatever reason, and you cannot get someone who can to join, then there is a program you can use: Hamachi. Let me preface this by saying that Hamachi basically 'tricks' your computers to believe that you are all connected via LAN.

To start, download Hamchi [[https://www.vpn.net/ here]] and install it. Create an account, and go to System > Preferences > Settings to make sure that 'Encryption' is enabled. Then, click on the power button to go online.

==== Hosting ====
If you're hosting, then click Network > Create a new network. Give it a unique name and password, making sure that nobody other than the people you're playing with find out this information. After this, you'll see it pop onscreen:

[[File:Guide.JPG|RTENOTITLE]]

To join an existing network, click Network > Join an existing network. Type in your friend's network ID and the network's password.

Once you're all connected in the network, you can start the multiworld.

Right click on the address above your nickname, and click 'Copy IPv4 address' and share it with the people joining you:

[[File:Guide2.JPG|RTENOTITLE]]

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)', Set your Username and Password as usual, and the game script to Ocarina of Time.

==== Joining ====

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)' and paste the IPv4 the host gave you into the 'Host IP' bar. Set your Username and Password as usual, and the game script to Ocarina of Time.

Now you should be ready to start. As usual, if you have any more problems, seek advice within the {{discord}}.

==== Security Awareness ====
'''Be careful with who you give permission to join your network to.''' Using Hamachi is like letting everyone using it with you use a computer on the same network as yours.

==== Hamachi Request Timed Out ====
[https://help.logmein.com/articles/en_US/FAQ/Resolving-Hamachi-Request-Timed-Out Follow these steps to ensure Hamachi is allowed through your firewall]. Both the Host and the clients connecting to the host should do this.

=== Playing over LAN ===

If you're playing over a LAN network, then all you need to do is set the 'room' to (Custom IP), type the LAN's Ipv4 into the 'host IP' field, and give yourself a username. Leave the password field blank.

=== Play Without Bizhawk ===

While Bizhawk is the officially supported emulator for multiworld, it is known to be a resource-intensive emulator in addition to being Windows only.

If port forwarding/using Hamachi is impossible for any reason, try [https://midos.house/mw Mido's House Multiworld]. It is compatible with Bizhawk and Project64 and can have players on different emulators at the same time. This method for multiworld was created by Fenhl and is the newest way to play multiworld. Issues with this can be brought up in the #setup-support channel of the OoTR discord, but it's unlikely anyone except Fenhl will be able to provide meaningful assistance so do not expect quick replies.

If using Bizhawk is impossible for any reason, try the emulator ModLoader64 (Windows and Linux compatible), as DemoXin has modified the multiworld script to work with it. This method does not require a host. Modloader64 is also the only way to play Ocarina of Time Online, which allows players to see each other in the world, and also supports other various features. As we do not officially support this emulator or any of their paks, we kindly refer you to [https://discord.gg/mWDztG their Discord] for all issues and support.

==== Feature comparison ====

{| class="wikitable"
|-
! Feature
! [https://github.com/TestRunnerSRL/bizhawk-co-op bizhawk-co-op]
! [https://midos.house/mw Mido's House Multiworld]
|-
| [[Project64]] support
|
| ✓
|-
| [[Bizhawk|BizHawk]] support
| 2.3–2.8 (no support for the current version)
| 2.9.1 only (no support for older versions)
|-
| no port forwarding or Hamachi required
|
| ✓
|-
| can be used via LAN without an internet connection
| ✓
| [https://github.com/midoshouse/ootr-multiworld/issues/3 planned]
|-
| async support: players don't need to be connected at the same time
|
| ✓
|-
| easier setup: player name and world number are read from the game
|
| ✓
|-
| prevents players from accidentally using the same world number
|
| ✓
|-
| support for some other games
| ✓
|
|-
| automatically updates itself
|
| ✓
|-
| send all remaining items from a world using a spoiler log
| using [https://pidgezero.one/zootr/mwlua.html an external service]
| built in
|-
| choose individual items to give to a player
| using [https://pidgezero.one/zootr/mwlua.html an external service]
|
|-
| rooms are automatically deleted after a period of inactivity
|
| ✓ (defaults to 7 days, configurable)
|}

Mido's House Multiworld

2024-04-29T06:14:17Z

Fenhl: added Linux installer permissions FAQ

'''Mido's House Multiworld''' is one of the plugins that can be used to play [[multiworld]].

To install, simply download the installer from [https://midos.house/mw its website] and follow the instructions. For more details on how the installer works, read the [[Mido's House Multiworld installer]] article.

If you need help, please ask in [https://discord.gg/BGRrKKn #setup-support on the OoTR Discord] (feel free to ping @fenhl) or [https://github.com/midoshouse/ootr-multiworld/issues/new open an issue].

== Frequently asked questions ==

=== Our room is gone, what can I do? ===

Rooms are automatically deleted after 7 days of inactivity. This can be increased to 90 days in the room options. If your room was deleted for inactivity or if you accidentally deleted your room, there is currently no way to restore the game progress. A [https://github.com/midoshouse/ootr-multiworld/issues/5 backup system] is planned to be added in a future version of Mido's House Multiworld.

=== How do I see other players in my game? ===

This is not possible with Mido's House Multiworld. You will need ModLoader64's OoT Online pak instead.

Please note that ModLoader64 is currently only compatible with [https://ootrandomizer.com/generator?version=6.2 version 6.2 of the randomizer]. Newer releases or Dev builds of OoTR are not yet supported. For assistance with ModLoader64, [https://discord.gg/UFVY9DE please join their Discord].

=== I'm on Linux, how do I run the installer? (Unknown file type) ===

Make sure the installer is set to executable.

* In most graphical file system apps, right-click the installer file, select Properties, enable “allow executing as program” or similar. You should then be able to run the installer by double-clicking it.
* On the command line, run <code>chmod +x multiworld-installer-linux</code>, then run <code>./multiworld-installer-linux</code>.

Mido's House Multiworld installer

2024-04-29T06:01:16Z

Fenhl: updated for EverDrive support, some corrections for Linux

This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.

== Console/emulator selection ==

On this page, you choose whether you want to install multiworld for [[EverDrive]], for [[BizHawk]], or for [[Project64]].

* For EverDrive, the installer will display a warning since EverDrive support is currently experimental and requires [https://ootrandomizer.com/generatorDev?version=devFenhl_ Fenhl's branch of the randomizer]. Progress on stabilizing EverDrive support is tracked in [https://github.com/midoshouse/ootr-multiworld/issues/23 this Mido's House Multiworld issue] and [https://github.com/OoTRandomizer/OoT-Randomizer/issues/2042 this randomizer issue].
* For emulators, the installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

On Linux, installing [[BizHawk]] requires root permissions. The installer will use [https://en.wikipedia.org/wiki/Zenity Zenity] to prompt for your password in order to use [https://en.wikipedia.org/wiki/APT_(software) APT] to install [https://en.wikipedia.org/wiki/Mono_(software) Mono]. If Zenity and/or APT are not available, the installer will skip this step and you should install Mono manually.

== Emulator location ==

This step is skipped for EverDrive.

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for EverDrive and Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''DO NOT close or click OK on the error message!''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

This step is completely automated for Project64. It is skipped for EverDrive.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.

On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs\Mido's House Multiworld.exe</code> on Windows, or <code>~/bin/mhmw</code> on Linux.

On Windows, there is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

== Summary ==

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''EverDrive:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the multiworld app and the emulator (if any) right now.

EverDrive

2024-04-29T05:44:15Z

Fenhl: Redirected page to Everdrive

#redirect [[Everdrive]]

Branch identifiers

2024-04-01T14:55:02Z

Fenhl: reserved 0xff for private use

This is a list of known '''branch identifiers''', i.e. values of [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/version.py#L8 the variable <code>branch_identifier</code> in version.py].

{| class="wikitable"
|-
! ID
! Branch
|-
| <code>0x00</code>
| main releases
|-
| <code>0x01</code>
| [https://github.com/OoTRandomizer/OoT-Randomizer Dev (OoTRandomizer)]
|-
| <code>0x43</code>
| [https://github.com/Cuphat/OoT-Randomizer/tree/Dev-C Dev-C (Cuphat)]
|-
| <code>0x45</code>
| [https://github.com/rrealmuto/OoT-Randomizer/tree/Dev-Rob Dev-Rob (rrealmuto)]
|-
| <code>0x52</code>
| [https://github.com/Roman971/OoT-Randomizer Dev-R (Roman971)]
|-
| <code>0x57</code>
| reserved by [https://github.com/cjohnson57/OoT-Randomizer cjohnson57]
|-
| <code>0x69</code>
| [https://github.com/Elagatua/OoT-Randomizer blitz (Elagatua)]
|-
| <code>0x99</code>
| [https://github.com/mracsys/OoT-Randomizer Dev-M (mracsys)]
|-
| <code>0x9c</code>
| [https://github.com/trezc0/OoT-Randomizer trez-test]
|-
| <code>0xfe</code>
| [https://github.com/fenhl/OoT-Randomizer dev-fenhl]
|-
| <code>0xff</code>
| reserved for private use
|}

Mido's House Multiworld installer

2024-01-30T18:09:40Z

Fenhl: /* Multiworld location */ updated for changes in version 15.1.0

This article documents the behavior of the installer for [[Mido's House Multiworld]]. The installer can be downloaded from [https://midos.house/mw the Mido's House Multiworld website]. It is currently available for Windows and Linux.

== Emulator selection ==

On this page, you choose whether you want to install multiworld for [[BizHawk]] or for [[Project64]]. The installer supports both installing multiworld for an existing copy of the selected emulator, as well as installing a new copy of the emulator itself. The choice between these two modes is made on the next page.

If there is only one supported emulator (which is currently the case on Linux, where only [[BizHawk]] is supported), this page is skipped and the supported emulator is selected automatically.

== Admin permissions ==

On Windows, installing multiworld for [[Project64]] requires administrator permissions. The installer will display a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt to reopen itself as administrator. The original installer window will remain open and display a message asking you to use the new instance instead.

== Emulator location ==

On this page, you choose whether to install multiworld for an existing copy of the selected emulator or to install the emulator as well. You can select the emulator installation folder, either to locate an existing emulator installed at an unusual location or to customize where to install it. The selected path should be the folder containing the emulator, not the emulator executable itself.

== Emulator update ==

This step is currently only implemented for BizHawk, it is skipped for Project64. You can check [https://www.pj64-emu.com/ the Project64 website] for updates if you'd like.

Each version of Mido's House Multiworld only works with exactly one version of BizHawk. If the installer detects an older version of BizHawk, it will offer to automatically update it. Note that updating BizHawk can sometimes break the emulator settings. In this case, the new BizHawk version will display an error message saying “It appears your config file (config.ini) is corrupted” when it's opened. '''DO NOT close or click OK on the error message!''' Make a backup of the file <code>config.ini</code> in your BizHawk folder first. It can be used with a “diff” tool to salvage your settings. See [https://github.com/TASEmulators/BizHawk/issues/2094 BizHawk issue #2094] for details.

== Emulator installation ==

This step is completely automated for Project64.

If BizHawk is being installed on Windows, there will be a [https://learn.microsoft.com/en-us/windows/security/application-security/application-control/user-account-control/ User Account Control] prompt, and then the [https://github.com/TASEmulators/BizHawk-Prereqs BizHawk-Prereqs] installer will pop up and you will need to click through it.

If BizHawk is being installed on Linux, the multiworld installer will attempt to use <code>zenity</code> and <code>apt</code> to install [https://www.mono-project.com/ Mono]. On Ubuntu, both of these programs are installed by default. If you're on a different distribution, you may have to manually install <code>mono-complete</code> or similar.

== Multiworld location ==

This step is skipped for Project64 version 4 and for BizHawk, for which the multiworld app is automatically placed in a hidden folder and automatically opened when the emulator plugin is started. For Project64 version 3, both the emulator itself and the multiworld app must be launched manually at the start of each play session.

On this page, you choose where to place the multiworld app. The default location is <code>%LOCALAPPDATA%\Programs</code>.

There is also an option to create a desktop shortcut. Regardless of whether this is selected, the app will be added to the program list in the Start menu (this is not the same as a Start menu shortcut, which must be created manually if desired).

== Summary ==

Once everything has been installed, there's a quick explanation of how to play multiworld. In case you skipped over it, here it is again:

* '''BizHawk:''' In BizHawk, select Tools → External Tool → Mido's House Multiworld.
* '''Project64 version 3:''' Open the “Mido's House Multiworld” app and follow its instructions.
* '''Project64 version 4:''' In Project64, select Debugger → Scripts → ootrmw.js and click Run.

Finally, the installer will offer to open the emulator right now.