5,455 bytes added
, 00:09, 22 January 2023
Badge Arcade plays actions and formats text with what I like to call, “tags”. Tags are a collection of hex bytes, and these tags can be placed inside of text to color or scale text, and play animations on Badge Bunny.
These tags are used for the MSBT text inside of <code>boss.sarc</code>.
<span id="tag-format"></span>
== Tag Format ==
{| class="wikitable"
|-
! Begin Format Tag
! Type
! Begin Data
! Data
! End Data and Tag
|-
| <code>0E 00 00 00</code>
| <code>03</code>
| <code>00</code>
| <code>02 00 78</code>
| <code>00 / FF / CD</code>
|}
Tags have a 4 byte section to begin the tag. The 3rd byte will be 02 if it is an action tag.
This is followed by what type of tag it is, if it’s a text format tag.
A 00 byte then follows to begin the tag data. This data continues until it hits either a 00, FF, or CD byte depending on what type of tag it is.
<span id="tags"></span>
== Tags ==
These are the tags that Badge Arcade uses to format.
{| class="wikitable"
|-
! Tag
! Description
|-
| <code>0E 00 00 00 03 00 04 00 RR GG BB FF</code>
| Colors text using the RR GG BB bytes as RGB hex.
|-
| <code>0E 00 00 00 02 00 02 00 FS 00</code>
| Changes the font scale using the FS byte.
|-
| <code>0E 00 02 00 00 00 04 00 AC TI ON CD</code>
| Changes Badge Bunny’s action using the AC TI ON bytes.
|}
The color and font scale tags format everything after them, unless an exit tag resets it. Action tags are to be placed at the end of a message.
<span id="exit-tags"></span>
== Exit Tags ==
Exit tags are simply normal tags that set the already customized values back to defaults. They are exactly like normal tags, and are provided for reference. Exit tags are not necessary if you do not want to unformat the text at any point during the message.
{| class="wikitable"
|-
! Exit Tag
! Description
|-
| <code>0E 00 00 00 03 00 04 00 00 00 00 FF</code>
| Changes text to black.
|-
| <code>0E 00 00 00 02 00 02 00 64 00</code>
| Changes font scale to 64, the default.
|}
If an exit tag is at the end of a message, an action tag MUST be provided, otherwise the game will read the exit tag as an action, which could cause problems.
<span id="recommended-color-values"></span>
== Recommended Color Values ==
These values are recommended for text coloration, as it is what official text is colored as. These are '''''not''''' restrictions.
{| class="wikitable"
|-
! Color
! Red
! Green
! Blue
|-
| Hex
| <code>#FF0000</code>
| <code>#009B00</code>
| <code>#0000FF</code>
|-
| Note
| Used for general highlighting,<br>and game names in the Miiverse Gallery.
| Rarely used, but mainly for the Miiverse Gallery.
| Usually used for character names,<br>and themes in the Miiverse Gallery.
|}
<span id="actions"></span>
== Actions ==
Actions are animations that play on Badge Bunny when he says the current message. If there are multiple action tags, only the last one will play. If there is '''no''' action tag, a default nodding animation will play.
An incomplete list of the most common actions is below, with names describing them, and a GIF preview of the animation. They are in no particular order.
You can substitute these into the ACTION bytes of the action tag.
{| class="wikitable"
|-
! Action
! Hex
! Preview
|-
| Flames
| <code>12 14 14</code>
| https://i.imgur.com/XJOXecm.gif
|-
| Pounce
| <code>11 13 13</code>
| https://i.imgur.com/yF5kIhz.gif
|-
| Shocked
| <code>00 30 2E</code>
| https://i.imgur.com/yUopyml.gif
|-
| Disappointed
| <code>00 34 32</code>
| https://i.imgur.com/Gg71ww3.gif
|-
| Shake My Hand
| <code>03 05 05</code>
| https://i.imgur.com/0koci1z.gif
|-
| Chop Explain
| <code>18 1F 1F</code>
| https://i.imgur.com/usfbqcq.gif
|-
| Laugh (Small)
| <code>00 20 20</code>
| https://i.imgur.com/eLgzpfm.gif
|-
| Laugh (Slapping)
| <code>19 21 21</code>
| https://i.imgur.com/YR47psp.gif
|-
| Head Shake
| <code>00 28 28</code>
| https://i.imgur.com/OUbeKS5.gif
|-
| Clap Explain
| <code>1D 27 27</code>
| https://i.imgur.com/tCnWOdJ.gif
|-
| Awkward
| <code>02 04 04</code>
| https://i.imgur.com/jO6Mlfof.gif
|-
| Flushed
| <code>00 39 37</code>
| https://i.imgur.com/ue2vopA.gif
|-
| Shimmer
| <code>00 1B 1B</code>
| https://i.imgur.com/PotZ3LP.gif
|-
| Arms Crossed
| <code>00 00 00</code>
| https://i.imgur.com/G7VYCsu.gif
|-
| Clapping
| <code>00 18 18</code>
| https://i.imgur.com/fopecNR.gif
|-
| Right Hand Slap
| <code>1E 2A 2A</code>
| https://i.imgur.com/fnICcPG.gif
|-
| Music Note Burst
| <code>17 1D 1D</code>
| https://i.imgur.com/QXchrzO.gif
|}
<span id="examples"></span>
== Examples ==
Below are raw hex blocks of example messages, and what they appear as.
<span id="color-example"></span>
=== Color Example ===
<div class="figure">
[[File:Nba-example-color.png|Color Example]]
</div>
<pre>
4E 00 6F 00 72 00 6D 00 61 00 6C 00 20 00 0E 00
00 00 03 00 04 00 FF 00 00 FF 52 00 65 00 64 00
20 00 0E 00 00 00 03 00 04 00 00 9B 00 FF 47 00
72 00 65 00 65 00 6E 00 20 00 0E 00 00 00 03 00
04 00 00 00 FF FF 42 00 6C 00 75 00 65 00 00 00
</pre>
-----
<span id="font-scale-example"></span>
=== Font Scale Example ===
<div class="figure">
[[File:Nba-example-scale.png|FS Example]]
</div>
<pre>
44 00 65 00 66 00 61 00 75 00 6C 00 74 00 20 00
0E 00 00 00 02 00 02 00 74 00 53 00 69 00 7A 00
65 00 20 00 37 00 34 00 20 00 0E 00 00 00 02 00
02 00 54 00 53 00 69 00 7A 00 65 00 20 00 35 00
34 00 20 00 0E 00 00 00 02 00 02 00 34 00 53 00
69 00 7A 00 65 00 20 00 33 00 34 00 00 00
</pre>