3dbrew - User contributions [en]

Nintendo Badge Arcade/MSBT

2023-01-25T03:15:19Z

Light: Update Action ID => Animation ID

Nintendo Badge Arcade uses <code>MSBT</code> files for Badge Bunny's dialog and animations

This page will only cover <code>MSBT</code> control tags specific to Nintendo Badge Arcade. For more details on <code>MSBT</code> files in general, refer to https://github.com/kinnay/Nintendo-File-Formats/wiki/MSBT-File-Format and https://mk8.tockdom.com/wiki/MSBT_(File_Format)


== Location ==

Nintendo Badge Arcade's <code>MSBT</code> files are loaded using <code>BOSS</code>. A large <code>SARC</code> archive file is downloaded which holds all the games data. Inside this <code>SARC</code> file, the <code>MSBT</code> files are stored in <code>/message/boss_REGION/LANG/slotID</code>


== Format ==

<code>MSBT</code> control tags have the following format

{|class="wikitable"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x2 || '''Magic'''. Always '''0E00'''.
|-
| 0x2 || 0x2 || Tag group ID
|-
| 0x4 || 0x2 || Tag ID
|-
| 0x6 || 0x2 || Data size
|-
| 0x8 || Data size || Data
|}


== Tag Groups ==

Nintendo Badge Arcade uses the following known tag groups:

{|class="wikitable"
|-
! Tag group ID !! Description
|-
| 2 || Badge Bunny (?)
|}


== Tags ==

The following is an incomplete list of the tag groups tags, with names describing each tag type


=== Badge Bunny (?) ===

Tag group ID <code>2</code>

{|class="wikitable"
|-
! Tag ID !! Name !! Data format
|-
| 0x0 || Play Action || Action ID. See below for details
|}


==== Badge Bunny Actions ====

The following is an incomplete list of the action datas, with names describing each, and a preview of their animations. They are in no particular order.

{|class="wikitable"
|-
! Action ID !! Name !! Preview
|-
| <code>121414CD</code> || Flames || https://i.imgur.com/XJOXecm.gif
|-
| <code>111313CD</code> || Pounce || https://i.imgur.com/yF5kIhz.gif
|-
| <code>00302ECD</code> || Shocked || https://i.imgur.com/yUopyml.gif
|-
| <code>003432CD</code> || Disappointed || https://i.imgur.com/Gg71ww3.gif
|-
| <code>030505CD</code> || Shake My Hand || https://i.imgur.com/0koci1z.gif
|-
| <code>181F1FCD</code> || Chop Explain || https://i.imgur.com/usfbqcq.gif
|-
| <code>002020CD</code> || Laugh (Small) || https://i.imgur.com/eLgzpfm.gif
|-
| <code>192121CD</code> || Laugh (Slapping) || https://i.imgur.com/YR47psp.gif
|-
| <code>002828CD</code> || Head Shake || https://i.imgur.com/OUbeKS5.gif
|-
| <code>1D2727CD</code> || Clap Explain || https://i.imgur.com/tCnWOdJ.gif
|-
| <code>020404CD</code> || Awkward || https://i.imgur.com/jO6Mlfo.gif
|-
| <code>003937CD</code> || Flushed || https://i.imgur.com/ue2vopA.gif
|-
| <code>001B1BCD</code> || Shimmer || https://i.imgur.com/PotZ3LP.gif
|-
| <code>000000CD</code> || Arms Crossed || https://i.imgur.com/G7VYCsu.gif
|-
| <code>001818CD</code> || Clapping || https://i.imgur.com/fopecNR.gif
|-
| <code>1E2A2ACD</code> || Right Hand Slap || https://i.imgur.com/fnICcPG.gif
|-
| <code>171D1DCD</code> || Music Note Burst || https://i.imgur.com/QXchrzO.gif
|}


== Recommended Color Values ==

These values are recommended for text coloration, as it is what official text is colored as. These are '''''not''''' restrictions

Format is RGBA. Alpha is ignored by Nintendo Badge Arcade and is always set to <code>FF</code>

{|class="wikitable"
|-
! Color !! Value !! Note
|-
| Red || <code>FF0000FF</code> || Used for general highlighting, and game names in the Miiverse Gallery.
|-
| Green || <code>009B00FF</code> || Rarely used, but mainly for the Miiverse Gallery.
|-
| Blue || <code>0000FFFF</code> || Usually used for character names, and themes in the Miiverse Gallery.
|}


== Examples ==

Below are raw hex blocks of example messages, and what they appear as.


=== 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>

-----


=== 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>

Nintendo Badge Arcade/MSBT

2023-01-25T03:14:30Z

Light: Update Animations => actions

Nintendo Badge Arcade uses <code>MSBT</code> files for Badge Bunny's dialog and animations

This page will only cover <code>MSBT</code> control tags specific to Nintendo Badge Arcade. For more details on <code>MSBT</code> files in general, refer to https://github.com/kinnay/Nintendo-File-Formats/wiki/MSBT-File-Format and https://mk8.tockdom.com/wiki/MSBT_(File_Format)


== Location ==

Nintendo Badge Arcade's <code>MSBT</code> files are loaded using <code>BOSS</code>. A large <code>SARC</code> archive file is downloaded which holds all the games data. Inside this <code>SARC</code> file, the <code>MSBT</code> files are stored in <code>/message/boss_REGION/LANG/slotID</code>


== Format ==

<code>MSBT</code> control tags have the following format

{|class="wikitable"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x2 || '''Magic'''. Always '''0E00'''.
|-
| 0x2 || 0x2 || Tag group ID
|-
| 0x4 || 0x2 || Tag ID
|-
| 0x6 || 0x2 || Data size
|-
| 0x8 || Data size || Data
|}


== Tag Groups ==

Nintendo Badge Arcade uses the following known tag groups:

{|class="wikitable"
|-
! Tag group ID !! Description
|-
| 2 || Badge Bunny (?)
|}


== Tags ==

The following is an incomplete list of the tag groups tags, with names describing each tag type


=== Badge Bunny (?) ===

Tag group ID <code>2</code>

{|class="wikitable"
|-
! Tag ID !! Name !! Data format
|-
| 0x0 || Play Action || Action ID. See below for details
|}


==== Badge Bunny Actions ====

The following is an incomplete list of the action datas, with names describing each, and a preview of their animations. They are in no particular order.

{|class="wikitable"
|-
! Animation ID !! Name !! Preview
|-
| <code>121414CD</code> || Flames || https://i.imgur.com/XJOXecm.gif
|-
| <code>111313CD</code> || Pounce || https://i.imgur.com/yF5kIhz.gif
|-
| <code>00302ECD</code> || Shocked || https://i.imgur.com/yUopyml.gif
|-
| <code>003432CD</code> || Disappointed || https://i.imgur.com/Gg71ww3.gif
|-
| <code>030505CD</code> || Shake My Hand || https://i.imgur.com/0koci1z.gif
|-
| <code>181F1FCD</code> || Chop Explain || https://i.imgur.com/usfbqcq.gif
|-
| <code>002020CD</code> || Laugh (Small) || https://i.imgur.com/eLgzpfm.gif
|-
| <code>192121CD</code> || Laugh (Slapping) || https://i.imgur.com/YR47psp.gif
|-
| <code>002828CD</code> || Head Shake || https://i.imgur.com/OUbeKS5.gif
|-
| <code>1D2727CD</code> || Clap Explain || https://i.imgur.com/tCnWOdJ.gif
|-
| <code>020404CD</code> || Awkward || https://i.imgur.com/jO6Mlfo.gif
|-
| <code>003937CD</code> || Flushed || https://i.imgur.com/ue2vopA.gif
|-
| <code>001B1BCD</code> || Shimmer || https://i.imgur.com/PotZ3LP.gif
|-
| <code>000000CD</code> || Arms Crossed || https://i.imgur.com/G7VYCsu.gif
|-
| <code>001818CD</code> || Clapping || https://i.imgur.com/fopecNR.gif
|-
| <code>1E2A2ACD</code> || Right Hand Slap || https://i.imgur.com/fnICcPG.gif
|-
| <code>171D1DCD</code> || Music Note Burst || https://i.imgur.com/QXchrzO.gif
|}


== Recommended Color Values ==

These values are recommended for text coloration, as it is what official text is colored as. These are '''''not''''' restrictions

Format is RGBA. Alpha is ignored by Nintendo Badge Arcade and is always set to <code>FF</code>

{|class="wikitable"
|-
! Color !! Value !! Note
|-
| Red || <code>FF0000FF</code> || Used for general highlighting, and game names in the Miiverse Gallery.
|-
| Green || <code>009B00FF</code> || Rarely used, but mainly for the Miiverse Gallery.
|-
| Blue || <code>0000FFFF</code> || Usually used for character names, and themes in the Miiverse Gallery.
|}


== Examples ==

Below are raw hex blocks of example messages, and what they appear as.


=== 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>

-----


=== 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>

Nintendo Badge Arcade/MSBT

2023-01-21T22:26:22Z

Light: Fix awkward link

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>.


== 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.


== 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.


== 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.


== 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, and game names in the Miiverse Gallery.
| Rarely used, but mainly for the Miiverse Gallery.
| Usually used for character names, and themes in the Miiverse Gallery.
|}


== 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/jO6Mlfo.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
|}


== Examples ==

Below are raw hex blocks of example messages, and what they appear as.


=== 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>

-----


=== 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>

Nintendo Badge Arcade

2023-01-21T22:12:45Z

Light: Add format tag reference

'''Nintendo Badge Arcade''' is an application that allows getting badges for the 3DS's [[Home Menu]] via a claw machine-like game.

== [[SpotPass]] usage ==
The game can use four different URLs to retrieve game data.
* <nowiki>https://npdl.cdn.nintendowifi.net/p01/nsa/<regionID>/FGONLYT/playinfo_<gameVersion>.dat</nowiki>
* <nowiki>https://npdl.cdn.nintendowifi.net/p01/nsa/<regionID>/data/data_<gameVersion>.dat</nowiki> This file is a SARC archive with all game data (like machines and [[Miiverse]] posts) that is available within a period of one week. This data is updated every Friday at 1:40 AM GMT
* <nowiki>https://npdl.cdn.nintendowifi.net/p01/nsa/<regionID>/data/allbadge_<gameVersion>.dat</nowiki> This has a SARC archive with all game badges and machines for the game.
* <nowiki>https://npdl.cdn.nintendowifi.net/p01/nsa/<regionID>/news/<language>/news_<gameVersion>.dat</nowiki>

Where gameVersion goes the version of the game, which can be v130 or v131, langcode is the two-character language codes from [[Config Savegame#Languages|config]], and regionID is from the below table.

{| class="wikitable"
|-
! Region
! ID
|-
| JPN
| j0ITmVqVgfUxe0O9
|-
| USA
| OvbmGLZ9senvgV3K
|-
| EUR
| J6la9Kj8iqTvAPOq
|}

== RomFS ==
Inside the romfs data, we can find the following folders:

root
├── message
├── primitive_renderer
├── region_common
└── region_XXX

* "message" has all in-game dialogues
* "region_common" has a similar scheme to data.dat, but has all in-game assets
* "region_XXX" is similar as region_common, but has all region specific files, like the first badge machine. Where XXX goes the region name (EUR, JPN, USA)

=== message ===
The message folder has the following structure:

message
├── boss_EUR
└─ XXxx
├── boss_JPN
└─ XXxx
├── boss_USA
└─ XXxx
└── rom
└─ XXxx

Where XX goes the region and xx belongs to the language. The dialogues are stored within SARC files.

The ''boss'' folders store the default online-related game dialogues. The ''rom'' folder has the gameplay and error dialogues. The ''boss'' dialogues can be overridden when they are providen by SpotPass.

Dialogue is formatted with [[Nintendo_Badge_Arcade/Format_Tags|Format Tags]].

=== region_common ===
The region_common folder stores all assets that aren't region dependent. Below are the assets folders:

region_common
├── banner
├── camera
├── cfl
├── effect
├── layout
├── model
├── scene
└── sound

==== banner ====
This folder has the game banner for each region on an ICN file?

==== camera ====
This folder has all camera animations? The contents are stored on Yaz0 compressed BCH files.

==== cfl ====
This folder's contents are unknown (Mii related?). The contents are stored on Yaz0 compressed BCH files.

==== effect ====
This folder stores all of the effects used ingame. These are stored on the following files:

* effect_CTR.ptcl
* elink.elk

==== layout ====
This folder's contents are unknown. The contents are stored on Yaz0 compressed SARC archives that have the following folders:

root
├── anim
├── blyt
└── timg

==== model ====
This folder has all of the games models. The contents are stored on Yaz0 compressed BCH files.

==== scene ====
This folder's contents are unknown (scene related?). The contents are stored on Yaz0 compressed BCH files.

==== shader ====
This folder stores the shaders of the game. The contents are stored on Yaz0 compressed BCH files.

==== sound ====
This folder has the sounds and music used ingame. It has the following files inside:

sound
├── center.bcsar
├── center.bkas
├── dspaudio.cdc
└── stream
├── <audio file name>.aac
└── <audio file name>.bcstm

== ExtData ==

Inside the extdata, we can find the following files:
* "addSaveData"
* "allbadge.sarc" A register of all badges retrieved from data_<gameVersion>.dat file?
* "boss.sarc" The data_<gameVersion>.dat file retrieved from SpotPass
* "savedata"

=== allbadge.sarc ===
This file uses the [[Nintendo Badge Arcade/PrizeCollection|PrizeCollection]] structure.

=== boss.sarc ===
All game data stored here has the following structure:
root
├── message
├── post
├── sharc
├── talkpic
├── xml
└── Schedule.xml

==== message ====
This folder stored all online-related game dialogues on each language supported by the region. It goes down the following directories:

message
└── boss_XXX
└── XXxx
└── boss
└── slotAXX
├── BossText.msbt
├── Emergency.msbf
├── HallAd.msbf
├── PaidTalk.msbf
├── PostComment.msbf
├── RetnHall.msbf
├── StartUp.msbf
├── ThemeShop.msbf
└── Training.msbf

Where X goes the region, and x belongs to the language.
Within slotAXX, A is a letter and XX are numbers.

==== post ====
This folder stored all Miiverse posts related to customizing the Home Menu with themes and badges. Each SARC file inside here has the following sructure:

root
├── Image.jpg
├── Mii.Etc1_a4
└── post.xml

The post.xml file contains the following data:
<?xml version="1.0" encoding="utf-8"?>
<DistributablePost xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<index>x</index>
<Id><Post ID></Id>
<Name>Mii name</Name>
<PathMii>Mii.Etc1_a4</PathMii>
<PathImage>Image.jpg</PathImage>
</DistributablePost>

The Mii.Etc1_a4 image has a 128x128 resolution.

==== sharc ====
This folder stores the [[Nintendo Badge Arcade/PrizeCollection|PrizeCollection]] file with the badges and machines available for the belonging week.

The file is named using the starting and ending dates that the collection is active for, in yy/mm/dd format separated with a dash. For example, a collection active between the dates December 15th, 2022 to December 22nd, 2022 is named `221215-221222.sarc`

==== talkpic ====
This folder contains some images inside SARC files. Each SARC file has the following content:

root
└── talkpic
└── <Name of SARC file>
└── The images...

==== xml ====
This folder has some XML data that controls some of the features inside this structure. It has the following structure:

xml
└── talkpic
└── TalkPic.xml

The TalkPic.xml file has the following data:

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<CenterTalkPicProperty>
<TalkPicSet>
<TalkPic Key='<Name of image>' Arc='<Name of SARC file>' Width='512' Height='256' Format='Etc1 or Etc1_a4 or Rgb565' Type='400x240 (Original image resolution?)' Path='path/to/image'/>
</TalkPicSet>
</CenterTalkPicProperty>

==== Schedule.xml ====
This file controls the availability of each of the features inside this structure within the specified dates. It has the following data:

<?xml version="1.0" encoding="utf-8"?>
<FileItems xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Items>
<FileItem>
<DateStartText>YYYYmmdd</DateStartText>
<DateExpireText>YYYYmmdd</DateExpireText>
<ColorText>#aaaaff</ColorText>
<Comment />
<RegexSetName>MessageDir</RegexSetName>
<Expression>boss/output/message/(?<Region>boss_(JPN|EUR|USA))/(?<Locale>[a-zA-Z]+)/boss/(?<Dir>.+)</Expression>
<KeyVariable>Boss/</KeyVariable>
<ValueVariable>boss/$(Dir)/</ValueVariable>
<OutputVariable>boss/archive_src/$(ArchiveName)/message/$(Region)/$(Locale)/boss/$(Dir)/</OutputVariable>
<PreviewVariable />
<CommandVariable>path/to/command_used.bat</CommandVariable>
<ArgumentsVariable />
<Key>Boss/</Key>
<Value>boss/slotAXX/</Value>
<Output>boss/archive_src/BossYYYYmmdd_YYYYmmdd/message/boss_XXX/XXxx/boss/slotAXX/</Output>
<Preview />
<SrcPath>boss/output/message/boss_EUR/EUde/boss/slotD07</SrcPath>
<Command>path/to/command_used.bat</Command>
<Arguments />
</FileItem>
</Items>
<ItemsCount><Number of items></ItemsCount>
<BasePath>%CTR_CENTER_ROOT%/</BasePath>
<XMLPath>boss/archive_src/$(ArchiveName)/Schedule.xml</XMLPath>
<ArchiveName>Boss$(DateFrom)_$(DateTo)</ArchiveName>
<DateFrom>YYYY-mm-ddT00:00:00</DateFrom>
<DateTo>YYYY-mm-ddT00:00:00</DateTo>
</FileItems>

Each FileItem's content varies depending on its RegexSetName. Below are the possible values:

{| class="wikitable"
|-
! RegexSetName
! Key
! Value
|-
| MessageDir
| Boss/
| boss/slotAXX/
|-
| TalkPicTex
| TalkPicTex/
| TalkPicTex/
|-
| TalkPicXml
| TalkPicXml/
| TalkPicXml/
|-
| PrizeCollection
| sharc/pc00.sarc
| sharc/YYmmdd_YYmmdd.sarc
|-
| Post
| post/PostXX.sarc
| post/<Post ID>.sarc
|-
| BonusStage
| BonusStageName
| <Stage Name>
|-
| DefaultStage
| DefaultStageNameXXX
| <Stage Name>
|}

The ''BonusStage'' and ''DefaultStage'' data define the sets (crane instances) available for each day of that week, although the difference between these is currently unknown.

Nintendo Badge Arcade/MSBT

2023-01-21T22:09:48Z

Light: Added page

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>.


== 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.


== 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.


== 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.


== 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, and game names in the Miiverse Gallery.
| Rarely used, but mainly for the Miiverse Gallery.
| Usually used for character names, and themes in the Miiverse Gallery.
|}


== 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
|}


== Examples ==

Below are raw hex blocks of example messages, and what they appear as.


=== 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>

-----


=== 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>

File:Nba-example-scale.png

2023-01-21T21:59:44Z

Light: Scale tag example

== Summary ==
Scale tag example

File:Nba-example-color.png

2023-01-21T21:59:25Z

Light: Color tag example

== Summary ==
Color tag example