Help:Text modding: Difference between revisions

→‎Icons: Remove zr as it's not recognized by any libraries
m (General clarifications)
(→‎Icons: Remove zr as it's not recognized by any libraries)
 
(7 intermediate revisions by 3 users not shown)
Line 8: Line 8:


==Accessing the files==
==Accessing the files==
All text in the game is located inside the <code>content/Pack/Bootup_xxXX.pack</code> files in what are called [[message archives]]. The <code>xxXX</code> is the locale of the message contents. If you want your mod to support multiple locales, you'll need to make your text changes in every locale file you want to support.
All text in the game is located inside the <code>content/Pack/Bootup_XXxx.pack</code> files in what are called [[message archives]]. The <code>XXxx</code> is the locale of the message contents, for example <code>EUen</code> for European English or <code>USes</code> for American Spanish. If you want your mod to support multiple locales, you'll need to make your text changes in every locale file you want to support.


Copy the message pack(s) you want to edit into your mod folder, then either open them with Wild Bits or unbuild your mod folder with Hyrule Builder. (If you use the latter, the new location of the message pack(s) will be <code>content/Message</code>.)
Copy the message pack(s) you want to edit into your mod folder, then either open them with Wild Bits or unbuild your mod folder with Hyrule Builder. (If you use the latter, the new location of the message pack(s) will be <code>content/Message</code>.)
Line 56: Line 56:


When putting spaces or line breaks at the beginning or end of a text node, the entire value of the node must be surrounded by unescaped double-quotes.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L98</ref>
When putting spaces or line breaks at the beginning or end of a text node, the entire value of the node must be surrounded by unescaped double-quotes.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L98</ref>
The font used in the game supports a number of special characters, including <code>♪</code>. For special characters not listed here, such as controller buttons, read about [[#Icons|the icon system]].


===Control nodes===
===Control nodes===
Line 85: Line 87:
           kind: icon
           kind: icon
           icon: y
           icon: y
</syntaxhighlight>The value of <code>icon</code> is the name of the icon to show. Options include arrows (<code>right_arrow</code>, <code>left_arrow</code>, <code>up_arrow</code>) and controller-related images (<code>gamepad</code>, <code>a</code>, <code>b</code>, <code>x</code>, <code>y</code>, <code>l</code>, <code>r</code>, <code>zl</code>, <code>zr</code>, <code>l_stick_press</code>, <code>l_stick_forward</code>, <code>l_stick_back</code>, <code>r_stick_press</code>, <code>d_pad_down</code>, <code>d_pad_left</code>, <code>d_pad_up</code>, <code>d_pad_right</code>, <code>plus</code>, <code>minus</code>).<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L47</ref>
</syntaxhighlight>The value of <code>icon</code> is the name of the icon to show. The following is an exhaustive list of valid vanilla options:<ref>https://github.com/ascclemens/msyt/blob/master/src/botw/mod.rs#L453</ref>
* <code>right_arrow</code>
* <code>left_arrow</code>
* <code>up_arrow</code>
* <code>gamepad</code>
* <code>a: 10</code>
* <code>a: 11</code>
* <code>b</code>
* <code>x: 12</code>
* <code>x: 37</code>
* <code>x: 38</code>
* <code>y</code>
* <code>l</code>
* <code>r</code>
* <code>zl: 14</code>
* <code>zl: 15</code>
* <code>l_stick_press</code>
* <code>l_stick_forward</code>
* <code>l_stick_back</code>
* <code>r_stick_press</code>
* <code>d_pad_down</code>
* <code>d_pad_left</code>
* <code>d_pad_up</code>
* <code>d_pad_right</code>
* <code>plus</code>
* <code>minus</code>
* <code>l_stick_left</code>
* <code>l_stick_right</code>
* <code>r_stick_vertical</code>
* <code>r_stick_horizontal</code>
 
Note that some any icon that has a number has multiple images, and the number determines which image is used. Also, some "icons" are actually available as [[#Text_nodes|standard characters]].


====Pausing====
====Pausing====
Line 176: Line 209:
|+
|+
!
!
!Facial Emotion
!Emotion
!Sound
!Sound
|-
|-
Line 238: Line 271:
==References==
==References==
<references />
<references />
[[Category:Guides]]
autopatrol, editnews
151

edits