Text Book: Difference between revisions
Documented unused text variables |
Added colour guides to variables |
||
| Line 65: | Line 65: | ||
|- | |- | ||
|blue | |blue | ||
|Once encountered, starts colouring characters | |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 | |None | ||
|- | |- | ||
| Line 73: | Line 73: | ||
|- | |- | ||
|color! | |color! | ||
|Once encountered, starts colouring characters | |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 | |None | ||
|- | |- | ||
|gray | |gray | ||
|Once encountered, starts colouring characters grey. | |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 | |None | ||
|- | |- | ||
|green | |green | ||
|Once encountered, starts colouring characters green. | |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 | |None | ||
|- | |- | ||
| Line 89: | Line 89: | ||
|- | |- | ||
|red | |red | ||
|Once encountered, starts colouring characters red. | |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 | |None | ||
|- | |- | ||
| Line 109: | Line 109: | ||
|- | |- | ||
|yellow | |yellow | ||
|Once encountered, starts colouring characters | |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 | |None | ||
|} | |} | ||
| Line 117: | Line 117: | ||
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 game should first play the sound <code>all01_a00_sn</code>, then draw something akin to the following text: | ||
The quick <span style="color:#7F3300;">brown</span> fox jumps over the <span style="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. | ||
[[Category:File Formats]] | [[Category:File Formats]] | ||
Revision as of 09:45, 3 December 2025
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 cache.arc and text.arc under the ./text/ directory from platform root as *.mst files.
Specification
Text Book uses a Binary Resource container. The text to be displayed is encoded as UTF-16, whereas the names and variables are encoded as Shift-JIS.
Header
The header consists of the following data structure:
| Offset | Type | Name | Description |
|---|---|---|---|
| 0x00 | Char[4] | Signature | Always "WTXT" (referring to UTF-16). |
| 0x04 | UInt32 | NameOffset | The offset of the name of this Text Book. |
| 0x08 | UInt32 | CardCount | The total number of Text Cards in this Text Book. |
Text Card
Text Cards consist of the following data structure:
| Offset | Type | Name | Description |
|---|---|---|---|
| 0x00 | UInt32 | NameOffset | The offset of the name of this Text Card. |
| 0x04 | UInt32 | TextOffset | The offset of the UTF-16 text for this Text Card. |
| 0x08 | UInt32 | VariablesOffset | The offset of the variables for this Text Card. |
Variables
Variables are stored as comma-separated values, there should be one for each '$' character in the actual text to be displayed.
| Variable | Description | Parameters |
|---|---|---|
| blue | Once encountered, starts colouring characters blue. | None |
| color | Once encountered, starts colouring characters white. | None |
| color! | Once encountered, starts colouring characters yellow. Presumably this is meant as the "warning" colour, hence the exclamation mark. | None |
| gray | Once encountered, starts colouring characters grey. | None |
| green | Once encountered, starts colouring characters green. | None |
| picture | Once encountered, draws the specified picture defined in the game's Text Font Picture file. | String |
| red | Once encountered, starts colouring characters red. | None |
| rgba | 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 | Once encountered, plays the specified sound effect if the Sound Bank containing it is loaded. | String |
| text | Unknown. | Unknown |
| value | Unknown. | Unknown |
| yellow | Once encountered, starts colouring characters yellow. | None |
For example, with the following text:
$The quick $brown$ fox jumps over the $lazy$ dog.\nPress the $ button to continue.
And the following variables:
sound(all01_a00_sn),rgba(127,51,0),color,red,color,picture(button_a)
The game should first play the sound all01_a00_sn, then draw something akin to the following text:
The quick brown fox jumps over the lazy dog. Press the Ⓐ button to continue.