Skip to content

Latest commit

 

History

History
106 lines (95 loc) · 7.33 KB

NOTES.md

File metadata and controls

106 lines (95 loc) · 7.33 KB
Raw

Notes

Format

Special syntax

For all text dumps in the standard format, the following brackets mark modified representations of the original data:

  • Text within square brackets mark variables and functions.
    • When searching, you can search for the variable syntax directly, such as [VAR 0100(0000)]. When using regular expressions, you will need to escape the syntax as \[VAR 0100\(0000\)\].
  • Text within curly brackets represent furigana in the {kanji|kana} format.
    • When searching, the string will match if the furigana syntax matches, the kanji match, or the kana match. For example, if you were searching for a line that includes 一(ひと)つ, all three of these queries will match: {一|ひと}つ, ひとつ, 一つ.
    • When using regular expressions, you will need to escape the syntax, such as \{一\|ひと\}つ.

Escape sequences

For all text dumps in the standard format, there are six escape sequences:

  • \n represents a line break.
    • When searching, you can search for \n directly.
    • When using regular expressions, it is converted to a line feed (\n).
  • \r represents a prompt to press a button; upon tapping it, it scrolls the current dialogue up one line.
    • When searching, you can search for \r directly.
    • When using regular expressions, it is converted to a carriage return (\r).
  • \c represents a prompt to press a button; upon tapping it, the dialogue box is cleared.
    • When searching, you can search for \c directly.
    • When using regular expressions, it is converted to a form feed (\f).
  • \\ represents a literal backslash.
    • When searching, you can search for \\ directly. (Searching for \ on its own will match any escape sequence.)
    • When using regular expressions, you will need to double-escape it as \\\\.
  • \[ represents a literal left square bracket.
    • When searching, you can search for \[ directly. (Searching for [ on its own will match variable syntax.)
    • When using regular expressions, you will need to double-escape it as \\\[.
  • \{ represents a literal left curly bracket.
    • When searching, you can search for \{ directly. (Searching for { on its own will match furigana syntax.)
    • When using regular expressions, you will need to double-escape it as \\\{.

Special characters

  • Use $ for the Pokémon Dollar sign.
  • Use ⒆⒇ for PKMN.
  • Use ᵉʳ, ʳᵉ, ʳ, ᵉ for the ordinals.
  • Use Ⓐ, Ⓑ, Ⓧ, Ⓨ, Ⓛ, Ⓡ, ✜, 🏠︎ for the Nintendo 3DS buttons.
  • Use ✜, Ⓐ, Ⓑ, ⊕, ⊖, ①, ②, ◎, Ⓒ, Ⓩ, 👆︎ for the Wii buttons.
  • Use ①, ②, ③, ④ for the PictoChat neutral, happy, sad, and angry faces.
  • Use ✨︎ for the sparkles used for the differently-colored statues in BDSP.

Sources and changes made

Most text dumps in this repo use the common format shared by xytext, pk3DS, and pkNX.

NDS

The text dumps from the NDS games have been converted to the standard format, with the following extensions to the format:

  • Compressed strings are decompressed and marked with [COMP] instead of \c.
  • [NULL] is used as a placeholder for lines and files which do not exist in a particular language version.
  • PKMN is encoded using ⒆⒇ as in the Generation V games.
  • The bag icons in the Generation IV games are encoded using ㌇㌈㌉㌊㌋㌌㌍㌎ as in the Wii games.

BDSP

The text dumps for Pokémon Brilliant Diamond and Pokémon Shining Pearl have been converted to the standard format, with the following extensions to the format:

  • The arguments for variables may include named parameters and |-delimited arrays of strings, such as in [VAR 1300(tagParameter=255,tagWordArray=he|she)]. (This is equivalent to [VAR 1100(00FF,0100)]she in other games.)
  • [WAIT] takes a float as an argument instead of an integer.
  • [SFX] takes a float as an argument. (This is equivalent to [VAR BE05] in other games.)
  • The Unity rich text tags <color>, <position>, <line-indent>, and <size> are used to format text.
  • Speaker names are taken from Dpr/masterdatas/MsgWindowData.json and converted to the [VAR 0114] format used in other games.

GBA

The text dumps from the GBA games are based on the format used by the pret decompilations. They have been converted to the standard format, with the following extensions to the format:

  • The text data has been formatted to align based on the corresponding symbol in the decompilation.
  • Variables and special characters are marked with square brackets instead of curly braces.
  • PKMN is encoded using ⒆⒇ as in the Generation V games.
  • Braille text is decoded to plain text.

GB/GBC

The text dumps from the GB and GBC games were done by RobbiRobb. As these games do not have a file system like later games, these text dumps include other data interpreted as text. These dumps are included unmodified.

GCN/Wii

The text dumps from Pokémon Colosseum and Pokémon XD: Gale of Darkness were done by Tiddlywinks, with the following changes:

  • The text data has been formatted to align based on their IDs. IDs with multiple corresponding strings are displayed together using an HTML description list.
  • Variables and special characters are marked with square brackets instead of curly braces.
  • {newline} and {clear_window} are replaced with \n and \c.
  • Furigana is converted to the {kanji|kana} format.
  • The {{null}} terminator is stripped.

The text dumps from Pokémon Battle Revolution are based on the format used by PBRHex. They have been converted to the standard format, with the following extensions to the format:

  • [FONT #] is used to set the font.
  • [SPACING #] is used to set the letter spacing.
  • [VERTOFFSET #] is used to set the Y-position of the cursor.
  • [ALIGN #] is used to align lines of text.
  • [COLOR #] is used to set the text color.
  • ["PP"], ["HP"], ["Lv."], and ["No."] are used to display language-dependent abbreviations.
  • ▽ and ▼ are used to represent \r and \c in lines taken from the DS games.

The text dumps from Pokémon Box Ruby & Sapphire and My Pokémon Ranch have been converted to the standard format, with the following extensions to the format:

  • Line feeds are replaced with \n.
  • [NULL] is used as a placeholder for lines and files which do not exist in a particular language version.
  • Entries with an offset of 0 in the INF1 block are represented as [~ #], where # is the one-based index of the entry in the block.

Additional notes for My Pokémon Ranch:

  • The farm_items file was split from the pokemonfarm file in the PAL version and the Japanese Platinum update. The equivalent lines are moved in the USA version to match.
  • Some of the lines in farm_event were moved to pokemonfarm in the Japanese Platinum update (specifically, lines 275-302 in pokemonfarm were originally beyween lines 538 and 539 in farm_event). The equivalent lines in the USA/PAL versions are moved to match.