Text Book - Revision history

Hyper at 18:04, 30 April 2026

2026-04-30T18:04:53Z

← Older revision		Revision as of 18:04, 30 April 2026
Line 70:		Line 70:
	\|-		\|-
	\|<code>$</code>		\|<code>$</code>
	\|Creates a placeholder marker for a variable to be inserted in the text entity. If no variable exists for this marker, it'll display ~~as <code>$</code>~~.		\|Creates a placeholder marker for a variable to be inserted in the text entity. If no variable exists for this marker, it'll display this character.
	\|}		\|}

Hyper at 18:03, 30 April 2026

2026-04-30T18:03:57Z

← Older revision		Revision as of 18:03, 30 April 2026
Line 57:		Line 57:

	== Control Characters ==		== Control Characters ==
	The text stored in '''Text Cards''' support using control characters for ~~specific message window behaviour~~.		The text stored in '''Text Cards''' support using control characters for certain interactive or visual behaviours.
	{\| class="wikitable"		{\| class="wikitable"
	\|+		\|+
Line 68:		Line 68:
	\|<code>\n</code>		\|<code>\n</code>
	\|Creates a new line in the text entity.		\|Creates a new line in the text entity.
			\|-
			\|<code>$</code>
			\|Creates a placeholder marker for a variable to be inserted in the text entity. If no variable exists for this marker, it'll display as <code>$</code>.
	\|}		\|}

Hyper at 17:57, 30 April 2026

2026-04-30T17:57:20Z

← Older revision		Revision as of 17:57, 30 April 2026
Line 65:		Line 65:
	\|<code>\f</code>		\|<code>\f</code>
	\|Creates a new page in the message window. The next page is switched to automatically after the voice line started by a '''sound''' variable has finished, otherwise it waits for player input.		\|Creates a new page in the message window. The next page is switched to automatically after the voice line started by a '''sound''' variable has finished, otherwise it waits for player input.
			\|-
			\|<code>\n</code>
			\|Creates a new line in the text entity.
	\|}		\|}

Hyper: Documented control characters

2026-04-19T16:50:34Z

Documented control characters

@@ Line 54: / Line 54: @@
 |VariablesOffset
 |The offset of the variables for this '''Text Card'''.
 |}

Hyper at 20:46, 4 December 2025

2025-12-04T20:46:56Z

← Older revision		Revision as of 20:46, 4 December 2025
Line 86:		Line 86:
	\|picture		\|picture
	\|String		\|String
	\|Once encountered, draws the specified picture defined in the game's ~~'''~~[[Text Font Picture]]~~'''~~ file.		\|Once encountered, draws the specified picture defined in the game's [[Text Font Picture]] file.
	\|-		\|-
	\|red		\|red

Hyper at 20:45, 4 December 2025

2025-12-04T20:45:29Z

← Older revision		Revision as of 20:45, 4 December 2025
Line 86:		Line 86:
	\|picture		\|picture
	\|String		\|String
	\|Once encountered, draws the specified picture defined in the game's '''Text Font Picture''' file.		\|Once encountered, draws the specified picture defined in the game's '''[[Text Font Picture]]''' file.
	\|-		\|-
	\|red		\|red

Hyper at 19:12, 4 December 2025

2025-12-04T19:12:57Z

← Older revision		Revision as of 19:12, 4 December 2025
Line 1:		Line 1:
	'''''Text Book''''' is a file format used in [[Sonic the Hedgehog (2006)]] for storing text with friendly names and variables.		'''''Text Book''''' is a file format used in [[Sonic the Hedgehog (2006)]] for storing text with friendly names and variables.

	These files are located in <code>cache.arc</code> and <code>text.arc</code> under the <code>./text/</code> directory from platform root as <code>*.mst</code> files.		These files are located in <code>cache.arc</code> and <code>text.arc</code> under the <code>./text/</code> directory from [[Sonic the Hedgehog (2006) File System#Platform Root\|platform root]] as <code>*.mst</code> files.

	== Specification ==		== Specification ==

Hyper: Use example notice for variables example

2025-12-03T10:22:37Z

Use example notice for variables example

← Older revision		Revision as of 10:22, 3 December 2025
Line 112:		Line 112:
	\|Once encountered, starts colouring characters yellow. <span title="#FCC658" style="display: inline-block; width: 12px; height: 12px; background: #FCC658; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters yellow. <span title="#FCC658" style="display: inline-block; width: 12px; height: 12px; background: #FCC658; margin: 0 4px; vertical-align: middle;"></span>
	\|}		\|}
	~~For~~ example~~, with~~ the following text:<syntaxhighlight lang="text">
			{{Notice\|type=example\|content=
			With the following text:
			<syntaxhighlight lang="text">
	$The quick $brown$ fox jumps over the $lazy$ dog.\nPress the $ button to continue.		$The quick $brown$ fox jumps over the $lazy$ dog.\nPress the $ button to continue.
	</syntaxhighlight>And the following variables:<syntaxhighlight lang="text">		</syntaxhighlight>
			And the following variables:
			<syntaxhighlight lang="text">
	sound(all01_a00_sn),rgba(127,51,0),color,red,color,picture(button_a)		sound(all01_a00_sn),rgba(127,51,0),color,red,color,picture(button_a)
	</syntaxhighlight>The game should first play the sound <code>all01_a00_sn</code>, then draw something akin to the following text:		</syntaxhighlight>
	The quick <span style="color:#7F3300;">brown</span> fox jumps over the <span style="color:#FD5858;">lazy</span> dog. Press the <span style="color:#58FF8E;">'''Ⓐ'''</span> button to continue.		The game should first play the sound <code>all01_a00_sn</code>, then draw something akin to the following text:
			<div class="mw-code" style="display: flex; align-items: center; margin: 20px 0 0 0; background-color: var(--hedgedocs-frame-bg-color); border-color: var(--hedgedocs-base-border-color);">
			The quick <span style="color:#7F3300;">brown</span> fox jumps over the <span style="color:#FD5858;">lazy</span> dog.
			Press the <span style="color:#58FF8E;">'''Ⓐ'''</span> button to continue.
			</div>
			}}

	[[Category:File Formats]]		[[Category:File Formats]]

Hyper at 09:50, 3 December 2025

2025-12-03T09:50:00Z

← Older revision		Revision as of 09:50, 3 December 2025
Line 61:		Line 61:
	\|+		\|+
	!Variable		!Variable
			!Parameters
	!Description		!Description
	~~!Parameters~~
	\|-		\|-
	\|blue		\|blue
			\|None
	\|Once encountered, starts colouring characters blue. <span title="#00C6C6" style="display: inline-block; width: 12px; height: 12px; background: #00C6C6; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters blue. <span title="#00C6C6" style="display: inline-block; width: 12px; height: 12px; background: #00C6C6; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|-		\|-
	\|color		\|color
			\|None
	\|Once encountered, starts colouring characters white. <span title="#FFFFFF" style="display: inline-block; width: 12px; height: 12px; background: #FFFFFF; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters white. <span title="#FFFFFF" style="display: inline-block; width: 12px; height: 12px; background: #FFFFFF; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|-		\|-
	\|color!		\|color!
			\|None
	\|Once encountered, starts colouring characters yellow. <span title="#FFC658" style="display: inline-block; width: 12px; height: 12px; background: #FFC658; margin: 0 4px; vertical-align: middle;"></span> Presumably this is meant as the "warning" colour, hence the exclamation mark.		\|Once encountered, starts colouring characters yellow. <span title="#FFC658" style="display: inline-block; width: 12px; height: 12px; background: #FFC658; margin: 0 4px; vertical-align: middle;"></span> Presumably this is meant as the "warning" colour, hence the exclamation mark.
	~~\|None~~
	\|-		\|-
	\|gray		\|gray
			\|None
	\|Once encountered, starts colouring characters grey. <span title="#737373" style="display: inline-block; width: 12px; height: 12px; background: #737373; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters grey. <span title="#737373" style="display: inline-block; width: 12px; height: 12px; background: #737373; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|-		\|-
	\|green		\|green
			\|None
	\|Once encountered, starts colouring characters green. <span title="#58FF8E" style="display: inline-block; width: 12px; height: 12px; background: #58FF8E; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters green. <span title="#58FF8E" style="display: inline-block; width: 12px; height: 12px; background: #58FF8E; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|-		\|-
	\|picture		\|picture
			\|String
	\|Once encountered, draws the specified picture defined in the game's '''Text Font Picture''' file.		\|Once encountered, draws the specified picture defined in the game's '''Text Font Picture''' file.
	~~\|String~~
	\|-		\|-
	\|red		\|red
			\|None
	\|Once encountered, starts colouring characters red. <span title="#FD5858" style="display: inline-block; width: 12px; height: 12px; background: #FD5858; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters red. <span title="#FD5858" style="display: inline-block; width: 12px; height: 12px; background: #FD5858; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|-		\|-
	\|rgba		\|rgba
			\|Byte, Byte, Byte
	\|Once encountered, starts colouring characters the specified colour. Despite the name, this does not support setting the alpha colour of the text.		\|Once encountered, starts colouring characters the specified colour. Despite the name, this does not support setting the alpha colour of the text.
	~~\|Byte, Byte, Byte~~
	\|-		\|-
	\|sound		\|sound
			\|String
	\|Once encountered, plays the specified sound effect if the '''Sound Bank''' containing it is loaded.		\|Once encountered, plays the specified sound effect if the '''Sound Bank''' containing it is loaded.
	~~\|String~~
	\|-		\|-
	\|text		\|text
			\|Unknown
	\|Unknown.		\|Unknown.
	~~\|Unknown~~
	\|-		\|-
	\|value		\|value
			\|Unknown
	\|Unknown.		\|Unknown.
	~~\|Unknown~~
	\|-		\|-
	\|yellow		\|yellow
			\|None
	\|Once encountered, starts colouring characters yellow. <span title="#FCC658" style="display: inline-block; width: 12px; height: 12px; background: #FCC658; margin: 0 4px; vertical-align: middle;"></span>		\|Once encountered, starts colouring characters yellow. <span title="#FCC658" style="display: inline-block; width: 12px; height: 12px; background: #FCC658; margin: 0 4px; vertical-align: middle;"></span>
	~~\|None~~
	\|}		\|}
	For example, with the following text:<syntaxhighlight lang="text">		For example, with the following text:<syntaxhighlight lang="text">

Hyper at 09:47, 3 December 2025

2025-12-03T09:47:57Z

← Older revision		Revision as of 09:47, 3 December 2025
Line 69:		Line 69:
	\|-		\|-
	\|color		\|color
	\|Once encountered, starts colouring characters white.		\|Once encountered, starts colouring characters white. <span title="#FFFFFF" style="display: inline-block; width: 12px; height: 12px; background: #FFFFFF; margin: 0 4px; vertical-align: middle;"></span>
	\|None		\|None
	\|-		\|-