Plandomizer - Revision history

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

ETR BTF: /* Sound Effects */ updated the safe range for plandos

2022-09-27T19:05:05Z

Sound Effects: updated the safe range for plandos

← Older revision		Revision as of 19:05, 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 ~~that are safe to use for chaining text boxes go~~ from <kbd>04 70</kbd> to <kbd>~~06 00~~</kbd> (in hexadecimal numbers). ~~Most other~~ values ~~are currently~~ in use by the Randomizer ~~and using those values~~ 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>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.

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

ETR BTF: /* Sound Effects */ change valid range

2022-09-27T12:44:58Z

Sound Effects: change valid range

← Older revision		Revision as of 12:44, 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 that are safe to use for chaining text boxes go from <kbd>04 50</kbd> to <kbd>06 00</kbd> (in hexadecimal numbers). Most other values are currently in use by the Randomizer and using those values 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 that are safe to use for chaining text boxes go from <kbd>04 70</kbd> to <kbd>06 00</kbd> (in hexadecimal numbers). Most other values are currently in use by the Randomizer and using those values 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: /* Gossip Stones and Other Text Boxes */ chaining text boxes and misc fixes

2022-09-27T09:53:53Z

Gossip Stones and Other Text Boxes: chaining text boxes and misc fixes

← Older revision		Revision as of 09:53, 27 September 2022
Line 770:		Line 770:

	==== Sound Effects ====		==== Sound Effects ====
	Each text box can be equipped with a sound effect. The full list of sound effect IDs can be found [https://wiki.cloudmodding.com/oot/Sound_Effect_Ids here], 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 <kbd>x</kbd> is the "Bank" as indicated on CloudModding and <kbd>yy</kbd> 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 <kbd>FF</kbd> (i.e. it has 3 characters on CloudModding).		Each text box can be equipped with a sound effect. The full list of sound effect IDs can be found [https://wiki.cloudmodding.com/oot/Sound_Effect_Ids here], 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 <kbd>x</kbd> is the "Bank" as indicated on CloudModding and <kbd>yy</kbd> is the sound number within the bank. The <kbd>8</kbd> must be swapped for <kbd>9</kbd> if the sound number is greater than <kbd>FF</kbd> (i.e. if 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.

			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.

	~~'''Warning''': Looping sounds will not stop until Link leaves~~ the ~~area or dies~~, ~~so it's recommended to avoid these sounds~~.		The Text ID values that are safe to use for chaining text boxes go from <kbd>04 50</kbd> to <kbd>06 00</kbd> (in hexadecimal numbers). Most other values are currently in use by the Randomizer and using those values 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 ====
Line 814:		Line 816:
	}}		}}

	'''Sound Effects Added''':		'''Sound Effects and Current Time Added''':
	{{json example\|		{{json example\|
	"gossip_stones": {		"gossip_stones": {
Line 826:		Line 828:
	"gossip_stones": {		"gossip_stones": {
	"$0307": {"text": "Is this magic?"}		"$0307": {"text": "Is this magic?"}
			}
			}}

			'''Chaining Text Boxes with the Sign in Front of the Exit from Kokiri Forest to Hyrule Field''':
			{{json example\|
			"gossip_stones": {
			"$0320": {"text": "${12 68 7a}Hey kids, want to learn how to chain text IDs?${07 04 60}"},
			"$0460": {"text": "${12 68 7a}Chained ID 1${07 04 61}"},
			"$0461": {"text": "${12 68 7a}Chained ID 2"}
	}		}
	}}		}}

ETR BTF: /* Gossip Stones and Other Text Boxes */ info on which hints are replaced first

2022-09-19T15:13:08Z

Gossip Stones and Other Text Boxes: info on which hints are replaced first

← Older revision		Revision as of 15:13, 19 September 2022
Line 754:		Line 754:
	\|expand=yes		\|expand=yes
	}}		}}

			When plandoing Gossip Stones, the Randomizer will replace available hints in reverse priority order.

	==== Special Characters ====		==== Special Characters ====