3dbrew - User contributions [en]

Nintendo Badge Arcade/MSBT

2023-01-25T03:02:01Z

Jonbarrow: Updated page to have the correct info

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 Animation || Animation ID. See below for details
|}


==== Badge Bunny Animations ====

The following is an incomplete list of the animation datas, with names describing each, and a preview of the animation. 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/Format Tags

2023-01-25T02:05:03Z

Jonbarrow: Jonbarrow moved page Nintendo Badge Arcade/Format Tags to Nintendo Badge Arcade/MSBT: Rename page to be more accurate

#REDIRECT [[Nintendo Badge Arcade/MSBT]]

Nintendo Badge Arcade/MSBT

2023-01-25T02:05:03Z

Jonbarrow: Jonbarrow moved page Nintendo Badge Arcade/Format Tags to Nintendo Badge Arcade/MSBT: Rename page to be more accurate

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/PrizeCollection

2022-12-18T15:51:03Z

Jonbarrow: /* Language Names */ Clarified information on the language names

== Overview ==

A '''PrizeCollection''' SARC file has the following folder structure:

root
└── pc
├── PrizeCollection.xml
├── ci
└── rt
├── At
├── CI
├── Ca
├── Cr
├── FO
└── Pr

Each of the subfolders contains a custom file format storing different properties between those. Each of those files are compressed using Yaz0 compression.

{| class="wikitable"
|-
! Subfolder
! File type
|-
| ci
| Crane Instance (cib)
|-
| At
| Attachment (atb)
|-
| CI
| Crane Icon (icb)
|-
| Ca
| Category (cab)
|-
| Cr
| Crane (crb)
|-
| FO
| Fixed Object (fob)
|-
| Pr
| Prize (prb)
|}

== PrizeCollection.xml ==
This file has an index of all of the game data stored here. It has the following data:

<?xml version="1.0" encoding="UTF-8"?>
<CenterPrizeCollectionFile>
<Categories count="x">
<Category name="CategoryName" />
</Categories>
<Cranes count="x">
<Crane name="CraneName" />
</Cranes>
<CraneIcons count="x">
<CraneIcon name="CraneIconName" />
</CraneIcons>
<Prizes count="x">
<Prize name="PrizeName" />
<Attachments count="x">
<Attachment name="AttachmentName" />
</Attachments>
<FixedObjects count="x">
<FixedObject name="FixedObjectName" />
</FixedObjects>
<CraneInstances>
<CraneInstance name="CraneInstanceName" />
</CraneInstances>
</CenterPrizeCollectionFile>

== Crane Instance (cib) ==
A crane instance file stores the data of a set and the components of the machine.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CIBS)
|-
| 0x30
| 0x30
| Crane Instance name
|-
| 0x60
| 0x30
| Crane name
|-
| 0x90
| 0x30
| Crane Icon name
|-
| 0x100
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x1100 + Offset
| 0x30
| Prize name x
|-
| 0x1880 + Offset
| 0x30
| Fixed Object name x
|}

Offset = 0x30 * x

== Attachment (atb) ==
An attachment file stores the data of an immovable object and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ATBS)
|-
| 0x2C
| 0x30
| Attachment name
|-
| 0x5C
| 0x4
| Image width
|-
| 0x60
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of attachment
|-
| 0x80 + (w * h)
| w * h
| A8 data of previous image
|}

== Crane Icon (icb) ==
A crane icon file stores the icon of a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ICBS)
|-
| 0x1C
| 0x30
| Crane icon name
|-
| 0x100
| 0x2000
| 64x64 RGB565 image
|}

== Category (cab) ==
A category file stores the data of a group of sets and its category image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CABS)
|-
| 0x24
| 0x4
| Category ID
|-
| 0x2C
| 0x30
| Category name
|-
| 0x5C
| 0x4
| Number of badges
|-
| 0x60
| 0x4
| Number of sets (crane instances)
|-
| 0x68
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x2080
| 0x2000
| 64x64 RGB565 image of category
|}

== Crane (crb) ==
A crane file stores the background image used on a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CRBS)
|-
| 0x1C
| 0x30
| Crane name
|-
| 0x800
| 0x10000
| ETC1 image? (Unknown resolution)
|}

== Fixed Object (fob) ==
A fixed object file stores the data of the terrain and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (FOBS)
|-
| 0x24
| 0x30
| Fixed object name
|-
| 0x54
| 0x4
| Image width
|-
| 0x58
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of fixed object
|}

== Prize (prb) ==
A prize file stores the badge data and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (PRBS)
|-
| 0x4
| 0x38
| Unknown
|-
| 0x3C
| 0x4
| Badge ID
|-
| 0x40
| 0x4
| Unknown
|-
| 0x44
| 0x30
| Badge file name
|-
| 0x74
| 0x30
| Badge category
|-
| 0xA4
| 0x8
| Title ID it opens (0xFFFFFFFF if none)
|-
| 0xAC
| 0xC
| Unknown
|-
| 0xB8
| 0x4
| Number of horizontal tiles
|-
| 0xBC
| 0x4
| Number of vertical tiles
|-
| 0xE0
| 0x1000
| [[#Language Names|Badge display names]]
|-
| 0x10E0
| 0x20
| Unknown (usually zero?)
|-
| 0x1100
|
| Image data
|}

Following the badges metadata is it's image data. Each badge contains multiple images used in different places during gameplay

An image can be either RGB565 or ETC1A4. RGB565 images are immediately followed with A4 data for itself, whereas ETC1A4 images are immediately followed with A8 data for itself

A badge may take up multiple spaces on the Home Menu, and as such contains images for each space called "tiles". The number of image tiles a badge uses is found in the badge metadata at offsets 0xB8 and 0xBC

All badge image data begins with a 64x64 RGB565 image of the full badge. Following the 64x64 image is a 32x32 RGB565 image of the full badge, which is used in the badge selector in Home Menu

If the badge is 1x1 tiles, then the first 64x64 RGB565 image is used in Home Menu to display the badge. If the badge is ''not'' 1x1, then the badge contains x*y number of additional 64x64 and 32x32 RGB565 images, where x is the number of horizontal tiles and y is the number of vertical tiles. These tiles are then used in Home Menu to display the badge. These additional images are stored immediately after the 32x32 image

Finally, the last image in the badge image data is a single 128x128 ETC1A4 image of the full badge which is used in game

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x1100
| 0x2000
| 64x64 RGB565 image of full badge (used in Home Menu if badge is 1x1)
|-
| 0x3100
| 0x800
| A4 data
|-
| 0x3900
| 0x800
| 32x32 RGB565 image of full badge (used in badge selector in Home Menu)
|-
| 0x4100
| 0x200
| A4 data
|-
|
| 0x2000
| 64x64 Optional additional RGB565 image tile(s). Only exists if badge is not 1x1 (used in Home Menu if badge is not 1x1)
|-
|
| 0x800
| A4 data
|-
|
| 0x800
| 32x32 Optional additional RGB565 image tile(s). Only exists if badge is not 1x1 (unknown use)
|-
|
| 0x200
| A4 data
|-
|
| 0x4000
| 128x128 ETC1A4 image (used in game)
|-
|
| 0x4000
| A8 data
|}

== Language Names ==
Some files, like the badge and the category file, store its display name in a set of 16 different languages.

Each language is stored as a little-endian utf16 string, in an allocated 0x100 byte section stacked on top of each other.

A string does not need to fill the entire 0x100 byte section, the remaining data is set to null bytes

The languages are ordered as follows:

# Japanese
# English
# French
# German
# Italian
# Spanish
# Chinese (simple)
# Korean
# Dutch
# Portuguese
# Russian
# Chinese (traditional)
# Unknown
# Unknown
# Unknown
# Unknown

Nintendo Badge Arcade/PrizeCollection

2022-12-18T15:43:34Z

Jonbarrow: /* Prize (prb) */ Added clarification on badge image data

== Overview ==

A '''PrizeCollection''' SARC file has the following folder structure:

root
└── pc
├── PrizeCollection.xml
├── ci
└── rt
├── At
├── CI
├── Ca
├── Cr
├── FO
└── Pr

Each of the subfolders contains a custom file format storing different properties between those. Each of those files are compressed using Yaz0 compression.

{| class="wikitable"
|-
! Subfolder
! File type
|-
| ci
| Crane Instance (cib)
|-
| At
| Attachment (atb)
|-
| CI
| Crane Icon (icb)
|-
| Ca
| Category (cab)
|-
| Cr
| Crane (crb)
|-
| FO
| Fixed Object (fob)
|-
| Pr
| Prize (prb)
|}

== PrizeCollection.xml ==
This file has an index of all of the game data stored here. It has the following data:

<?xml version="1.0" encoding="UTF-8"?>
<CenterPrizeCollectionFile>
<Categories count="x">
<Category name="CategoryName" />
</Categories>
<Cranes count="x">
<Crane name="CraneName" />
</Cranes>
<CraneIcons count="x">
<CraneIcon name="CraneIconName" />
</CraneIcons>
<Prizes count="x">
<Prize name="PrizeName" />
<Attachments count="x">
<Attachment name="AttachmentName" />
</Attachments>
<FixedObjects count="x">
<FixedObject name="FixedObjectName" />
</FixedObjects>
<CraneInstances>
<CraneInstance name="CraneInstanceName" />
</CraneInstances>
</CenterPrizeCollectionFile>

== Crane Instance (cib) ==
A crane instance file stores the data of a set and the components of the machine.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CIBS)
|-
| 0x30
| 0x30
| Crane Instance name
|-
| 0x60
| 0x30
| Crane name
|-
| 0x90
| 0x30
| Crane Icon name
|-
| 0x100
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x1100 + Offset
| 0x30
| Prize name x
|-
| 0x1880 + Offset
| 0x30
| Fixed Object name x
|}

Offset = 0x30 * x

== Attachment (atb) ==
An attachment file stores the data of an immovable object and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ATBS)
|-
| 0x2C
| 0x30
| Attachment name
|-
| 0x5C
| 0x4
| Image width
|-
| 0x60
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of attachment
|-
| 0x80 + (w * h)
| w * h
| A8 data of previous image
|}

== Crane Icon (icb) ==
A crane icon file stores the icon of a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ICBS)
|-
| 0x1C
| 0x30
| Crane icon name
|-
| 0x100
| 0x2000
| 64x64 RGB565 image
|}

== Category (cab) ==
A category file stores the data of a group of sets and its category image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CABS)
|-
| 0x24
| 0x4
| Category ID
|-
| 0x2C
| 0x30
| Category name
|-
| 0x5C
| 0x4
| Number of badges
|-
| 0x60
| 0x4
| Number of sets (crane instances)
|-
| 0x68
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x2080
| 0x2000
| 64x64 RGB565 image of category
|}

== Crane (crb) ==
A crane file stores the background image used on a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CRBS)
|-
| 0x1C
| 0x30
| Crane name
|-
| 0x800
| 0x10000
| ETC1 image? (Unknown resolution)
|}

== Fixed Object (fob) ==
A fixed object file stores the data of the terrain and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (FOBS)
|-
| 0x24
| 0x30
| Fixed object name
|-
| 0x54
| 0x4
| Image width
|-
| 0x58
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of fixed object
|}

== Prize (prb) ==
A prize file stores the badge data and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (PRBS)
|-
| 0x4
| 0x38
| Unknown
|-
| 0x3C
| 0x4
| Badge ID
|-
| 0x40
| 0x4
| Unknown
|-
| 0x44
| 0x30
| Badge file name
|-
| 0x74
| 0x30
| Badge category
|-
| 0xA4
| 0x8
| Title ID it opens (0xFFFFFFFF if none)
|-
| 0xAC
| 0xC
| Unknown
|-
| 0xB8
| 0x4
| Number of horizontal tiles
|-
| 0xBC
| 0x4
| Number of vertical tiles
|-
| 0xE0
| 0x1000
| [[#Language Names|Badge display names]]
|-
| 0x10E0
| 0x20
| Unknown (usually zero?)
|-
| 0x1100
|
| Image data
|}

Following the badges metadata is it's image data. Each badge contains multiple images used in different places during gameplay

An image can be either RGB565 or ETC1A4. RGB565 images are immediately followed with A4 data for itself, whereas ETC1A4 images are immediately followed with A8 data for itself

A badge may take up multiple spaces on the Home Menu, and as such contains images for each space called "tiles". The number of image tiles a badge uses is found in the badge metadata at offsets 0xB8 and 0xBC

All badge image data begins with a 64x64 RGB565 image of the full badge. Following the 64x64 image is a 32x32 RGB565 image of the full badge, which is used in the badge selector in Home Menu

If the badge is 1x1 tiles, then the first 64x64 RGB565 image is used in Home Menu to display the badge. If the badge is ''not'' 1x1, then the badge contains x*y number of additional 64x64 and 32x32 RGB565 images, where x is the number of horizontal tiles and y is the number of vertical tiles. These tiles are then used in Home Menu to display the badge. These additional images are stored immediately after the 32x32 image

Finally, the last image in the badge image data is a single 128x128 ETC1A4 image of the full badge which is used in game

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x1100
| 0x2000
| 64x64 RGB565 image of full badge (used in Home Menu if badge is 1x1)
|-
| 0x3100
| 0x800
| A4 data
|-
| 0x3900
| 0x800
| 32x32 RGB565 image of full badge (used in badge selector in Home Menu)
|-
| 0x4100
| 0x200
| A4 data
|-
|
| 0x2000
| 64x64 Optional additional RGB565 image tile(s). Only exists if badge is not 1x1 (used in Home Menu if badge is not 1x1)
|-
|
| 0x800
| A4 data
|-
|
| 0x800
| 32x32 Optional additional RGB565 image tile(s). Only exists if badge is not 1x1 (unknown use)
|-
|
| 0x200
| A4 data
|-
|
| 0x4000
| 128x128 ETC1A4 image (used in game)
|-
|
| 0x4000
| A8 data
|}

== Language Names ==
Some files, like the badge and the category, store its name displayed on different languages. Here is the language list:

{| class="wikitable"
|-
! Offset
! Size
! Language
|-
| 0x0
| 0x100
| Japanese
|-
| 0x100
| 0x100
| English
|-
| 0x200
| 0x100
| French
|-
| 0x300
| 0x100
| German
|-
| 0x400
| 0x100
| Italian
|-
| 0x500
| 0x100
| Spanish
|-
| 0x600
| 0x100
| Unknown
|-
| 0x700
| 0x100
| Unknown
|-
| 0x800
| 0x100
| Netherlands
|-
| 0x900
| 0x100
| Portuguese
|-
| 0xA00
| 0x100
| Russian
|-
| 0xB00
| 0x100
| Unknown
|-
| 0xC00
| 0x100
| Unknown
|-
| 0xD00
| 0x100
| Unknown
|-
| 0xE00
| 0x100
| Unknown
|-
| 0xF00
| 0x100
| Unknown
|}

Nintendo Badge Arcade/PrizeCollection

2022-12-18T15:14:47Z

Jonbarrow: /* Prize (prb) */ Adding missing data to PRBS file structure

== Overview ==

A '''PrizeCollection''' SARC file has the following folder structure:

root
└── pc
├── PrizeCollection.xml
├── ci
└── rt
├── At
├── CI
├── Ca
├── Cr
├── FO
└── Pr

Each of the subfolders contains a custom file format storing different properties between those. Each of those files are compressed using Yaz0 compression.

{| class="wikitable"
|-
! Subfolder
! File type
|-
| ci
| Crane Instance (cib)
|-
| At
| Attachment (atb)
|-
| CI
| Crane Icon (icb)
|-
| Ca
| Category (cab)
|-
| Cr
| Crane (crb)
|-
| FO
| Fixed Object (fob)
|-
| Pr
| Prize (prb)
|}

== PrizeCollection.xml ==
This file has an index of all of the game data stored here. It has the following data:

<?xml version="1.0" encoding="UTF-8"?>
<CenterPrizeCollectionFile>
<Categories count="x">
<Category name="CategoryName" />
</Categories>
<Cranes count="x">
<Crane name="CraneName" />
</Cranes>
<CraneIcons count="x">
<CraneIcon name="CraneIconName" />
</CraneIcons>
<Prizes count="x">
<Prize name="PrizeName" />
<Attachments count="x">
<Attachment name="AttachmentName" />
</Attachments>
<FixedObjects count="x">
<FixedObject name="FixedObjectName" />
</FixedObjects>
<CraneInstances>
<CraneInstance name="CraneInstanceName" />
</CraneInstances>
</CenterPrizeCollectionFile>

== Crane Instance (cib) ==
A crane instance file stores the data of a set and the components of the machine.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CIBS)
|-
| 0x30
| 0x30
| Crane Instance name
|-
| 0x60
| 0x30
| Crane name
|-
| 0x90
| 0x30
| Crane Icon name
|-
| 0x100
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x1100 + Offset
| 0x30
| Prize name x
|-
| 0x1880 + Offset
| 0x30
| Fixed Object name x
|}

Offset = 0x30 * x

== Attachment (atb) ==
An attachment file stores the data of an immovable object and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ATBS)
|-
| 0x2C
| 0x30
| Attachment name
|-
| 0x5C
| 0x4
| Image width
|-
| 0x60
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of attachment
|-
| 0x80 + (w * h)
| w * h
| A8 data of previous image
|}

== Crane Icon (icb) ==
A crane icon file stores the icon of a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (ICBS)
|-
| 0x1C
| 0x30
| Crane icon name
|-
| 0x100
| 0x2000
| 64x64 RGB565 image
|}

== Category (cab) ==
A category file stores the data of a group of sets and its category image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CABS)
|-
| 0x24
| 0x4
| Category ID
|-
| 0x2C
| 0x30
| Category name
|-
| 0x5C
| 0x4
| Number of badges
|-
| 0x60
| 0x4
| Number of sets (crane instances)
|-
| 0x68
| 0x1000
| [[#Language Names|Language Names]]
|-
| 0x2080
| 0x2000
| 64x64 RGB565 image of category
|}

== Crane (crb) ==
A crane file stores the background image used on a set (crane instance).

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (CRBS)
|-
| 0x1C
| 0x30
| Crane name
|-
| 0x800
| 0x10000
| ETC1 image? (Unknown resolution)
|}

== Fixed Object (fob) ==
A fixed object file stores the data of the terrain and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (FOBS)
|-
| 0x24
| 0x30
| Fixed object name
|-
| 0x54
| 0x4
| Image width
|-
| 0x58
| 0x4
| Image height
|-
| 0x80
| w * h
| ETC1A4 image of fixed object
|}

== Prize (prb) ==
A prize file stores the badge data and its image.

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Header magic (PRBS)
|-
| 0x4
| 0x38
| Unknown
|-
| 0x3C
| 0x4
| Badge ID
|-
| 0x40
| 0x4
| Unknown
|-
| 0x44
| 0x30
| Badge file name
|-
| 0x74
| 0x30
| Badge category
|-
| 0xA4
| 0x8
| Title ID it opens (0xFFFFFFFF if none)
|-
| 0xAC
| 0xC
| Unknown
|-
| 0xB8
| 0x4
| Number of horizontal tiles
|-
| 0xBC
| 0x4
| Number of vertical tiles
|-
| 0xE0
| 0x1000
| [[#Language Names|Badge display names]]
|-
| 0x10E0
| 0x20
| Unknown (usually zero?)
|-
| 0x1100
|
| Image data
|}

If the tile size is 1x1:

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x1100
| 0x2000
| 64x64 RGB565 image (used in Home Menu)
|-
| 0x3100
| 0x800
| 64x64 A4 data of previous image
|-
| 0x3900
| 0x800
| 32x32 RGB565 image (used in badge selector in Home Menu)
|-
| 0x4100
| 0x200
| 32x32 A4 data of previous image
|-
| 0x4300
| 0x4000
| 128x128 ETC1A4 image (used ingame)
|-
| 0x8300
| 0x4000
| 128x128 A8 data of previous image
|}

If the tile size is anything other than 1x1:

{| class="wikitable"
|-
! Offset
! Size
! Description
|-
| 0x1100
| 0x2000
| 64x64 RGB565 image of full tile
|-
| 0x3100
| 0x800
| 64x64 A4 data of previous image
|-
| 0x3900
| 0x800
| 32x32 RGB565 image of full tile
|-
| 0x4100
| 0x200
| 32x32 A4 data of previous image
|-
| ...
| 0x2000
| 64x64 RGB565 image of tile x
|-
| ...
| 0x800
| 64x64 A4 data of previous image
|-
| ...
| 0x800
| 32x32 RGB565 image of tile x
|-
| ...
| 0x200
| 32x32 A4 data of previous image
|-
| ...
| 0x4000
| 128x128 ETC1A4 image of full tile
|-
| ...
| 0x4000
| 128x128 A8 data of previous image
|}

== Language Names ==
Some files, like the badge and the category, store its name displayed on different languages. Here is the language list:

{| class="wikitable"
|-
! Offset
! Size
! Language
|-
| 0x0
| 0x100
| Japanese
|-
| 0x100
| 0x100
| English
|-
| 0x200
| 0x100
| French
|-
| 0x300
| 0x100
| German
|-
| 0x400
| 0x100
| Italian
|-
| 0x500
| 0x100
| Spanish
|-
| 0x600
| 0x100
| Unknown
|-
| 0x700
| 0x100
| Unknown
|-
| 0x800
| 0x100
| Netherlands
|-
| 0x900
| 0x100
| Portuguese
|-
| 0xA00
| 0x100
| Russian
|-
| 0xB00
| 0x100
| Unknown
|-
| 0xC00
| 0x100
| Unknown
|-
| 0xD00
| 0x100
| Unknown
|-
| 0xE00
| 0x100
| Unknown
|-
| 0xF00
| 0x100
| Unknown
|}

Nintendo Badge Arcade

2022-12-18T14:48:06Z

Jonbarrow: /* sharc */ Clarified the naming format for the PrizeCollection SARC file to make it more understandable

'''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
| ?
|-
| 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)

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