OoT Randomizer Wiki - User contributions [en]

Plandomizer

2022-05-19T04:02:37Z

ShadowShine57: Note about dev starting items

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the {{discord|plando-support}} channel in the {{discord}} for help resolving these errors.
{{collapsible list code style
|Deliver Letter
|Sell Big Poe
|Skull Mask
|Spooky Mask
|Keaton Mask
|Bunny Hood
|Mask of Truth
|Milk
|Goron Mask
|Zora Mask
|Gerudo Mask
|Zeldas Letter
|Location: HC Zeldas Letter
|title=Also note that the following are not assignable.}}
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
{{collapsible list code style
|'Deku Stick'
|'Deku Nut'
|'Bow'
|'Slingshot'
|'Fairy Ocarina'
|'Bombchu'
|'Longshot'
|'Boomerang'
|'Lens of Truth'
|'Beans'
|'Megaton Hammer'
|'Bottled Fish'
|'Bottled Milk'
|'Mask of Truth'
|'SOLD OUT'
|'Cucco'
|'Mushroom'
|'Saw'
|'Frog'
|'Master Sword'
|'Mirror Shield'
|'Kokiri Tunic'
|'Hover Boots'
|'Silver Gauntlets'
|'Gold Scale'
|'Stone of Agony'
|'Skull Token'
|'Heart Container'
|'Boss Key'
|'Compass'
|'Map'
|'Big Magic'
|title=Expand to view the full list of valid hash icons for the current version of the randomizer.}}

==== Examples ====
'''Set all 5 icons to Deku Nut''':
{{json example|
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
}}

'''Set only the first icon to Deku Nut''':
{{json example|
"file_hash": ["Deku Nut", null, null, null, null]
}}
or
{{json example|
"file_hash": ["Deku Nut"]
}}

'''Set only the last icon to Deku Nut''':
{{json example|
"file_hash": [null, null, null, null, "Deku Nut"]
}}

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
{{json example|
"starting_items": {
"Rupees": 99
}
}}

'''Start with all shields''':
{{json example|
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
}}

'''Please note there are two starting item sections''', this section refers to the one after randomized_settings in a spoiler log. The starting items, starting equipment, and starting songs sections within the settings section have a different format, but as listing what falls under each here would be a long section, please instead generate a spoiler log using the GUI to see where items need to be listed.

'''NOTE''': In current dev versions, the starting items sections have been unified into the one under the settings dictionary. Make sure to place your starting items dictionary inside the settings dictionary for it to work.

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
{{json example|
"item_pool": {
"Mirror Shield": 3
}
}}
or
{{json example|
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
}}

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
{{json example|
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
}}

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
{{json example|
"dungeons": {
"Deku Tree": "mq"
}
}}

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
{{json example|
"dungeons": {
"Spirit Temple": "vanilla"
}
}}

'''Set Dodongo's Cavern to random''':
{{json example|
"dungeons": {
"Dodongos Cavern": "random"
}
}}

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
{{json example|
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
}}

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
{{json example|
"trials": {
"Light": "active"
}
}}

'''Set water trial to random''':
{{json example|
"trials": {
"Water": "random"
}
}}

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Ground''':
{{json example|
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Ground Lobby", "from": "Gerudo Fortress"}
}
}}

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
{{json example|
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
}}

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by the settings chosen, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there.
* A list containing multiple items to randomly choose from to place there.
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

Item names can also take advantage of the wildcard <kbd><samp>*</kbd></samp> and the not indicator <kbd><samp>!</kbd></samp>.

For example, this will guarantee Link starts with a medallion, Spirit Temple will always have a stone, and one of the shields can be found in Mido's House.
{{json example|
"locations": {
"Links Pocket": "*Medallion",
"Twinrova": "!Medallion",
"KF Midos Top Left Chest": "*Shield"
}
}}

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Shop Location Prices ====
When defining a shop location, rather than simply assigning a string of the item name to the location, you must define a dictionary with the properties item (a string of the item name) and price (a number). So for example, a shop item location will look something like this:
{{json example|
"KF Shop Item 7": {
"item": "Light Arrows",
"price": 40
},
}}
If you try to set a price higher than 999, it will simply be capped to 999 so it won't be impossible to buy. However, you can actually plando negative prices, which will give the player the absolute value of the price. So if you plando a shop item to be -10 rupees, the player will be able to purchase it with any wallet size and it will give them 10 rupees. Due to reasons related to the binary numbers used to represent the prices in-game, the lowest possible price is -32768.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
{{collapsible list code style
|<nowiki>#</nowiki>Bottle - Places a bottle and randomly chooses a contents for it
|#Junk - Places a junk item (used by exclude locations)
|#AdultTrade - Places the adult trade item without specifying which one
|title=The ones that should work fine:
|expand=yes
}}
{{-}}
{{collapsible list code style
|<nowiki>#</nowiki>Vanilla - Places whatever was on that location in the original game. Also applies to MQ locations.
|#MajorItem - Places a settings-dependent major item at that location.
|#Song - Places a song item
|#NonWarpSong - Places non warp song item
|#WarpSong - Places a warp song item
|#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
|#Spell - Places one of the three spells
|#Shield - Deku or Hylian. Doesn't include Mirror.
|#HealthUpgrade - Heart Container or Piece of Heart
|title=If you are feeling a little bit more daring, you can try:
|expand=yes
}}

All of these should work, but only the first list have been extensively tested.

You can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
{{json example|
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
}}

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
{{json example|
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
}}

'''Bottles in Mido's''':
{{json example|
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
}}

'''One step to fighting Ganon in the Kokiri Sword chest''':
{{json example|
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
}}

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
{{json example|
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
}}

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
{{json example|
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
}}

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

{{json example|
{
"name": "tournament",
"gui_name": "Tournament",
"description": "Hint Distribution for the S5 Tournament. 5 Goal Hints, 3 Barren Hints, 5 Sometimes hints, 7 Always hints (including skull mask).",
"add_locations": [{ "location": "Deku Theater Skull Mask", "types": ["always"]}],
"remove_locations": [{"location": "Ganons Castle Shadow Trial Golden Gauntlets Chest", "types": "sometimes"}],
"add_items": [],
"remove_items": [{ "item": "Zeldas Lullaby", "types": ["goal"]}],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": true,
"vague_named_items": false,
"use_default_goals": true,
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"goal": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 8, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
},
"groups": [],
"disabled": []
}
}}
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

{{json example|
"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]
}}
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Custom Goals ====

As of version 6.0.111, the '''goal''' hint type can use built-in goals for the bridge, Ganon's Castle Boss Key, and Trials conditions as well as custom goals defined in the hint distribution. Custom goals use the <code>custom_goals</code> key inside a custom hint distribution as shown in the example below.

{{json example|
{
"settings": {
"hint_dist_user": {
...
"custom_goals": [
{
"category": "all_items",
"priority": 1,
"minimum_goals": 4,
"lock_entrances": ["Ganons Castle Grounds -> Ganons Castle Lobby"],
"goals": [
{
"name": "memes",
"hint_text": "path of memes",
"color": "Light Blue",
"items": [
{"name": "Ice Arrows", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Double Defense", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Stone of Agony", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Nayrus Love", "quantity": 2, "minimum": 1, "hintable": true}
]
}
]
}
],
...
}
}
}
}}

===== '''Category Definition''' =====

Both goal categories and individual goals can be defined. Goals can be assigned to existing default categories by setting the `category` key to one of the following:

* '''rainbow_bridge''' - Includes goals for dungeon rewards or skulltula tokens. Not active with open bridge.
* '''ganon_bosskey''' - Includes goals for dungeon rewards, skulltula tokens, or Ganon's Boss Key directly. Not active with the boss key removed or vanilla.
* '''trials''' - Includes path to the Tower goal for any enabled trials. Only active with non-zero trials
* '''triforce_hunt''' - Includes path of gold goal for Triforce Pieces. Only active when Triforce Hunt is enabled
* '''ganon''' - Equivalent to way of the hero. Only active with open bridge and Ganon's Castle Boss Key removed/vanilla and zero trials.

===== '''Category Priority''' =====

Custom goals follow the same category priority rules as default goals. A custom goal in the <code>ganon_bosskey</code> category will not include items that are part of the bridge category. A custom category with a priority between the <code>bridge</code> and <code>ganon_bosskey</code> categories will not include items from the <code>bridge</code> category, and the <code>ganon_bosskey</code> category will not include items from <code>bridge</code> or the custom category. Caution should be used adding custom categories before or in the middle of default categories for this reason. If a custom category has the same priority as a default goal, a required item can be included for goals in both categories. Default priorities are:

* '''rainbow_bridge''' - 10
* '''ganon_bosskey''' - 20 for dungeon rewards/tokens, 30 for keysanity variants
* '''trials''' - 30
* '''triforce_hunt''' - 30
* '''ganon''' - 30

===== '''Category Minimum Goals''' =====

Minimum goals determine if the overall category objective is fulfilled. For example, the <code>bridge</code> category has a minimum requirement of however many dungeon rewards are needed to spawn the bridge to Ganon's Castle. If there are not enough obtainable goals in the world, the category objective is not fulfilled and goal hints will not be generated for that category. This system is available to custom goal categories with the <code>minimum_goals</code> key.

===== '''Category Entrance Locks''' =====

Entrances between regions can be disconnected to artificially restrict world access for a category. This was designed primarily for the rainbow bridge to only hint goals reachable without access to Ganon's Castle. The system can be used with custom goal categories by listing entrances to lock in the <code>lock_entrances</code> key. Entrance names use the syntax "Region A -> Region B", where the different regions are named in the logic files. This has only been tested with overworld entrances, but should work with dungeon internal entrances as well.

It is not possible to change default goal category entrance locks.

===== '''Goal Definition''' =====

All goal names must be unique within a category. Goal names are only used internally. The <code>hint_text</code> key defines how the goal is presented in the spoiler log and in hints. Default goals use the convention "path to <X>".

Goal colors change how the path is colored. The hinted area with the required item will always be light blue.
{{collapsible list code style
|White
|Red
|Green
|Blue
|Light Blue
|Pink
|Yellow
|Black
|title=Valid colors are:
|expand=yes
}}

Required item definition can include any number of items for each goal. Each item has four keys:

* name - Item name as defined in <code>ItemList.py</code>
* quantity - Maximum possible items to complete the goal
* minimum - Minimum possible items to complete the goal
* hintable - Whether or not this item can be directly hinted, or only items required to obtain this item. In both cases required items are a possibility for hints.

The <code>quantity</code> key must be equal to or greater than the <code>minimum</code> key. The <code>minimum</code> key cannot be zero. The randomizer will consider a goal valid for hints if the all minimum items are reachable. It will attempt to hint items required for all copies of this item up to the maximum <code>quantity</code>, but will automatically reduce the <code>quantity</code> to the maximum reachable copies in beatable only or with a category lock defined.

Required items for goals must be major items. Rupees and heart containers are not major items and will cause the goal to always be unobtainable and thus unhintable.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

{{json example|
{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}
}}
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

{{json example|
{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}
}}

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Multiple text boxes can be assigned to a single gossip stone by separating the strings with <kbd>^</kbd>. However, this is not strictly required as the randomizer will automatically break up strings that are too long for a single text box.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

{{collapsible list code style
|White
|Red
|Green
|Blue
|Light Blue
|Pink
|Yellow
|Black
|title=Valid colors:
|expand=yes
}}

==== Special Characters ====
You can also use some special characters within your hints. In terms of normal characters, you can use within your hint text the following just by putting them within the string as usual: À, Á, Â, Ä, Ç, È, É, Ê, Ë, Ï, Ô, Ö, Ù, Û, Ü, the lowercase versions of all previous characters, and ß.

You can also specify codes for special, in-game button characters using Unicode values. Reference the following table for the value for each button character, and then it can be specified within your hint text with \u00xx, where xx is the value from the table. For example, the A button has a value of 9F, so it would be printed using \u009F within your hint. [https://i.imgur.com/sfbnKF6.png Here] you can see what these characters look like in-game.

{| class="wikitable"
|-
| Code || 9F || A0 || A1 || A2 || A3 || A4 || A5 || A6 || A7 || A8 || A9 || AA
|-
| Button Displayed || A || B || C || L || R || Z || C-up || C-down || C-left || C-right || Down arrow || Joystick
|}

==== Sound Effects ====
Each text box can be equipped with a sound effect. The full list of sound effect IDs can be found at [https://wiki.cloudmodding.com/oot/Sound_Effect_Ids on CloudModding], but it takes a little bit of work to convert them to the correct format. Sound effects are designated by <kbd>${12 x8 yy}</kbd>, where x is the "Bank" as indicated on CloudModding and yy is the sound number within the bank. The <kbd>8</kbd> will be swapped for <kbd>9</kbd> if the sound number is greater than FF (i.e. it has 3 characters on CloudModding).

Please note that only one sound effect will play per gossip stone, but it will play on whichever text box <kbd>${12 x8 yy}</kbd> is placed in.

'''Warning''': Looping sounds will not stop until Link leaves the area or dies, so it's recommended to avoid these sounds.

==== Examples ====
'''Just white text''':
{{json example|
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
}}

'''Colored text''':
{{json example|
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
}}

'''Helpful Tutorial Message''':
{{json example|
"gossip_stones": {
"KF (Outside Storms)": { "text": "To target, press \u00A4" }
}
}}

'''Appreciation''':
{{json example|
"gossip_stones": {
"KF (Deku Tree Right)": { "text": "Dampé is a pretty cool guy." }
}
}}

'''Sound Effects Added''':
{{json example|
"gossip_stones": {
"ToT (Left)": { "text": "The time is ${1F}.^${12 28 df}The cow goes moo." },
"ToT (Left-Center)": { "text": "${12 39 C7}Ganondorf laughs maniacally." }
}
}}

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
{{json example|
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
}}

'''Set tunic colors using built-in color options''':
{{json example|
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
}}

'''Set rainbow sword trail with a duration of 1 second''':
{{json example|
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
}}

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
{{json example|
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
}}

'''Set background music''':
{{json example|
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
}}

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). If this is done incorrectly, then the randomizer will skip it and not output an error message. This means that some other track will be placed there instead without your knowledge.

=== Plando Exclusive Features ===
As of v6.1 there is a setting that can only be changed through the use of Plandomizer.

==== Light Arrows Cutscene Condition ====

This is a setting that determines what the condition is for triggering the Light Arrows Cutscene (LACS) event. This was originally made a setting so that Ganon's Boss Key could be placed here with the condition being, for example, a certain number of dungeon rewards. This would allow players to have the Rainbow Bridge open from the start for early access to Ganon's Castle while still locking Ganondorf behind a certain condition. Now that Ganon's Boss Key can be given to the player anywhere, this setting is no longer needed and was made to be Plando-only rather than removed completely.

To use this setting, add the following to the settings dictionary of the Plando file

{{json example|
"lacs_condition": "X",
}}
where valid settings for <code>X</code> are <code>Stones</code>, <code>Medallions</code>, <code>Dungeons</code> and <code>Tokens</code>. If you wish for the LACS condition to remain vanilla, then simply don't add anything to your Plando file as vanilla is the default setting. Finally, you'll want to add the following line
{{json example|
"lacs_stones/medallions/dungeons/tokens": Y,
}}
where <code>Y</code> is a number (note the lack of quotation marks) and where you should choose <code>lacs_medallions/stones/dungeons/tokens</code> as appropriate (so <code>lacs_stones</code> if you picked Spiritual Stones as your condition, <code>lacs_medallions</code> if you picked Medallions etc.). Keep in mind that the last line of the settings dictionary should '''not''' have a comma at the end, so remove it if appropriate.

==== Examples ====
'''Set the LACS condition to be 69 Gold Skulltula Tokens''':
{{json example|
{
"settings": {
"lacs_condition": "Tokens",
"lacs_tokens": 69
}
}
}}

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the {{discord|plando-support}} channel on the {{discord}} to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Dolphin

2022-04-07T19:28:57Z

ShadowShine57: Increase size of region picture as it was hard to read

Dolphin is a popular emulator for both Gamecube and Wii games, but it can also be used to play Ocarina of Time Randomizer on thru the Wii's Virtual Console mode. Dolphin is very good at emulating Wii VC and only suffers from potential slight additional lag in certain areas (such as Market as child), which can be mitigated using settings discussed below.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to softmod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update. You will need a version specific to the operating system you use, see below for details.

=== Windows ===

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png|RTENOTITLE]]

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png|RTENOTITLE]]

=== Mac OS ===

On the Dolphin page, download the latest MacOS Intel version and drag to Application folder per normal installation.

[[File:MacDownloadPage.png|Mac Download Page]]

The Disk Image (DMG) will include Dolphin and the Dolphin Updater.

[[File:DMG.png|Mac OS Dolphin DMG]]

Similar to the Windows setup, create a filepath directory to where the WAD will be located.

[[File:DolphinMacEmu.png|Dolphin main screen]]

=== Controller Configuration ===

Click on <kbd><samp>Controllers</samp></kbd> on the home page. Controllers can be setup either as "GameCube Controllers", or as "Wii Remotes". For the purpose of the randomizer your controller will need to be configured as a "GameCube Controller" (even if it is, say, an Xbox controller). Under Gamecube controllers, click <samp>Configure</samp> next to Port 1.

[[File:DolphinControlConfig1.png|275px|DolphinControlConfig1.png]]

If you are using a Gamecube Controller with a Wii U Adapter by either Nintendo or Mayflash (Wii U mode), then your controller should be detected and configured automatically and the new window that opens will simply ask you to enable/disable the Rumble Pak.

[[File:Gcnadapter.png|RTENOTITLE]]

For reference, these are the default controller mappings Dolphin will use. Keep in mind that if you've used the webpatcher, or gzinjectgui with the right configuration, that D-pad left/right/down will be overwritten to properly work with boots/ocarina on D-pad.

[[File:Gamecube Controls.png|RTENOTITLE]]

If you are using any other controller, or if you're using a Gamecube adapter in PC mode, then you will need to configure the controller yourself. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig2.png|725px|DolphinControlConfig2.png]]

[[File:DolphinControlerConfig.png|Controller Configuration screen]]

If you find the sensitivity is not to your liking even after calibrating, you can right click the gray box for each direction on the joystick and adjust the range. Lower range is lower sensitivity. Note you must set the range for each direction individually.

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>. This ensures that you don't get a PAL frame rate.

[[File:DolphinRegion.png|450px|DolphinRegion.png]]

Next, close the window and under <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked. This fixes the black pause screens

[[File:EFBImage.png|Setting for EFB]]

=== Enable FPS Display ===

Under <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>General</samp></kbd>, check the box which says <samp>Show FPS</samp>.

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required. If there is already an in-game save file present, delete it before starting the new seed.

== After Finishing a Seed ==

Since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

=== Recommended Baseline Settings ===

If you are experiencing lag, these are optional settings to change from default.

First go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp></kbd>, and then in the <samp>General</samp> tab change the <samp>Backend</samp> from <samp>OpenGL</samp> to <samp>Vulkan</samp> if you are on Windows. Dolphin recommends switching this driver as there may or may not be performance driven issues using OpenGL and its compatibility: [https://dolphin-emu.org/docs/guides/performance-guide/ Dolphin Performance Page]

[[File:VideoDriver.png|Video Driver Screen]]

Second, there are optional graphics settings enabled for more frame rate heavy games which are not required for Ocarina of Time. Below are some settings to verify if you are experiencing lag and what to uncheck.

[[File:VulcanGraphicsConfigEnhancements.png|Under the Enhancements tab]]

[[File:VulcanGraphicsConfigAdvanced.png|Advanced Tab]]

=== Graphical Enhancements ===

Depending on the power of your computer, you may want to enable some graphics enhancements. If your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px|DolphinEnhancements.png]]

=== Aspect Ratio ===

Go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp> </kbd>, and select whatever you prefer. Note that if you update Dolphin, this setting may return to its default state of 16x9.

[[File:DolphinAspect.png|RTENOTITLE]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, please come to {{discord|setup-support}} channel on the {{discord}}.

=== MacOS will not open Dolphin ===

Some security settings may affect whether the application has privledges to write to a file directory. This can be overridden by giving permission to Dolphin to write to Finder. Open Terminal and in the command line copy these two commands and run them in one after the other:

<samp>sudo xattr -r -d com.apple.quarantine /path/to/Dolphin.app</samp>

<samp>sudo xattr -r -d com.apple.quarantine /path/to/DolphinUpdater.app</samp>

Change where it says path to your path directory location before running the command. You can copy the path by right clicking Dolphin.app with <samp>Opt key</samp> held and click <samp>Copy Path Name</samp>.

After running the commands, Dolphin should reopen normally.

=== Performance may be poor message on startup ===

When starting the emulator, yellow text may appear which says "Performance may be poor". This only occurs on older computers or computers with specifications lower than Dolphin recommends. Refer to the previous section on Optional Settings to decrease Graphical Enhancements and change Video Driver. Actual gameplay may not be affected, however you may experience some lag.

[[File:PerformanceMayBePoor.png|Performance may be poor]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png|RTENOTITLE]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Graphical_Enhancements your graphical enhancements].

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. '''This should be a last resort''', go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). '''<span>This is not allowed for racing.</span>'''

[[File:DolphinOverclock.png|RTENOTITLE]]

=== The Wii Home Menu Randomly Pops Up ===

Click on <kbd><samp>Controllers</samp></kbd> on the home page and then either untick <samp>Background Input</samp> (your controller inputs will still be registered with this setting unticked even when the window is unfocused), or change the <samp>HOME</samp> binding of <samp>Wii Remote 1</samp>.

=== GFX FIFO Unknown Opcode on Resetting ===

This is a known bug with resetting VC on Dolphin. You can click OK on both dialogs that pop up and then won't have to worry about it again until you restart Dolphin itself. You can also go to <kbd><samp>Options</samp> ⇒ <samp>Configuration</samp> ⇒ <samp>Interface</samp></kbd> and disable <samp>Use Panic Handlers</samp> to always ignore it.

Trackers

2022-02-13T01:53:07Z

ShadowShine57: Update countdhoun 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.

'''<span style="color:red">Please keep in mind that using auto-trackers and/or logic trackers during a race is against our community's racing rules (except for some [[Dungeon_Door_Requirement|DDR]] races)</span>.''' In the list below it will be indicated in '''<span style="color:red">red</span>''' if a tracker is banned for racing.

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 =

=== '''alphachain ER Tracker''' ===

[http://alphachain.recursivebytes.com/ Link]

'''Tracker type''': Entrance Tracker<br/> '''Browser Support (confirmed)''': Microsoft Edge<br/> '''Features''':

*Create a network of entrances by typing chains in a field using a custom syntax.

*Filter all the chains that are irrelevant to the place you wish to go to.

*It takes some getting used to this tracker, but it's a very powerful tool when mastered.

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

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

[http://bombch.us/C8v2 Link]

'''Tracker type''': Entrance Tracker<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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]]

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

[https://spoilizer.com/ Link]

'''Tracker type''': Checklist<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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|300x169px|Spoilizer.png]][[File:Spoilizer2.png|800x450px|Spoilizer2.png]]

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

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

'''Tracker type''': Item/Checklist Tracker<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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://mracsys.github.io/tootr/ Link]

'''Tracker type''': Entrance/Location Tracker<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome, iOS<br/> '''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]]

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

[http://vadorando.com/ Link]

'''Tracker type''': Checklist<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''Features''':

*A simple Item Tracker.

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

=== '''ZidArgs Map Tracker''' ===

(formerly known as 2deep4real)

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

'''Tracker type''': Map Tracker<br/> '''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br/> '''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]]

= Downloadable Trackers =



=== '''Barinade's Item Tracker''' ===

[http://bombch.us/DOif Link]

'''Tracker type''': Item Tracker <br/> '''Emulator Support (confirmed)''': Project64, Bizhawk, Retroarch<br/> '''Features''':

*A simple Item Tracker.

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

*Customizable colors, item icons and more.

*Supports MMR.

*'''<span style="color:red">Please keep in mind that auto-trackers are banned in all races (except for some [[Dungeon_Door_Requirement|DDR]] races) that take place on Racetime and SpeedRunsLive</span>.'''

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

=== '''Countdhoun's Item Tracker''' ===

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

'''Tracker type''': Item Tracker <br/> '''Features''':

*A simple Item Tracker.

*Supports keysanity and random song notes.

*Save load up to 6 trackers.

*Allows counting skulls, heart pieces, ice traps and blupees with keyboard binds.

*Customizable layout and background.

*MMR support planned.

[[File:Countdhoun.png|650x366px|Countdhoun.png]][[File:Countdhoun3.png|650x366px|Countdhoun3.png]][[File:Countdhoun2.png|650x366px|Countdhoun2.png]]

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

[http://bombch.us/C8jl Link]

'''Tracker type''': Item Tracker <br/> '''Features''':

*A simple Item Tracker.

*Automatically adjusts the layout upon resizing of window.

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

=== '''Fenhl's Tracker''' ===

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

'''Tracker type''': Item Tracker<br/> '''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/]
*'''<span style="color:red">Please keep in mind that auto-trackers are banned in all races (except for some [[Dungeon_Door_Requirement|DDR]] races) that take place on Racetime and SpeedRunsLive</span>.'''

[[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 <br/> '''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<br/> '''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<br/> '''Features''':

*Handles Entrance Shuffle
*Uses the Randomizer logic directly

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

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

[http://bombch.us/DNro Link]

'''Tracker type''': Item Tracker <br/> '''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]]

=== '''LinSo's Item Tracker''' ===

[https://pastebin.com/vYrNGweu Link]

'''Tracker type''': Item Tracker <br/> '''Features''':

*A simple Item Tracker.

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

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

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

'''Tracker type''': Entrance Randomizer Tracker<br/> '''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''' ===

[http://bombch.us/DBxi Link]

'''Tracker type''': Entrance Tracker <br/> '''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''' ===

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

'''Tracker type''': Location Tracker<br/> '''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)
*'''<span style="color:red">Please keep in mind that auto-trackers are banned in all races (except for some [[Dungeon_Door_Requirement|DDR]] races) that take place on Racetime and SpeedRunsLive</span>.'''

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

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

[http://bombch.us/C8jm Link]

'''Tracker type''': Green Rupee Tracker <br/> '''Features''':

*A Green Rupee Tracker.

*Doesn't support MQ.

[[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 <br/> '''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]]

= 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''' ===

'''Tracker type''': Item, Map and Entrance Trackers<br/> '''Features''':

*A fork of [https://wiki.ootrandomizer.com/index.php?title=Trackers#Hamsda.27s_Package Hamsda's Package] that added auto-tracker support.

*'''<span style="color:red">Please keep in mind that auto-trackers are banned in all races (except for some [[Dungeon_Door_Requirement|DDR]] races) that take place on Racetime and SpeedRunsLive</span>.''' This is true even in "manual mode", so use Hamsda's pack if you wish to use this tracker in races.

*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''' ===

'''Tracker type''': Item Tracker<br/> '''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<br/> '''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]]<br/> [[File:Hamsda1.png|800x450px|Hamsda1.png]]

=== '''JRJathome's Package''' ===

'''Tracker type''': Item Tracker<br/> '''Features''':

*A simple Item Tracker.

*Supports keysanity.

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

=== '''Raikaru's & atz's Package''' ===

'''Tracker type''': Item Tracker<br/> '''Features''':

*A simple Item Tracker.

*Supports keysanity.

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

=== '''Xopar's Package''' ===

'''Tracker type''': Item Tracker<br/> '''Features''':

*A simple Item Tracker.

*Supports keysanity.

[[File:Xopar.png|600x388px|Xopar.png]]

=== '''Darkened5ky's & Spleebie's Package''' ===

'''<span style="color:red">NOTE: According to the creators themselves this package is very out of date with logic and will therefore probably be changed to an item-only package in the near future due to neither of them having the desire/time to keep it updated. Use at your own risk.</span>'''

'''Tracker type''': Map Tracker<br/> '''Features''':

*Supports keysanity and different DoT, forest and rainbow bridge options.

*Has 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.

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

Glossary

2022-01-21T02:04:54Z

ShadowShine57: Add mk

Most every small community will eventually create its own jargon and abbreviations for things naturally out of the desire to communicate more quickly.  Ocarina of Time and the Randomizer which was built for it is no different.  Below you'll find an alphabetized list of both terminology and abbreviations commonly used in both the Ocarina of Time speedrunning and randomizer communities.  If you join the discord or a stream chat and are curious what something means, but don't want to ask, this is the place for you.

{{TOClimit|limit=2}}

= A =
=== ACE ===
- Arbitrary Code Execution. Allows the player to write data into the game's memory and have it executed as code. This is one of the most powerful glitches any video game can have as it theoretically allows you to rewrite the entire game into something else using nothing but the game itself.
=== AD ===
- An abbreviation for All Dungeons. In randomizer this can refer to both a setting which requires all of the dungeons to be beaten, but often it is refering to a seed where it was not required by the settings to beat every dungeon yet the item placement and ruleset combination forced it. This is also a speedrun category where the goal is to beat every dungeon and reach the credits.
=== All Locations Reachable ===
- A setting available as part of the randomizer which ensures that you can reach every location in the game under your current [[logic]] setting.
=== ALR ===
- [[#All Locations Reachable|All Locations Reachable]].

= B =
=== BA ===
- Bottle Adventure. A glitch which allows the player to write an arbitrary value to their B button.
=== Bait ===
- A term used to describe an item, location, or hint that may be unnecessary if the player knows a way to circumvent it.
=== Barren ===
- A synonym for [[#Foolish|Foolish]].
=== Beatable Only ===
- A reference to turning the [[#All Locations Reachable|All Locations Reachable]] setting off which can logically lock off entire sections of the game, based on an older name for this setting.
=== BGS ===
- Biggoron's Sword.
=== Bingo ===
- A game mode where you generate a 5x5 board of goals to complete. When you've completed a goal you check it off the board. There are many sub-variants of bingo which change how it is played. The most common ways to play, however, are standard bingo (any 5 in a row, column, or diagonal), blackout (complete all 25 goals), and lockout (only 1 person can complete any goal, person who has the most wins).
=== BK ===
- Boss Key.
=== BK Mode ===
- A commonly used phrase in [[Multiworld]] games describing the situation where a player can no longer do any [[#Check|checks]] due to their lacking of items. Stands for "Burger King Mode" after a player actually went to Burger King to get food while their teammates gathered items.
=== Blue Potato ===
- A nickname for the Ocarina of Time, due to its color and shape.
=== BotW ===
- Bottom of the Well. This is also used as an abbreviation for the game The Legend of Zelda: Breath of the Wild. Normally it is clear from context which is meant, however this shared abbreviation is often used in jokes.
=== BQ ===
- Beta Quest. A romhack which randomizes shuffles the entrance table completely randomly. Items remain in their vanilla areas, but those areas can be anywhere.
=== Burning Kak ===
- Alternative name for the Nocturne of Shadow [[#Check|check]], requiring the Forest, Fire, and Water Medallions and then walking into Kakariko Village.

= C =
=== Check ===
- A location in the game where you can receive a randomized item.
=== Chest Size Matches Contents ===
- A setting in the randomizer which changes the appearance of every chest to be in line with what's inside of it.
=== Co-op ===
- Often written as simply "coop", this can be referring to a couple things. "Local coop" is where multiple people play the same seed separately, but share information. "[[#Online|Online]] coop" refers to a separate emulator setup that allows multiple people to play in the same game as the same time.
=== CSMC ===
- [[#Chest Size Matches Contents|Chest Size Matches Contents]].
=== Culling ===
- The act of moving the camera or Link far enough away from an actor so that it ceases updating every frame. This can be used glitchlessly to hold actors in place, most useful for Keese. If glitches are allowed, then it can be used to ignore some collision as well.

= D =
=== Damage ESS ===
- An alternative name for a [[#FESS|FESS]].
=== DC ===
- Dodongo's Cavern.

=== DDR ===
- [[Dungeon Door Requirement]]. A [[Rules|ruleset]] for racing which allows more glitches than [[#Standard|Standard]].

=== DMC ===
- Death Mountain Crater.
=== DMT ===
- Death Mountain Trail.
=== DoT ===
- The Door of Time. Openable with just the [[#SoT|Song of Time]]. One of the oldest glitches in Ocarina of Time is the DoT skip, allowing the player to become adult without first obtaining the Song of Time.
=== DT ===
- Deku Tree. An uncommon abbreviation.

= E =
=== Egg ===
- Can refer to either the [[#Pocket Egg|Pocket Egg]] or the [[#Weird Egg|Weird Egg]].
=== Entrance Randomizer ===
- A setting which shuffles the entrances in the world giving it an entirely new geography.
=== ER ===
- [[Entrance Randomizer|Entrance Randomizer]].

=== ESS ===
- Extended Superslide. However, this acronym is most commonly used in reference to the region on the control stick in which the game recognizes minimal input. Link will turn in place at a constant angle per frame, which is exceedingly useful for setups. You will almost never see this written out.

=== ESS Turns ===
- Using [[#ESS|ESS]] position in small increments to turn specific angles. Often seen in discrete amounts such as "3 ess turns right" or "3 ess right."

= F =
=== FESS ===
- An abbreviation for Forward [[#Extended Superslide|Extended Superslide]]. Also known as a [[#Damage ESS|Damage ESS]], this is a method of failure when attempting a [[#HESS|HESS]]. This is almost never seen typed out fully.
=== FiT ===
- Fire Temple.
=== Flame Storange ===
- A glitch which allows you to remotely light a Deku Stick on fire, allowing you to carry it a longer distance.
=== Foolish ===
- Used to describe a region of the game which is devoid of logically useful items. Hints will say that searching the area is a "[[Hints#Foolish Choice|Foolish Choice]]."

=== FoT ===
- Forest Temple.
=== Freestanding ===
- This is used to describe [[#Check|checks]] which are not in a chest and instead just items on the ground to be picked up. In randomizer, they will take on the appearance of the item which you will receive as in vanilla they are all Heart Pieces, Heart Containers, and small keys. Be careful of ice traps!
=== Frog Song ===
- After playing the 6 white note songs for the frogs in Zora's River, you can prompt them to play a bug catching game. The goal of the game is to press the button of the corresponding frog when the bug is over their head. However, the order of this song never changes. It is always: A < > v < > v A v A v > < A

[[File:FrogSong.png|450px|center]]

=== FW ===
- Farore's Wind

= G =
=== GBK ===
- Ganon's Boss Key.
=== GC ===
- An abbreviation for either Ganon's Castle or Goron City. This is used inconsistently, but is usually clear from context.

=== GF ===
- Gerudo Fortress.
=== GIM ===
- Get Item Manipulation. A glitch which allows the player to modify the item which is queued to be given to them.
=== GJ ===
- [[#Groundjump|Groundjump]].
=== GK ===
- Giant's Knife. This is a very uncommon abbreviation. Can refer to both the [[#Check|check]] and the item itself.
=== Glow Mode ===
- The point in a randomizer game when you only need to gather the Light Arrows to proceed to the end of the game.
=== Go Mode ===
- The point in a randomizer game when you either have or know the location of every item you require to beat the game.
=== Greg ===
- A nickname for the "Rupee (1)" item, standing for Green Rupee of Eternal Glory.
=== Groundjump ===
- A glitch that allows the player to cancel a backflip or sidehop, effectively giving Link the ability to jump slightly higher.
=== GS ===
- Gold Skulltula.
=== GT ===
- An abbreviation for Ganon's Tower. This is not very commonly used.
=== GTG ===
- Gerudo Training Ground.

=== GV ===
- Gerudo Valley.
=== GY ===
- An uncommon abbreviation for the Graveyard.
=== GZ ===
- Our [https://practicerom.com/ practice tool], also known as the Practice ROM.

= H =
=== HBA ===
- Horseback Archery. Refers to both the 1000 and 1500 game in the Gerudo Fortress that in vanilla rewards a Heart Piece and Quiver upgrade, respectively.
=== HC ===
- Heart Container/Hyrule Castle.

=== HESS ===
- Hyper [[#Extended Superslide|Extended Superslide]]. A glitch which allows the player to move backwards at the highest sustainable in-game speed. This is almost never seen typed out fully.
=== HF ===
- Hyrule Field.
=== Hookshot Extension ===
- A technique which allows the player to fire their hookshot, longshot, bow, or slingshot from slightly in front of where it would normally fire, allowing you to hook on to things a little bit easier and even shoot through some walls.
=== Hover ===
- In a glitchless context, refers to using the Hover boots to cross a gap. In glitch contexts, can also refer to using [[#ISG|ISG]] and a damage source to literally hover in midair.
=== HP ===
- Heart Piece. Also commonly referred to as PoH or Piece of Heart.

= I =
=== IC ===
- Ice Cavern.
=== IM ===
- An umbrella term for the three glitches: [[#RBA|RBA]], [[#BA|BA]], and [[#GIM|GIM]]. Stands for Item Manipulation.

=== ISG ===
- Infinite Sword Glitch; a glitch which results in your weapon being in a constant attack state.

= J =
=== Jabu ===
- Jabu Jabu's Belly. Sometimes referred to as JJB.

= K =
=== Kak ===
- Short for Kakariko Village.
=== KD ===
- King Dodongo.
=== KF ===
- Kokiri Forest.
=== Know Mode ===
- Exclusive to restreams, this is a point in the randomizer whereby the audience knows the location of every item required to beat the game through the means of watching multiple players at once.
=== KZ ===
- King Zora.

= L =
=== LACS ===
- Light Arrow Cutscene. In randomizer, this mainly refers to the location where you would normally receive the Light Arrows in vanilla.
=== Ladder ===
- A type of randomizer race where a pool of racers are ranked on one leaderboard where rank is determined by a pairing of many 1-vs.-1 races. Please see their [https://ootrladder.com/ website] for more details.
=== Lensless Wasteland ===
- The act of crossing the Haunted Wasteland without the Lens of Truth. The path is always the same, so memorizing it removes the need for following the Poe.
=== LH ===
- Lake Hylia.
=== LLR ===
- Lon Lon Ranch.
=== LW ===
- Lost Woods.

= M =
=== Megaflip ===
- A glitch which allows the player to backflip with maximum sustainable speed to extend its distance.
=== Megasidehop ===
- A glitch which allows the player to sidehop with maximum sustainable speed to extend its distance.
=== MK ===
- Market, specifically, Hyrule Castle Town market.
=== MoT ===
- Mask of Truth. Refers to both the item and the [[#Check|check]] from showing it in the Deku Theatre.

= N =
=== Naked Wasteland ===
- The act of crossing the Haunted Wasteland, although more specifically the quicksand on the Gerudo Fortress side of the Wasteland, without the use of any items. This can be achieved with a well-aimed backwalk.
=== NL ===
- Nayru's Love.
=== No IM/WW ===
- A [[No IM/WW|ruleset]] for racing.
=== No Logic ===
- A setting that will place items into the world completely at random without checking that the game is beatable. Ocarina of Time has many glitches, so most seeds will still be beatable but often may require use of very advanced tech.

= O =
=== Ocarina Minigame ===
- The minigame in Lost Woods in which you repeat back a series of ocarina notes to two skull kids.
=== OGC ===
- Outside Ganon's Castle. Refers to the area where the Rainbow Bridge spawns, the Gold Skulltula there, as well as the Fairy Fountain reward.
=== Online ===
- Refers to the [https://discord.gg/UFVY9DE ModLoader64] emulator and setup which allows multiple people to play in the same game at the same time. Sometimes abbreviated OoTO.

=== OoT ===
- The Legend of Zelda: Ocarina of Time. Also commonly used to refer to the Ocarina of Time item or location.
=== Out of Logic ===
- Obtaining an item or performing an activity outside of the intended order determined by the program's logic.

= P =
=== Path of Gold ===
- A type of [[Hints#Path of Gold|hint]] describing an area which contains an item logically required to collect every Triforce Piece in the seed. Appears only when [[#Triforce Hunt|Triforce Hunt]] is enabled.
=== PCS ===
- [[#Power Crouch Stab|Power Crouch Stab]]
=== PG ===
- Phantom Ganon.
=== Pocket Egg ===
- The first item in the adult trade sequence, ultimately resulting in the Biggoron's Sword.
=== PoG ===
- [[#Path of Gold|Path of Gold]].
=== PoH ===
- Piece of Heart. Also commonly referred to as HP or Heart Piece.
=== Potato ===
- A nickname for the Fairy Ocarina, due to its color and shape.
=== Power Crouch Stab ===
- The damage value used for crouch stabs is the last attack used with a sword/hammer/stick. Most often used in conjuction with a jumpslash to "store" a high damage attack in order to deal damage more quickly. This technique is known as ''Power Crouch Stabbing''. When no sword/hammer/stick has been used since entering the current area the crouch stab will take the damage value of a regular Kokiri Sword slash.

= Q =
=== QPA ===
- Quick Putaway. A glitch which allows the player to store a glitched [[#Power Crouch Stab|Power Crouch Stab]] value.

= R =
=== RA ===
- A common abbreviation for the emulator [[Retroarch]].
=== Reverse Wasteland ===
- The act of traveling the Haunted Wasteland from the Colossus side to the Fortress side. This is considered [[#Out of Logic|Out of Logic]] by default, though can be enabled via the Tricks menu.
=== RBA ===
- Reverse Bottle Adventure. A glitch which allows the player to write values into memory. It is extremely powerful, but very limited.

= S =
=== SFM ===
- Sacred Forest Meadow.
=== ShT ===
- Shadow Temple.
=== Skull Mask ===
- This refers to both the item itself which is part of the Child Trade Quest, as well as the [[#Check|check]] in which the mask is shown off in the Deku Theater.
=== SoA ===
- Stone of Agony.
=== SoS ===
- Song of Storms. Can refer to both the song itself and the location you would normally find it in vanilla.
=== SoT ===
- Song of Time. Can refer to both the song itself and the location you would normally find it in vanilla.
=== Spheres ===
- Spheres are a conceptual explanation of how more things become available to you as you collect more items. It is the "intended path" as written by a computer, but you will likely never actually go from sphere to sphere while playing.
"Sphere 0" is what you can get as soon as you boot up your game without collecting anytime else, such as Mido's house and the freestanding Gerudo Valley HPs.
What you've collected in Sphere 0 enables what you have access to in Sphere 1. Under normal settings, you get an Ocarina from Saria in Sphere 0. So, whatever you get from Ocarina Minigame is acquired in Sphere 1. Let's say that reward is a Scale. If you receive a Scale in Sphere 1, then anything it unlocks is part of that seed's Sphere 2. Let's say you find a Bomb Bag at the Ruto Bottle check. That Bomb Bag is in Sphere 2, and everything it directly unlocks becomes part of Sphere 3.
Keep radiating outward as you collect more unique items that unlock more unique locations until you are able to defeat Ganon.

The description above details how Spheres work for the Playthrough in your Spoiler Log. Colloquially, for example when discussing a race seed, a slightly different variant is also used, where non-randomized checks and events that are the same every seed don't increase the Sphere count. The Ocarina Minigame is placed in Sphere 1 in the above example, whereas in this variant it is counted in Sphere 0 because you can always immediately get the Ocarina if it is unshuffled. Same goes for events such as unlocking Time Travel. Usually only Sphere 0 is discussed this way, because figuring out which check is in which Sphere can get very convoluted and can change over the course of the seed as players find more items.

=== Spoiler Log ===
- A document created by the randomizer which lists all the settings, item locations, hints, etc. This will not open automatically or give you any extra information. It simply serves as a resource in case you get stuck or if you really wanted to know what was in that one chest you forgot.
=== SpT ===
Spirit Temple.
=== SRM ===
- Stale Reference Manipulation. A glitch which allows the player to take advantage of free but uncleared memory to do a variety of things including but not limited to calling arbitrary functions, redirecting pointers, and [[#ACE|Arbitrary Code Execution]].
=== Standard ===
- [[Standard]] is the most common racing [[rules|ruleset]].

= T =
=== TH ===
- [[#Triforce Hunt|Triforce Hunt]].
=== Three Song Route ===
- A common opener for the [[Standard]] weekly races that involves [[#Check|checking]] all 3 child song locations - Zelda's Lullaby, Epona's Song, Saria's Song - in quick succession.
=== ToT ===
- Temple of Time.
=== Trials ===
- Another way to refer to entirety of Ganon's Castle and Ganon's Tower.
=== Triforce Hunt===
- An alternative game mode where pieces of the Triforce are spread throughout the world and you must collect a certain number to win.

= U =

= V =

= W =
=== WaT ===
- Water Temple, sometimes just WT.
=== Way of the Hero ===
- A [[Hints#Way of the Hero|hint]] which describes an area which contains an item that is logically required to beat the game.

=== Weird Egg ===
- The first item in the child trade series, ultimately resulting in the Mask of Truth.
=== Weirdshot ===
- A glitch which allows the player to fire first person weapons from underground.
=== WOTH ===
- [[#Way of the Hero|Way of the Hero]]

= X =

= Y =

= Z =
=== ZD ===
- Zora's Domain.
=== ZF ===
- Zora's Fountain.
=== ZL ===
- An abbreviation for either Zelda's Letter or Zelda's Lullaby. It is often clear from context which is meant. It can also refer to the vanilla location of Zelda's Lullaby to refer to it as a [[#Check|check]].
=== ZR ===
- Zora's River.

Glossary

2022-01-09T21:38:46Z

ShadowShine57: Add adult dungeon appreviations

Most every small community will eventually create its own jargon and abbreviations for things naturally out of the desire to communicate more quickly.  Ocarina of Time and the Randomizer which was built for it is no different.  Below you'll find an alphabetized list of both terminology and abbreviations commonly used in both the Ocarina of Time speedrunning and randomizer communities.  If you join the discord or a stream chat and are curious what something means, but don't want to ask, this is the place for you.

{{TOClimit|limit=2}}

= A =
=== ACE ===
- Arbitrary Code Execution. Allows the player to write data into the game's memory and have it executed as code. This is one of the most powerful glitches any video game can have as it theoretically allows you to rewrite the entire game into something else using nothing but the game itself.
=== AD ===
- An abbreviation for All Dungeons. In randomizer this can refer to both a setting which requires all of the dungeons to be beaten, but often it is refering to a seed where it was not required by the settings to beat every dungeon yet the item placement and ruleset combination forced it. This is also a speedrun category where the goal is to beat every dungeon and reach the credits.
=== All Locations Reachable ===
- A setting available as part of the randomizer which ensures that you can reach every location in the game under your current [[logic]] setting.
=== ALR ===
- [[#All Locations Reachable|All Locations Reachable]].

= B =
=== BA ===
- Bottle Adventure. A glitch which allows the player to write an arbitrary value to their B button.
=== Bait ===
- A term used to describe an item, location, or hint that may be unnecessary if the player knows a way to circumvent it.
=== Barren ===
- A synonym for [[#Foolish|Foolish]].
=== Beatable Only ===
- A reference to turning the [[#All Locations Reachable|All Locations Reachable]] setting off which can logically lock off entire sections of the game, based on an older name for this setting.
=== BGS ===
- Biggoron's Sword.
=== Bingo ===
- A game mode where you generate a 5x5 board of goals to complete. When you've completed a goal you check it off the board. There are many sub-variants of bingo which change how it is played. The most common ways to play, however, are standard bingo (any 5 in a row, column, or diagonal), blackout (complete all 25 goals), and lockout (only 1 person can complete any goal, person who has the most wins).
=== BK ===
- Boss Key.
=== BK Mode ===
- A commonly used phrase in [[Multiworld]] games describing the situation where a player can no longer do any [[#Check|checks]] due to their lacking of items. Stands for "Burger King Mode" after a player actually went to Burger King to get food while their teammates gathered items.
=== Blue Potato ===
- A nickname for the Ocarina of Time, due to its color and shape.
=== BotW ===
- Bottom of the Well. This is also used as an abbreviation for the game The Legend of Zelda: Breath of the Wild. Normally it is clear from context which is meant, however this shared abbreviation is often used in jokes.
=== BQ ===
- Beta Quest. A romhack which randomizes shuffles the entrance table completely randomly. Items remain in their vanilla areas, but those areas can be anywhere.
=== Burning Kak ===
- Alternative name for the Nocturne of Shadow [[#Check|check]], requiring the Forest, Fire, and Water Medallions and then walking into Kakariko Village.

= C =
=== Check ===
- A location in the game where you can receive a randomized item.
=== Chest Size Matches Contents ===
- A setting in the randomizer which changes the appearance of every chest to be in line with what's inside of it.
=== Co-op ===
- Often written as simply "coop", this can be referring to a couple things. "Local coop" is where multiple people play the same seed separately, but share information. "[[#Online|Online]] coop" refers to a separate emulator setup that allows multiple people to play in the same game as the same time.
=== CSMC ===
- [[#Chest Size Matches Contents|Chest Size Matches Contents]].
=== Culling ===
- The act of moving the camera or Link far enough away from an actor so that it ceases updating every frame. This can be used glitchlessly to hold actors in place, most useful for Keese. If glitches are allowed, then it can be used to ignore some collision as well.

= D =
=== Damage ESS ===
- An alternative name for a [[#FESS|FESS]].
=== DC ===
- Dodongo's Cavern.

=== DDR ===
- [[Dungeon Door Requirement]]. A [[Rules|ruleset]] for racing which allows more glitches than [[#Standard|Standard]].

=== DMC ===
- Death Mountain Crater.
=== DMT ===
- Death Mountain Trail.
=== DoT ===
- The Door of Time. Openable with just the [[#SoT|Song of Time]]. One of the oldest glitches in Ocarina of Time is the DoT skip, allowing the player to become adult without first obtaining the Song of Time.
=== DT ===
- Deku Tree. An uncommon abbreviation.

= E =
=== Egg ===
- Can refer to either the [[#Pocket Egg|Pocket Egg]] or the [[#Weird Egg|Weird Egg]].
=== Entrance Randomizer ===
- A setting which shuffles the entrances in the world giving it an entirely new geography.
=== ER ===
- [[Entrance Randomizer|Entrance Randomizer]].

=== ESS ===
- Extended Superslide. However, this acronym is most commonly used in reference to the region on the control stick in which the game recognizes minimal input. Link will turn in place at a constant angle per frame, which is exceedingly useful for setups. You will almost never see this written out.

=== ESS Turns ===
- Using [[#ESS|ESS]] position in small increments to turn specific angles. Often seen in discrete amounts such as "3 ess turns right" or "3 ess right."

= F =
=== FESS ===
- An abbreviation for Forward [[#Extended Superslide|Extended Superslide]]. Also known as a [[#Damage ESS|Damage ESS]], this is a method of failure when attempting a [[#HESS|HESS]]. This is almost never seen typed out fully.
=== FiT ===
- Fire Temple.
=== Flame Storange ===
- A glitch which allows you to remotely light a Deku Stick on fire, allowing you to carry it a longer distance.
=== Foolish ===
- Used to describe a region of the game which is devoid of logically useful items. Hints will say that searching the area is a "[[Hints#Foolish Choice|Foolish Choice]]."

=== FoT ===
- Forest Temple.
=== Freestanding ===
- This is used to describe [[#Check|checks]] which are not in a chest and instead just items on the ground to be picked up. In randomizer, they will take on the appearance of the item which you will receive as in vanilla they are all Heart Pieces, Heart Containers, and small keys. Be careful of ice traps!
=== Frog Song ===
- After playing the 6 white note songs for the frogs in Zora's River, you can prompt them to play a bug catching game. The goal of the game is to press the button of the corresponding frog when the bug is over their head. However, the order of this song never changes. It is always: A < > v < > v A v A v > < A

[[File:FrogSong.png|450px|center]]

=== FW ===
- Farore's Wind

= G =
=== GBK ===
- Ganon's Boss Key.
=== GC ===
- An abbreviation for either Ganon's Castle or Goron City. This is used inconsistently, but is usually clear from context.

=== GF ===
- Gerudo Fortress.
=== GIM ===
- Get Item Manipulation. A glitch which allows the player to modify the item which is queued to be given to them.
=== GJ ===
- [[#Groundjump|Groundjump]].
=== GK ===
- Giant's Knife. This is a very uncommon abbreviation. Can refer to both the [[#Check|check]] and the item itself.
=== Glow Mode ===
- The point in a randomizer game when you only need to gather the Light Arrows to proceed to the end of the game.
=== Go Mode ===
- The point in a randomizer game when you either have or know the location of every item you require to beat the game.
=== Greg ===
- A nickname for the "Rupee (1)" item, standing for Green Rupee of Eternal Glory.
=== Groundjump ===
- A glitch that allows the player to cancel a backflip or sidehop, effectively giving Link the ability to jump slightly higher.
=== GS ===
- Gold Skulltula.
=== GT ===
- An abbreviation for Ganon's Tower. This is not very commonly used.
=== GTG ===
- Gerudo Training Ground.

=== GV ===
- Gerudo Valley.
=== GY ===
- An uncommon abbreviation for the Graveyard.
=== GZ ===
- Our [https://practicerom.com/ practice tool], also known as the Practice ROM.

= H =
=== HBA ===
- Horseback Archery. Refers to both the 1000 and 1500 game in the Gerudo Fortress that in vanilla rewards a Heart Piece and Quiver upgrade, respectively.
=== HC ===
- Heart Container/Hyrule Castle.

=== HESS ===
- Hyper [[#Extended Superslide|Extended Superslide]]. A glitch which allows the player to move backwards at the highest sustainable in-game speed. This is almost never seen typed out fully.
=== HF ===
- Hyrule Field.
=== Hookshot Extension ===
- A technique which allows the player to fire their hookshot, longshot, bow, or slingshot from slightly in front of where it would normally fire, allowing you to hook on to things a little bit easier and even shoot through some walls.
=== Hover ===
- In a glitchless context, refers to using the Hover boots to cross a gap. In glitch contexts, can also refer to using [[#ISG|ISG]] and a damage source to literally hover in midair.
=== HP ===
- Heart Piece. Also commonly referred to as PoH or Piece of Heart.

= I =
=== IC ===
- Ice Cavern.
=== IM ===
- An umbrella term for the three glitches: [[#RBA|RBA]], [[#BA|BA]], and [[#GIM|GIM]]. Stands for Item Manipulation.

=== ISG ===
- Infinite Sword Glitch; a glitch which results in your weapon being in a constant attack state.

= J =
=== Jabu ===
- Jabu Jabu's Belly. Sometimes referred to as JJB.

= K =
=== Kak ===
- Short for Kakariko Village.
=== KD ===
- King Dodongo.
=== KF ===
- Kokiri Forest.
=== Know Mode ===
- Exclusive to restreams, this is a point in the randomizer whereby the audience knows the location of every item required to beat the game through the means of watching multiple players at once.
=== KZ ===
- King Zora.

= L =
=== LACS ===
- Light Arrow Cutscene. In randomizer, this mainly refers to the location where you would normally receive the Light Arrows in vanilla.
=== Ladder ===
- A type of randomizer race where a pool of racers are ranked on one leaderboard where rank is determined by a pairing of many 1-vs.-1 races. Please see their [https://ootrladder.com/ website] for more details.
=== Lensless Wasteland ===
- The act of crossing the Haunted Wasteland without the Lens of Truth. The path is always the same, so memorizing it removes the need for following the Poe.
=== LH ===
- Lake Hylia.
=== LLR ===
- Lon Lon Ranch.
=== LW ===
- Lost Woods.

= M =
=== Megaflip ===
- A glitch which allows the player to backflip with maximum sustainable speed to extend its distance.
=== Megasidehop ===
- A glitch which allows the player to sidehop with maximum sustainable speed to extend its distance.
=== MoT ===
- Mask of Truth. Refers to both the item and the [[#Check|check]] from showing it in the Deku Theatre.

= N =
=== Naked Wasteland ===
- The act of crossing the Haunted Wasteland, although more specifically the quicksand on the Gerudo Fortress side of the Wasteland, without the use of any items. This can be achieved with a well-aimed backwalk.
=== NL ===
- Nayru's Love.
=== No IM/WW ===
- A [[No IM/WW|ruleset]] for racing.
=== No Logic ===
- A setting that will place items into the world completely at random without checking that the game is beatable. Ocarina of Time has many glitches, so most seeds will still be beatable but often may require use of very advanced tech.

= O =
=== Ocarina Minigame ===
- The minigame in Lost Woods in which you repeat back a series of ocarina notes to two skull kids.
=== OGC ===
- Outside Ganon's Castle. Refers to the area where the Rainbow Bridge spawns, the Gold Skulltula there, as well as the Fairy Fountain reward.
=== Online ===
- Refers to the [https://discord.gg/UFVY9DE ModLoader64] emulator and setup which allows multiple people to play in the same game at the same time. Sometimes abbreviated OoTO.

=== OoT ===
- The Legend of Zelda: Ocarina of Time. Also commonly used to refer to the Ocarina of Time item or location.
=== Out of Logic ===
- Obtaining an item or performing an activity outside of the intended order determined by the program's logic.

= P =
=== Path of Gold ===
- A type of [[Hints#Path of Gold|hint]] describing an area which contains an item logically required to collect every Triforce Piece in the seed. Appears only when [[#Triforce Hunt|Triforce Hunt]] is enabled.
=== PCS ===
- [[#Power Crouch Stab|Power Crouch Stab]]
=== PG ===
- Phantom Ganon.
=== Pocket Egg ===
- The first item in the adult trade sequence, ultimately resulting in the Biggoron's Sword.
=== PoG ===
- [[#Path of Gold|Path of Gold]].
=== PoH ===
- Piece of Heart. Also commonly referred to as HP or Heart Piece.
=== Potato ===
- A nickname for the Fairy Ocarina, due to its color and shape.
=== Power Crouch Stab ===
- The damage value used for crouch stabs is the last attack used with a sword/hammer/stick. Most often used in conjuction with a jumpslash to "store" a high damage attack in order to deal damage more quickly. This technique is known as ''Power Crouch Stabbing''. When no sword/hammer/stick has been used since entering the current area the crouch stab will take the damage value of a regular Kokiri Sword slash.

= Q =
=== QPA ===
- Quick Putaway. A glitch which allows the player to store a glitched [[#Power Crouch Stab|Power Crouch Stab]] value.

= R =
=== RA ===
- A common abbreviation for the emulator [[Retroarch]].
=== Reverse Wasteland ===
- The act of traveling the Haunted Wasteland from the Colossus side to the Fortress side. This is considered [[#Out of Logic|Out of Logic]] by default, though can be enabled via the Tricks menu.
=== RBA ===
- Reverse Bottle Adventure. A glitch which allows the player to write values into memory. It is extremely powerful, but very limited.

= S =
=== SFM ===
- Sacred Forest Meadow.
=== ShT ===
- Shadow Temple.
=== Skull Mask ===
- This refers to both the item itself which is part of the Child Trade Quest, as well as the [[#Check|check]] in which the mask is shown off in the Deku Theater.
=== SoA ===
- Stone of Agony.
=== SoS ===
- Song of Storms. Can refer to both the song itself and the location you would normally find it in vanilla.
=== SoT ===
- Song of Time. Can refer to both the song itself and the location you would normally find it in vanilla.
=== Spheres ===
- Spheres are a conceptual explanation of how more things become available to you as you collect more items. It is the "intended path" as written by a computer, but you will likely never actually go from sphere to sphere while playing.
"Sphere 0" is what you can get as soon as you boot up your game without collecting anytime else, such as Mido's house and the freestanding Gerudo Valley HPs.
What you've collected in Sphere 0 enables what you have access to in Sphere 1. Under normal settings, you get an Ocarina from Saria in Sphere 0. So, whatever you get from Ocarina Minigame is acquired in Sphere 1. Let's say that reward is a Scale. If you receive a Scale in Sphere 1, then anything it unlocks is part of that seed's Sphere 2. Let's say you find a Bomb Bag at the Ruto Bottle check. That Bomb Bag is in Sphere 2, and everything it directly unlocks becomes part of Sphere 3.
Keep radiating outward as you collect more unique items that unlock more unique locations until you are able to defeat Ganon.

The description above details how Spheres work for the Playthrough in your Spoiler Log. Colloquially, for example when discussing a race seed, a slightly different variant is also used, where non-randomized checks and events that are the same every seed don't increase the Sphere count. The Ocarina Minigame is placed in Sphere 1 in the above example, whereas in this variant it is counted in Sphere 0 because you can always immediately get the Ocarina if it is unshuffled. Same goes for events such as unlocking Time Travel. Usually only Sphere 0 is discussed this way, because figuring out which check is in which Sphere can get very convoluted and can change over the course of the seed as players find more items.

=== Spoiler Log ===
- A document created by the randomizer which lists all the settings, item locations, hints, etc. This will not open automatically or give you any extra information. It simply serves as a resource in case you get stuck or if you really wanted to know what was in that one chest you forgot.
=== SpT ===
Spirit Temple.
=== SRM ===
- Stale Reference Manipulation. A glitch which allows the player to take advantage of free but uncleared memory to do a variety of things including but not limited to calling arbitrary functions, redirecting pointers, and [[#ACE|Arbitrary Code Execution]].
=== Standard ===
- [[Standard]] is the most common racing [[rules|ruleset]].

= T =
=== TH ===
- [[#Triforce Hunt|Triforce Hunt]].
=== Three Song Route ===
- A common opener for the [[Standard]] weekly races that involves [[#Check|checking]] all 3 child song locations - Zelda's Lullaby, Epona's Song, Saria's Song - in quick succession.
=== ToT ===
- Temple of Time.
=== Trials ===
- Another way to refer to entirety of Ganon's Castle and Ganon's Tower.
=== Triforce Hunt===
- An alternative game mode where pieces of the Triforce are spread throughout the world and you must collect a certain number to win.

= U =

= V =

= W =
=== WaT ===
- Water Temple, sometimes just WT.
=== Way of the Hero ===
- A [[Hints#Way of the Hero|hint]] which describes an area which contains an item that is logically required to beat the game.

=== Weird Egg ===
- The first item in the child trade series, ultimately resulting in the Mask of Truth.
=== Weirdshot ===
- A glitch which allows the player to fire first person weapons from underground.
=== WOTH ===
- [[#Way of the Hero|Way of the Hero]]

= X =

= Y =

= Z =
=== ZD ===
- Zora's Domain.
=== ZF ===
- Zora's Fountain.
=== ZL ===
- An abbreviation for either Zelda's Letter or Zelda's Lullaby. It is often clear from context which is meant. It can also refer to the vanilla location of Zelda's Lullaby to refer to it as a [[#Check|check]].
=== ZR ===
- Zora's River.

Plandomizer

2021-11-13T21:37:37Z

ShadowShine57: Remove dev version comments now that 6.1 is out

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

'''Please note there are two starting item sections''', this section refers to the one after randomized_settings in a spoiler log. The starting items, starting equipment, and starting songs sections within the settings section have a different format, but as listing what falls under each here would be a long section, please instead generate a spoiler log using the GUI to see where items need to be listed.

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by the settings chosen, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there.
* A list containing multiple items to randomly choose from to place there.
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

Item names can also take advantage of the wildcard <kbd><samp>*</kbd></samp> and the not indicator <kbd><samp>!</kbd></samp>.

For example, this will guarantee Link starts with a medallion, Spirit Temple will always have a stone, and one of the shields can be found in Mido's House.
<pre style="display:inline-block">
"locations": {
"Links Pocket": "*Medallion",
"Twinrova": "!Medallion",
"KF Midos Top Left Chest": "*Shield"
}
</pre>

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Shop Location Prices ====
When defining a shop location, rather than simply assigning a string of the item name to the location, you must define a dictionary with the properties item (a string of the item name) and price (a number). So for example, a shop item location will look something like this:
<blockquote><pre>
"KF Shop Item 7": {
"item": "Light Arrows",
"price": 40
},
</pre></blockquote>
If you try to set a price higher than 999, it will simply be capped to 999 so it won't be impossible to buy. However, you can actually plando negative prices, which will give the player the absolute value of the price. So if you plando a shop item to be -10 rupees, the player will be able to purchase it with any wallet size and it will give them 10 rupees. Due to reasons related to the binary numbers used to represent the prices in-game, the lowest possible price is -32768.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Vanilla - Places whatever was on that location in the original game. Also applies to MQ locations.
#MajorItem - Places a settings-dependent major item at that location.
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

You can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
<blockquote><pre>
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
</pre></blockquote>

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Custom Goals ====

As of version 6.0.111, the '''goal''' hint type can use built-in goals for the bridge, Ganon's Castle Boss Key, and Trials conditions as well as custom goals defined in the hint distribution. Custom goals use the <code>custom_goals</code> key inside a custom hint distribution as shown in the example below.

<pre>
{
"settings": {
"hint_dist_user": {
...
"custom_goals": [
{
"category": "all_items",
"priority": 1,
"minimum_goals": 4,
"lock_entrances"=["Ganons Castle Grounds -> Ganons Castle Lobby"],
"goals": [
{
"name": "memes",
"hint_text": "path of memes",
"color": "Light Blue",
"items": [
{"name": "Ice Arrows", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Double Defense", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Stone of Agony", "quantity": 2, "minimum": 1, "hintable": true},
{"name": "Nayrus Love", "quantity": 2, "minimum": 1, "hintable": true}
]
}
]
}
],
...
}
}
}
</pre>

===== '''Category Definition''' =====

Both goal categories and individual goals can be defined. Goals can be assigned to existing default categories by setting the `category` key to one of the following:

* '''rainbow_bridge''' - Includes goals for dungeon rewards or skulltula tokens. Not active with open bridge.
* '''ganon_bosskey''' - Includes goals for dungeon rewards, skulltula tokens, or Ganon's Boss Key directly. Not active with the boss key removed or vanilla.
* '''trials''' - Includes path to the Tower goal for any enabled trials. Only active with non-zero trials
* '''triforce_hunt''' - Includes path of gold goal for Triforce Pieces. Only active when Triforce Hunt is enabled
* '''ganon''' - Equivalent to way of the hero. Only active with open bridge and Ganon's Castle Boss Key removed/vanilla and zero trials.

===== '''Category Priority''' =====

Custom goals follow the same category priority rules as default goals. A custom goal in the <code>ganon_bosskey</code> category will not include items that are part of the bridge category. A custom category with a priority between the <code>bridge</code> and <code>ganon_bosskey</code> categories will not include items from the <code>bridge</code> category, and the <code>ganon_bosskey</code> category will not include items from <code>bridge</code> or the custom category. Caution should be used adding custom categories before or in the middle of default categories for this reason. If a custom category has the same priority as a default goal, a required item can be included for goals in both categories. Default priorities are:

* '''rainbow_bridge''' - 10
* '''ganon_bosskey''' - 20 for dungeon rewards/tokens, 30 for keysanity variants
* '''trials''' - 30
* '''triforce_hunt''' - 30
* '''ganon''' - 30

===== '''Category Minimum Goals''' =====

Minimum goals determine if the overall category objective is fulfilled. For example, the <code>bridge</code> category has a minimum requirement of however many dungeon rewards are needed to spawn the bridge to Ganon's Castle. If there are not enough obtainable goals in the world, the category objective is not fulfilled and goal hints will not be generated for that category. This system is available to custom goal categories with the <code>minimum_goals</code> key.

===== '''Category Entrance Locks''' =====

Entrances between regions can be disconnected to artificially restrict world access for a category. This was designed primarily for the rainbow bridge to only hint goals reachable without access to Ganon's Castle. The system can be used with custom goal categories by listing entrances to lock in the <code>lock_entrances</code> key. Entrance names use the syntax "Region A -> Region B", where the different regions are named in the logic files. This has only been tested with overworld entrances, but should work with dungeon internal entrances as well.

It is not possible to change default goal category entrance locks.

===== '''Goal Definition''' =====

All goal names must be unique within a category. Goal names are only used internally. The <code>hint_text</code> key defines how the goal is presented in the spoiler log and in hints. Default goals use the convention "path to <X>".

Goal colors change how the path is colored. The hinted area with the required item will always be light blue. Valid colors are:
<pre style="display:inline-block">* White
* Red
* Green
* Blue
* Light Blue
* Pink
* Yellow
* Black</pre>

Required item definition can include any number of items for each goal. Each item has four keys:

* name - Item name as defined in <code>ItemList.py</code>
* quantity - Maximum possible items to complete the goal
* minimum - Minimum possible items to complete the goal
* hintable - Whether or not this item can be directly hinted, or only items required to obtain this item. In both cases required items are a possibility for hints.

The <code>quantity</code> key must be equal to or greater than the <code>minimum</code> key. The <code>minimum</code> key cannot be zero. The randomizer will consider a goal valid for hints if the all minimum items are reachable. It will attempt to hint items required for all copies of this item up to the maximum <code>quantity</code>, but will automatically reduce the <code>quantity</code> to the maximum reachable copies in beatable only or with a category lock defined.

Required items for goals must be major items. Rupees and heart containers are not major items and will cause the goal to always be unobtainable and thus unhintable.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Multiple text boxes can be assigned to a single gossip stone by separating the strings with <kbd>^</kbd>. However, this is not strictly required as the randomizer will automatically break up strings that are too long for a single text box.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">White
Red
Green
Blue
Light Blue
Pink
Yellow
Black</pre>

==== Special Characters ====
You can also use some special characters within your hints. In terms of normal characters, you can use within your hint text the following just by putting them within the string as usual: À, Á, Â, Ä, Ç, È, É, Ê, Ë, Ï, Ô, Ö, Ù, Û, Ü, the lowercase versions of all previous characters, and ß.

You can also specify codes for special, in-game button characters using Unicode values. Reference the following table for the value for each button character, and then it can be specified within your hint text with \u00xx, where xx is the value from the table. For example, the A button has a value of 9F, so it would be printed using \u009F within your hint. [https://i.imgur.com/sfbnKF6.png Here] you can see what these characters look like in-game.

{| class="wikitable"
|-
| Code || 9F || A0 || A1 || A2 || A3 || A4 || A5 || A6 || A7 || A8 || A9 || AA
|-
| Button Displayed || A || B || C || L || R || Z || C-up || C-down || C-left || C-right || Down arrow || Joystick
|}

==== Sound Effects ====
Each text box can be equipped with a sound effect. The full list of sound effect IDs can be found at [https://wiki.cloudmodding.com/oot/Sound_Effect_Ids on CloudModding], but it takes a little bit of work to convert them to the correct format. Sound effects are designated by <kbd>${12 x8 yy}</kbd>, where x is the "Bank" as indicated on CloudModding and yy is the sound number within the bank. The <kbd>8</kbd> will be swapped for <kbd>9</kbd> if the sound number is greater than FF (i.e. it has 3 characters on CloudModding).

Please note that only one sound effect will play per gossip stone, but it will play on whichever text box <kbd>${12 x8 yy}</kbd> is placed in.

'''Warning''': Looping sounds will not stop until Link leaves the area or dies, so it's recommended to avoid these sounds.

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

'''Helpful Tutorial Message''':
<blockquote><pre>
"gossip_stones": {
"KF (Outside Storms)": { "text": "To target, press \u00A4" }
}
</pre></blockquote>

'''Appreciation''':
<blockquote><pre>
"gossip_stones": {
"KF (Deku Tree Right)": { "text": "Dampé is a pretty cool guy." }
}
</pre></blockquote>

'''Sound Effects Added''':
<blockquote><pre>
"gossip_stones": {
"ToT (Left)": { "text": "The time is ${1F}.^${12 28 df}The cow goes moo." },
"ToT (Left-Center)": { "text": "${12 39 C7}Ganondorf laughs maniacally." }
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). If this is done incorrectly, then the randomizer will skip it and not output an error message. This means that some other track will be placed there instead without your knowledge.

=== Plando Exclusive Features ===
As of v6.1 there is a setting that can only be changed through the use of Plandomizer.

==== Light Arrows Cutscene Condition ====

This is a setting that determines what the condition is for triggering the Light Arrows Cutscene (LACS) event. This was originally made a setting so that Ganon's Boss Key could be placed here with the condition being, for example, a certain number of dungeon rewards. This would allow players to have the Rainbow Bridge open from the start for early access to Ganon's Castle while still locking Ganondorf behind a certain condition. Now that Ganon's Boss Key can be given to the player anywhere, this setting is no longer needed and was made to be Plando-only rather than removed completely.

To use this setting, add the following to the settings dictionary of the Plando file

<pre>
"lacs_condition": "X",
</pre>
where valid settings for <code>X</code> are <code>Stones</code>, <code>Medallions</code>, <code>Dungeons</code> and <code>Tokens</code>. If you wish for the LACS condition to remain vanilla, then simply don't add anything to your Plando file as vanilla is the default setting. Finally, you'll want to add the following line
<pre>
"lacs_stones/medallions/dungeons/tokens": Y,
</pre>
where <code>Y</code> is a number (note the lack of quotation marks) and where you should choose <code>lacs_medallions/stones/dungeons/tokens</code> as appropriate (so <code>lacs_stones</code> if you picked Spiritual Stones as your condition, <code>lacs_medallions</code> if you picked Medallions etc.). Keep in mind that the last line of the settings dictionary should '''not''' have a comma at the end, so remove it if appropriate.

==== Examples ====
'''Set the LACS condition to be 69 Gold Skulltula Tokens''':
<blockquote><pre>
"lacs_condition": "Tokens",
"lacs_tokens": 69
</pre></blockquote>

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Dolphin

2021-10-12T16:13:51Z

ShadowShine57: Add info on how to manually adjust sensitivity

Dolphin is a popular emulator for both Gamecube and Wii games, but it can also be used to play Ocarina of Time Randomizer on thru the Wii's Virtual Console mode. Dolphin is very good at emulating Wii VC and only suffers from potential slight additional lag in certain areas (such as Market as child), which can be mitigated using settings discussed below.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to softmod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update. You will need a version specific to the operating system you use, see below for details.

=== Windows ===

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png|RTENOTITLE]]

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png|RTENOTITLE]]

=== Mac OS ===

On the Dolphin page, download the latest MacOS Intel version and drag to Application folder per normal installation.

[[File:MacDownloadPage.png|Mac Download Page]]

The Disk Image (DMG) will include Dolphin and the Dolphin Updater.

[[File:DMG.png|Mac OS Dolphin DMG]]

Similar to the Windows setup, create a filepath directory to where the WAD will be located.

[[File:DolphinMacEmu.png|Dolphin main screen]]

=== Controller Configuration ===

Click on <kbd><samp>Controllers</samp></kbd> on the home page. Controllers can be setup either as "GameCube Controllers", or as "Wii Remotes". For the purpose of the randomizer your controller will need to be configured as a "GameCube Controller" (even if it is, say, an Xbox controller). Under Gamecube controllers, click <samp>Configure</samp> next to Port 1.

[[File:DolphinControlConfig1.png|275px|DolphinControlConfig1.png]]

If you are using a Gamecube Controller with a Wii U Adapter by either Nintendo or Mayflash (Wii U mode), then your controller should be detected and configured automatically and the new window that opens will simply ask you to enable/disable the Rumble Pak.

[[File:Gcnadapter.png|RTENOTITLE]]

For reference, these are the default controller mappings Dolphin will use. Keep in mind that if you've used the webpatcher, or gzinjectgui with the right configuration, that D-pad left/right/down will be overwritten to properly work with boots/ocarina on D-pad.

[[File:Gamecube Controls.png|RTENOTITLE]]

If you are using any other controller, or if you're using a Gamecube adapter in PC mode, then you will need to configure the controller yourself. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig2.png|725px|DolphinControlConfig2.png]]

[[File:DolphinControlerConfig.png|Controller Configuration screen]]

If you find the sensitivity is not to your liking even after calibrating, you can right click the gray box for each direction on the joystick and adjust the range. Lower range is lower sensitivity. Note you must set the range for each direction individually.

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>. This ensures that you don't get a PAL frame rate.

[[File:DolphinRegion.png|350px|DolphinRegion.png]]

Next, close the window and under <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked. This fixes the black pause screens

[[File:EFBImage.png|Setting for EFB]]

=== Enable FPS Display ===

Under <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>General</samp></kbd>, check the box which says <samp>Show FPS</samp>.

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required. If there is already an in-game save file present, delete it before starting the new seed.

== After Finishing a Seed ==

Since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

=== Recommended Baseline Settings ===

If you are experiencing lag, these are optional settings to change from default.

First go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp></kbd>, and then in the <samp>General</samp> tab change the <samp>Backend</samp> from <samp>OpenGL</samp> to <samp>Vulcan</samp> if you are on Windows. Dolphin recommends switching this driver as there may or may not be performance driven issues using OpenGL and its compatibility: [https://dolphin-emu.org/docs/guides/performance-guide/ Dolphin Performance Page]

[[File:VideoDriver.png|Video Driver Screen]]

Second, there are optional graphics settings enabled for more frame rate heavy games which are not required for Ocarina of Time. Below are some settings to verify if you are experiencing lag and what to uncheck.

[[File:VulcanGraphicsConfigEnhancements.png|Under the Enhancements tab]]

[[File:VulcanGraphicsConfigAdvanced.png|Advanced Tab]]

=== Graphical Enhancements ===

Depending on the power of your computer, you may want to enable some graphics enhancements. If your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px|DolphinEnhancements.png]]

=== Aspect Ratio ===

Go to <kbd><samp>Options</samp> ⇒ <samp>Graphics Settings</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp> </kbd>, and select whatever you prefer. Note that if you update Dolphin, this setting may return to its default state of 16x9.

[[File:DolphinAspect.png|RTENOTITLE]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, please come to <kbd><samp>#setup-support</samp></kbd> on [https://discord.gg/q6m6kzK our Discord].

=== MacOS will not open Dolphin ===

Some security settings may affect whether the application has privledges to write to a file directory. This can be overridden by giving permission to Dolphin to write to Finder. Open Terminal and in the command line copy these two commands and run them in one after the other:

<samp>sudo xattr -r -d com.apple.quarantine /path/to/Dolphin.app</samp>

<samp>sudo xattr -r -d com.apple.quarantine /path/to/DolphinUpdater.app</samp>

Change where it says path to your path directory location before running the command. You can copy the path by right clicking Dolphin.app with <samp>Opt key</samp> held and click <samp>Copy Path Name</samp>.

After running the commands, Dolphin should reopen normally.

=== Performance may be poor message on startup ===

When starting the emulator, yellow text may appear which says "Performance may be poor". This only occurs on older computers or computers with specifications lower than Dolphin recommends. Refer to the previous section on Optional Settings to decrease Graphical Enhancements and change Video Driver. Actual gameplay may not be affected, however you may experience some lag.

[[File:PerformanceMayBePoor.png|Performance may be poor]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png|RTENOTITLE]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Graphical_Enhancements your graphical enhancements].

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. '''This should be a last resort''', go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). '''<span>This is not allowed for racing.</span>'''

[[File:DolphinOverclock.png|RTENOTITLE]]

=== The Wii Home Menu Randomly Pops Up ===

Click on <kbd><samp>Controllers</samp></kbd> on the home page and then either untick <samp>Background Input</samp> (your controller inputs will still be registered with this setting unticked even when the window is unfocused), or change the <samp>HOME</samp> binding of <samp>Wii Remote 1</samp>.

=== GFX FIFO Unknown Opcode on Resetting ===

This is a known bug with resetting VC on Dolphin. You can click OK on both dialogs that pop up and then won't have to worry about it again until you restart Dolphin itself. You can also go to <kbd><samp>Options</samp> ⇒ <samp>Configuration</samp> ⇒ <samp>Interface</samp></kbd> and disable <samp>Use Panic Handlers</samp> to always ignore it.

Multiworld

2021-09-24T18:34:34Z

ShadowShine57: Add info about a cause for unprotected call error

The aim of this page is to help the reader set up [[Bizhawk]] for 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 need to make use of "lua scripts". As written, these are only compatible with Bizhawk, however the ModLoader64 devs have made a copy which is compatible with ModLoader64. ([https://discord.gg/mWDztG For assistance with ModLoader64, please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

=== 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 From Seed</code>. 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 ==

=== 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.3 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.3 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.3 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.3 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.3 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.3 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. '''<span style="color:red">In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!</span>''' 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.3 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 Ocarina of Time Randomizer Discord, you can assign the Multiworld role to yourself by going to the [https://discordapp.com/channels/274180765816848384/478962049079050241 #chat-bot] channel and typing <code>!role Multiworld</code> - 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 [https://discordapp.com/channels/274180765816848384/535739089521999883 #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) ===

==== Windows 7 ====

If you are running Windows 7 you will need to enable remote Powershell script execution, and make sure Powershell is updated.

First, go to the [https://docs.microsoft.com/en-us/powershell/scripting/install/installing-windows-powershell?view=powershell-6#upgrading-existing-windows-powershell|Microsoft Installing Powershell page] and navigate to the download page for the the latest Windows 7 SP1 Powershell version. At the time of writing it is WMF 5.1. The file on the download page you want to download is named similar to <code>Win7AndW2K8R2-KB3191566-x64.zip</code>. Run the <code>.msu</code> file inside of the zip file and it should update Powershell.

==== 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 [[#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 [[#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.

=== 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, '''<span style="color:red">DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!</span>''' 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]]

== 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 OoTR Discord Server.

==== 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 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.

Editing RAM

2021-07-18T23:00:47Z

ShadowShine57: Add screenshot for how to view memory

This page will tell you how to use emulator tools to add items to your inventory. This is useful for fixing bugged or softlocked seeds, resuming after losing a save, recreating issues on seeds without having to play through them, or just for fun.

RAM is temporary memory within a system that holds values currently being used by the running program. Memory is accessed via addresses, which are represented as strings of hexadecimal numbers (more on those later). For our purposes, we are interested in certain addresses in RAM which are the [https://wiki.cloudmodding.com/oot/Save_Format#Save_Context "Save Context"] of OoT. The Save Context is everything that is stored when you save your game. It includes things like story and event flags, your current location, how many hearts you have, and importantly for this page, items obtained. Since the save context is checked when the game is deciding what items to place in your inventory, by overwriting the values at these addresses in RAM we can easily give the player items.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]][[File:DolphinViewMemory.png|500px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive to use. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure how to add hex numbers, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

=== Wii Virtual Console / Virtual Wii ===

It is possible to transfer your save file from Wii VC/vWii (the latter is unconfirmed, but should theoretically work the same) onto an SD card, import it into Dolphin, make changes on Dolphin and then transfer the save file back onto your Wii/Wii U. To do this you'll first want to transfer your save file to your SD card thru the Wii system menu. Turn off the Wii/Wii U and inject the SD card into your computer. On your SD card navigate to <kbd><samp>private</samp> ⇒ <samp>wii</samp> ⇒ <samp>title</samp> ⇒ <samp>[Channel ID]</samp></kbd>. The Channel ID will be 4 letters, most likely <code>NICE</code> or <code>NRKE</code>. Make a backup of <samp>data.bin</samp> if you wish. Now open [[Dolphin]] and load the WAD that you were playing so it can create a save file. Right-click the WAD in the list of games and choose <kbd><samp>Open Wii Save Folder</samp></kbd>. There should be a <samp>banner.bin</samp> file in here. If not, load the WAD again until there is one (it should be there once the N64 logo appears). Stop the emulation and go to <kbd><samp>Tools</samp> ⇒ <samp>Import Wii Save...</samp></kbd>. Navigate to the <samp>data.bin</samp> on your SD card and click Open. This should properly import the Wii save file for use on Dolphin. If there is an error about NAND being corrupt, then follow the instructions to clean it. Also make sure that the <samp>banner.bin</samp> file was created. Now you can make your changes [https://wiki.ootrandomizer.com/index.php?title=Editing_RAM#Dolphin as described in the Dolphin section].

After you've made your changes, go to <kbd><samp>Tools</samp> ⇒ <samp>Export All Wii Saves</samp></kbd> and select a folder. You can just create a temporary folder on your Desktop. In this folder navigate to <kbd><samp>private</samp> ⇒ <samp>wii</samp> ⇒ <samp>title</samp> ⇒ <samp>[Channel ID]</samp></kbd> and you should see a <samp>data.bin</samp> again. Copy this to your SD card in the same location and overwrite the existing file. Safely eject the SD card from your computer, insert it into the Wii/Wii U and then copy/move your save file from your SD card back onto your Wii/Wii U. Now when you load your seed it should have the changes you made on Dolphin.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide and are essentially "entangled" with each other and the Progressive Strength, Wallet and Scale Upgrades. So to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

File:DolphinViewMemory.png

2021-07-18T22:58:17Z

ShadowShine57:

Editing RAM

2021-07-17T23:17:46Z

ShadowShine57: Add use of lost saves

''This page is still a work in progress''

This page will tell you how to use emulator tools to add items to your inventory. This is useful for fixing bugged or softlocked seeds, resuming after losing a save, recreating issues on seeds without having to play through them, or just for fun.

RAM is temporary memory within a system that holds values currently being used by the running program. Memory is accessed via addresses, which are represented as strings of hexadecimal numbers (more on those later). For our purposes, we are interested in certain addresses in RAM which are the [https://wiki.cloudmodding.com/oot/Save_Format#Save_Context "Save Context"] of OoT. The Save Context is everything that is stored when you save your game. It includes things like story and event flags, your current location, how many hearts you have, and importantly for this page, items obtained. Since the save context is checked when the game is deciding what items to place in your inventory, by overwriting the values at these addresses in RAM we can easily give the player items.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive to use. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure how to add hex numbers, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide and are essentially "entangled" with each other and the Progressive Strength, Wallet and Scale Upgrades. So to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

Editing RAM

2021-07-17T23:05:18Z

ShadowShine57: Slight clarification on what is being overwritten

''This page is still a work in progress''

This page will tell you how to use emulator tools to add items to your inventory. This is useful for fixing bugged or softlocked seeds, recreating issues on seeds without having to play through them, or just for fun.

RAM is temporary memory within a system that holds values currently being used by the running program. Memory is accessed via addresses, which are represented as strings of hexadecimal numbers (more on those later). For our purposes, we are interested in certain addresses in RAM which are the [https://wiki.cloudmodding.com/oot/Save_Format#Save_Context "Save Context"] of OoT. The Save Context is everything that is stored when you save your game. It includes things like story and event flags, your current location, how many hearts you have, and importantly for this page, items obtained. Since the save context is checked when the game is deciding what items to place in your inventory, by overwriting the values at these addresses in RAM we can easily give the player items.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive to use. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure how to add hex numbers, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide and are essentially "entangled" with each other and the Progressive Strength, Wallet and Scale Upgrades. So to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

Editing RAM

2021-07-17T23:02:14Z

ShadowShine57: Add introduction

''This page is still a work in progress''

This page will tell you how to use emulator tools to add items to your inventory. This is useful for fixing bugged or softlocked seeds, recreating issues on seeds without having to play through them, or just for fun.

RAM is temporary memory within a system that holds values currently being used by the running program. Memory is accessed via addresses, which are represented as strings of hexadecimal numbers (more on those later). For our purposes, we are interested in certain addresses in RAM which are the [https://wiki.cloudmodding.com/oot/Save_Format#Save_Context "Save Context"] of OoT. The Save Context is everything that is stored when you save your game. It includes things like story and event flags, your current location, how many hearts you have, and importantly for this page, items obtained. Since the save context is checked when the game is deciding what items to place in your inventory, by overwriting these addresses in RAM we can easily give the player items.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive to use. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure how to add hex numbers, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide and are essentially "entangled" with each other and the Progressive Strength, Wallet and Scale Upgrades. So to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

Editing RAM

2021-07-17T22:26:56Z

ShadowShine57: minor phrasing

''This page is still a work in progress''

For the purpose of fixing softlocked/"unbeatable" seeds and for helping staff members recreate reported issues.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive to use. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure how to add hex numbers, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide, so to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

Editing RAM

2021-07-17T22:07:06Z

ShadowShine57: Add link to a hex calculator for adding to addresses in dolphin

''This page is still a work in progress''

For the purpose of fixing softlocked/"unbeatable" seeds and for helping staff members recreate reported issues.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. (If you're unsure, you can add the number of slots to the base address with a calculator [https://www.calculator.net/hex-calculator.html like this one.])

However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide, so to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

Editing RAM

2021-07-17T21:57:05Z

ShadowShine57:

''This page is still a work in progress''

For the purpose of fixing softlocked/"unbeatable" seeds and for helping staff members recreate reported issues.

== Accessing and Using the Hex Editor / Debugger ==

=== Bizhawk ===
With your ROM loaded, head to <kbd><samp>Tools</samp> ⇒ <samp>Hex Editor</samp></kbd>. A new window should pop up. Next, go to <kbd><samp>Options</samp> ⇒ <samp>Memory Domains</samp></kbd> and select <kbd><samp>System Bus</samp></kbd>. Also go to <kbd><samp>Options</samp> ⇒ <samp>Data Size</samp></kbd> and select <kbd><samp>1 Byte</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by hitting <kbd><samp>CTRL + G</samp></kbd> or going to <kbd><samp>Options</samp> ⇒ <samp>Go to Address...</samp></kbd>. To make changes to the RAM, right-click the relevant byte and select <kbd><samp>Poke Address</samp></kbd>. In the new window enter the value you want to change the byte to and hit <kbd><samp>Poke</samp></kbd> to confirm. Your changes should be reflected in the game immediately.

[[File:bizhawk hex editor.png]][[File:bizhawk poke.png]]

=== Project64 ===
To enable the debugger, go to <kbd><samp>Options</samp> ⇒ <samp>Settings...</samp> ⇒ <samp>Advanced</samp></kbd> and check <kbd><samp>Enable debugger</samp></kbd>. Click <samp>Apply</samp>.

[[File:pj64 enable debugger.png]]

Close the settings window and go to <kbd><samp>Debugger</samp> ⇒ <samp>View memory...</samp></kbd>. A new window should pop up. Right-click any of the bytes in this window and go to <kbd><samp>Byte group size</samp> ⇒ <samp>1</samp></kbd>. Navigate to the relevant address (e.g. <code>8011A644</code>) by entering the address in the field in the top left corner of the window. To make your changes, simply select the location where you want to make your change and type in the value. Your changes should be reflected in the game immediately.

[[File:pj64 data size.png]][[File:pj64 byte.png]]

=== Dolphin ===
To enable the debugger, go to <kbd><samp>Config</samp> ⇒ <samp>Interface</samp></kbd> and check <kbd><samp>Show Debugging UI</samp></kbd>. A code window will pop up, and several things will be added to your toolbar. You can close the code window and ignore all the additions.

[[File:DolphinEnableDebugger.png|400px]]

Next, in the menu bar go to <kbd><samp>View</samp></kbd> and check <kbd><samp>Memory</samp></kbd>. You'll see a window that looks like this. (Note that Dolphin only displays values in memory when emulation is paused, but values can still be set while emulation is running.) Pay attention to the highlighted section in the upper right, this is where we will be working.

[[File:DolphinMemoryViewer.png|400px]]

Next, you must determine your offset value. Since Dolphin is running OoT within a WAD, the WAD itself adds bytes, meaning you must add an offset. Luckily, Dolphin's memory viewer already has an offset field, so you can just add it here and not worry about it. If you're using a US WAD, the offset will be <code>F64120</code>. If you're using a JP WAD, the offset will be <code>E74000</code>.

Finally, to set values in memory, you'll want to make sure Hex is selected, put the target address in the "Search Address" field, set Offset to the proper value, your desired value in the Value field, and then hit the Set Value button.

Dolphin's memory viewer is different from the others in that you cannot click to select bytes and edit them that way, so it's a bit less intuitive. If you want to set the 3rd slot in inventory, you'll have to add 2 to the base inventory address for the 2 bytes skipped. However, you can also set multiple bytes at once. For example, if you want to give yourself just deku sticks, you can enter the base inventory address and type <code>00</code> in the Value field to give yourself deku sticks in the first slot; but if you want to give yourself deku sticks, deku nuts, bombs, and the bow, you can enter <code>00010203</code> in the Value field to give yourself them all at once. This can be used to make it easier to give yourself all ammo at once, giving all equipment, all keys, etc.

== Finding the Correct Address and Value ==

In everyday life we use a "base 10 numeral system", which means that we use 10 different symbols for denoting numbers: "0-9". When we add one more to 9, we loop back to 0 but prefix it with a 1 to indicate that we've looped back once and we get the number "10". The hex editor/debugger uses a "base 16 numeral system" instead, which means it uses 16 different symbols for denoting numbers: "0-9" (for the numbers 0 to 9) and "A-F" (for the numbers 10-15). "Decimal numbers" are what we call the symbols of the first system and "hex numbers" are what we call symbols of the second system. To properly use the hex editor/debugger you will need to count in hex numbers. Fortunately, most calculators and many [https://www.binaryhexconverter.com/hex-to-decimal-converter tools] online can convert numbers between both numeral systems for you.

=== (Progressive) Items ===
The locations of your items on the item select screen (i.e. items you can put on C buttons) start at address <code>8011A644</code> and last for 24 bytes (i.e. 24 double digit hex numbers) as seen in the image below.

[[File:RAM slots2.png]]

The value of the first byte determines what item is in the first slot, the value of the second byte determines what item is in the second slot, etc. The ordering for the slots follows the "logical" western reading order, that is it starts in the top left corner and goes left-to-right and top-to-bottom. Below is a table that tells you which hex numbers correspond to which items. Keep in mind that this table is only true for these 24 bytes in the RAM.

[[File:RAM items.png]]

If you want to test if you understood everything so far correctly, then try to work out the inventory of the RAM in the first image of this section. The answer is: Deku Nuts in the Deku Nuts slot, Din's Fire in the Din's Fire slot, Ocarina of Time in the Ocarina slot, and Megaton Hammer in the Farore's Wind slot (whoops!).

The addresses for ammo counts (e.g. Deku Sticks, Bombs, Magic Beans) start at <code>8011A65C</code> and is 15 bytes long. However, only 7 of these bytes correspond to relevant ammo counts: the 1st, 2nd, 3rd, 4th, 7th, 9th and 15th (see image below). These are the counts for Deku Sticks, Deku Nuts, Bombs, Arrows, Deku Seeds, Bombchus and Magic Beans respectively. Using or obtaining additional ammo without the associated ammo holder, such as a Quiver for Arrows, will immediately drop the ammo count to 0. Note that even Deku Sticks and Deku Nuts require an "ammo holder". There are two ways to prevent this. Firstly, you can right-click the relevant bytes and choose <kbd><samp>Freeze</samp></kbd> (Bizhawk) or <kbd><samp>Lock value</samp></kbd> (Project64) (no way to do this in Dolphin). Alternatively, you can give yourself the relevant ammo holders. This information is laid out in memory in a considerably more complicated way than the other "items" mentioned in this guide, so to keep things simple we will just give you the value for having the maximum of every upgrade, and after you've resolved your softlock you can revert these bytes to their original value (make sure to write them down beforehand). Go to address <code>8011A670</code> and change the first 4 bytes into <code>00 36 F4 DB</code>.

[[File:Ammo memory.png]]

To give yourself Magic, set the byte at <code>8011A60A</code> to <code>01</code>, and the byte at <code>8011A603</code> to <code>30</code>.

=== Swords/Shields/Tunics/Boots ===

The address for modifying Tunics and Boots is <code>8011A66C</code>, and the address for Swords and Shields is <code>8011A66D</code>. They are both a single byte long. The first digit of each byte controls the Boots and Shields, and the second digit controls the Tunics and Swords. Changing any of these digits to a <code>7</code> will give you all Swords/Shields/Tunics/Boots. If you don't want to have them all but only 1 or 2, then try different numbers in the range 1-7 until you get the layout you desire. Keep in mind that if you want the Biggoron Sword instead of the Giant's Knife, you'll have to change the byte at <code>8011A60E</code> from <code>00</code> to <code>01</code>

If you want to play around with the famous "F boots" (= anti-gravity boots), then change the byte at <code>8011A640</code> into <code>F1</code>.

=== Dungeon Rewards, Songs and Gerudo Card ===

The address for modifying the Spiritual Stones, Song of Time, Song of Storms and Gerudo Card (and some irrelevant things) is <code>8011A675</code>, the address for Bolero of Fire, Minuet of Forest and the Medallions is <code>8011A677</code>, and the address for the other songs is <code>8011A676</code>. They are all a single byte long. Changing these bytes to <code>FF</code> will give you all of the items and songs. If you don't want to have them all but only a certain combination of them, then manually try different hex numbers. A systematic approach to finding the right number would be to increment the current hex number by 1 until you find the right one.

=== Keys ===

Below is a table that gives the addresses for the Small Keys and Boss Keys of all the relevant locations. They are all 1 byte long. For the Small Keys you can just insert the number of keys you want. For the Boss Keys you'll want to use one of the following numbers depending on if you also want the Map and/or Compass: <code>01</code>, <code>03</code>, <code>05</code> or <code>07</code>.

[[File:Keys memory.png]]

File:DolphinMemoryViewer.png

2021-07-17T21:17:13Z

ShadowShine57:

File:DolphinEnableDebugger.png

2021-07-17T21:07:26Z

ShadowShine57:

Dolphin

2021-07-02T16:07:42Z

ShadowShine57: Remove "not officially supported"

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin has not been tested extensively for OoTR.</li>
<li>Dolphin is not race legal.</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

Click on <kbd><samp>Controllers</samp></kbd> on the home page. Controllers can be setup either as "GameCube Controllers", or as "Wii Remotes". For the purpose of the randomizer your controller will need to be configured as a "GameCube Controller" (even if it is, say, an Xbox controller). Under Gamecube controllers, click <samp>Configure</samp> next to Port 1.

[[File:DolphinControlConfig1.png|275px]]

If you are using a Gamecube Controller with a Wii U Adapter by either Nintendo or Mayflash (Wii U mode), then your controller should be detected and configured automatically and the new window that opens will simply ask you to enable/disable the Rumble Pak.

[[File:Gcnadapter.png]]

For reference, these are the default controller mappings Dolphin will use. Keep in mind that if you've used the webpatcher, or gzinjectgui with the right configuration, that D-pad left/right/down will be overwritten to properly work with boots/ocarina on D-pad.

[[File:Gamecube Controls.png]]

If you are using any other controller, or if you're using a Gamecube adapter in PC mode, then you will need to configure the controller yourself. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig2.png|725px]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>. This ensures that you don't get a PAL frame rate.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked. This fixes the black pause screens

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required. If there is already an in-game save file present, delete it before starting the new seed.

== After Finishing a Seed ==

Since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

=== Graphical Enhancements ===

Depending on the power of your computer, you may want to enable some graphics enhancements. If your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

=== Aspect Ratio ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select whatever you prefer.

[[File:DolphinAspect.png]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, please come to <kbd><samp>#setup-support</samp></kbd> on [https://discord.gg/q6m6kzK our Discord].

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Graphical_Enhancements your graphical enhancements].

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

=== The Wii Home Menu Randomly Pops Up ===

Click on <kbd><samp>Controllers</samp></kbd> on the home page and then either untick <samp>Background Input</samp> (your controller inputs will still be registered with this setting unticked even when the window is unfocused), or change the <samp>HOME</samp> binding of <samp>Wii Remote 1</samp>.

=== GFX FIFO Unknown Opcode on Resetting ===

This is a known bug with resetting VC on Dolphin. You can click OK on both dialogs that pop up and then won't have to worry about it again until you restart Dolphin itself. You can also go to <kbd><samp>Options</samp> ⇒ <samp>Configuration</samp> ⇒ <samp>Interface</samp></kbd> and disable <samp>Use Panic Handlers</samp> to always ignore it.

Plandomizer

2021-06-25T05:04:32Z

ShadowShine57: Added subsection about special characters for gossip stones

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by what settings you choose, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there
* A list containing multiple items to randomly choose from to place there
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Shop Location Prices ====
When defining a shop location, rather than simply assigning a string of the item name to the location, you must define a dictionary with the properties item (a string of the item name) and price (a number). So for example, a shop item location will look something like this:
<blockquote><pre>
"KF Shop Item 7": {
"item": "Light Arrows",
"price": 40
},
</pre></blockquote>
Note that, prior to Dev v6.0.41, plando shop prices were not properly considered in logic, so using any price above 99 may be risky.

As of Dev v6.0.41, If you try to set a price higher than 999, it will simply be capped to 999 so it won't be impossible to buy. However, you can actually plando negative prices, which will give the player the absolute value of the price. So if you plando a shop item to be -10 rupees, the player will be able to purchase it with any wallet size and it will give them 10 rupees. Due to reasons related to the binary numbers used to represent the prices in-game, the lowest possible price is -32768.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Vanilla - Places whatever was on that location in the original game (Dev v6.0.54 onwards). Also applies to MQ locations.
#MajorItem - Places a settings-dependent major item at that location (Dev v6.0.24 onwards).
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

As of Dev v6.0.45, you can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
<blockquote><pre>
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
</pre></blockquote>

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">
White
Red
Green
Blue
Light Blue
Pink
Yellow
Black
</pre>

==== Special Characters ====
As of Dev v6.0.50, you can also use some special characters within your hints. In terms of normal characters, you can use within your hint text the following just by putting them within the string as usual: À, Á, Â, Ä, Ç, È, É, Ê, Ë, Ï, Ô, Ö, Ù, Û, Ü, the lowercase versions of all previous characters, and ß.

You can also specify codes for special, in-game button characters using Unicode values. Reference the following table for the value for each button character, and then it can be specified within your hint text with \u00xx, where xx is the value from the table. For example, the A button has a value of 9F, so it would be printed using \u009F within your hint. [https://i.imgur.com/sfbnKF6.png Here] you can see what these characters look like in-game.

{| class="wikitable"
|-
| Code || 9F || A0 || A1 || A2 || A3 || A4 || A5 || A6 || A7 || A8 || A9 || AA
|-
| Button Displayed || A || B || C || L || R || Z || C-up || C-down || C-left || C-right || Down arrow || Joystick
|}

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

'''Helpful Tutorial Message''':
<blockquote><pre>
"gossip_stones": {
"KF (Outside Storms)": { "text": "To target, press \u00A4" }
}
</pre></blockquote>

'''Appreciation''':
<blockquote><pre>
"gossip_stones": {
"KF (Deku Tree Right)": { "text": "Dampé is a pretty cool guy." }
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). This means that some other track will be placed there instead without your knowledge.

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Plandomizer

2021-06-25T04:46:06Z

ShadowShine57: edit an accidentally dumb example

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by what settings you choose, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there
* A list containing multiple items to randomly choose from to place there
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Shop Location Prices ====
When defining a shop location, rather than simply assigning a string of the item name to the location, you must define a dictionary with the properties item (a string of the item name) and price (a number). So for example, a shop item location will look something like this:
<blockquote><pre>
"KF Shop Item 7": {
"item": "Light Arrows",
"price": 40
},
</pre></blockquote>
Note that, prior to Dev v6.0.41, plando shop prices were not properly considered in logic, so using any price above 99 may be risky.

As of Dev v6.0.41, If you try to set a price higher than 999, it will simply be capped to 999 so it won't be impossible to buy. However, you can actually plando negative prices, which will give the player the absolute value of the price. So if you plando a shop item to be -10 rupees, the player will be able to purchase it with any wallet size and it will give them 10 rupees. Due to reasons related to the binary numbers used to represent the prices in-game, the lowest possible price is -32768.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Vanilla - Places whatever was on that location in the original game (Dev v6.0.54 onwards). Also applies to MQ locations.
#MajorItem - Places a settings-dependent major item at that location (Dev v6.0.24 onwards).
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

As of Dev v6.0.45, you can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
<blockquote><pre>
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
</pre></blockquote>

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">
White
Red
Green
Blue
Light Blue
Pink
Yellow
Black
</pre>

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). This means that some other track will be placed there instead without your knowledge.

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Plandomizer

2021-06-25T04:43:21Z

ShadowShine57: Add subsection about plandoing prices

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by what settings you choose, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there
* A list containing multiple items to randomly choose from to place there
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Shop Location Prices ====
When defining a shop location, rather than simply assigning a string of the item name to the location, you must define a dictionary with the properties item (a string of the item name) and price (a number). So for example, a shop item location will look something like this:
<blockquote><pre>
"KF Shop Item 7": {
"item": "Light Arrows",
"price": 40000
},
</pre></blockquote>
Note that, prior to Dev v6.0.41, plando shop prices were not properly considered in logic, so using any price above 99 may be risky.

As of Dev v6.0.41, If you try to set a price higher than 999, it will simply be capped to 999 so it won't be impossible to buy. However, you can actually plando negative prices, which will give the player the absolute value of the price. So if you plando a shop item to be -10 rupees, the player will be able to purchase it with any wallet size and it will give them 10 rupees. Due to reasons related to the binary numbers used to represent the prices in-game, the lowest possible price is -32768.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Vanilla - Places whatever was on that location in the original game (Dev v6.0.54 onwards). Also applies to MQ locations.
#MajorItem - Places a settings-dependent major item at that location (Dev v6.0.24 onwards).
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

As of Dev v6.0.45, you can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
<blockquote><pre>
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
</pre></blockquote>

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">
White
Red
Green
Blue
Light Blue
Pink
Yellow
Black
</pre>

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). This means that some other track will be placed there instead without your knowledge.

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Plandomizer

2021-06-25T04:31:09Z

ShadowShine57: Add info about MajorItem item group, and custom item groups

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms (or take advantage of this mechanic to put in comments between sections, but note that it cannot be used within {} sections such as Locations or Entrances).

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by what settings you choose, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there
* A list containing multiple items to randomly choose from to place there
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Vanilla - Places whatever was on that location in the original game (Dev v6.0.54 onwards). Also applies to MQ locations.
#MajorItem - Places a settings-dependent major item at that location (Dev v6.0.24 onwards).
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

As of Dev v6.0.45, you can also define your own, custom item groups by adding a <code>custom_groups</code> dictionary to your plando. Within this dictionary you can define groups which contain a list of item names in brackets, and then use those group names as you would with other item groups.

Here is such an example, which will place a random sword in Mido's top left chest and a small key for water or shadow temple in his top right chest:
<blockquote><pre>
{
"custom_groups": {
"CustomList1": [ "Kokiri Sword", "Biggoron Sword", "Giants Knife" ],
"CustomList2": [ "Small Key (Water Temple)", "Small Key (Shadow Temple)" ]
},
"locations": {
"KF Midos Top Left Chest": "#CustomList1",
"KF Midos Top Right Chest": "#CustomList2"
}
}
</pre></blockquote>

Note that currently patterns do not work on custom groups (so, for example, you cannot do <code>!#CustomList1</code>) and custom groups cannot be nested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">
White
Red
Green
Blue
Light Blue
Pink
Yellow
Black
</pre>

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). This means that some other track will be placed there instead without your knowledge.

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Logic

2021-06-25T04:18:47Z

ShadowShine57: Remove outdated reference to 5.2

'''“My Seed Is Broken!” (Glitchless Logic)''' - Solutions to completing randomized runs of ''Ocarina of Time'' can sometimes be unintuitive. While your seed may appear to be unbeatable, this isn’t often the case. Thanks to the diligent efforts of the developers, OoTR’s logic is incredibly robust. Listed below are some common sources of confusion, grouped by location. If you don’t mind spoiling the rest of the playthrough, instructions to finding your next step will be listed [[#Knowing_the_Way_with_the_Spoiler_Log|here]].

If you follow these steps and still need help, you’re welcome to ask for support in the [https://discordapp.com/channels/274180765816848384/274186223147417600 #gameplay-and-tricks] channel of our [https://discord.gg/3VJPQNK Discord Server]. Please provide the seed and setting string along with any important details about the issue. If it turns out there is indeed a logical flaw, kind members of our team will report issues from there.

{{TOClimit|1}}

= Other Logic Pages =
This page of the Wiki is for Glitchless Logic; for more information on Glitched and Entrance Randomizer Logic, please view the [[Glitched_Logic|Glitched]] and [[Entrance_Randomizer|Entrance Randomizer]] pages of the Wiki.

The logical item requirements for each dungeon are also available on the [[Vanilla_Dungeon_Requirements | Vanilla]] and [[Master_Quest_Dungeon_Requirements | Master Quest]] dungeon requirements pages.

It is also to document unusual logic that is '''absolutely required''' know in a seed to finish most randomizer seeds. Anyone who wish to contribute to the randomizer by adding features with logical requirements will likely need to be familiar with the logic on a deeper level. The [[Advanced Logic]] page will provide a better explanation of some of the more difficult to comprehend, but unnecessary to know by heart, logic quirks.

= Vanilla Help =
For a quick refresher regarding the most basic aspects of Ocarina of Time, see these [https://strategywiki.org/wiki/The_Legend_of_Zelda:_Ocarina_of_Time/Getting_Started getting Started pages for Ocarina of Time].

For players who have not played randomizer before, it is strongly recommended to play the original game (i.e. vanilla) before attempting a randomizer seed. Strategy guides such as those from [https://strategywiki.org/wiki/The_Legend_of_Zelda:_Ocarina_of_Time/Table_of_Contents StrategyWiki] and [https://www.zeldadungeon.net/ocarina-of-time-walkthrough/ Zelda Dungeon] can be very helpful. Video guides are also available, the user [https://www.youtube.com/user/ScarecrowScythe Krow's Graveyard] has a playlist for [https://www.youtube.com/playlist?list=PLC4ADFACDF4946595 Vanilla Ocarina of Time] and [https://www.youtube.com/playlist?list=PLDgypNs3MY2Rd1jlYqNTWIfeLW7AiuoOK Master Quest Ocarina of Time]. Understanding how to beat vanilla is '''vital''' to beating a randomized seed.

For those who would prefer a quicker experience, [https://ootrandomizer.com/seed/vanilla Vanilla] and [https://ootrandomizer.com/seed/MQvanilla Master Quest] are available as randomizer seeds with all the QoL changes inherent to randomizer.



<div style="font-size:larger;">'''Spinning Pottery'''</div>
The spinning Goron Pot is activated by lighting the torches surrounding it. This can be accomplished by lighting sticks from Darunia's chamber OR by casting Din's Fire.
The Spinning Pot has 3 faces - Happy, Neutral, and Mad. Only the Happy face gives a randomized reward; Neutral give 3 bomb refills and Mad gives 3 green rupees.

<div style="font-size:larger;">'''Scarecrow’s Song'''</div>
Link must teach it to Bonooru (the scarecrow nearer the lake) as a child and then remind him again as an adult. The song cannot be all the same note; many alternate between two notes for simplicity.

<div style="font-size:larger;">'''Stuck without Warp Songs'''</div>
Save and quit outside the dungeon. Reloading the game will return Link to the Temple of Time (if adult) or Link's house (if child).

<div style="font-size:larger;">'''Opening Grottos without Bombs'''</div>
Any grotto which can be opened with Bombs can also be opened with Hammer. However some grottos open when the Song of Storms is played and not with explosives.

= Misunderstood Vanilla Mechanics =
A lot of randomizer uses the vanilla requirements to do certain things. It just so happens that vanilla takes logic shortcuts in some locations because it's impossible to do some events before others. Meanwhile other events have requirements which do not come up in ordinary play. These are the most common issues people have starting randomizer after vanilla.

<div style="font-size:larger;">'''Open the Door of Time'''</div>
Play the Song of Time while standing in front of the pedestal. The only requirements are a '''Fairy Ocarina''' and the '''Song of Time'''. The Spiritual Stones are '''not''' required, and the Ocarina of Time is also '''not''' required.

<div style="font-size:larger;">'''Skull Kid Ignores the Skull Mask'''</div>
Skull Kid must be befriended with Saria's Song before he will buy the Skull Mask. This is '''not''' required for the Skull Mask check- that is done by showing the Skull Mask to the Deku Scrubs inside the Lost Woods Theater.

<div style="font-size:larger;">'''Saria Missing from Sacred Forest Meadow'''</div>
Link must have Zelda's Letter or later in the child trade sequence before Saria arrives to teach her song. This means finding the Weird Egg, waking Talon, and visiting Zelda first.

<div style="font-size:larger;">'''Ocarina of Time and Song of Time Cutscenes'''</div>
This is the Zelda & Impa's escape cutscene initiated by approaching the Castle Town draw bridge as a child. Link must have all 3 Spiritual Stones before approaching the draw bridge, Zora's Sapphire alone is not enough.

<div style="font-size:larger;">'''Can't Find the Running Man'''</div>
Link must possess all 3 Spiritual Stones before the Running Man appears in Hyrule Field. Zora's Sapphire alone is not enough.

<div style="font-size:larger;">'''Big Poe Hunt'''</div>
Without Epona, there is a 2/5 (40%) chance of a Big Poe spawning while passing their spawn areas. While on Epona, there is a 100% chance that the poe that spawns will be a Big Poe. Due to this, default logic does '''not''' expect hunting Big Poes without Epona. However, logic may expect them to be found as the random contents of bottles if the Big Poe Count setting is low enough.

<div style="font-size:larger;">'''Burning Village/Nocturne of Shadow Cutscene'''</div>
Link must have the <span style="color: green">Forest</span>, <span style="color: crimson">Fire</span>, and <span style="color: blue">Water</span> Medallions and then enter Kakariko Village as Adult from any entrance.

<div style="font-size:larger;">'''Kakariko Shooting Gallery Gives 50 Rupees'''</div>
The Fairy Bow/Quiver is required to win the special prize, otherwise you will receive 50 rupees.

<div style="font-size:larger;">'''Requiem of Spirit'''</div>
The song typically acquired by leaving Spirit Temple as an adult can be collected as a child too. Exiting Spirit Temple is the vanilla requirement, since outside sequence breaks child would never reach the Colossus before adult.

In Entrance Randomizer, exit whichever dungeon is placed at Desert Colossus.

<div style="font-size:larger;">'''Zelda Light Arrow Cutscene'''</div>
Enter the Temple of Time as adult with the Shadow and Spirit medallions to receive this item check. From the Master Sword pedestal, Link must approach the exit.

= Vanilla Mechanics Changed by Randomizer =
Randomizer has also changed some vanilla mechanics in an attempt to make randomization of certain elements more valuable. Those ''very'' familiar with Ocarina of Time may want to take note of the following differences.

<div style="font-size:larger;">'''Ocarina Memory Game'''</div>
Randomizer changed this mini-game to only require completing the 5 note version of the game to obtain the item. The mini-game does not need to be done a second time.

<div style="font-size:larger;">'''Malon or Talon Missing from Ranch'''</div>
Malon and Talon normally appear in Lon Lon Ranch after speaking to Zelda and receiving Zelda's Letter. Due to Weird Egg being able to be shuffled some changes have had to be made to this to avoid softlocks. Waking Talon up at Hyrule Castle with the Cucco from the Weird Egg and obtaining Zelda's Letter will have him appear at the ranch. If the Weird Egg is not shuffled, Malon will also appear at the ranch after this. If Weird Egg is shuffled, she will not appear at the ranch until Link speaks to her at Hyrule Castle and receives an item from her.

<div style="font-size:larger;">'''Dampe's Heart-Pounding Gravedigging Tour'''</div>
Dampe no longer requires a random number of attempts and will instead dig up the Heart Piece on the first attempt. He doesn't even need to be over a dirt patch.

There is a bug in vanilla where if Link leaves the area before picking up the Heart Piece it is lost forever. The randomizer has ''mostly'' resolved this issue. Don't die before picking up the Heart Piece because this seems to do the same thing the vanilla bug does and isn't handled properly by the randomizer yet.

<div style="font-size:larger;">'''Sheik at Temple'''</div>
The Sheik cutscene at the Master Sword pedestal to obtain Prelude of Light has been changed from beating Forest Temple to obtaining the Forest Medallion. Once Link has the Forest Medallion, approaching the pedestal as adult either from the door of time, or from pulling the sword out as child will give you the reward.

<div style="font-size:larger;">'''Fishing Pond'''</div>
The fishing reward minimums were lowered so an 8 pound fish is required as Child and a 10 pound fish is required as Adult. However, the lure must still be in deep enough water to cause the fish to bite.

<div style="font-size:larger;">'''Biggoron's Claim Check'''</div>
Biggoron no longer requires three days between giving him the eyedrops and claim check. The claim check can now be immediately returned to Biggoron for a randomized item.

<div style="font-size:larger;">'''Bombchu Bowling'''</div>
Randomizer changed this mini-game so that the two randomized prizes are always the first two prizes offered by the lady- if you lose the game, leave and re-enter to reset the prize order. The requirements for unlocking this check have also been changed- if bombchus are in logic, then finding a bombchu pack is required, otherwise a bomb bag is required if bombchus are not in logic.

== Forest ==
This section covers the following areas '''Kokiri Forest''', '''The Lost Woods''', and '''The Sacred Forest Meadow'''.

<div style="font-size:largest;">'''Closed Forest'''</div>
When the "Closed Forest" setting is active, Link is expected to stay in the aforementioned areas until beating Gohma in the Great Deku Tree. Do not leave these areas, even if there is a bomb bag, silver scale, or ocarina and a warp song. The Kokiri Sword will be in one of these forest areas and the shop will have a repeatably purchasable Deku Shield, even with Shopsanity active.

<div style="font-size:larger;">'''Slingshot'''</div>
If Closed Forest is enabled a Slingshot will always be found somewhere in '''Kokiri Forest''', '''The Lost Woods''', '''The Sacred Forest Meadow''' or '''[[#Inside the Deku Tree|The Great Deku Tree]]'''.

<div style="font-size:larger;">'''Hidden Grottos'''</div>
Hidden grottos in these areas can be required, especially with the Closed Forest setting enabled. The Stone of Agony must be found before logic can expect these locations, provided the trick that removes the SoA requirement is not enabled.

<div style="font-size:larger;">'''Tokensanity'''</div>
With Tokensanity enabled the three dirt patch Skulltulas can be required, especially if the Closed Forest setting is enabled. In the Lost Woods, jump slashing the bushes outside of the Goron City warp with a stick will release bugs which can be caught in a bottle and used on the dirt patches. Since the sword could be in a dirt patch, keep this in mind.

== Kakariko Village ==

<div style="font-size:larger;">'''Rear Entrance to Impa's House as Child'''</div>
Take a cucco to the incomplete building. Toss it onto the top of the pile of bricks and climb up after it. Once on top of the pile of bricks with the cucco, pick it up and fly across to the Scaffolding. From here follow behind the carpenter to reach a good position to jump towards the entrance above the chicken coop.

<div style="font-size:larger;">'''Reach Rooftops without Longshot'''</div>
It's possible to get on the important rooftops with only Hookshot. Get a little closer and try again.

<div style="font-size:larger;">'''Draining Kakariko Well'''</div>
Play the Song of Storms to the Windmill Operator as a child.

*Project 64 will have this issue if not configured correctly. Be sure you have followed the instructions in [[Project64]] if you run into it: ''Draining the well at night can crash the game; attempting it during the day is less likely to cause this crash.''

<div style="font-size:larger;">'''Freestanding PoH in Windmill'''</div>
The freestanding heart piece in the windmill doesn't always expect an ocarina or the Song of Time. Use the boomerang to grab the item here or, if the trick is enabled, [https://www.youtube.com/watch?v=vDl7lr4Ecv8| reach it as adult with no other items required].

== Goron City ==

<div style="font-size:larger;">'''Reach Goron City from Lost Woods without Bombs'''</div>
Ignite the Bomb Flowers behind the boulders using Din’s Fire. Alternatively, if Adult Link destroys the boulders with Hammer, Strength, or Bow they'll be destroyed in the past so Child Link can enter.

<div style="font-size:larger;">'''Get Large Rolling Goron to Relinquish Goods'''</div>
Bomb the Goron in the dark tunnel near the sign (Bomb/Bombchu).

''In version 4.0 and older the Large Rolling Goron also requires Link to have a Bomb Bag''

<div style="font-size:larger;">'''Boulder Maze without Bombs or Hammer'''</div>
Silver Guantlets are effective at clearing a path to each of the chests in the room. This will take some time, however.

<div style="font-size:larger;">'''Reaching the Grotto'''</div>
This grotto is adult only, and contains three business scrubs. Requirements to reach this grotto are as follows: Goron Tunic + Hookshot, or Ocarina + Song of Time, or Nayru's Love + Hookshot. If one-hit KO or 4x damage is on, then the glitchless logical requirements are either Ocarina + Song of Time + Goron Tunic/Longshot/Nayru's Love, or Nayru's Love + Hookshot. Further explanation [[Grottos#Goron_City:_1_Grotto|here]].

== Death Mountain Crater ==

<div style="font-size:larger;">'''Reach the lower Exit'''</div>
From the top of the tall ladder, use the Hover Boots to hover over the boulder blocking the shortcut to Goron City (lower exit). Hover Boots can also be used at the bottom of the ladder to bypass the Boulder.

<div style="font-size:larger;">'''Reach the Bottom Area for Bolero of Fire and Access to Fire Temple'''</div>
Use Hover Boots to cross the dilapidated bridge to reach the Warp Platform & Fire Temple.

Alternatively, reach this bottom area with the Longshot by jumping from the upper area onto the lava platforms below and shooting a wooden plank to pull Link across the pool of lava.

== Zora’s Domain ==

<div style="font-size:larger;">'''Access with Silver Scale'''</div>
Silver Scale allows access to Zora's Domain as child from Lake Hylia.

<div style="font-size:larger;">'''Need Blue Fire to Unfreeze King Zora/Zora Shop'''</div>
In Ganon’s Castle, Blue Fire can be found in Water Trial. Blue Fire may also be a purchasable item for 300 rupees in shops.

== Lake Hylia ==

<div style="font-size:larger;">'''Go fishing'''</div>
The fishing man rewards an 8 pound fish as a Child and a 10 pound fish as an Adult. Make sure to toss the lure in deep enough water to entice fish to bite. There's a minimum depth required for the mini-game to work. Tossing the Lure in very shallow water may cause the fish may swim around the Lure but never bite.

<div style="font-size:larger;">'''Lake Hylia - Shooting the Sun with an Arrow'''</div>
The tall rectangle island can be reached without filling the lake by using Scarecrow's Song and Longshot. You may not need to complete the Water Temple and raise the water level at Lake Hylia to acquire the item. The arrow must be fired at the sun during the early morning as per the written instructions on the stone platform.

== Gerudo Fortress/Gerudo Valley ==

<div style="font-size:larger;">'''Traversing the Gerudo Valley Broken Bridge'''</div>
Cross the Broken Bridge as an Adult by using either Epona to jump it or using the Longshot on the sign above the gate on the other side.

<div style="font-size:larger;">'''Entering Gerudo Training Grounds without Being Captured'''</div>
Link must have the Gerudo Membership Card and also rescue all of the Carpenters that have been captured. If the Gerudo Membership Card is shuffled, then only the card is needed and the Carpenters do not need to be rescued to access the area.

<div style="font-size:larger;">'''Getting Caught without a Hookshot'''</div>
If caught by a Gerudo Guard, either inside during combat or outside by being seen, without a Hookshot, Link will be thrown into the valley outside the tent, rather than into the jail cell from which Link could not escape.

<div style="font-size:larger;">'''Horse Archery NPC is Missing or Won't Initiate the Mini-game'''</div>
This mini-game requires the Fairy Bow, Epona, and the Gerudo Membership Card. It must also be day time.

<div style="font-size:larger;">'''Fortress Rooftop Chest without Longshot'''</div>
The chest can be reached from the top with the Hover Boots or by spawning a scarecrow and using the Hookshot. You'll have to stand close to the edge of the top level for the Hookshot to reach. Note that you won't see the Hookshot's red dot on the scarecrow.

== Inside the Deku Tree ==

<div style="font-size:larger;">'''Access F3 without Slingshot'''</div>
The slingshot is not required to get to the top floor of the Deku Tree. In fact, in Master Quest Link doesn't get the slingshot until climbing all the way up the tree in the first place. Skulltulas don't rush Link when he is not moving. Sneak past them while they are looking away.

<div style="font-size:larger;">'''Two Chests in Slingshot Room'''</div>
In vanilla Deku Tree there are two chests in the Slingshot room. The first is the obvious one that has the slingshot, but there are climbable vines on the wall to the left of it which lead to a second chest.

== Dodongo's Cavern ==

<div style="font-size:larger;">'''Gold Skulltula on top of the Sinking Staircase'''</div>
Progress through the right side of the dungeon and hit the switch that makes the platforms in the entrance room rise higher, then leave the dungeon and re-enter it, progress through the dungeon backwards by taking the right platform in the entrance room to the top floor and going through the door on the upper level. This will grant you access to vines on the side of the stairs before the stairs have been lowered by the bomb blasts.

== Inside Jabu-Jabu's Belly ==

<div style="font-size:larger;">'''First Switch'''</div>
The switch on the ceiling in the first room of Jabu Jabu's Belly can be hit using explosives.

== Forest Temple ==

<div style="font-size:larger;">'''Get Outside without Song of Time or Bow'''</div>
With Hover Boots, float to the door connecting the large block-pushing room with the courtyard.

<div style="font-size:larger;">'''Cross to the Other Courtyard via Well'''</div>
With Gold Scale or Iron Boots, Link can cross from one courtyard to the other through the well.

<div style="font-size:larger;">'''Can’t Push Large Colored Blocks as Adult'''</div>
In the Forest Temple, the Goron’s Bracelet is required to push these blocks, even as adult. Link only put on gauntlets to keep his hands from drying out.

<div style="font-size:larger;">'''Triggering the Frozen Eye Switch without Bow'''</div>
Use Din's Fire from the platform below the frozen eye switch to activate it.

== MQ Forest Temple ==

<div style="font-size:larger;">'''Get Outside with just Hover Boots'''</div>
The western courtyard can be reached from the room with the block-push puzzle by hovering towards the crystal switch behind the transparent wall and then jump slashing to hit the switch from the other side. This will remove the transparent wall, allowing you to hover to this door leading to the courtyard. The ledge from which you'll want to hover is behind the first blocks, but if you lack strength then this ledge can also be hovered to from where you end up after climbing the second ladder. If you have trouble making these hovers, then try rolling for extra distance.

== Fire Temple ==

<div style="font-size:larger;">'''Can’t Push Large Colored Blocks as Adult'''</div>
In the Fire Temple, the Goron’s Bracelet is required to push these blocks, even as adult. Link only put on gauntlets to keep his hands from drying out.

<div style="font-size:larger;">'''Reach Volvagia without Hammer'''</div>
With Hover Boots equipped, it’s a simple matter of floating over to the boss door. That said, the Hammer is still required to defeat the boss.

<div style="font-size:larger;">'''Skip the Topmost Locked Door'''</div>
Similarly to Volvagia, skip the topmost locked door by using Hover boots to float over to the pillar. Then use the Hammer to open the door leading to the Highest Goron and Hammer Chest.

<div style="font-size:larger;">'''Extra Key'''</div>
When key-sanity is disabled (that is, keys are in their own dungeon), the lock in the basement behind the hammer blocks is removed. This results in a spare key for this dungeon.

== Water Temple ==

<div style="font-size:larger;">'''Entering without Iron Boots'''</div>
The entryway is in logic with just longshot and gold scale. However, nothing inside Water Temple is in default logic without Iron Boots, except for beating Morpha and part of the Dark Link loop (Longshot chest, whirlpool river chest and the Gold Skulltula in the falling platforms room). Therefore this is only logically relevant in Entrance Randomizer or various Boss/Small Key settings. Nevertheless, there are [https://www.youtube.com/watch?v=4_3GPW8xVuo strats for getting most of the checks in Water Temple without Iron Boots].

<div style="font-size:larger;">'''Boss Key Chest without Bombs or Goron’s Bracelet'''</div>
Use the Hover Boots to reach the chest.

<div style="font-size:larger;">'''Getting Past the Timed Gate without Longshot'''</div>
After shooting the eye switch, cross the gap with Hover Boots.

<div style="font-size:larger;">'''Center Room Gold Skulltula without Longshot'''</div>
Cast Farore’s Wind inside the center room. Raise the water to its highest level and cast Farore's Wind again to return to the warp point. Swim to the surface to reach the Gold Skulltula. '''In versions 6.0 and newer''', this is no longer in default logic.

<div style="font-size:larger;">'''Extra Key'''</div>
The door leading to the highest water level changer is never locked in rando. This results in a spare key for this dungeon.

<div style="font-size:larger;">'''Can’t Raise the Water Level'''</div>
''This is only relevant prior to version 4.0 of randomizer''

With the water level lowered, jump down to the second level of the central structure. This may require savewarping to the beginning of the dungeon to reach. Use the Hookshot to climb onto the top level. With a well-spaced rolling jump you should be able to reach the ledge where you can raise the water to its highest level. This isn't required but it's a handy time saver.

== Shadow Temple ==

<div style="font-size:larger;">'''Crossing the First Gap without Hookshot'''</div>
Hoverboots will reach the other side. If you fall short, start from the wall to build up speed before leaving the ledge.

<div style="font-size:larger;">'''First Silver Rupee Room without Hookshot'''</div>
Reach raised platform in the corner of the room by using the Hover Boots from the nearby low wall.

<div style="font-size:larger;">'''Spike floor room without Longshot'''</div>
Backflip onto the chest spawned in the middle of the room. From there, use the Hookshot to reach the upper ledge.

<div style="font-size:larger;">'''Reach the Boat without Goron’s Bracelet'''</div>
Bypass pushing the large block by shooting the top of the ladder with a Hookshot.

<div style="font-size:larger;">'''Reach Bongo Bongo without the Fairy Bow'''</div>
Play the Scarecrow’s Song to summon Pierre. Use Longshot to get to the other side.

== Gerudo Training Ground ==

<div style="font-size:larger;">'''Lava room without Longshot'''</div>
The torch at the end of this room is in reach using only the Hookshot.

<div style="font-size:larger;">'''Timed Boulder Room without Longshot'''</div>
The target on the ceiling is just within range of the Hookshot when standing almost directly under it. A wallmaster can also lift Link into the rupee if it’s the last to be collected.

== Spirit Temple ==

<div style="font-size:larger;">'''Child Side Enemy Room'''</div>
In order to kill the Armos in this room, you're expected to have at least one of the following item combinations: Deku Sticks (jumpslashes can hit), Kokiri Sword, or Deku Nuts + Slingshot.

<div style="font-size:larger;">'''Lower Metal Bridge on Child Side without Boomerang'''</div>
You can just barely hit the switch with a well-placed slingshot shot. Alternatively, hit the crystal switch with a well-timed Bombchu placement in the opposite direction.

<div style="font-size:larger;">'''Map chest without Din’s Fire or Magic'''</div>
Child Link is perfectly capable of lighting the torches using only a Deku Stick.

<div style="font-size:larger;">'''Collect Silver Rupees in the Boulder Room without Hover Boots'''</div>
Reach the floating rupee by jumping into the boulder with a jump slash, or even without hitting the boulder with a properly timed jump slash.

<div style="font-size:larger;">'''Silver Gauntlets Chest from Adult Side using Longshot'''</div>
With a Longshot, shoot the chest opposite from the Mirror Shield chest to gain access to its contents and the end of child-side.

<div style="font-size:larger;">'''Boss Key Chest'''</div>
The Eye Switch can be accessed by hitting the fake door with something to make it fall over. You do not necessarily need to destroy the fake door.

== Inside Ganon’s Castle ==

<div style="font-size:larger;">'''Spirit Trial without Fire Arrows'''</div>
A precise shot of an arrow through the torch will burn the web to reveal the light.

<div style="font-size:larger;">'''Water Trial Blue Fire'''</div>
With your bridge requirement set to Open, Blue Fire can be brought from the Water Trial to thaw King Zora or, if you have shopsanity active, to open the Zora Shop as adult if inaccessible as child.

<div style="font-size:larger;">'''Shadow Trial without Fire Arrows'''</div>
There are 2 scenarios possible here, either with Hover Boots or with Din's Fire. Obviously, Link may have both, in which case either method will work.<br/>
With Hover Boots, Longshot the torch to the right as you enter. From there, Link can reach the Like-Like with the Longshot. Once to the middle platform, equip the Hover Boots and roll across the gap to the platform where the chest spawns. From here open the chest and finish the trial.<br/>
With Din's Fire as a fire source, do the same thing as with Hover Boots, but instead of going to the Like-Like immediately, cast Din's Fire first. This will spawn the glass platform to the chest platform so Link can jump across.

= Knowing the Way with the Spoiler Log =

The spoiler log contains information about your personally randomized copy of the game and can be very helpful when looking for important items you've missed. Please be aware that the Playthrough presented is intended to prove the seed is beatable in logic. It does not represent the only way to logically beat the seed. It takes only a few steps to find:

= How do I find my Spoiler Log? =
*[[Frequently_Asked_Questions#How_Do_I_Find_My_Spoiler_Log_Again.3F|How do I find my spoiler log again?]]

<div style="font-size:larger;">'''Versions 1.0 - 3.0 and Standalone Download'''</div>
Open the spoiler log generated in the same folder that the randomized ROM is located in. It should be formatted as <code>OoT_SETTINGSTR_SEED_Spoiler.txt</code>.

Glitch Logic (outdated)

2021-06-25T04:17:20Z

ShadowShine57: Remove outdated reference to dev version of 5.2

Glitch Logic is a different set of logic files to the normal [[Logic|Glitchless Logic]] files. These take into account a massive amount of tricks, glitches, clips, etc. for placement of items throughout the world. This option is a somewhat middle ground between the Glitchless Logic, which expects only what the player can normally perform with no special knowledge, and No Logic, which randomly places items throughout the world without regard to potential softlocks. This set of logic files was designed around the no IM/WW ruleset.

== no IM/WW ==

[[No_IM/WW|No Item Manipulation or Wrong warp]], commonly abbreviated no IM/WW is a [[Rules|ruleset]] originating from the speedrun community of Ocarina of Time. It has evolved over the years from its humble beginnings and has changed names many times. The name currently comes from the two major categories of glitches which are banned by the ruleset: Item Manipulation and Wrong Warping.

==== Item Manipulation ====

This is an umbrella term for 3 glitches in particular which can be used to effectively hack items into your inventory or HUD. These 3 glitches are Bottle Adventure (BA), Reverse Bottle Adventure (RBA), and Get Item Manipulation (GIM). These glitches can allow you to write medallions straight into your inventory, give yourself a Hammer on B even if you don't have one in the inventory, and even turn a Recovery Heart into Light Arrows, just to name a few examples. The overarching power of these glitches to circumvent gameplay is why they are banned.

==== Wrong Warp ====

The Wrong Warp is probably the most famous glitch in Ocarina of Time as it is the crux of the any% route, allowing the player to instantly teleport themselves from Gohma's Boss Room straight to the Collapse sequence following the Ganondorf Fight, essentially skipping the entire game. How it works is beyond the scope of this description, however essentially we can influence what entrance the game pulls from an internal table. Blue warps are not the only way to do this as one can also use Trade Item timers and Farore's Wind, amongst other things, to achieve similar effects. As with Item Manipulation this is banned as it circumvents a lot of gameplay.

== Guidelines ==

Because playing Ocarina of Time with glitches, even ones not so powerful as IM and WW, allows the player to do some crazy stuff and skip a lot of things, certain guidelines were put in place when considering how to handle the logic. There were 4 tenets that went into building the logic and they are as follows:

# Any trick or glitch must be infinitely repeatable to be considered in logic.
# Obscurity of a trick or glitch is not a factor in its inclusion .
# Difficulty of a trick or glitch may be a factor.
#* Any trick which has a reliable setup can be considered regardless of its difficulty or precision.
# In regards to hovering, only those which are incredibly common, obviously possible, or quite short will be considered.
#* A maximum of 20 bombs or 50 chus, with chus in logic, is the distance/height limit.

==== Allowed but not in logic ====

As these guidelines are both fairly strict and fairly loose at the same time, a list of tricks/glitches which are possible under the no IM/WW ruleset, but are not logically considered are as follows:

*Ocarina Items
**When done improperly you can dupe a bottle over an item which is irretrievable violating tenet #1.
*Equip Swap
**Allows duping bottles over irretrievable items in much the same way as ocarina items.
*Actor Push Clips
**These are clips where actors such as bombs or small rocks push Link through seams or other actors. Unless a repeatable setup exists, these are not considered due to their extreme precision.
*Reaching Zelda as a child without moving sleeping Talon.
**Getting Zelda's Letter prior to the Weird Egg can lead to a situation whereby you are unable to trade masks at all, locking the Skull Mask and Mask of Truth checks forever.
*Out of Bounds Chu Hovers
**These crash the game on N64 and emulator, thus are not considered in logic for any reason.
*Item Duping
**Duping Skulltula tokens, GTG Keys, Heart Pieces, etc. by any means.
*Extra Heart Pieces
**These are not randomized at all, so if you want an extra Heart Piece go grab the 37th.

== Oddities ==

Because the game is so incredibly open and free under this ruleset there are many situations that you can find yourself in which could potentially softlock your game by not allowing you access to a specific check. These are listed below:

*Any of the tricks/glitches mentioned above.
*Collection delay such as Hold R or Gold Scale as child.
*The Colossus hands chests (vanilla Mirror Shield and Silver Gauntlets) are considered part of Spirit Temple for hints.
*Child Fire Temple
**Logically child isn't considered to have any access to Fire Temple.

== Less Common Maneuvers ==

This table consists of things which can be expected of the player logically and which are less common in the world of speedrunning, or aren't as widely known by the public. This list is NOT exhaustive of what's required, however simply serves to highlight some of the most esoteric things which aren't immediately obvious as possible to someone who otherwise has general knowledge of glitches in OoT.

{| class="wikitable"
| Area || Description || Video(s) || Name
|-
| Dodongo's Cavern || Hover onto the head or hookshot jump || https://www.youtube.com/watch?v=XlJU9IR4Yc8 || DC Hookshot Jump
|-
| Dodongo's Cavern || Hoverboost to it || https://www.youtube.com/watch?v=aGoR-nCXVKQ || DC Stairs Skulltula Hoverboost
|-
| Dodongo's Cavern || Connected to lobby, hover into head and jump into the door || https://www.youtube.com/watch?v=PU7FfP0zYiM || DC Enter Back Area with Head Closed
|-
| Ice Cavern || Child clip || https://www.youtube.com/watch?v=KWuhClJKaNU || Ice Child Clip to Compass Room
|-
| Ice Cavern || Adult hover recoil or HESS through red ice || https://www.youtube.com/watch?v=qkNQOAXV_DM || Ice Adult Clip to Iron Boots
|-
| Ice Cavern || Clip red ice as child or hoverboost as adult || https://www.youtube.com/watch?v=asxpTMImoJ4 || Ice Puzzle Room Skulltula
|-
| Fire Temple || Ledge clip the boss platform, hover OOB || https://www.youtube.com/watch?v=iFGpHVLysoI https://www.youtube.com/watch?v=lug_wipqBdI || Fire BK Skip with Hover
|-
| Fire Temple || Break door and reload the room || https://www.youtube.com/watch?v=-bOCrfxafnw || Fire Flare Dancer no Explosives
|-
| Deku Tree || Only is_adult because 231 skip from compass room || https://www.youtube.com/watch?v=FRNf34xShqE || 231 Skip as Adult
|-
| Kokiri Forest || Get into the roof as adult with just ISG || https://www.youtube.com/watch?v=0athDHNrqz4 || Adult Skull No Hookshot
|-
| Bottom of the Well || Actor glitch or vine clip || https://www.youtube.com/watch?v=Y8gunZf4vEk || Deadhand without ZL
|-
| Ganon's Castle || Gold gauntlets skip without hovers || https://www.youtube.com/watch?v=knD785hDfjw || Fire Trial Gold Gauntlets Skip
|-
| Ganon's Castle || Weirdshot the torch slug || https://www.youtube.com/watch?v=1fYWFCiozc8 || Spirit Trial Chus skip
|-
| Ganon's Castle || Rupee without hookshot/shield || https://www.twitch.tv/videos/49443412 || Spirit Trial Hookshot skip
|-
| Water Temple || Hookshot the chest around the door above || https://www.youtube.com/watch?v=xzUnMvDBwo0 || Cracked Wall Chest No Explosives
|-
| Water Temple || Various tricks to get around in Water Temple || https://www.youtube.com/watch?v=jLWPQ__MO4A || Showcase of Water Temple Mobility
|-
| Water Temple || Hover to river chest from dragon head room || https://www.youtube.com/watch?v=ZgyG1JLxLF4 || Hover to River Chest from Dragon Head Room
|-
| Water Temple || Song of Time skip for longshot to river || https://www.youtube.com/watch?v=rOFJipW6aoQ || Song of Time Skip
|-
| Water Temple || Ledge clip out of bounds || https://www.youtube.com/watch?v=0RTgJZURmHk || Ledge Clip in the Alcove
|-
| Lake Hylia || Child Navi dive and adult can ground clip or swim around if Morpha beaten || https://www.youtube.com/watch?v=LOgjpPd5A_Y https://www.youtube.com/watch?v=W6I_moafi8A || To Zora's Domain from Lake Hylia
|-
| Water Temple || Child entry || https://www.youtube.com/watch?v=CU57Cpgtsv8 || Enter Water with Nothing
|-
| General || Child swordless DoT skip and adult DoT skip || https://www.youtube.com/watch?v=GRyP43DidF8 https://www.youtube.com/watch?v=aolcugsrlkg || DoT Skip
|-
| Hyrule Castle || Clip into Din's Fire without explosives swordless || https://www.youtube.com/watch?v=WGf-8oJQrWk || Din's Fire without Explosives
|-
| Hyrule Castle || Seam walk swordless || https://www.youtube.com/watch?v=5R6-ViFgoiY || Swordless Seamwalk Setup in Hyrule Castle
|-
| Kokiri Forest || Rock push escape || https://www.youtube.com/watch?v=kvW3sJmmmBY || Itemless Escape
|-
| Ganon's Castle || Damage clip into double defense || https://www.youtube.com/watch?v=I3pwrLRSo8U || Damage Clip to Double Defense
|-
| Ganon's Castle || Superslide/recoil clip into double defense || https://www.youtube.com/watch?v=dJQTB4TKJh8 https://www.youtube.com/watch?v=UoPvmiHUMhQ || Superslide or Recoil Clip to Double Defense
|-
| Kakariko Village || Drop off ladder and jumpslash || https://www.youtube.com/watch?v=7XDrhExj3M4 || Tower Skull with Jumpslash
|-
| Graveyard || Unload graves and Shadow door || https://www.youtube.com/watch?v=MKXJHbEpkcw ||
|-
| DMT Chest Clip || Jumpslash clip past the explody wall || https://www.youtube.com/watch?v=wlDgntC5MS0 ||
|-
| DMC Upper from DMT || Tektite Hover || ||
|-
| DMT Magic || Explosiveless magic || ||
|-
| Goron City || Boulder maze hess || ||
|-
| Goron City || Pot with chus || https://www.youtube.com/watch?v=RlBz7qFljZQ ||
|-
| Goron City || Clip into Darunia's room || ||
|-
| DMC Lower || Clip statue in Darunia's chamber as child || ||
|-
| DMC Hammer Grotto || Weirdclip || ||
|-
| Zora's River Clip to LW || Clip or cucco dive || https://www.youtube.com/watch?v=zy9sW50GXhQ ||
|-
| Domain to Lake Clip as Child || Jumpslash clip || https://www.youtube.com/watch?v=Tw0E7nCSVLE ||
|-
| GS Domain || Can also throw pot through the ceiling to kill || https://www.youtube.com/watch?v=vZA5w3f8u5c https://www.youtube.com/watch?v=7itR3yQWsxI ||
|-
| Frozen Domain to Lake || Ladder clip || https://www.youtube.com/watch?v=nFNtKyGu-Jo ||
|-
| Kokiri Forest || Itemless escape || https://www.youtube.com/watch?v=yKjlROAWPDU ||
|-
| Lake Hylia || Tektite hover || ||
|-
| Gerudo Valley || Crate HP as adult with just hoverboots || https://youtu.be/qzqgDPbOY7o ||
|-
| Zora's Domain || Unfreeze king zora with Navi || ||
|-
| Spirit Trial || Rupee with no items - needs setup || ||
|-
| BotW || Ocarina dive || https://www.youtube.com/watch?v=msx6hwUHXKM ||
|-
| BotW || Vine clip with sticks || https://www.youtube.com/watch?v=kweZHHT56-0 ||
|-
| BotW || Vineclip || https://www.youtube.com/watch?v=AbbLcln2PIs ||
|-
| BotW Keese Room GS || Keese hover || https://youtu.be/tuWC0PiXs0c ||
|-
| BotW Pot Room GS || No item hover (watch the right side at the timestamp) || https://youtu.be/G_r44m9Ggjs?t=40 ||
|-
| Dodongo's Cavern || Recoil jump to switch as child || https://www.youtube.com/watch?v=v0TpAcM51AI&t=7s ||
|-
| Goron City || Statue clip to crater as child || https://youtu.be/UCnoWTA4xE8 ||
|-
| Spirit trial || Silver rupees with just mastersword || https://youtu.be/2wR9Pw8CwRg ||
|-
| Ice Cavern || Left side red ice HESS clip || https://www.youtube.com/watch?v=ggzKbvYXv94 ||
|-
| Jabu Compass || Adult no boots/fairy || https://www.youtube.com/watch?v=Dj46eaWJpHs ||
|-
| Jabu Compass || Adult no damage || https://www.youtube.com/watch?v=cXjNjygQK3o ||
|-
| GTG|| Dlame circle key room - gold switch without hammer || https://www.youtube.com/watch?v=DiWbVbyK-J0 ||
|-
| Spirit Temple || Child side as adult with just hoverboots || https://www.youtube.com/watch?v=rLRro_F7MxY ||
|-
| Spirit Temple || Child side as adult with just explosives || https://www.youtube.com/watch?v=VwxYwVHDnPE ||
|-
| Spirit Temple || Clip child side pillar as adult with bombs || https://www.youtube.com/watch?v=ZHANwJT929c ||
|-
| Spirit Temple || Reach adult side as child from main room (crazy dance) || https://www.youtube.com/watch?v=OsWBm2bjsbA ||
|-
| Forest Temple || Reach boss as child || https://youtu.be/wDXpoH5iwnI ||
|-
| Shadow Temple || Child fence clip with jumpslash || https://www.youtube.com/watch?v=pP4JNCU8fgU ||
|-
| Water Temple || Tektite Navi dive || https://youtu.be/iAOlgvI2eaU ||
|}

Hints

2021-06-25T04:03:52Z

ShadowShine57: Added section about hint regions

Hints are given by the Gossip Stones all over Hyrule. There are 40 Gossip Stones in total that give hints once the requirement to get them have been met. This requirement can be set to nothing, having the Stone of Agony in your inventory, and wearing the Mask of Truth. A Gossip Stone was added on the largest island in Lake Hylia which doesn't give a hint, but is instead used to lower and raise the water level in the lake once Morpha has been defeated.

== Hint Categories ==
Hints are split up in multiple categories, to allow customization of the amount of hints of each category in the different hint distributions and with [[Plandomizer]]. Some hint categories only show up in certain hint distributions, and some only show up if certain settings are enabled.

=== Trial ===
Trial Hints tell you which of Ganon's Trials are enabled, if this isn't implicitly known from the settings. There are different possibilities for this to happen, so the amount of them varies by setting:
* If trials are set to random and all 6 trials end up being enabled you will get a single hint: "Ganon's Tower is protected by a powerful barrier."
* If trials are set to random and no trials end up being enabled you will get a single hint: "Sheik dispelled the barrier around Ganon's Tower."
* If 1-3 trials end up being enabled you will get 1-3 of the following hint: "the [Medallion Type] Trial protects Ganon's Tower."
* If 4-5 trials end up being enabled you will get 1-2 of the following hint: "the [Medallion Type] Trial was dispelled by Sheik."

=== Location ===
Location hints are hints that tell you which item is at a specific location. Excluded Locations will never get a hint. These hints are split into four different categories:
* Song Hints
* Minigame Hints
* Overworld Hints
* Dungeon Hints

Locations are also classified as either "Always" or "Sometimes" hints.
==== Always ====
Always Hints are hints for item locations that are considered to be so bad that they will get a hint in every seed. Some of these are dynamic based on other settings in your seed.

==== Sometimes ====
Sometimes Hints are hints manually picked for race settings (Weeklies and Tournaments) and therefore only show up in the Tournament Distribution.

For more information on which hints falls into which category see [[List of all location hints]]

=== Entrance ===
Entrance Hints are exclusive to Entrance Randomizer, and are similar to Location Hints, but instead give you info about which Entrance leads where.

=== Item and Random ===
Item Hints and Random Hints are hints that state that an area has a certain items in it. For example: "The Hookshot can be found at Zora's River" or "Spirit Temple hoards a Red Rupee". Item Hints only hint towards Major Items, whereas Random Hints can hint towards any item in the game.

=== Junk ===
Junk Hints are hints that tell you nothing about the seed. They can be funny in nature or give general gameplay tips.

=== Way of the Hero ===
Way of the Hero (WotH) Hints are hints that tell you that an area holds an item that is logically required to beat the seed. For Example: "Kakariko Village is on the way of the hero." It will only tell you that an area is way of the hero if that specific instance of the item is required. For example, even though a Bow is always required to beat Ganondorf, it might not be on the way of the hero if you have a choice on which one to get first, since there are multiple of them in a seed.
WotH Hints give info only about that area, not any sub-areas. For example, Gerudo Fortress being on the Way of the Hero tells you nothing about Gerudo Training Grounds.

In any seed, a maximum of two WotH hints can point at dungeons (including two hints pointing at the same dungeon) unless the hint distribution is set to Very Strong.

=== Path of Gold ===
Path of Gold hints are exclusive to Triforce Hunt and replace Way of the Hero hints in that mode. They point to items that logically lock any of the Triforce Pieces in that seed. They cannot point at the Triforce Pieces themselves. The hinted item isn't necessarily required to beat the seed, since the amount of Triforce Pieces in the world can be higher than the goal. Otherwise, they work similarly to Way of the Hero hints, including the maximum of two dungeons.

=== Foolish Choice ===
Foolish Choice Hints (also commonly called Barren Hints) point towards areas that contain no [[Major Items]]. This means that you can ignore this area when looking for progression in the seed. To increase the amount of Foolish Areas per seed, there are three exceptions where a Major Item can show up in a Foolish Areas:

# The Major Item isn't shuffled (For example Ocarina, or Ganon's Boss Key if it is set to be on [https://wiki.ootrandomizer.com/index.php?title=Glossary#LACS LACS]), or not considered in logic (Bombchus).
# The item in question doesn't unlock any Location. This list is mostly predetermined and consists of Double Defense, Ice Arrows and Biggoron Sword. Nayrus Love is also in this list damage is not set to Quadruple Damage or OHKO, Scrub Shuffle is disabled, and [[Entrance_Randomizer | ER]] is disabled or set to Dungeons Only. Stone of Agony is also in this list if it isn't used for hints and the trick to open hidden grottos without it is enabled. Serenade of Water and Prelude of Light are also in this list unless Full Indoors or Overworld ER is enabled.
# An exact duplicate of the item is on the WotH AND getting that duplicate would make the item in the Foolish Area obsolete. For Weekly/Tourney standards this can only be Bows, Bombs, "Normal" Bottles, Slingshots and Magic. Depending on other settings this can also include Bombchus, Ocarina, or any non-progressive item if the Item Pool is set to Plentiful.

Special Progressive Major Items are items where getting copies of the item changes the functionality of the item in logic. These items can only be in Foolish Areas if there are more copies in the item pool than there are useful upgrades, and only if the amount of them that are WotH is the same as the amount of useful upgrades. For example: If there are 3 Hookshots in the pool, the third one can be in a Foolish Area, since you only need 2 upgrades to get the Longshot, but only if both other Hookshots are WotH. Special Progressive Major Items and their amount of useful upgrades are: Hookshots (2), Wallets (3), Strength Upgrades (3), and Scales (2). Small Keys (Infinite), but only with Keysanity. Gold Skulltula Tokens (Infinite), but only with Token Bridge and Tokensanity.

One tiny caveat with this is that Skulltula Tokens are not considered Major Items when not playing with Token Bridge, even in tokensanity. This means there's a chance that you'll be required to get Skulltula Tokens from a Foolish area to get to a certain Token Reward.

Foolish Choice Hints give info only about that area, not any sub-areas. For example, Gerudo Fortress being a foolish choice tells you nothing about Gerudo Training Grounds.

In any seed, a maximum of one dungeon can be hinted as Foolish, unless the hint distribution is set to Very Strong.

=== Named-item ===
This type of hint indicates the area in which one instance of a specified item from a provided list can be found, not taking logic into account. For example, you could get a hint which states "They say that Hover Boots can be found in Kakariko Village." which indicates that the only set of Hover Boots are somewhere in Kakariko Village. It is important to note that logic is not taken into account when providing the location. In the case of unique items (such as the hover boots in the example above), this is less important. However, for items with multiple copies, like Slingshots, Bows and Bomb Bags, it is possible for the hints to point towards a self-locked copy of that item. For example, the hints could point to a logically Bow-locked Bow in GTG or Forest.

Named-item hints can be set as 'vague', which will result in the hint only indicating the area which the item may be found, not the specific item that is there. For example, the hint given above, "They say that Hover Boots can be found in Kakariko Village.", would be given as "They say that Kakariko Village may be on the hero's path." if Named-item hins were set as vague.

The list of items from which this hint type can draw is defined by the hint distribution.

== Hint Overlap ==
Item locations can never be hinted towards by more than one hint. For example: This means that if you get a hint for the Song on Ocarina of Time and a hint that Hyrule Field is on the way of the hero, that WotH hint isn't pointing at the song. The hint types that follow this rule are:
* WotH hints
* Location Hints (Song, Minigame, Overworld, Dungeon, Always, and Sometimes)
* Item and Named-item Hints
* Random Hints

This also includes Foolish Choice Hints. However, it will only follow this rule if the Foolish Choice Hint is chosen before the other hint. This means that it is only consistent in the Tournament Distribution. For more info on why this is, see the next section.

== Hint Distributions ==
How hints get distributed amongst the 40 available gossip stones is quite flexible, but falls into two main camps: Weighted Distributions and Exact Distributions. These two main categories have commonalities otherwise, such as allowing duplicates of certain chosen hint types. These are done by type, some having a single copy while others having multiple copies. It's also imporotant to keep in mind that some of the hint types such as Trials hints and Entrance hints are only placed if the settings allow for it.

=== Weighted Distributions ===
Most hint distributions don't have a set amount of hints for each category. Instead, they use weights to pick hint types randomly. The higher the weight, the higher the chance of that hint type getting picked. Trial Hints and Always Hints are exempt from this, and their amount is dependent on the settings.

The amounts and weights for each of the built-in weighted hint distributions are as follows:

==== Useless ====
{| class="wikitable"
|-
! Type !! Weight !! Copies
|-
| Junk || 9.0 || 1
|-
| All other types || 0.0 || 0
|}
Note that this distribution doesn't have any Trial or Always Hints, since the amount of copies is set to 0.

==== Balanced ====
{| class="wikitable"
|-
! Type !! Weight !! Copies
|-
| Trial || 0.0 || 1
|-
| Always || 0.0 || 1
|-
| WOTH || 3.5 || 1
|-
| Foolish || 2.0 || 1
|-
| Item || 5.0 || 1
|-
| Song || 1.0 || 1
|-
| Minigame || 0.5 || 1
|-
| Overworld || 2.0 || 1
|-
| Dungeon || 1.5 || 1
|-
| Entrance || 3.0 || 1
|-
| Random || 6.0 || 1
|-
| Junk || 3.0 || 1
|}

==== Strong ====
{| class="wikitable"
|-
! Type !! Weight !! Copies
|-
| Trial || 0.0 || 1
|-
| Always || 0.0 || 2
|-
| WOTH || 3.0 || 2
|-
| Foolish || 3.0 || 1
|-
| Item || 1.0 || 1
|-
| Song || 0.33 || 1
|-
| Minigame || 0.33 || 1
|-
| Overworld || 0.66 || 1
|-
| Dungeon || 0.66 || 1
|-
| Entrance || 1.0 || 1
|-
| Random || 2.0 || 1
|-
| Junk || 0.0 || 0
|}

==== Very Strong ====
{| class="wikitable"
|-
! Type !! Weight !! Copies
|-
| Trial || 0.0 || 1
|-
| Always || 0.0 || 2
|-
| WOTH || 3.0 || 2
|-
| Foolish || 3.0 || 1
|-
| Item || 1.0 || 1
|-
| Song || 0.5 || 1
|-
| Minigame || 0.5 || 1
|-
| Overworld || 1.5 || 1
|-
| Dungeon || 1.5 || 1
|-
| Entrance || 2.0 || 1
|-
| Random || 0.0 || 0
|-
| Junk || 0.0 || 0
|}

=== Exact Distributions ===
Rather than use weights to randomly choose how many hints of a given type should be chosen, these distributions instead specify exactly how many should exist. For example, you can specify that there should be exactly 4 Way of the Hero (or Path of Gold if Triforce Hunt is enabled) type hints, rather than simply giving them a weight. This allows for structuring the hints so that they are the same every time, particularly useful when a lot of players will be using the same settings for a long time, such as the case with weeklies or tournaments, which is where these types of hints originated.

An important note: if not enough hints of a certain type can be generated, it will just move on to the next type. Additionally, Entrance, Trials, and Always type hints are still dependent on settings, and as such you will often see their amounts as 0. This can be misleading as these hint types will still be generated, but their amounts will vary based on settings.

==== Scrubs ====
The Scrubs Distribution is a continuation of the original Tournament Distribution as was in use from Season 1 to Season 3. This distribution was renamed and is still in use by the Scrub Community and others.

The description from the Hint Distribution file reads: "Tournament hints used for Scrubs Races. Duplicates of each hint, Skull Mask is an always hint, 5 WotH, 3 Foolish, 8 sometimes. Can also be used to simulate S3 Tournament hints."
{| class="wikitable"
|-
! Type !! Amount !! Copies
|-
| Trial || 0 || 2
|-
| Always || 0 || 2
|-
| WOTH || 5 || 2
|-
| Foolish || 3 || 2
|-
| Entrance || 4 || 2
|-
| Sometimes || 0 || 2
|-
| Random || 0 || 2
|}
The Sometimes and Random Hints are used as filler hints. This means that once all other hint types above have been placed, it'll start placing Sometimes hints on the remaining Gossip Stones. If it runs out of those, it'll start placing Random Hints instead.

==== Tournament ====
This distribution covers the current Ocarina of Time Randomizer Tournament's choice of hint distribution as it changes season to season. For Season 4, a new feature was added which allows the removal of certain groups of hint stones, forcing them to be Junk type hints. This allows for better routing of hints, disabling certain locations of hints, or in the case of Season 4 emulating earlier versions of the randomizer where the hints inside the generic grottos were all the same.

Therefore this distribution has the unique sub-category of disabled locations, listed thus: HC (Storms Grotto), HF (Cow Grotto), HF (Near Market Grotto), HF (Southeast Grotto), HF (Open Grotto), Kak (Open Grotto), ZR (Open Grotto), KF (Storms Grotto), LW (Near Shortcuts Grotto), DMT (Storms Grotto), DMC (Upper Grotto).

The description from the Hint Distribution file reads: "Tournament hints used for OoTR Season 4. Gossip stones in grottos are disabled. 4 WotH, 2 Barren, remainder filled with Sometimes. Always, WotH, and Barren hints duplicated."

And lastly the distribution itself is:
{| class="wikitable"
|-
! Type !! Amount !! Copies
|-
| Trial || 0 || 2
|-
| Always || 0 || 2
|-
| WOTH || 4 || 2
|-
| Foolish || 2 || 2
|-
| Entrance || 4 || 1
|-
| Sometimes || 0 || 1
|-
| Random || 0 || 1
|}
This distribution is pretty unique because rather than working with all 40 stones, 11 are removed from consideration, giving a final pool of 29. Also this uses another new feature which allows for certain items to be removed from consideration from a specified hint type. On this distribution, Zelda's Lullaby cannot be hinted as Way of the Hero.

==== DDR ====
This distribution covers the hint distribution used for Season 1 of the DDR ruleset [[Dungeon_Door_Requirement|DDR ruleset]] Tournament. The distribution itself is:

{| class="wikitable"
|-
! Type !! Amount !! Copies
|-
| Always || 0 || 2
|-
| WOTH || 2 || 2
|-
| Foolish || 3 || 2
|-
| Named-item || 3 || 2
|-
| Sometimes || 0 || 2
|}

The list of items used for the Named-item hints is: Hover Boots, Hookshot, Din's Fire, Bomb Bag, Boomerang, Bow, Megaton Hammer, Iron Boots, Magic Meter, Mirror Shield, Fire Arrows, or Strength Upgrade. This selection takes place after the WotH hints are chosen, and so the later takes precedent for overlap purposes. The Named-item hints are also set as 'vague', and so they do not indicate the specific item in the hinted area.

In addition, Zelda's Lullaby, Ruto's Letter, Zora Tunic, and Goron Tunic are prevented from appearing as Way of the Hero hints; they can still be logically required to complete the seed, but the Way of the Hero hints will not directly indicate these items.

The Sometimes Hints are used as filler hints. This means that once all other hint types above have been placed, it'll start placing Sometimes hints on the remaining Gossip Stones.

=== Miscellaneous Hint Distributions===

[[Bingo_hints|Bingo Hints]]

[https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/data/Hints/league.json League Hints]

[https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/data/Hints/mw2.json Multiworld Hints]

=== Copies of WotH hints ===
Because the amount of copies of every hint type is known, you can determine how many WotH items an area has at minimum by the amount of hints you find for it. For example, if you find 2 WotH hints for Shadow Temple in the Tournament Distribution, that only means there's at least one WotH item in there (original hint plus the copy). Once you find a third hint you know for certain that there has to be a second WotH item in Shadow Temple (original hint plus copy plus another hint). Ditto for 5, 7 etc. In distributions where there's only one of each hint you can treat every WotH hint as it's own separate WotH item.

== Hint Logic ==
When a hint points towards a Major Item (WotH hints, location hints, random/item hints), at least one of the hints has to be available before you have to use said item. For example: If Ruto's Letter is on 50 Skultulla Tokens in a non-ER seed with Tournament Distribution, both hints towards it can't be at Zora's Fountain at the same time. At least one of them has to be available without the use of Ruto's Letter. You can (very rarely) use this info to your advantage. For example, if instead Ruto's Letter is at Man on Roof in Kakariko village and you find two WotH Kakariko hints in Zora's Fountain, you now know that at least one of those doesn't point towards Ruto's Letter, so there has to be a different WotH item in Kakariko.

In Beatable Only, some of these hints can still end up on completely unreachable Gossip Stones. You probably won't notice this during gameplay since the stone is completely unreachable in logic. You would have to sequence break to get to the hint in the first place.

== Hint Regions ==
Hint regions are the regions referred to by WotH, Foolish Choice, and Item hints. For example, in the hint "The Hookshot can be found at Zora's River", Zora's River is the hint region. Grottos and interiors fall under the hint region of their encompassing overworld location, but dungeons do not. So, for example, if you get the hint that plundering Zora's Fountain is a foolish choice, this includes the Great Fairy Fountain interior at Zora's Fountain, but does not include Jabu-Jabu's Belly or Ice Cavern, as dungeons are their own hint regions. Also note that Zora's Fountain does not include Zora's Domain, as they are separate overworld regions.

Some notes:
* Although it is an interior, Temple of Time is considered its own hint region.
* Outside Ganon's Castle and Hyrule Castle are separate hint regions.
* If Cowsanity is enabled and hints are on, both ends of Impa's house must be in the same hint region in ER, or a hint for the cow would cross multiple hint regions. Otherwise, the Piece of Heart is considered within the hint region connected to the back of the house.
* For similar reasons, both ends of the Kakariko Potion Shop must be to the same hint region when hints are on.
* However, Windmill/Dampe's Grave are allowed to go between different hint regions. The Windmill Piece of Heart and Song of Storms check are considered part of the hint region connected to the Windmill exit, while Dampe's items are considered part of the hint region connected to the entrance to Dampe's grave.

Hints

2021-06-25T03:21:57Z

ShadowShine57: Remove dated reference to dev version

Trackers

2021-04-09T17:09:29Z

ShadowShine57: Commenting out Automatic Item Tracker v8 as it's no longer available

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.

If you would like to see a Tracker added to the list, please contact a moderator on Discord. :)

{{TOClimit|1}}
= <u>Web Trackers</u> =

==== '''ZidArgs Map Tracker''' ====
(formerly known as 2deep4real)

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

'''Tracker type''': Map Tracker<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''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 sanities and other options are supported.

*Automatic setup of tracker upon import of Spoiler Log (Extra 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

*Save and load your progress.

*A tab for taking notes (e.g. hints).

[[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]]<br/>

=== '''alphachain ER Tracker''' ===

[http://alphachain.recursivebytes.com/ Link]

'''Tracker type''': Entrance Tracker<br>
'''Browser Support (confirmed)''': Microsoft Edge<br>
'''Features''':

*Create a network of entrances by typing chains in a field using a custom syntax.

*Filter all the chains that are irrelevant to the place you wish to go to.

*It takes some getting used to this tracker, but it's a very powerful tool when mastered.

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

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

[http://bombch.us/C8v2 Link]

'''Tracker type''': Entrance Tracker<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''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<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''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]]

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

[https://spoilizer.com/ Link]

'''Tracker type''': Checklist<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''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|300x169px|Spoilizer.png]][[File:Spoilizer2.png|800x450px|Spoilizer2.png]]

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

[https://mracsys.github.io/tootr/ Link]

'''Tracker type''': Entrance/Location Tracker<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome, iOS<br>
'''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]]

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

[http://vadorando.com/ Link]

'''Tracker type''': Checklist<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''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<br>
'''Browser Support (confirmed)''': Microsoft Edge, Mozilla Firefox, Google Chrome<br>
'''Features''':

*A simple Item Tracker.

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

= <u>Downloadable Trackers</u> =

  

=== '''Barinade's Item Tracker''' ===

[http://bombch.us/DOif Link]

'''Tracker type''': Item Tracker <br>
'''Features''':

*A simple Item Tracker.

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

*Customizable colors, item icons and more.

*Supports MMR.

*'''Please keep in mind that auto-trackers are banned in all races that take place on Racetime and SpeedRunsLive.'''

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

=== '''Countdhoun's Item Tracker''' ===

[https://www.millstoneworks.com/item-tracker.html Link]

'''Tracker type''': Item Tracker <br>
'''Features''':

*A simple Item Tracker.

*Supports keysanity and random song notes.

*Save load up to 6 trackers.

*Allows counting skulls, heart pieces, ice traps and blupees with keyboard binds.

*Customizable layout and background.

*MMR support planned.

[[File:Countdhoun.png|650x366px|Countdhoun.png]][[File:Countdhoun3.png|650x366px|Countdhoun3.png]][[File:Countdhoun2.png|650x366px|Countdhoun2.png]]

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

[http://bombch.us/C8jl Link]

'''Tracker type''': Item Tracker <br>
'''Features''':

*A simple Item Tracker.

*Automatically adjusts the layout upon resizing of window.

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



=== '''Fenhl's Tracker''' ===

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

'''Tracker type''': Item Tracker<br>
'''Features''':

*Supports manual tracking on macOS and Windows systems
*Supports auto-tracking with Bizhawk 2.6+ 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/ and https://ootr-random-settings-tracker.web.app/
*'''Please keep in mind that auto-trackers are banned in all races that take place on Racetime and SpeedRunsLive.'''

[[File:TrackerFenhlTrackerDimmedV3.png|276x367px|TrackerFenhlTrackerDimmedV3.png]] [[File:TrackerFenhlTrackerLitV3.png|276x367px|TrackerFenhlTrackerLitV3.png]]

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

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

'''Tracker type''': Item Tracker <br>
'''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]]

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

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

'''Tracker type''': Item/Location/Entrance Tracker<br>
'''Features''':

*Handles Entrance Shuffle
*Uses the Randomizer logic directly

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

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

[http://bombch.us/DNro Link]

'''Tracker type''': Item Tracker <br>
'''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]]

=== ''LinSo's Item Tracker'' ===

[https://pastebin.com/vYrNGweu Link]

'''Tracker type''': Item Tracker <br>
'''Features''':

*A simple Item Tracker.

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

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

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

'''Tracker type''': Entrance Randomizer Tracker<br>
'''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''' ===

[http://bombch.us/DBxi Link]

'''Tracker type''': Entrance Tracker <br>
'''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''' ===

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

'''Tracker type''': Location Tracker<br>
'''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)
*'''Please keep in mind that auto-trackers are banned in all races that take place on Racetime and SpeedRunsLive.'''

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

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

[http://bombch.us/C8jm Link]

'''Tracker type''': Green Rupee Tracker <br>
'''Features''':

*A Green Rupee Tracker.

*Doesn't support MQ.

[[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 <br>
'''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]]

= <u>EmoTracker</u> = 

[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]]

=== '''Fouton's PugHUD Package''' ===

'''Tracker type''': Item Tracker<br>
'''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<br>
'''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]]<br>[[File:Hamsda1.png|800x450px|Hamsda1.png]]

=== '''JRJathome's Package''' ===

'''Tracker type''': Item Tracker<br>
'''Features''':

*A simple Item Tracker.

*Supports keysanity.

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

=== '''Raikaru's & atz's Package''' ===

'''Tracker type''': Item Tracker<br>
'''Features''':

*A simple Item Tracker.

*Supports keysanity.

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

=== '''Xopar's Package''' ===

'''Tracker type''': Item Tracker<br>
'''Features''':

*A simple Item Tracker.

*Supports keysanity.

[[File:Xopar.png|600x388px|Xopar.png]]

=== '''Darkened5ky's & Spleebie's Package''' ===

'''<span style="color:red">NOTE: According to the creators themselves this package is very out of date with logic and will therefore probably be changed to an item-only package in the near future due to neither of them having the desire/time to keep it updated. Use at your own risk.</span>'''

'''Tracker type''': Map Tracker<br>
'''Features''':

*Supports keysanity and different DoT, forest and rainbow bridge options.

*Has 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.

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

Plandomizer

2021-03-18T21:22:59Z

ShadowShine57: Changed #setup-support to #plando-support

'''Plandomizer''', often shortened to just '''Plando''', permits total control over item placement. You can place a specific item on any location and locations not specified will be filled following the normal algorithm. Using a <samp>.json</samp> format text file, referred to as a '''distribution file''' when using plandomizer, most aspects of the randomizer can be overwritten.

This can be used to create custom challenges to play through yourself or share with others. The more details defined in a plandomizer, the less the randomizer interferes, though the randomizer will still verify whether it is beatable based on the logic settings, and if it is logically impossible it will refuse to generate a seed.

There is a [https://ootrandomizer.com/plandoMaker beta GUI for Plandomizer on the website] that can help you with simpler plandomizer ideas, however to truly grasp the power of plandomizer you will have to modify a distribution file yourself. '''''Warning:''' This is a beta feature and frequently generates JSON files with issues that must be fixed in a text editor prior to use. Please visit the plando-support channel in the discord for help resolving these errors.
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Also note that the following are not assignable. </p>
<pre class="mw-collapsible-content" style="display:inline-block">Deliver Letter
Sell Big Poe
Skull Mask
Spooky Mask
Keaton Mask
Bunny Hood
Mask of Truth
Milk
Goron Mask
Zora Mask
Gerudo Mask
Zeldas Letter
Location: HC Zeldas Letter
</pre></div>
These items and location are used internally by the logic to handle new item locations becoming available. They are not meant to be used in a plando.

== Using a Plandomizer Distribution File on the Generator ==
Plandomizer's distribution file text box is hidden by default. To enable it go to <samp>ROM Options</samp> on the generator and turn on the <kbd><samp>Enable Plandomizer (Optional)</samp></kbd> setting. Then use the <kbd><samp>Browse</samp></kbd> button next to the new text box to find your Plandomizer distribution <samp>.json</samp> file.

== Opening and Editing a Distribution File ==
Distributions are just normal text files using the <samp>.json</samp> extension instead of the <samp>.txt</samp> extension. They can be opened in any text editor that will open <samp>.txt</samp> files. Even Notepad, TextEdit, and gedit can open these files. The extension is only to help let you know that text within is expected to look a certain way.

=== Distribution File Format ===
'''JSON''' is a common format used for data that both a human and a computer are intended to read. It's a fairly picky format so it is a good idea to use a text editor that can tell you if you did something wrong through syntax highlighting. [https://visualstudio.microsoft.com/ Visual Studio Code] is such a text editor, and as it is cross-platform and used by many people in the community. It is the one we recommend you use if you go down this path. Alternatively, a validator such as [https://jsonlint.com/ JSONLint] can check formatting, if you prefer a text editor without syntax highlighting. A validator may also help identify issues which are harder to understand in VSCode.

The randomizer generator on the website will also display an error if you try to use a distribution file that is not in the proper JSON format. You may wish to use this, JSONLint, and VSCode all together to figure out how to fix any formatting problems.

=== Understanding a Distribution File ===
When generating a seed with a spoiler log, that spoiler log is actually a distribution file itself. It can be used directly to generate the exact same seed. Because of this, you can take a look at a spoiler log to help you get familiar with the types of things that can be changed, and how to format the distribution file.

Since a distribution file is in JSON format, it's somewhat rigid about how things can be written.

=== The Base Dictionary ===
First, a distribution file starts with a <kbd>{</kbd> opening curly brace, and ends with a <kbd>}</kbd> closing curly brace. Everything you define must be placed between these braces. These braces mark a '''Dictionary''' or an [https://en.wikipedia.org/wiki/Associative_array associative array], and while that link has a lot of useful information, you don't really have to understand it. Think of a dictionary data structure like you would a dictionary in the real world. You have a term, then you have the definition of that term. As this is the base dictionary, you don't write a term as the code that reads the JSON file creates its own term for this dictionary.

=== The Dictionary "Terms" ===
Within the base dictionary there are many terms, such as <samp>:version</samp>, <samp>file_hash</samp>, and <samp>locations</samp>. If you are viewing a spoiler log you'll notice some of these terms start with a <kbd>:</kbd>. These terms are ignored when Plandomizer is used and are autogenerated by the randomizer. When you are creating a distribution file yourself you can delete these terms.

Terms are followed by a <kbd>:</kbd> and then some spaces, then their definitions.

Definitions that start and end with <kbd>"</kbd> are '''Strings'''. They are just text you write, but it is important that they are between quotes.

Definitions starting with <kbd>[</kbd> an open bracket and ending with a <kbd>]</kbd> closing bracket are called '''Lists'''. In a distribution file lists will usually only contain strings. However, with other types of JSON files you could see them containing other data structures such as dictionaries, or other lists.

The rest of the definitions are just more dictionaries with their own terms that have definitions. These are the only data structures that you have to keep in mind, and generally they are already defined properly in the spoiler log for you so you can just modify them how you see fit. Just ensure you don't accidentally remove the symbols that go before and after the term.

=== The Most Common Format/Syntax Issue ===
You'll notice that each of these terms is followed at the very end by a <kbd>,</kbd> comma, except the very last one. This is probably the most common mistake someone will make when making their own distribution file. Each term needs to be separated by a comma, but the last one cannot have a comma after it. This is true for strings inside of lists, and lists, strings, and other dictionaries within a dictionary as well. If you are getting a syntax error, you probably added a comma you shouldn't have, or removed one you need. The generator will tell you that your JSON is invalid if you try to use a distribution file with one of these errors.

== What Can Plandomizer Affect ==
Plandomizer can affect an enormous amount of the resulting seed. Everything from inconsequential things like the File Hash, to the Settings the randomizer uses to fill the world, and even specifically set items in locations that the world fill algorithm will have to work around.

=== File Hash ===
The file hash is the 5 icons that are displayed at the top of the file select screen. You can set these to any valid [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Spoiler.py#L9-L42 HASH_ICON].

You can set the <samp>file_hash</samp> definition to a list of up to 5 hash icons. If you do not want to specify an icon for a set position you can either set it to the value '''null''', or if it is after all the ones you do want to set you can just not include it.

==== Hash Icons ====
<div class="mw-collapsible mw-collapsed" style="display:inline-block">
<p style="overflow:auto">Expand to view the full list of valid hash icons for the current version of the randomizer.</p>
<pre class="mw-collapsible-content" style="display:inline-block">
'Deku Stick',
'Deku Nut',
'Bow',
'Slingshot',
'Fairy Ocarina',
'Bombchu',
'Longshot',
'Boomerang',
'Lens of Truth',
'Beans',
'Megaton Hammer',
'Bottled Fish',
'Bottled Milk',
'Mask of Truth',
'SOLD OUT',
'Cucco',
'Mushroom',
'Saw',
'Frog',
'Master Sword',
'Mirror Shield',
'Kokiri Tunic',
'Hover Boots',
'Silver Gauntlets',
'Gold Scale',
'Stone of Agony',
'Skull Token',
'Heart Container',
'Boss Key',
'Compass',
'Map',
'Big Magic',
</pre></div>

==== Examples ====
'''Set all 5 icons to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut", "Deku Nut"]
</pre></blockquote>

'''Set only the first icon to Deku Nut''':
<blockquote><pre>
"file_hash": ["Deku Nut", null, null, null, null]
</pre>
or
<pre>
"file_hash": ["Deku Nut"]
</pre></blockquote>

'''Set only the last icon to Deku Nut''':
<blockquote><pre>
"file_hash": [null, null, null, null, "Deku Nut"]
</pre></blockquote>

=== Settings ===
This is a dictionary defining the rules that the randomizer uses to fill the world. ''Any settings you set here will override the ones set in the GUI''. That also means that you can leave some settings out of this dictionary and the person using your distribution file to create a seed can have a small amount of customization they can apply in case they need a little more additional help, or perhaps want to increase the difficulty a little bit.

It is not recommended to set these manually. Instead, you should go to the beta plandomizer maker on the website. You can set all the settings you want on the first tab, then create the JSON file. From here you can copy the settings dictionary from that file into this file and remove any settings you don't want to enforce. Alternatively, if you only want a few settings to be enforced, you can copy only the settings you want from the dictionary in that other JSON file into the settings dictionary in your settings file.

There are two major issues with creating the settings dictionary entirely manually:
# If you mistype, or the name of a setting changes between versions, you will not get an error. The randomizer will just ignore this issue entirely.
# The process of figuring out the proper name for a setting, and the various values it can hold is tedious.

If you still think you want to try this method, the file in the source code you want to look at to see all this necessary information is [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/SettingsList.py SettingsList.py]. This is a 3000 line monstrosity that isn't very useful if you're not already pretty familiar with the settings you are looking for in the first place. Each setting has a <var>name</var> that you have to use for a definition inside of the settings dictionary. Then various other variables within the option's object in the settings list file are used to determine what possible definitions you want to use for that setting.

Just using the plandomizer maker on the website is highly recommended over putting yourself through this experience.

=== Starting Items ===
The starting items dictionary lets you define what items a player starts with, and how many of them. This includes both items you find in the world, and consumables you would pick up such as ammo and bombs. Any items you start with will be replaced by junk in the item pool. Songs placed here will force an item to be on one of the song locations even if <var>shuffle_song_items</var> is not set. This will completely override the starting items set on the randomizer generator GUI.

The term is the item you want to start with. The definition is how many of that item you want to start with. The number is not a string and should not be put in quotes.

==== Examples ====
'''Start with full wallet without Max Rupees setting''':
<blockquote><pre>
"starting_items": {
"Rupees": 99
}
</pre></blockquote>

'''Start with all shields''':
<blockquote><pre>
"starting_items": {
"Deku Shield": 1,
"Hylian Shield": 1,
"Mirror Shiled": 1
}
</pre></blockquote>

=== Item Pool ===
This is a dictionary defining every item possible to place in the world. ''It is highly recommended that you do not set every possible item to a value in this dictionary.'' Primarily junk items because the randomizer often needs to generate new junk, but will not change any value you manually place in the item pool. This would make your plandomizer very rigid and can cause various issues if you try changing settings that change what, and how many items you start with, or that are available in the base pool.

You can also specify if you want to <var>add</var> to the base number, <var>remove</var> from the base number, or <var>set</var> the base number for the item. The default is to set the value. If you want to use the other options you'll need to set the definition to be another dictionary.

The term is the item you want to specify the number of in the pool. The definition is either:
# The number of that item you want in the pool
# A dictionary with a term of <var>type</var> set to any of the strings "add", "remove", or "set" and a term of <var>count</var> set to the number to modify by.

==== Examples ====
'''Set Mirror Shield to have 3 copies placed in the world''':
<blockquote><pre>
"item_pool": {
"Mirror Shield": 3
}
</pre>
or
<pre>
"item_pool": {
"Mirror Shield": {
"type": "set",
"count": 3
}
}
</pre></blockquote>

'''Add 3 Deku Shields to place in the world in addition to the ones already in the base pool''':
<blockquote><pre>
"item_pool": {
"Deku Shield": {
"type": "add",
"count": 3
}
}
</pre></blockquote>

=== Dungeons ===
This dictionary lets you define which dungeons are <var>vanilla</var> and which are <var>mq</var> (master quest). ''You will have to set the number of MQ dungeons setting to match at least whatever master quest dungeons you define here''. However, you do not have to define all of the dungeons and the rest will be defined by the randomizer generator instead.

The term is the name of the dungeon. The definitions is either the string "vanilla", the string "mq", or the string "random".

==== Examples ====
'''Set only Deku Tree to mq''':
<blockquote><pre>
"dungeons": {
"Deku Tree": "mq"
}
</pre></blockquote>

'''Set only Spirit Temple to vanilla, because you don't want to learn the second version of spirit logic''':
<blockquote><pre>
"dungeons": {
"Spirit Temple": "vanilla"
}
</pre></blockquote>

'''Set Dodongo's Cavern to random''':
<blockquote><pre>
"dungeons": {
"Dodongos Cavern": "random"
}
</pre></blockquote>

=== Trials ===
You will define which trials are <var>active</var> and which ones are <var>inactive</var> in this dictionary. ''You will have to set the number of trials to match at least the trials you define here''. However, you do not have to define all of the trials and the rest will be defined by the randomizer generator instead.

The term is the name of the trial. The definition is either the string "active", the string "inactive", or the string "random".

==== Examples ====
'''Set forest, fire, and water trials as inactive''':
<blockquote><pre>
"trials": {
"Forest": "inactive",
"Fire": "inactive",
"Water": "inactive"
}
</pre></blockquote>

'''Set light trial to active, ensuring that 3 strength upgrades are required for fighting Ganon''':
<blockquote><pre>
"trials": {
"Light": "active"
}
</pre></blockquote>

'''Set water trial to random''':
<blockquote><pre>
"trials": {
"Water": "random"
}
</pre></blockquote>

=== Entrances ===
This dictionary defines how different entrances are linked together when using entrance randomizer. Entrances must be shuffled among their respective groups so you cannot use plandomizer to force a mixed entrance pool seed. You may wish to generate a entrance randomizer seed and use its spoiler log to ensure you use the correct names for the locations.

The term is the loading zone you pass through. The definition is:
* '''For Dungeons and Interiors''': a string with the name of the location you end up at
* '''For Overworld''': a dictionary with a term of <var>region</var> set to a string of the overworld region it leads to and a term of <var>from</var> set to a string of the loading zone in that region that you will appear out of.

==== Examples ====
'''Set Deku Tree entrance to Gerudo Training Grounds''':
<blockquote><pre>
"entrances": {
"KF Outside Deku Tree -> Deku Tree Lobby": {"region": "Gerudo Training Grounds Lobby", "from": "Gerudo Fortress"}
}
</pre></blockquote>

'''Set Hyrule Castle exit from Market to Lon Lon Ranch main entrance''':
<blockquote><pre>
"entrances": {
"Market -> Castle Grounds": {
"region": "Lon Lon Ranch",
"from": "Hyrule Field"
}
}
</pre></blockquote>

=== Locations ===
This dictionary handles what is probably the main feature of plandomizer. You can assign items to any location in the game world here. Which locations are available are heavily influenced by what settings you choose, so ensure you have the proper settings set.

The term is the name of the location. The definition is either:
* A string of an item to place there
* A list containing multiple items to randomly choose from to place there
* A dictionary containing the term <var>item</var> containing one of the above two bullet points.
** If making a multiworld plandomizer: the term <var>player</var> with the world number value of the player the item belongs to.
** If the location is a shop: the term <var>price</var> with the rupee number value the item should cost. ''You cannot set scrub prices using plandomizer''
** If the item can be an ice trap: the term <var>model</var> set to a string of the item model it should appear as in the overworld.

==== Shop Location Numbers ====
Due to the odd way the shop items are stored in the game files, using shopsanity item placement is not very intuitive.

When using 1 item shopsanity, the number you use is 7 and is the bottom left item on the left side.<br/>
When using 2 items shopsanity, you also have number 5 which is the bottom right item on the left side.<br/>
When using 3 items shopsanity, you add on the number 8 which is the top left item on the left side.<br/>
When using 4 items shopsanity, you can now use all 4 numbers 5-8 for all of the left side items.

==== Special Item Groups ====
There are shortcut terms you can use for certain items when using plandomizer. They start with the <kbd>#</kbd> character. The ones that should work fine are:
<pre style="display:inline-block">
#Bottle - Places a bottle and randomly chooses a contents for it
#Junk - Places a junk item (used by exclude locations)
#AdultTrade - Places the adult trade item without specifying which one
</pre>

If you are feeling a little bit more daring, you can try:
<pre style="display:inline-block">
#Song - Places a song item
#NonWarpSong - Places non warp song item
#WarpSong - Places a warp song item
#JunkSong - Places Serenade or Prelude in non-entrance randomizer.
#Spell - Places one of the three spells
#Shield - Deku or Hylian. Doesn't include Mirror.
#HealthUpgrade - Heart Container or Piece of Heart
</pre>

All of these should work, but only the first list have been extensively tested.

==== Examples ====
'''Ready to fight Ganon after Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "Bow",
"KF Midos Top Right Chest": "Magic Meter",
"KF Midos Bottom Left Chest": "Light Arrows",
"KF Midos Bottom Right Chest": "Ice Trap"
}
</pre></blockquote>

'''Bottles in Mido's''':
<blockquote><pre>
"locations": {
"KF Midos Top Left Chest": "#Bottle",
"KF Midos Top Right Chest": "#Bottle",
"KF Midos Bottom Left Chest": "#Bottle",
"KF Midos Bottom Right Chest": "#Bottle"
}
</pre></blockquote>

'''One step to fighting Ganon in the Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"KF Kokiri Sword Chest": ["Bow", "Magic Meter", "Light Arrows"]
}
</pre></blockquote>

'''Setting shopsanity 1 item in Kokiri Shop to Ice Trap posing as Light Arrows''':
<blockquote><pre>
"locations": {
"KF Shop Item 7": {
"item": "Ice Trap",
"price": 60,
"model": "Light Arrows"
}
}
</pre></blockquote>

'''Place player 2's Light Arrows in player 1's Kokiri Sword chest''':
<blockquote><pre>
"locations": {
"World 1": {
"KF Kokiri Sword Chest": {
"item": "Light Arrows",
"player": 2
}
}
}
</pre></blockquote>

=== Hint Distribution Files ===

Hint distribution file format is similar to the old hard-coded dictionaries, plus new keys to offer finer control of different hint groups. The goal of this change is to facilitate easier sharing and updating of custom hint distributions for the different racing tournaments. An example with the Tournament distribution is provided below.

<pre>{
"name": "tournament",
"gui_name": "Tournament",
"description": "Fixed number of hints for each type, contains duplicates, and only useful hints.",
"add_locations": [
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [],
"add_items": [],
"remove_items": [],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 5, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 3, "copies": 2},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 100, "copies": 2},
"random": {"order": 7, "weight": 9.0, "fixed": 0, "copies": 2},
"item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"song": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"overworld": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"junk": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2},
"named-item": {"order": 0, "weight": 0.0, "fixed": 0, "copies": 2}
}
}</pre>
GUI names and tooltip descriptions are now defined with each distribution file. Tooltips are automatically parsed to add line returns as needed for the GUI.

==== Hint Type Distribution ====

The <code>distribution</code> key is a similar format to the previous dictionary. Each hint group must be listed with the following keys:

* <code>order</code>: Integer to sort hint types from smallest to largest
* <code>weight</code>: Same as hint type weight in balanced and similar hint distributions
* <code>fixed</code>: Same as tournament distribution number of hints per world
* <code>copies</code>: Same as count per hint in predefined distributions

Tournament-style fixed hints and weighted-style hints are defined together in the same distribution. Fixed hints are rolled first. Any remaining gossip stones are filled from a random choice of hint types with assigned weights. Checks exist to make sure there are enough gossip stones left for a given random hint type count per hint. Fixed hints do not have this safeguard and rely on the user not to overfill them. Using the tournament distribution as an example, fixed hints are rolled according to the defined order and fixed number. If any gossip stones remain, the <code>random</code> hint group is rolled as part of the weighted hint types (in this case the only one, so it is guaranteed upon exhaustion of all sometimes hints). Other built-in hint types with no fixed hints have non-zero orders for all types and weights equal to the old style weight, and all types have a <code>fixed</code> value of <code>0</code>.

==== Dungeon Limits ====

Dungeon way of the hero and barren limitations are moved out of the hint generation functions into the distribution files. Values are identical in all built-in distributions except <code>very_strong</code>, which has a limit of <code>40</code> for both (equivalent to no limit).

==== Hint Type Requirements and Exclusions ====

Four new lists are provided to include or exclude hinted locations from different hint groups, as specified by the location name or filled item name. As seen in the tournament distribution, the <code>add_locations</code> key can be used to force a given location to be hinted by adding it to the <code>always</code> hint type. Locations can be added to (or removed from) any hint type. Likewise, the item keys allow for adding or removing locations to be hinted based on what items they contain. For example, to remove all songs from being hinted as way of the hero, the following would be utilized:

<pre>"remove_items": [
{ "item": "Zeldas Lullaby", "types": ["woth"] },
{ "item": "Eponas Song", "types": ["woth"] },
{ "item": "Sarias Song", "types": ["woth"] },
{ "item": "Suns Song", "types": ["woth"] },
{ "item": "Song of Time", "types": ["woth"] },
{ "item": "Song of Storms", "types": ["woth"] },
{ "item": "Minuet of Forest", "types": ["woth"] },
{ "item": "Bolero of Fire", "types": ["woth"] },
{ "item": "Serenade of Water", "types": ["woth"] },
{ "item": "Requiem of Spirit", "types": ["woth"] },
{ "item": "Nocturne of Shadow", "types": ["woth"] },
{ "item": "Prelude of Light", "types": ["woth"] }
]</pre>
Alternately, if songsanity is disabled, the song locations could be removed from the <code>woth</code> hint type to achieve the same effect.

Way of the Hero and Barren hints cannot have locations added via `add_locations`. Additionally, Barren hints cannot be removed via `remove_locations`. This is to prevent situations where required items are in hinted barren areas. Using the song example again, a foolish Song of Storms that leads to a required item in Bottom of the Well would be confusing to players unfamiliar with the setting. Excluding from way of the hero means it won’t be hinted, not that the game is actively lying to you.

Barren hints can be added or removed from consideration for specific items via the <code>add_items</code> and <code>remove_items</code> lists. This affects not just hints, but also the <code>:barren_regions</code> list in the spoiler log. In contrast, way of the hero items will still be listed in the <code>:woth_locations</code> section regardless of hint distribution changes. Forced barren items that are logically required still show up in the <code>:woth_locations</code> list if required by the seed.

==== Plando Support ====

The <code>hint_dist_user</code> setting takes a hint distribution dictionary as defined by the built-in hint distribution files. If specified, it overrides the GUI-selected hint distribution. Internally, the distribution is defined as <code>custom</code>.

==== Example Plando ====

The attached plando

* Requires a “random”-type location hint for the location containing Lens of Truth
* Adds shooting the sun in Lake Hylia as an always hint with custom text
* Removes Frog Ocarina Game and 40 Skulls as always hints
* Keeps other “conditional” always hints from Standard weekly settings, including Skull Mask
* Adds the location with Zelda’s Lullaby as an always hint
* Removes all other song locations from way of the hero and sometimes hint types
* Forces Rutos Letter to be considered foolish, and places it outside Ganon’s Castle to verify
* Excludes Biggoron Sword from foolish hints, and places it in the Haunted Wasteland to verify

and applies a custom hint distribution as follows:

====== Fixed Hints ======

(in order)
* Always and Trials hints at 2 stones/hint
* 1 Named Item hint for Lens of Truth at 2 stones/hint (as required by <code>named_items_required</code>)
* 3 Way of the Hero hints at 2 stones/hint
* 2 Foolish hints at 1 stone/hint
* 4 Entrance hints at 2 stones/hint
* 5 Sometimes hints at 1 stone/hint

====== Weighted Hints ======

On weekly settings, this is 27-29 gossip stones filled, depending on if Zelda’s Lullaby is on Ocarina of Time. The remaining 11-13 stones draw hints from weighted hint types as follows:

* Random (0.5 weight, 2 stones/hint)
* Item (1.0 weight, 2 stones/hint)
* Song (2.0 weight, 2 stones/hint)
* Overworld (3.0 weight, 2 stones/hint)
* Dungeon (1.0 weight, 2 stones/hint)
* Junk (0.5 weight, 1 stone/hint)

At least 1 junk hint will be added due to the odd number of remaining stones.

<pre>{
"settings": {
"item_hints": [
"Lens of Truth"
],
"hint_dist_user": {
"name": "custom",
"gui_name": "Plando Test Hint Distribution",
"description": "for debugging",
"add_locations": [
{ "location": "LH Sun", "types": ["always"], "text": "those who #blot out the sun# will find" },
{ "location": "Deku Theater Skull Mask", "types": ["always"] }
],
"remove_locations": [
{ "location": "ZR Frogs Ocarina Game", "types": ["always"] },
{ "location": "Kak 40 Gold Skulltula Reward", "types": ["always"] }
],
"add_items": [
{ "item": "Zeldas Lullaby", "types": ["always"] },
{ "item": "Rutos Letter", "types": ["barren"] }
],
"remove_items": [
{ "item": "Eponas Song", "types": ["woth", "sometimes"] },
{ "item": "Sarias Song", "types": ["woth", "sometimes"] },
{ "item": "Suns Song", "types": ["woth", "sometimes"] },
{ "item": "Song of Time", "types": ["woth", "sometimes"] },
{ "item": "Song of Storms", "types": ["woth", "sometimes"] },
{ "item": "Minuet of Forest", "types": ["woth", "sometimes"] },
{ "item": "Bolero of Fire", "types": ["woth", "sometimes"] },
{ "item": "Serenade of Water", "types": ["woth", "sometimes"] },
{ "item": "Requiem of Spirit", "types": ["woth", "sometimes"] },
{ "item": "Nocturne of Shadow", "types": ["woth", "sometimes"] },
{ "item": "Prelude of Light", "types": ["woth", "sometimes"] },
{ "item": "Biggoron Sword", "types": ["barren"] }
],
"dungeons_woth_limit": 2,
"dungeons_barren_limit": 1,
"named_items_required": "True",
"distribution": {
"trial": {"order": 1, "weight": 0.0, "fixed": 0, "copies": 2},
"always": {"order": 2, "weight": 0.0, "fixed": 0, "copies": 2},
"woth": {"order": 3, "weight": 0.0, "fixed": 3, "copies": 2},
"barren": {"order": 4, "weight": 0.0, "fixed": 2, "copies": 1},
"entrance": {"order": 5, "weight": 0.0, "fixed": 4, "copies": 2},
"sometimes": {"order": 6, "weight": 0.0, "fixed": 5, "copies": 1},
"random": {"order": 7, "weight": 0.5, "fixed": 0, "copies": 2},
"item": {"order": 8, "weight": 1.0, "fixed": 0, "copies": 2},
"song": {"order": 9, "weight": 2.0, "fixed": 0, "copies": 2},
"overworld": {"order": 10, "weight": 3.0, "fixed": 0, "copies": 2},
"dungeon": {"order": 11, "weight": 1.0, "fixed": 0, "copies": 2},
"junk": {"order": 12, "weight": 0.5, "fixed": 0, "copies": 1},
"named-item": {"order": 13, "weight": 0.0, "fixed": 0, "copies": 2}
}
}
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {},
"entrances": {},
"locations": {
"OGC Great Fairy Reward": "Rutos Letter",
"Wasteland Chest": "Biggoron Sword"
}
}</pre>
==== Item Hints for Bingo ====

The <code>item_hints</code> plando setting contains a list of items as named in ItemList.py to be added as “random” location hints. This is outside of the hint distribution setting. Built-in hint distributions assume copies per hint is the same as the sometimes category equivalent of the original distribution. The <code>named_items_required</code> hint distribution key controls if named item hints are treated as always hints. In contrast to always hints, an error will be thrown if any required named item hint cannot be placed.

Plando or third party hint distribution files can specify fixed or weighted <code>named-item</code> group hints if <code>named_items_required</code> is false.

Note that <code>add_items</code> provides similar functionality to the <code>item_hints</code> plando key if an item is added to the <code>always</code> group. The reason for duplication of this feature is to provide an easier interface for Bingo races desiring hinted tile goals without building a whole hint distribution from scratch.

===== Example Bingo Plando =====

The example plando below:

* Requires two separate strength upgrades to be hinted
* Requires Lens of Truth to be hinted
* Modifies the item pool to contain 3 empty bottles, one of which will be hinted.

<pre>{
"settings": {
"item_hints": [
"Progressive Strength Upgrade",
"Progressive Strength Upgrade",
"Lens of Truth",
"Bottle"
]
},
"randomized_settings": {},
"starting_items": {},
"item_pool": {
"Bottle": 3
},
"entrances": {},
"locations": {}
}</pre>

=== Gossip Stones ===
This dictionary is just evil. It lets you replace the Gossip Stone text with any text you wish. Unlike normal randomizer, this text can lie and mislead the player. It is recommended that you use it more for inside jokes, or different types of hints than you'd normally get using the randomizer to keep the plandomizer fun for the player. Gossip stones set here will not be taken into consideration for hints by logic.

The term is the name of the Gossip Stone. The definition is a dictionary with the term <var>text</var>.
* Any text you surround with <kbd>#</kbd> can also be colored. If you wish to do this add another term to the inner dictionary with the term <var>colors</var> and set it to a list containing strings of the colors you wish to use. You can have multiple groups of text surrounded by <kbd>#</kbd> and each one can be a different color.

==== Valid Colors ====
<pre style="display:inline-block">
White
Red
Green
Blue
Light Blue
Pink
Yellow
Black
</pre>

==== Examples ====
'''Just white text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "It's hot in here!"
}
}
</pre></blockquote>

'''Colored text''':
<blockquote><pre>
"gossip_stones": {
"DMC (Bombable Wall)": {
"text": "They say #Luigi# was put in this game instead of Super #Mario# 64",
"colors": ["Green", "Red"]
}
}
</pre></blockquote>

=== Cosmetics and Sounds ===

As of version 6.0 users can select both their cosmetics and sounds with a cosmetics plandomizer file. Just like how the spoiler log syntax is used to create a plandomizer file for locations, entrances, etcetera, the cosmetics log syntax is used to create a cosmetics plandomizer file. '''This plandomizer file has to be inserted separately''', because cosmetics and sounds are typically (re-)applied after the patching process. Make sure that the file is saved as a <kbd>.json</kbd> file. To insert a cosmetics plando, toggle <kbd><samp>Enable Cosmetics Plandomizer (Advanced)</samp></kbd> on the <kbd><samp>ROM Options</samp></kbd> tab and insert it in the field that will appear below. Note; if you also toggled <kbd><samp>Enable Plandomizer (Advanced)</samp></kbd>, then there will be two fields.

[[File:Cosmeticsplandoweb.png|700px]]

==== Cosmetics ====
''Note: Custom cosmetics colors can be chosen through the GUI as well, so it is not needed to specify these in the plandomizer. ''

There are two ways in which you can plandomize cosmetics. The first is to specify colors through hex values. This gives you the freedom to select any color in the color spectrum for any of the cosmetics options. The second method is to use presets built into the randomizer. These are the options found in the dropdown bars in the GUI and include options such as "Kokiri Green", "Random Choice" and "Magenta". Keep in mind that each cosmetic option has its own set of preset colors and that they can't be used interchangeably. For example, tunics have the preset color "Majora Purple", but gauntlets do not, so that color cannot be set for gauntlets unless you specify hex values. Because of this limitation it is recommended that users specify hex values. [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Colors.py The hex values associated with the preset colors can be found here]. The correct formatting for the plandomizer file is to take the three double-character codes that follow an "x" and put them next to each other in the order in which they appear, preceded by a "#". For example the hex value for "Kokiri Green" in the correct format is <code>#1E691B</code>. It's case-insensitive and the order matters.

Some cosmetics can be made to cycle through the colors of the rainbow. This cannot be done with hex values and must be specified using the "Rainbow" preset. This is currently only supported for Navi, Bombchu trail, Boomerang trail and Sword trail cosmetics.

The sword trail duration option is unique in that you don't specify a string but an integer. This integer denotes for how many frames the sword trail will linger with the presets being "Default" (= 4), "Long" (= 10), "Very Long" (= 15) and "Lightsaber" (= 20). Normal gameplay is 20 frames per second, so "Lightsaber" will leave a trail for roughly 1 second. This integer can be set higher than 20, but you can expect lag if the number is set extremely high.

===== Examples =====

'''Set the tunic colors using hex values''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "#ffffff",
"goron_color": "#1E691B",
"zora_color": "#AAaaAA"
}
}
</pre></blockquote>

'''Set tunic colors using built-in color options''':
<blockquote><pre>
{
"settings": {
"kokiri_color": "Goron Red",
"goron_color": "Majora Purple",
"zora_color": "Completely Random"
}
}
</pre></blockquote>

'''Set rainbow sword trail with a duration of 1 second''':
<blockquote><pre>
{
"settings": {
"sword_trail_color_inner": "Rainbow",
"sword_trail_color_outer": "Rainbow",
"sword_trail_duration": 20
}
}
</pre></blockquote>

==== Sounds ====

To set sound effects, choose the sound you want to use as the value (right column) and the event when it plays as the key (left column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Sounds.py A list of sounds effects can be found here] (use the <samp>keyword</samp> column). Valid strings for the plandomizer file are found in the <samp>keyword</samp> column. For vanilla sound effects choose <code>default</code>, except for <samp>sfx_low_hp</samp> and <samp>sfx_ocarina</samp> where the vanilla sounds are called <code>soft-beep</code> and <code>ocarina</code> respectively. <samp>completely-random</samp>, <samp>random-ear-safe</samp>, <samp>random-choice</samp>, and <samp>none</samp> are also valid choices.

To set background music, choose the location where you want the music to be played as the key (left column) and the music that will be played as the corresponding value (right column). [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Music.py A list of valid strings can be found here]. Note that these strings are valid both as key and value. Use <code>None</code> for no background music.

===== Examples =====

'''Set sound effects''':
<blockquote><pre>
{
"settings": {
"sfx_low_hp": "soft-beep",
"sfx_navi_overworld": "bow-twang",
"sfx_navi_enemy": "navi-hey",
"sfx_menu_cursor": "ruto-wiggle",
"sfx_menu_select": "talon-snore",
"sfx_horse_neigh": "default",
"sfx_nightfall": "completely-random",
"sfx_hover_boots": "child-owo",
"sfx_ocarina": "malon"
}
}
</pre></blockquote>

'''Set background music''':
<blockquote><pre>
{
"bgm": {
"Hyrule Field": "None",
"Temple of Time": "Shop",
"Gerudo Valley": "Ingo Theme"
}
}
</pre></blockquote>

It is also possible to plando [https://wiki.ootrandomizer.com/index.php?title=Readme#Custom_Music_and_Fanfares custom music]. In this case what you insert as the track name is whatever is on the first line of the <kbd><samp>.meta</samp></kbd> file (open with any text editor). This means that some other track will be placed there instead without your knowledge.

== Common Errors ==
You're very likely to run into many errors while trying to make a plandomizer. These explanations should help you with some of the more cryptic ones. You can also narrow down the source of the error code by running small sections of the original plandomizer at a time until you get the error message.

=== Not A Valid JSON Format ===
[https://wiki.ootrandomizer.com/index.php?title=Plandomizer#The_Most_Common_Format.2FSyntax_Issue See this section]

=== Game Unbeatable ===
The randomizer generator could not place items following your defined settings. You've created a situation that is not logically possible to complete.

Sometimes this is just bad luck and you have to try generating again, but if you continuously get the same exact error messages over and over, you most likely need to modify your settings or where items are placed in the world. Think carefully about what logical problems your settings and item placements might have. Refer to the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/master/data/World Release logic files] or the [https://github.com/TestRunnerSRL/OoT-Randomizer/tree/Dev/data/World Dev logic files] depending on which one you are using to try to help find any you have forgotten.

Of course you can always come to the [https://discord.com/channels/274180765816848384/802659695323250729 #plando-support] channel on the Discord to ask for help if you're feeling stuck. We can usually point you in the right direction or find the exact issue causing the error.

=== Cannot Choose From An Empty Sequence ===

This means that an item in your <samp>locations</samp> dictionary was not spelled correctly (e.g. <samp>Light Arrow</samp> instead of <samp>Light Arrows</samp>).

=== My Plandomized Track Is Not Playing ===

Make sure that there are no spelling errors. If you're using custom music, then make sure that you are using the track name that is inside the <code>.meta</code> file.

Major Items

2021-02-28T06:35:14Z

ShadowShine57: Noting that tokens are also major for Ganon BK LACS

These items are considered Major regardless of settings, however it will only impact the settings which depend on Major Items, e.g. Chest Size Matches Contents and One Item Per Dungeon, if they are shuffled.

{| class="wikitable"
|-
| Slingshots || Bomb Bags || Bows
|-
| Boomerang || Hookshots || Megaton Hammer
|-
| Fire Arrows || Ice Arrows || Light Arrows
|-
| Din's Fire || Farore's Wind || Nayru's Love
|-
| Ocarinas || Progressive Strength Upgrades || Magic Meters
|-
| Kokiri Sword || Biggoron Sword || Mirror Shield
|-
| Goron Tunic || Zora Tunic || Stone of Agony
|-
| Iron Boots || Hover Boots || Gerudo Membership Card
|-
| Lens of Truth || Child Trade Items || Adult Trade Items
|-
| Wallets || Scales || Double Defense
|-
| Bottles (any contents) || Ruto's Letter || All Songs
|-
| Magic Beans || Triforce Pieces
|}

== Conditional Major Items ==

'''Bombchus''' - Only when "Bombchus Are Considered in Logic" is enabled.

'''Small Keys and Boss Keys''' - Only when the appropriate "keysanity" option is enabled.

'''Gold Skulltula Tokens''' - Only when the bridge requirement is set to Gold Skulltula Tokens, or Ganon's Boss Key is set to "On LACS: Tokens".

Dolphin

2021-02-11T06:04:06Z

ShadowShine57: Removed info about stuff that flagrama fixed

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin is not officially supported, and has not been tested extensively.</li>
<li>Dolphin is not race legal.</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

For the purpose of the randomizer, you will want to configure the Gamecube controller. Click on <kbd><samp>Controllers</samp></kbd> on the home page. and under Gamecube controllers, click <samp>Configure</samp> next to Port 1. Configure the controller however you wish. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig1.png|275px]][[File:DolphinControlConfig2.png|725px]]
[[File:Gamecube Controls.png]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked.

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required.

== After Finishing a Seed ==

Since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

Depending on the power of your computer, you may want to enable some graphics enhancements. This is in fact recommended if your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, come to <kbd><samp>#setup-support</samp></kbd> on the Discord.

=== The Video is Stretched to 16:9 ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select <samp>Force 4:3</samp>.

[[File:DolphinAspect.png]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

Logic

2021-02-07T02:31:01Z

ShadowShine57: Added note about scarecrow's song

'''“My Seed Is Broken!” (Glitchless Logic)''' - Solutions to completing randomized runs of ''Ocarina of Time'' can sometimes be unintuitive. While your seed may appear to be unbeatable, this isn’t often the case. Thanks to the diligent efforts of the developers, OoTR’s logic is incredibly robust. Listed below are some common sources of confusion, grouped by location. If you don’t mind spoiling the rest of the playthrough, instructions to finding your next step will be listed [[#Knowing_the_Way_with_the_Spoiler_Log|here]].

If you follow these steps and still need help, you’re welcome to ask for support in the [https://discordapp.com/channels/274180765816848384/274186223147417600 #gameplay-and-tricks] channel of our [https://discord.gg/3VJPQNK Discord Server]. Please provide the seed and setting string along with any important details about the issue. If it turns out there is indeed a logical flaw, kind members of our team will report issues from there.

{{TOClimit|2}}

== Other Logic Pages ==
This page of the Wiki is for Glitchless Logic; for more information on Glitched and Entrance Randomizer Logic, please view the [[Glitched_Logic|Glitched]] and [[Entrance_Randomizer|Entrance Randomizer]] pages of the Wiki.

It is also to document unusual logic that is '''absolutely required''' know in a seed to finish most randomizer seeds. Anyone who wish to contribute to the randomizer by adding features with logical requirements will likely need to be familiar with the logic on a deeper level. The [[Advanced Logic]] page will provide a better explanation of some of the more difficult to comprehend, but unnecessary to know by heart, logic quirks.

== Vanilla Help ==
For a quick refresher regarding the most basic aspects of Ocarina of Time, see these [https://strategywiki.org/wiki/The_Legend_of_Zelda:_Ocarina_of_Time/Getting_Started getting Started pages for Ocarina of Time].

For players who have not played randomizer before, it is strongly recommended to play the original game (i.e. vanilla) before attempting a randomizer seed. Strategy guides such as those from [https://strategywiki.org/wiki/The_Legend_of_Zelda:_Ocarina_of_Time/Table_of_Contents StrategyWiki] and [https://www.zeldadungeon.net/ocarina-of-time-walkthrough/ Zelda Dungeon] can be very helpful. Video guides are also available, the user [https://www.youtube.com/user/ScarecrowScythe Krow's Graveyard] has a playlist for [https://www.youtube.com/playlist?list=PLC4ADFACDF4946595 Vanilla Ocarina of Time] and [https://www.youtube.com/playlist?list=PLDgypNs3MY2Rd1jlYqNTWIfeLW7AiuoOK Master Quest Ocarina of Time]. Understanding how to beat vanilla is '''vital''' to beating a randomized seed.

For those who would prefer a quicker experience, [https://ootrandomizer.com/seed/vanilla Vanilla] and [https://ootrandomizer.com/seed/MQvanilla Master Quest] are available as randomizer seeds with all the QoL changes inherent to randomizer.



<div style="font-size:larger;">'''Spinning Pottery'''</div>
The spinning Goron Pot is activated by lighting the torches surrounding it. This can be accomplished by lighting sticks from Darunia's chamber OR by casting Din's Fire.
The Spinning Pot has 3 faces - Happy, Neutral, and Mad. Only the Happy face gives a randomized reward; Neutral give 3 bomb refills and Mad gives 3 green rupees.

<div style="font-size:larger;">'''Scarecrow’s Song'''</div>
Link must teach it to Bonooru (the scarecrow nearer the lake) as a child and then remind him again as an adult. The song cannot be all the same note; many alternate between two notes for simplicity.

<div style="font-size:larger;">'''Stuck without Warp Songs'''</div>
Save and quit outside the dungeon. Reloading the game will return Link to the Temple of Time (if adult) or Link's house (if child).

<div style="font-size:larger;">'''Opening Grottos without Bombs'''</div>
Any grotto which can be opened with Bombs can also be opened with Hammer. However some grottos open when the Song of Storms is played and not with explosives.

== Misunderstood Vanilla Mechanics ==
A lot of randomizer uses the vanilla requirements to do certain things. It just so happens that vanilla takes logic shortcuts in some locations because it's impossible to do some events before others. Meanwhile other events have requirements which do not come up in ordinary play. These are the most common issues people have starting randomizer after vanilla.

<div style="font-size:larger;">'''Skull Kid Ignores the Skull Mask'''</div>
Skull Kid must be befriended with Saria's Song before he will buy the Skull Mask. This is '''not''' required for the Skull Mask check- that is done by showing the Skull Mask to the Deku Scrubs inside the Lost Woods Theater.

<div style="font-size:larger;">'''Saria Missing from Sacred Forest Meadow'''</div>
Link must have Zelda's Letter or later in the child trade sequence before Saria arrives to teach her song. This means finding the Weird Egg, waking Talon, and visiting Zelda first.

<div style="font-size:larger;">'''Ocarina of Time and Song of Time Cutscenes'''</div>
This is the Zelda & Impa's escape cutscene initiated by approaching the Castle Town draw bridge as a child. Link must have all 3 Spiritual Stones before approaching the draw bridge, Zora's Sapphire alone is not enough.

<div style="font-size:larger;">'''Can't Find the Running Man'''</div>
Link must possess all 3 Spiritual Stones before the Running Man appears in Hyrule Field. Zora's Sapphire alone is not enough.

<div style="font-size:larger;">'''Open the Door of Time'''</div>
Play the Song of Time while standing in front of the pedestal. The only requirements are a '''Fairy Ocarina''' and the '''Song of Time'''. The Spiritual Stones are '''not''' required, and the Ocarina of Time is also '''not''' required.

<div style="font-size:larger;">'''Big Poe Hunt'''</div>
Without Epona, there is a 2/5 (40%) chance of a Big Poe spawning while passing their spawn areas. While on Epona, there is a 100% chance that the poe that spawns will be a Big Poe. Due to this, default logic does '''not''' expect hunting Big Poes without Epona. However, logic may expect them to be found as the random contents of bottles if the Big Poe Count setting is low enough.

<div style="font-size:larger;">'''Burning Village/Nocturne of Shadow Cutscene'''</div>
Link must have the <span style="color: green">Forest</span>, <span style="color: crimson">Fire</span>, and <span style="color: blue">Water</span> Medallions and then enter Kakariko Village as Adult from any entrance.

<div style="font-size:larger;">'''Requiem of Spirit'''</div>
The song typically acquired by leaving Spirit Temple as an adult can be collected as a child too. Exiting Spirit Temple is the vanilla requirement, since outside sequence breaks child would never reach the Colossus before adult.

In Entrance Randomizer, exit whichever dungeon is placed at Desert Colossus.

<div style="font-size:larger;">'''Zelda Light Arrow Cutscene'''</div>
Enter the Temple of Time as adult with the Shadow and Spirit medallions to receive this item check. From the Master Sword pedestal, Link must approach the exit.

== Vanilla Mechanics Changed by Randomizer ==
Randomizer has also changed some vanilla mechanics in an attempt to make randomization of certain elements more valuable. Those ''very'' familiar with Ocarina of Time may want to take note of the following differences.

<div style="font-size:larger;">'''Ocarina Memory Game'''</div>
Randomizer changed this mini-game to only require completing the 5 note version of the game to obtain the item. The mini-game does not need to be done a second time.

<div style="font-size:larger;">'''Malon or Talon Missing from Ranch'''</div>
Malon and Talon normally appear in Lon Lon Ranch after speaking to Zelda and receiving Zelda's Letter. Due to Weird Egg being able to be shuffled some changes have had to be made to this to avoid softlocks. Waking Talon up at Hyrule Castle with the Cucco from the Weird Egg and obtaining Zelda's Letter will have him appear at the ranch. If the Weird Egg is not shuffled, Malon will also appear at the ranch after this. If Weird Egg is shuffled, she will not appear at the ranch until Link speaks to her at Hyrule Castle and receives an item from her.

<div style="font-size:larger;">'''Dampe's Heart-Pounding Gravedigging Tour'''</div>
Dampe no longer requires a random number of attempts and will instead dig up the Heart Piece on the first attempt. He doesn't even need to be over a dirt patch.

There is a bug in vanilla where if Link leaves the area before picking up the Heart Piece it is lost forever. The randomizer has mostly solved this issue, as long as Link doesn't die before picking up the Heart Piece. This seems to do the same thing the vanilla bug does and isn't handled properly by the randomizer yet.

<div style="font-size:larger;">'''Sheik at Temple'''</div>
The Sheik cutscene at the Master Sword pedestal to obtain Prelude of Light has been changed from beating Forest Temple to obtaining the Forest Medallion. Once Link has the Forest Medallion, approaching the pedestal as adult either from the door of time, or from pulling the sword out as child will give you the reward.

<div style="font-size:larger;">'''Fishing Pond'''</div>
The fishing reward minimums were lowered so an 8 pound fish is required as Child and a 10 pound fish is required as Adult. However, the lure must still be in deep enough water to cause the fish to bite.

<div style="font-size:larger;">'''Biggoron's Claim Check'''</div>
Biggoron no longer requires three days between giving him the eyedrops and claim check. The claim check can now be immediately returned to Biggoron for a randomized item.

== Forest ==
This area covers '''Kokiri Forest''', '''The Lost Woods''', and '''The Sacred Forest Meadow'''.

<div style="font-size:larger;">'''Closed Forest'''</div>
When the "Closed Forest" setting is active, Link is expected to stay in these areas until beating Gohma in the Great Deku Tree. Do not leave these areas, even if there is a bomb bag, silver scale, or ocarina and a warp song. The Kokiri Sword will be in one of these forest areas and the shop will have a repeatably purchasable Deku Shield, even with Shopsanity active.

A Slingshot will appear anywhere in these forest areas ''or'' [[#Deku Tree|The Great Deku Tree]].

Hidden grottos in these areas can be required. In version 5.1 and prior this was required without any hint to the locations, but as of 5.2 the Stone of Agony will be found before logic can expect these locations, provided the trick that removes the SoA requirement was not enabled.

With Tokensanity enabled, the three dirt patch Skulltulas can be required. In the Lost Woods, jump slashing the bushes outside of the Goron City warp with a stick will release bugs which can be caught in a bottle and used on the dirt patches. Since the sword could be in a dirt patch, keep this in mind.

== Kakariko Village ==

<div style="font-size:larger;">'''Rear Entrance to Impa's House as Child'''</div>
Take a cucco to the incomplete building. Toss it onto the top of the pile of bricks and climb up after it. Once on top of the pile of bricks with the cucco, pick it up and fly across to the Scaffolding. From here follow behind the carpenter to reach a good position to jump towards the entrance above the chicken coop.

<div style="font-size:larger;">'''Shooting Gallery Gives 50 Rupees'''</div>
The Fairy Bow/Quiver is required to win the special prize. Otherwise you will receive 50 rupees.

<div style="font-size:larger;">'''Reach Rooftops without Longshot'''</div>
It's possible to get on the important rooftops with only Hookshot. Get a little closer and try again.

<div style="font-size:larger;">'''Draining Kakariko Well'''</div>
Play the Song of Storms to the Windmill Operator as a child.

*Project 64 will have this issue if not configured correctly. Be sure you have followed the instructions in [[Project64]] if you run into it: ''Draining the well at night can crash the game; attempting it during the day is less likely to cause this crash.''

<div style="font-size:larger;">'''Freestanding PoH in Windmill'''</div>
The freestanding heart piece in the windmill doesn't always expect an ocarina or the Song of Time. Use the boomerang to grab the item here or, if the trick is enabled, [https://www.youtube.com/watch?v=vDl7lr4Ecv8| reach it as adult with no other items required].

== Goron City ==

<div style="font-size:larger;">'''Reach Goron City from Lost Woods without Bombs'''</div>
Ignite the Bomb Flowers behind the boulders using Din’s Fire. Alternatively, if Adult Link destroys the boulders with Hammer, Strength, or Bow they'll be destroyed in the past so Child Link can enter.

<div style="font-size:larger;">'''Get Large Rolling Goron to Relinquish Goods'''</div>
Bomb the Goron in the dark tunnel near the sign (Bomb/Bombchu).

''In version 4.0 and older the Large Rolling Goron also requires Link to have a Bomb Bag''

<div style="font-size:larger;">'''Boulder Maze without Bombs or Hammer'''</div>
Silver Guantlets are effective at clearing a path to each of the chests in the room. This will take some time, however.

== Death Mountain Crater ==

<div style="font-size:larger;">'''Reach the lower Exit'''</div>
From the top of the tall ladder, use the Hover Boots to hover over the boulder blocking the shortcut to Goron City (lower exit). Hover Boots can also be used at the bottom of the ladder to bypass the Boulder.

<div style="font-size:larger;">'''Reach the Bottom Area for Bolero of Fire and Access to Fire Temple'''</div>
Use Hover Boots to cross the dilapidated bridge to reach the Warp Platform & Fire Temple.

Alternatively, reach this bottom area with the Longshot by jumping from the upper area onto the lava platforms below and shooting a wooden plank to pull Link across the pool of lava.

== Zora’s Domain ==

<div style="font-size:larger;">'''Access with Silver Scale'''</div>
Silver Scale allows access to Zora's Domain as child from Lake Hylia.

<div style="font-size:larger;">'''Need Blue Fire to Unfreeze King Zora/Zora Shop'''</div>
In Ganon’s Castle, Blue Fire can be found in Water Trial. Blue Fire may also be a purchasable item for 300 rupees in shops.

== Lake Hylia ==

<div style="font-size:larger;">'''Go fishing'''</div>
The fishing man rewards an 8 pound fish as a Child and a 10 pound fish as an Adult. Make sure to toss the lure in deep enough water to entice fish to bite. There's a minimum depth required for the mini-game to work. Tossing the Lure in very shallow water may cause the fish may swim around the Lure but never bite.

<div style="font-size:larger;">'''Lake Hylia - Shooting the Sun with an Arrow'''</div>
The tall rectangle island can be reached without filling the lake by using Scarecrow's Song and Longshot. You may not need to complete the Water Temple and raise the water level at Lake Hylia to acquire the item. The arrow must be fired at the sun during the early morning as per the written instructions on the stone platform.

== Gerudo Fortress/Valley ==

<div style="font-size:larger;">'''Traversing the Gerudo Valley Broken Bridge'''</div>
Cross the Broken Bridge as an Adult by using either Epona to jump it or using the Longshot on the sign above the gate on the other side.

<div style="font-size:larger;">'''Entering Gerudo Training Grounds without Being Captured'''</div>
Link must have the Gerudo Membership Card and also rescue all of the Carpenters that have been captured. If the Gerudo Membership Card is shuffled, then only the card is needed and the Carpenters do not need to be rescued to access the area.

<div style="font-size:larger;">'''Getting Caught without a Hookshot'''</div>
If caught by a Gerudo Guard, either inside during combat or outside by being seen, without a Hookshot, Link will be thrown into the valley outside the tent, rather than into the jail cell from which Link could not escape.

<div style="font-size:larger;">'''Horse Archery NPC is Missing or Won't Initiate the Mini-game'''</div>
This mini-game requires the Fairy Bow, Epona, and the Gerudo Membership Card. It must also be day time.

<div style="font-size:larger;">'''Fortress Rooftop Chest without Longshot'''</div>
The chest can be reached from the top with the Hover Boots or by spawning a scarecrow and using the Hookshot. You'll have to stand close to the edge of the top level for the Hookshot to reach. Note that you won't see the Hookshot's red dot on the scarecrow.

== Gerudo Training Grounds ==

<div style="font-size:larger;">'''Lava room without Longshot'''</div>
The torch at the end of this room is in reach using only the Hookshot.

<div style="font-size:larger;">'''Timed Boulder Room without Longshot'''</div>
The target on the ceiling is just within range of the Hookshot when standing almost directly under it. A wallmaster can also lift Link into the rupee if it’s the last to be collected.

== Deku Tree ==

<div style="font-size:larger;">'''Access F3 without Slingshot'''</div>
The slingshot is not required to get to the top floor of the Deku Tree. In fact, in Master Quest Link doesn't get the slingshot until climbing all the way up the tree in the first place. Skulltulas don't rush Link when he is not moving. Sneak past them while they are looking away.

<div style="font-size:larger;">'''Two Chests in Slingshot Room'''</div>
In vanilla Deku Tree there are two chests in the Slingshot room. The first is the obvious one that has the slingshot, but there are climbable vines on the wall to the left of it which lead to a second chest.

== Dodongo's Cavern ==

<div style="font-size:larger;">'''Gold Skulltula on top of the Sinking Staircase'''</div>
Progress through the right side of the dungeon and hit the switch that makes the platforms in the entrance room rise higher, then leave the dungeon and re-enter it, progress through the dungeon backwards by taking the right platform in the entrance room to the top floor and going through the door on the upper level. This will grant you access to vines on the side of the stairs before the stairs have been lowered by the bomb blasts.

== Inside Jabu Jabu's Belly ==

<div style="font-size:larger;">'''First Switch'''</div>
The switch on the ceiling in the first room of Jabu Jabu's Belly can be hit using explosives.

== Forest Temple ==

<div style="font-size:larger;">'''Get Outside without Song of Time or Bow'''</div>
With Hover Boots, float to the door connecting the large block-pushing room with the courtyard.

<div style="font-size:larger;">'''Cross to the Other Courtyard via Well'''</div>
With Gold Scale or Iron Boots, Link can cross from one courtyard to the other through the well.

<div style="font-size:larger;">'''Can’t Push Large Colored Blocks as Adult'''</div>
In the Forest Temple, the Goron’s Bracelet is required to push these blocks, even as adult. Link only put on gauntlets to keep his hands from drying out.

<div style="font-size:larger;">'''Triggering the Frozen Eye Switch without Bow'''</div>
Use Din's Fire from the platform below the frozen eye switch to activate it.

== MQ Forest Temple ==

<div style="font-size:larger;">'''Get Outside with just Hover Boots'''</div>
The western courtyard can be reached from the room with the block-push puzzle by hovering towards the crystal switch behind the transparent wall and then jump slashing to hit the switch from the other side. This will remove the transparent wall, allowing you to hover to this door leading to the courtyard. The ledge from which you'll want to hover is behind the first blocks, but if you lack strength then this ledge can also be hovered to from where you end up after climbing the second ladder. If you have trouble making these hovers, then try rolling for extra distance.

== Fire Temple ==

<div style="font-size:larger;">'''Can’t Push Large Colored Blocks as Adult'''</div>
In the Fire Temple, the Goron’s Bracelet is required to push these blocks, even as adult. Link only put on gauntlets to keep his hands from drying out.

<div style="font-size:larger;">'''Reach Volvagia without Hammer'''</div>
With Hover Boots equipped, it’s a simple matter of floating over to the boss door. That said, the Hammer is still required to defeat the boss.

<div style="font-size:larger;">'''Skip the Topmost Locked Door'''</div>
Similarly to Volvagia, skip the topmost locked door by using Hover boots to float over to the pillar. Then use the Hammer to open the door leading to the Highest Goron and Hammer Chest.

<div style="font-size:larger;">'''Extra Key'''</div>
When key-sanity is disabled (that is, keys are in their own dungeon), the lock in the basement behind the hammer blocks is removed. This results in a spare key for this dungeon.

== Water Temple ==

<div style="font-size:larger;">'''Entering without Iron Boots'''</div>
The entryway is in logic with just longshot and gold scale. However, nothing inside Water Temple is in default logic without Iron Boots, thus is only relevant in entrance randomizer.

<div style="font-size:larger;">'''Boss Key Chest without Bombs or Goron’s Bracelet'''</div>
Use the Hover Boots to reach the chest.

<div style="font-size:larger;">'''Getting Past the Timed Gate without Longshot'''</div>
After shooting the eye switch, cross the gap with Hover Boots.

<div style="font-size:larger;">'''Center Room Gold Skulltula without Longshot'''</div>
Cast Farore’s Wind inside the center room. Raise the water to its highest level and cast Farore's Wind again to return to the warp point. Swim to the surface to reach the Gold Skulltula. '''In versions 6.0 and newer''', this is no longer in default logic.

<div style="font-size:larger;">'''Extra Key'''</div>
The door leading to the highest water level changer is never locked in rando. This results in a spare key for this dungeon.

<div style="font-size:larger;">'''Can’t Raise the Water Level'''</div>
''This is only relevant prior to version 4.0 of randomizer''

With the water level lowered, jump down to the second level of the central structure. This may require savewarping to the beginning of the dungeon to reach. Use the Hookshot to climb onto the top level. With a well-spaced rolling jump you should be able to reach the ledge where you can raise the water to its highest level. This isn't required but it's a handy time saver.

== Spirit Temple ==

<div style="font-size:larger;">'''Child Side Enemy Room'''</div>
In order to kill the Armos in this room, you're expected to have at least one of the following item combinations: Deku Sticks (jumpslashes can hit), Kokiri Sword, or Deku Nuts + Slingshot.

<div style="font-size:larger;">'''Lower Metal Bridge on Child Side without Boomerang'''</div>
You can just barely hit the switch with a well-placed slingshot shot. Alternatively, hit the crystal switch with a well-timed Bombchu placement in the opposite direction.

<div style="font-size:larger;">'''Map chest without Din’s Fire or Magic'''</div>
Child Link is perfectly capable of lighting the torches using only a Deku Stick.

<div style="font-size:larger;">'''Collect Silver Rupees in the Boulder Room without Hover Boots'''</div>
Reach the floating rupee by jumping into the boulder with a jump slash, or even without hitting the boulder with a properly timed jump slash.

<div style="font-size:larger;">'''Silver Gauntlets Chest from Adult Side using Longshot'''</div>
With a Longshot, shoot the chest opposite from the Mirror Shield chest to gain access to its contents and the end of child-side.

<div style="font-size:larger;">'''Boss Key Chest'''</div>
The Eye Switch can be accessed by hitting the fake door with something to make it fall over. You do not necessarily need to destroy the fake door.

== Shadow Temple ==

<div style="font-size:larger;">'''Crossing the First Gap without Hookshot'''</div>
Hoverboots will reach the other side. If you fall short, start from the wall to build up speed before leaving the ledge.

<div style="font-size:larger;">'''First Silver Rupee Room without Hookshot'''</div>
Reach raised platform in the corner of the room by using the Hover Boots from the nearby low wall.

<div style="font-size:larger;">'''Spike floor room without Longshot'''</div>
Backflip onto the chest spawned in the middle of the room. From there, use the Hookshot to reach the upper ledge.

<div style="font-size:larger;">'''Reach the Boat without Goron’s Bracelet'''</div>
Bypass pushing the large block by shooting the top of the ladder with a Hookshot.

<div style="font-size:larger;">'''Reach Bongo Bongo without the Fairy Bow'''</div>
Play the Scarecrow’s Song to summon Pierre. Use Longshot to get to the other side.

== MQ Bottom of the Well ==

<div style="font-size:larger;">'''Central Area without Zelda's Lullaby'''</div>
The central area is gated off, and Zelda's Lullaby is required to lower the gates. However, from the western side you can bomb boulders and jump slash or backflip over a pit to reach the central area without playing Zelda's Lullaby.

== Ganon’s Castle ==

<div style="font-size:larger;">'''Spirit Trial without Fire Arrows'''</div>
A precise shot of an arrow through the torch will burn the web to reveal the light.

<div style="font-size:larger;">'''Water Trial Blue Fire'''</div>
With your bridge requirement set to Open, Blue Fire can be brought from the Water Trial to thaw King Zora or, if you have shopsanity active, to open the Zora Shop as adult if inaccessible as child.

<div style="font-size:larger;">'''Shadow Trial without Fire Arrows'''</div>
There are 2 scenarios possible here, either with Hover Boots or with Din's Fire. Obviously, Link may have both, in which case either method will work.<br/>
With Hover Boots, Longshot the torch to the right as you enter. From there, Link can reach the Like-Like with the Longshot. Once to the middle platform, equip the Hover Boots and roll across the gap to the platform where the chest spawns. From here open the chest and finish the trial.<br/>
With Din's Fire as a fire source, do the same thing as with Hover Boots, but instead of going to the Like-Like immediately, cast Din's Fire first. This will spawn the glass platform to the chest platform so Link can jump across.

== Knowing the Way with the Spoiler Log ==

The spoiler log contains information about your personally randomized copy of the game and can be very helpful when looking for important items you've missed. Please be aware that the Playthrough presented is intended to prove the seed is beatable in logic. It does not represent the only way to logically beat the seed. It takes only a few steps to find:

'''Website Seeds'''
*[[Frequently_Asked_Questions#How_Do_I_Find_My_Spoiler_Log_Again.3F|How do I find my spoiler log again?]]

'''Versions 1.0 - 3.0 and Standalone Download'''

Open the spoiler log generated alongside your ROM. It should be formatted as <code>OoT_SETTINGSTR_SEED_Spoiler.txt</code>.

Major Items

2021-01-22T06:22:53Z

ShadowShine57: Fixed parenthesis that was accidentally a }

Dolphin

2021-01-20T20:06:32Z

ShadowShine57: Added sentence about red box in home picture

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin is not officially supported, and has not been tested extensively.</li>
<li>Dolphin is not race legal.</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

For the purpose of the randomizer, you will want to configure the Gamecube controller. Click on <kbd><samp>Controllers</samp></kbd> on the home page. and under Gamecube controllers, click <samp>Configure</samp> next to Port 1. Configure the controller however you wish. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig1.png|275px]][[File:DolphinControlConfig2.png|725px]]
[[File:Gamecube Controls.png]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked.

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required.

== After Finishing a Seed ==

Similarly to Wii VC, each seed must be properly uninstalled before starting a new one. To do this, simply right click the seed on Dolphin's home menu and select <samp>Uninstall from the NAND</samp>.

This is required for the current Beta of Dolphin and any version before <samp>5.0-13191</samp>.

Also, since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

Depending on the power of your computer, you may want to enable some graphics enhancements. This is in fact recommended if your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, come to <kbd><samp>#setup-support</samp></kbd> on the Discord.

=== The Video is Stretched to 16:9 ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select <samp>Force 4:3</samp>.

[[File:DolphinAspect.png]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

File:DolphinHome.png

2021-01-20T20:03:19Z

ShadowShine57: ShadowShine57 uploaded a new version of File:DolphinHome.png

File:DolphinControlConfig2.png

2021-01-20T19:57:13Z

ShadowShine57: ShadowShine57 uploaded a new version of File:DolphinControlConfig2.png

== Summary ==
Sample gamecube control config in dolphin using an xbox controller.

Dolphin

2021-01-20T19:47:55Z

ShadowShine57: Adding that you need to delete saves between seeds

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin is not officially supported, and has not been tested extensively.</li>
<li>Dolphin is not race legal.</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

For the purpose of the randomizer, you will want to configure the Gamecube controller. Click on <kbd><samp>Controllers</samp></kbd> on the home page. and under Gamecube controllers, click <samp>Configure</samp> next to Port 1. Configure the controller however you wish. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig1.png|275px]][[File:DolphinControlConfig2.png|725px]]
[[File:Gamecube Controls.png]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked.

== Starting a Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required.

== After Finishing a Seed ==

Similarly to Wii VC, each seed must be properly uninstalled before starting a new one. To do this, simply right click the seed on Dolphin's home menu and select <samp>Uninstall from the NAND</samp>.

This is required for the current Beta of Dolphin and any version before <samp>5.0-13191</samp>.

Also, since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

== Optional Settings ==

Depending on the power of your computer, you may want to enable some graphics enhancements. This is in fact recommended if your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, come to <kbd><samp>#setup-support</samp></kbd> on the Discord.

=== The Video is Stretched to 16:9 ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select <samp>Force 4:3</samp>.

[[File:DolphinAspect.png]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

Cows

2021-01-20T03:01:12Z

ShadowShine57: Added that the GV cow is child only

'''by ETR_BTF'''

This is a comprehensive list of all the cows in the game. All locations are named as they are in the spoiler log and are accompanied by pictures and item requirements. The purpose of this page is to aid players in finding all the cows spread throughout Hyrule. Keep in mind that in order to receive their randomized item you need to be able to play Epona's Song.

{{TOClimit|3}}

== Kokiri Forest: 1 Cow ==

'''KF Links House Cow'''

''Requirements'': Beat Malon's obstacle course in under 50 seconds. Adult only.

[[File:malon.png|560x315px]][[File:cowinhouse.png|560x315px]]

== Hyrule Field: 1 Cow ==

'''HF Cow Grotto Cow'''

''Requirements'': As child explosives, as adult Hammer. Both ages also need a fire source to reach the cow.

[[File:hfcowchild.png|560x315px]][[File:hfcowadult.png|560x315px]][[File:hfcow2.png|560x315px]]

== Lon Lon Ranch: 4 Cows ==

Note: when cowsanity is on the cows will be placed further apart from one another than in the images below to prevent the player from accidentally milking the same cow twice rather than both cows once.

'''LLR Stables Left/Right Cow'''

''Requirements'': None.

[[File:llrstableoutside.png|560x315px]][[File:llrstable.png|560x315px]]

'''LLR Tower Left/Right Cow'''

''Requirements'': None.

[[File:llrtoweroutside.png|560x315px]][[File:llrtower.png|560x315px]]

== Kakariko Village: 1 Cow ==

'''Kak Impas House Cow'''

''Requirements'': None.

[[File:impaoutside.png|560x315px]][[File:impa.png|560x315px]]

== Death Mountain Trail: 1 Cow ==

'''DMT Cow Grotto Cow'''

''Requirements'': Explosives or Hammer.

[[File:dmtcowoutside.png|560x315px]][[File:dmtcow.png|560x315px]]

== Gerudo Valley: 1 Cow ==

'''GV Cow'''

''Requirements'': None. Child only.

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

== Inside Jabu Jabu's Belly MQ: 1 Cow ==

'''Jabu Jabus Belly MQ Cow'''

''Requirements'': Jabu Access, Boomerang, Slingshot, Explosives, and either Deku Sticks or Din's Fire + Kokiri Sword. Hit the cow switch with the slingshot to spawn the cow. Child only.

[[File:mqjabu2.png|560x315px]][[File:mqjabu1.png|560x315px]]

Dolphin

2021-01-20T01:22:04Z

ShadowShine57: Moved graphic enhancements to new optional settings section

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin is not officially supported, and has not been tested extensively.</li>
<li>Dolphin is not race legal.</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

For the purpose of the randomizer, you will want to configure the Gamecube controller. Click on <kbd><samp>Controllers</samp></kbd> on the home page. and under Gamecube controllers, click <samp>Configure</samp> next to Port 1. Configure the controller however you wish. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-Analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig1.png|275px]][[File:DolphinControlConfig2.png|725px]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked.

== Starting Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required.

== After Finishing a Seed ==

Similarly to Wii VC, each seed must be properly uninstalled before starting a new one. To do this, simply right click the seed on Dolphin's home menu and select <samp>Uninstall from the NAND</samp>.

This is required for the current Beta of Dolphin and any version before <samp>5.0-13191</samp>.

== Optional Settings ==

Depending on the power of your computer, you may want to enable some graphics enhancements. This is in fact recommended if your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

== Troubleshooting ==

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, come to <kbd><samp>#setup-support</samp></kbd> on the Discord.

=== The Video is Stretched to 16:9 ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select <samp>Force 4:3</samp>.

[[File:DolphinAspect.png]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

Dolphin

2021-01-20T00:35:09Z

ShadowShine57: Created page, added basic set up and troubleshooting steps.

<span style="color:red">Important warnings:</span>
<ol style="color: red;">
<li>Dolphin is not officially supported, and has not been tested extensively.</li>
<li>Dolphin is not race legal.</li>
<li>This page is still an early work in progress</li>
</ol>

Dolphin is a popular emulator for both Gamecube and Wii. As it can be used as a Wii emulator, you can load a WAD into it and play the randomizer that way, meaning you will be emulating a Wii which is emulating a Nintendo 64. Yes, it sounds convoluted, but it's not terribly complicated to set up and brings the benefits of both playing on emulator (faster in certain places, improved visuals) and playing on Wii VC (faster in other places, more accurate emulation). That being said, playing the randomizer on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to soft mod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

== First Time Dolphin User Set Up ==

[https://dolphin-emu.org/download/ Download the latest beta release of Dolphin.] Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update.

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

[[File:DolphinHome.png]]

The first thing you will want to do is create a game directory. Go to <kbd><samp>Config</samp> ⇒ <samp>Paths</samp> ⇒ <samp>Add...</samp></kbd> and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

[[File:DolphinPaths.png]]

For the purpose of the randomizer, you will want to configure the Gamecube controller. Click on <kbd><samp>Controllers</samp></kbd> on the home page. and under Gamecube controllers, click <samp>Configure</samp> next to Port 1. Configure the controller however you wish. Note that, even if you have a controller with analog triggers, you must set <samp>L</samp> and <samp>R</samp> for the buttons to work properly, not just <samp>L-Analog</samp> and <samp>R-analog</samp>. Below shows a sample controller config with an Xbox controller.

[[File:DolphinControlConfig1.png|275px]][[File:DolphinControlConfig2.png|725px]]

Finally, depending on the power of your computer, you may want to enable some graphics enhancements. This is in fact recommended if your computer can handle it as it makes games look much nicer. Back on the home page, go to <kbd><samp>Graphics</samp> ⇒ <samp>Enhancements</samp></kbd>. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. <samp>Per-Pixel Lighting</samp> and <samp>Anti-Aliasing</samp> above 4x are particularly demanding. <samp>Post-Processing Effects</samp> are mostly gimmicks.

[[File:DolphinEnhancements.png|350px]]

== Randomizer Dolphin Set Up ==

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer. <span style="color:red">This list may currently be incomplete.</span>

First, under <kbd><samp>Config</samp> ⇒ <samp>General</samp></kbd> make sure that <samp>Allow Mismatched Region Settings</samp> is unchecked and <samp>Fallback Region</samp> is set to <samp>NTSC-J</samp>.

[[File:DolphinRegion.png|350px]]

Next, under <kbd><samp>Graphics</samp> ⇒ <samp>Hacks</samp></kbd>, ensure that <samp>Store EFB Copies to Texture Only</samp> is unchecked.

== Starting Seed ==

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. [https://wiki.ootrandomizer.com/index.php?title=Wii_Virtual_Console#Generating_a_Seed Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.]

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required.

== After Finishing a Seed ==

Similarly to Wii VC, each seed must be properly uninstalled before starting a new one. To do this, simply right click the seed on Dolphin's home menu and select <samp>Uninstall from the NAND</samp>.

== Troubleshooting ==

<span style="color:red">This section is almost certainly incomplete.</span>

=== The Video is Stretched to 16:9 ===

Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select <samp>Force 4:3</samp>.

[[File:DolphinAspect.png]]

=== The Game is Running Slowly/Less than 20 FPS ===

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

[[File:DolphinVPS.png]]

==== VPS is less than 60 and unstable ====

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

==== VPS is stable at 50 ====

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in [https://wiki.ootrandomizer.com/index.php?title=Dolphin#Randomizer_Dolphin_Set_Up Randomizer Dolphin Set Up].

==== VPS is stable at 60 ====

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. The current workaround for this is to go to <kbd><samp>Config</samp> ⇒ <samp>Advanced</samp> ⇒ <samp>Clock Override</samp></kbd>, checking <samp>Enable Emulated CPU Clock Override</samp>, and setting the slider to 200% (or whatever number seems to work for you). Note this is not a permanent solution and currently considered a workaround.

[[File:DolphinOverclock.png]]

File:DolphinAspect.png

2021-01-20T00:32:05Z

ShadowShine57: Shows how to force Dolphin's aspect ratio to 4:3.

== Summary ==
Shows how to force Dolphin's aspect ratio to 4:3.

File:DolphinOverclock.png

2021-01-20T00:28:05Z

ShadowShine57: Showing how to overclock Dolphin's emulated CPU

== Summary ==
Showing how to overclock Dolphin's emulated CPU

File:DolphinVPS.png

2021-01-20T00:19:46Z

ShadowShine57: Showing where to find the VPS measure in Dolphin.

== Summary ==
Showing where to find the VPS measure in Dolphin.

File:DolphinRegion.png

2021-01-20T00:06:09Z

ShadowShine57: Shows which settings must be changed in Dolphin for proper region compatability.

== Summary ==
Shows which settings must be changed in Dolphin for proper region compatability.

File:DolphinEnhancements.png

2021-01-20T00:00:39Z

ShadowShine57:

File:DolphinControlConfig2.png

2021-01-19T23:51:34Z

ShadowShine57: Sample gamecube control config in dolphin using an xbox controller.

== Summary ==
Sample gamecube control config in dolphin using an xbox controller.

File:DolphinControlConfig1.png

2021-01-19T23:50:59Z

ShadowShine57:

File:DolphinPaths.png

2021-01-19T23:44:38Z

ShadowShine57:

File:DolphinHome.png

2021-01-19T23:33:19Z

ShadowShine57:

Multiworld

2021-01-19T19:07:14Z

ShadowShine57: Added a solution for the LUA console window being too small.

The aim of this page is to help the reader set up [[Bizhawk]] for 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 need to make use of "lua scripts". As written, these are only compatible with Bizhawk, however the ModLoader64 devs have made a copy which is compatible with ModLoader64. ([https://discord.gg/mWDztG For assistance with ModLoader64, please join their Discord].) Support for other emulators, as well as console support, is planned for future releases.

{{TOClimit|4}}

== Generating the Seeds ==

=== 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 From Seed</code>. 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 ==

=== 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.3 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.3 folder somewhere else if you wish. Afterwards, open up the Bizhawk 2.3 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.3 install and place everything for you. Once Powershell is done, open up the Bizhawk 2.3 folder it created and launch <code>EmuHawk.exe</code>. ''Note: It is recommended you delete everything outside of the Bizhawk 2.3 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. '''<span style="color:red">In the event of a crash (or if you open TAStudio by accident) DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!</span>''' 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.3 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 Ocarina of Time Randomizer Discord, you can assign the Multiworld role to yourself by going to the [https://discordapp.com/channels/274180765816848384/478962049079050241 #chat-bot] channel and typing <code>!role Multiworld</code> - 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 [https://discordapp.com/channels/274180765816848384/535739089521999883 #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) ===

==== Windows 7 ====

If you are running Windows 7 you will need to enable remote Powershell script execution, and make sure Powershell is updated.

First, go to the [https://docs.microsoft.com/en-us/powershell/scripting/install/installing-windows-powershell?view=powershell-6#upgrading-existing-windows-powershell|Microsoft Installing Powershell page] and navigate to the download page for the the latest Windows 7 SP1 Powershell version. At the time of writing it is WMF 5.1. The file on the download page you want to download is named similar to <code>Win7AndW2K8R2-KB3191566-x64.zip</code>. Run the <code>.msu</code> file inside of the zip file and it should update Powershell.

==== 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.

==== 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.

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

First, the host must have the [[#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 [[#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.

=== 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, '''<span style="color:red">DO NOT RELOAD THE ROM! DO NOT RELOAD THE ROM!</span>''' 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]]

== 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.

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':

[[File:Guide2.JPG|RTENOTITLE]]

Then, start up the Bizhawk co-op lua script. Set 'Rooms' to '(Custom IP)' and paste the IPv4 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 OoTR Discord Server. '''Oh, and, be careful with who you give permission to join your network to.'''

==== 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 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.