Plandomizer - Revision history

Maplestar: /* Gossip Stones and Other Text Boxes */ Note that as of v9.0, text boxes can't exceed 1200 characters

2025-12-31T20:33:16Z

Gossip Stones and Other Text Boxes: Note that as of v9.0, text boxes can't exceed 1200 characters

← Older revision		Revision as of 20:33, 31 December 2025
Line 740:		Line 740:

	The definition is a dictionary with the term <var>text</var>.		The definition is a dictionary with the term <var>text</var>.
	* Multiple text boxes can be assigned to a single Gossip Stone/sign/NPC/etc. 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. '''Warning''': ~~Really~~ long texts (1200+ characters) will have negative side effects ranging from graphical issues to hard crashes, so don't make your text too long, or test them if you do. Keep in mind that this character limit appears to be significantly lower on N64 than on emulator or Wii VC.		* Multiple text boxes can be assigned to a single Gossip Stone/sign/NPC/etc. 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. '''Warning''': Prior to v9.0, really long texts (1200+ characters) could be entered, but they will have negative side effects ranging from graphical issues to hard crashes, so don't make your text too long, or test them if you do. Keep in mind that this character limit appears to be significantly lower on N64 than on emulator or Wii VC.
	* 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.		* 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.

Maplestar: typo fix

2024-09-29T19:44:15Z

typo fix

← Older revision		Revision as of 19:44, 29 September 2024
Line 4:		Line 4:

	<!--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. -->		<!--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. -->
	~~There~~ plandoMaker site is currently not available, so you will have to modify a distribution file yourself. For any confusion, please visit the {{discord\|plando-support}} channel in the {{discord}} for help resolving issues.		The plandoMaker site is currently not available, so you will have to modify a distribution file yourself. For any confusion, please visit the {{discord\|plando-support}} channel in the {{discord}} for help resolving issues.
	{{collapsible list code style		{{collapsible list code style
	\|Deliver Letter		\|Deliver Letter

Maplestar: /* Plando Exclusive Features */ Add password_lock

2024-09-29T19:39:03Z

Plando Exclusive Features: Add password_lock

← Older revision		Revision as of 19:39, 29 September 2024
Line 941:		Line 941:
	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.		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		To use this setting, add the following to the settings dictionary of the Plando file:

	{{json example\|		{{json example\|
	"lacs_condition": "X",		"lacs_condition": "X",
	}}		}}
	where valid settings for <code>X</code> are <code>Stones</code>, <code>Medallions</code>, <code>Dungeons</code>, <code>Tokens</code> and <code>Hearts</code> (hearts v6.2.76 onwards). 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		where valid settings for <code>X</code> are <code>Stones</code>, <code>Medallions</code>, <code>Dungeons</code>, <code>Tokens</code> and <code>Hearts</code> (hearts v6.2.76 onwards). 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\|		{{json example\|
	"lacs_stones/medallions/dungeons/tokens/hearts": Y,		"lacs_stones/medallions/dungeons/tokens/hearts": 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/hearts</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.). Hearts are in units of full hearts (= Heart Containers) and not in units of quarters of hearts (= Pieces of Heart). Keep in mind that the last line of the settings dictionary should '''not''' have a comma at the end, so remove it if appropriate.		Where <code>Y</code> is a number (note the lack of quotation marks) and where you should choose <code>lacs_medallions/stones/dungeons/tokens/hearts</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.). Hearts are in units of full hearts (= Heart Containers) and not in units of quarters of hearts (= Pieces of Heart). 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 ====		==== Examples ====
Line 959:		Line 959:
	"lacs_condition": "Tokens",		"lacs_condition": "Tokens",
	"lacs_tokens": 69		"lacs_tokens": 69
			}
			}
			}}

			==== Password Locked Seeds ====

			This is a setting for creating a password lock on seeds. The password must be entered before the save can be started for the first time. It will consist of a sequence of 6 button presses, using the A and C button, and can be found near the top of the spoiler log. You cannot use this to define a specific password.

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

			{{json example\|
			"password_lock": true
			}}

			==== Example ====
			For altering no other settings, just to enable a password, this is a complete plando:
			{{json example\|
			{
			"settings": {
			"password_lock": true
	}		}
	}		}

Maplestar: Remove plandoMaker link and comment out items that are now valid under child trade quest shuffle.

2024-09-17T19:39:20Z

Remove plandoMaker link and comment out items that are now valid under child trade quest shuffle.

← Older revision		Revision as of 19:39, 17 September 2024
Line 3:		Line 3:
	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.		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.		<!--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. -->
			There plandoMaker site is currently not available, so you will have to modify a distribution file yourself. For any confusion, please visit the {{discord\|plando-support}} channel in the {{discord}} for help resolving issues.
	{{collapsible list code style		{{collapsible list code style
	\|Deliver Letter		\|Deliver Letter
	\|Sell Big Poe		\|Sell Big Poe
	\|Skull Mask		\|Milk
			\|<!--Skull Mask
	\|Spooky Mask		\|Spooky Mask
	\|Keaton Mask		\|Keaton Mask
	\|Bunny Hood		\|Bunny Hood
	\|Mask of Truth		\|Mask of Truth
	~~\|Milk~~
	\|Goron Mask		\|Goron Mask
	\|Zora Mask		\|Zora Mask
	\|Gerudo Mask		\|Gerudo Mask
	\|Zeldas Letter		\|Zeldas Letter
	\|Location: HC Zeldas Letter		\|Location: HC Zeldas Letter-->
	\|title=~~Also note that the~~ following are not assignable.}}		\|title=The following items are not assignable, despite appearing in the items lists. Other items may not be assignable depending on the settings chosen.}}
	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.		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.

ETR BTF: /* Gossip Stones and Other Text Boxes */ issue warning that 1200+ character text breaks text boxes

2023-06-22T07:03:06Z

Gossip Stones and Other Text Boxes: issue warning that 1200+ character text breaks text boxes

← Older revision		Revision as of 07:03, 22 June 2023
Line 739:		Line 739:

	The definition is a dictionary with the term <var>text</var>.		The definition is a dictionary with the term <var>text</var>.
	* Multiple text boxes can be assigned to a single Gossip Stone/sign/NPC/etc. 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.		* Multiple text boxes can be assigned to a single Gossip Stone/sign/NPC/etc. 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. '''Warning''': Really long texts (1200+ characters) will have negative side effects ranging from graphical issues to hard crashes, so don't make your text too long, or test them if you do. Keep in mind that this character limit appears to be significantly lower on N64 than on emulator or Wii VC.
	* 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.		* 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.

ETR BTF: /* Examples */ add new instructions for v7.1.123+

2023-06-19T09:05:04Z

Examples: add new instructions for v7.1.123+

← Older revision		Revision as of 09:05, 19 June 2023
Line 931:		Line 931:
	}}		}}

	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.		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). (As of v7.1.123 this <kbd><samp>.meta</samp></kbd> file will be packed with the <kbd><samp>.seq</samp></kbd> inside a <kbd><samp>.ootrs</samp></kbd> file.) If you are having trouble accessing this <kbd><samp>.meta</samp></kbd> file, the file name of the <kbd><samp>.seq</samp></kbd> or <kbd><samp>.ootrs</samp></kbd> should also work (but is not guaranteed to). If this is done incorrectly, then the randomizer will skip the song and not output an error message. This means that some other track will be placed there instead without your knowledge.

	=== Plando Exclusive Features ===		=== Plando Exclusive Features ===

Maplestar: add stuff about text control codes

2023-04-01T23:40:35Z

add stuff about text control codes

← Older revision		Revision as of 23:40, 1 April 2023
Line 734:		Line 734:
	=== Gossip Stones and Other Text Boxes ===		=== Gossip Stones and Other Text Boxes ===

	Plandomizer can also alter the text of Gossip Stones and as of v6.2.28 of nearly all other text boxes in the game. This is a very powerful and flexible feature, but keep in mind that the Randomizer cannot check for (hint) logic if you plando Gossip Stones. In other words, '''Custom-made hints can be false and should therefore be constructed carefully'''. This feature has not been tested extensively for other text boxes, but it seems to work for all text boxes that the Randomizer doesn't already alter itself. For example, you cannot change the text boxes for receiving Small Keys or Gold Skulltula Tokens.		Plandomizer can also alter the text of Gossip Stones and as of v6.2.28 of nearly all other text boxes in the game. This is a very powerful and flexible feature, but keep in mind that the Randomizer cannot check for (hint) logic if you plando Gossip Stones. In other words, '''Custom-made hints can be false and should therefore be constructed carefully'''. This feature has not been tested extensively for other text boxes, but it seems to work for all text boxes that the Randomizer doesn't already alter itself. For example, you cannot change the text boxes for receiving Small Keys or Gold Skulltula Tokens. However, be very cautious of altering text boxes that chain to others or lead into an action as these can easily cause softlocks if those actions are not accounted for.

	When plandoing text boxes, the term is the name of the Gossip Stone or the [https://wiki.cloudmodding.com/oot/Text_IDs Text ID] when changing other text boxes. The names of Gossip Stones can be found [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Hints.py here] or in the <kbd>gossip_stones</kbd> section of an old Spoiler Log. The Text IDs can be found [https://wiki.cloudmodding.com/oot/Text_IDs here]. Click on the appropriate ID List and search for the vanilla text using <kbd>CTRL</kbd> + <kbd>F</kbd> to find the correct ID number. Changing the text of Gossip Stones using the Text ID will not work. You have to use the Gossip Stone name for that.		When plandoing text boxes, the term is the name of the Gossip Stone or the [https://wiki.cloudmodding.com/oot/Text_IDs Text ID] when changing other text boxes. The names of Gossip Stones can be found [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/Dev/Hints.py here] or in the <kbd>gossip_stones</kbd> section of an old Spoiler Log. The Text IDs can be found [https://wiki.cloudmodding.com/oot/Text_IDs here]. Click on the appropriate ID List and search for the vanilla text using <kbd>CTRL</kbd> + <kbd>F</kbd> to find the correct ID number. Changing the text of Gossip Stones using the Text ID will not work. You have to use the Gossip Stone name for that.
Line 755:		Line 755:
	}}		}}

	When plandoing Gossip Stones, the Randomizer will replace available hints in reverse priority order.		When plandoing Gossip Stones, the Randomizer will replace available hints in reverse priority order. (As of version 7.1.51, this now works in proper listed order.)

	==== Special Characters ====		==== Special Characters ====
Line 778:		Line 778:
	The Text ID values from <kbd>05 00</kbd> to <kbd>05 60</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 96 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.		The Text ID values from <kbd>05 00</kbd> to <kbd>05 60</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 96 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.

	==== ~~Miscellaneous~~ ====		==== Control Codes ====
			Control Codes allow text boxes to be chained together or ensure actions occur after text boxes.

			The <kbd>${07 xx xx}</kbd> explained in the Sound Effects section is the control code to link to other text boxes. Some text boxes require this when they are replaced For example, Link the Goron's first text upon standing up is <kbd>$3032</kbd>. If this text ID is replaced, it must end with <kbd>${07 30 33}</kbd> in order to link to the "Boohoo" text which will allow the interaction to continue so his item can be received.

			The control code <kbd>${0B}</kbd> is required for text boxes that lead into the game performing an action. For example, minigame NPC dialogue which leads into the start of the game must end with this. There is not currently a comprehensive list of dialogue that requires this, so we recommend testing all custom dialogue in game before releasing a plando to others. Examples of a few IDs that require this are 4086, 6040, and 71AF.

	To print the current in-game time in a text box, use <kbd>${1F}</kbd>.		To print the current in-game time in a text box, use <kbd>${1F}</kbd>.

Blackwall: /* Locations */

2022-10-26T11:29:41Z

Locations

← Older revision		Revision as of 11:29, 26 October 2022
Line 292:		Line 292:
	"locations": {		"locations": {
	"Links Pocket": "*Medallion",		"Links Pocket": "*Medallion",
	"Twinrova": "!Medallion",		"Twinrova": "!*Medallion",
	"KF Midos Top Left Chest": "*Shield"		"KF Midos Top Left Chest": "*Shield"
	}		}

ETR BTF: /* Sound Effects */ and again lol

2022-09-27T19:18:26Z

Sound Effects: and again lol

← Older revision		Revision as of 19:18, 27 September 2022
Line 776:		Line 776:
	Only one sound effect will play per Text ID. If you want a single source of text boxes (e.g. a Gossip Stone) to play a sound effect on every single text box, then you will need to chain text boxes together. This is done by putting <kbd>${07 xx xx}</kbd>, where <kbd>xx xx</kbd> is the Text ID of another text box, at the end of a text box. Then, you'll want to make a new <kbd>gossip_stones</kbd> entry that uses this Text ID as the term. You can chain that entry into a new one and keep chaining until you are satisfied. It is highly recommended to take a look at the example of chaining text boxes down below.		Only one sound effect will play per Text ID. If you want a single source of text boxes (e.g. a Gossip Stone) to play a sound effect on every single text box, then you will need to chain text boxes together. This is done by putting <kbd>${07 xx xx}</kbd>, where <kbd>xx xx</kbd> is the Text ID of another text box, at the end of a text box. Then, you'll want to make a new <kbd>gossip_stones</kbd> entry that uses this Text ID as the term. You can chain that entry into a new one and keep chaining until you are satisfied. It is highly recommended to take a look at the example of chaining text boxes down below.

	The Text ID values from <kbd>05 00</kbd> to <kbd>05 40</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 64 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.		The Text ID values from <kbd>05 00</kbd> to <kbd>05 60</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 96 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.

	==== Miscellaneous ====		==== Miscellaneous ====

ETR BTF: /* Sound Effects */ new range again lol

2022-09-27T19:17:42Z

Sound Effects: new range again lol

← Older revision		Revision as of 19:17, 27 September 2022
Line 776:		Line 776:
	Only one sound effect will play per Text ID. If you want a single source of text boxes (e.g. a Gossip Stone) to play a sound effect on every single text box, then you will need to chain text boxes together. This is done by putting <kbd>${07 xx xx}</kbd>, where <kbd>xx xx</kbd> is the Text ID of another text box, at the end of a text box. Then, you'll want to make a new <kbd>gossip_stones</kbd> entry that uses this Text ID as the term. You can chain that entry into a new one and keep chaining until you are satisfied. It is highly recommended to take a look at the example of chaining text boxes down below.		Only one sound effect will play per Text ID. If you want a single source of text boxes (e.g. a Gossip Stone) to play a sound effect on every single text box, then you will need to chain text boxes together. This is done by putting <kbd>${07 xx xx}</kbd>, where <kbd>xx xx</kbd> is the Text ID of another text box, at the end of a text box. Then, you'll want to make a new <kbd>gossip_stones</kbd> entry that uses this Text ID as the term. You can chain that entry into a new one and keep chaining until you are satisfied. It is highly recommended to take a look at the example of chaining text boxes down below.

	The Text ID values from <kbd>~~04 60~~</kbd> to <kbd>~~04 C0~~</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 96 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.		The Text ID values from <kbd>05 00</kbd> to <kbd>05 40</kbd> (in hexadecimal numbers) have been reserved for text box chaining by Plandomakers. Other Text IDs could be in use by the Randomizer either currently or in the future, so in order to future-proof your Plando it is highly encouraged to stay within this range of 64 different Text IDs. Using values already in use by the Randomizer would result in the Randomizer overwriting your text boxes with its own. Keep in mind that chaining text boxes is only required for having multiple sound effects tied to a single source of text boxes. If you just want additional text boxes without sound effects, then you can achieve this far easier with the <kbd>^</kbd> character.

	==== Miscellaneous ====		==== Miscellaneous ====