Wexos: Imported from avsys wiki

2024-05-01T17:18:55Z

Imported from avsys wiki

New page

'''BRLAN''' files ('''B'''inary '''R'''evolution '''L'''ayout '''A'''nimatio'''N''') are used to produce layout animations. Along with [[BRCTR (File Format)|BRCTR]] and [[BRLYT (File Format)|BRLYT]] files, it's part of the [[Filesystem/Scene/UI|UI]] from [[Mario Kart Wii]]. BRLAN files are always into the '''anim''' folders.

== Header ==
The file starts with a header that is 0x10 bytes long:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Char[4] || '''File magic'''. Always ''RLAN'' in ASCII.
|-
| 0x04 || UInt16 || {{BOM}}
|-
| 0x06 || UInt16 || '''Version number''' of the file format.
|-
| 0x08 || UInt32 || Length of the file in bytes.
|-
| 0x0C || UInt16 || Length of this header in bytes.
|-
| 0x0E || UInt16 || Number of sections.
|-
| 0x10 || colspan=2 {{Unknown|End of file header}}
|}

== pat1 ==
After the header comes the '''pat1''' section. The section is pretty unknown.

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Char[4] || '''Section magic'''. Always ''pat1'' in ASCII.
|-
| 0x04 || UInt32 || '''S''' = Size of this section.
|-
| 0x08 || UInt16 || {{Unknown-left|'''Unknown'''.}}
|-
| 0x0A || Int16 || Negated number of frames.
|-
| 0x0C || UInt32 || '''O1''' = Offset to '''string 1''' relative to the start of this section.
|-
| 0x10 || UInt32 || '''O2''' = Offset to '''string 2''' relative to the start of this section. Sometimes no string is stored and then this values refers to the end of the section.
|-
| 0x14 || Int16 || Negated number of total frames.
|-
| 0x16 || UInt16 || {{Unknown-left|'''Unknown'''.}}
|-
| 0x18 || Byte || ''isDescendingBind''.
|-
| 0x19 || Byte || {{Unknown-left|'''Unknown'''.}}
|-
| 0x1A || UInt16 || {{Unknown-left|'''Unknown'''.}}
|-
| '''O1''' || StringNT || Unknown-left|'''String 1'''. This is the name of this animation used by [[BRCTR]].
|-
| '''O2''' || StringNT || {{Unknown-left|'''String 2'''. Unknown usage. Often nothing.}}
|-
| '''S''' || colspan=2 {{Unknown|End of section}}
|}
There may be padding (00) stored after the pat1 section to align next section.

== pai1 ==
After the pat1 section comes the '''pai1''' section:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Char[4] || '''Section magic'''. Always ''pai1'' in ASCII.
|-
| 0x04 || UInt32 || '''Size of this section''' including all the animation entries.
|-
| 0x08 || UInt16 || Number of frames.
|-
| 0x0A || Byte || {{Unknown-left|Flags.}}
|-
| 0x0B || Byte || {{Unknown-left|'''Unknown'''.}}
|-
| 0x0C || UInt16 || '''T''' = Number of '''[[TPL]] filenames'''.
|-
| 0x0E || UInt16 || '''N''' = Number of '''[[#Animation|animations]]'''.
|-
| 0x10 || UInt32 || '''O''' = Offset to the '''offset array''' which points to the animations. Relative to the start of this section.
|-
| 0x14 || UInt32['''T'''] || Offsets to '''null-terminated strings''' which store the [[TPL]] filenames. Relative to the start of this array.
|-
| '''O''' || UInt32['''N'''] || Offsets to '''[[#Animation|animation sections]]'''. Relative to the start of this section.
|}

== Animation ==
An animation starts with the following structure:

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || '''Name''' of this animation. The length is always 0x14. Unused bytes are set to 00.
|-
| 0x14 || Byte || '''N''' = Number of '''[[#Animation Tag|animation tags]]''' in this animation.
|-
| 0x15 || Byte || Defines what the '''animation is animating'''. 0 = pane, 1 = material.
|-
| 0x16 || UInt16 || {{Unknown-left|'''Unknown'''.}}
|-
| 0x18 || UInt32['''N'''] || Offsets to the '''[[#Animation Tag|animation tags]]'''. Relative to the start of this section.
|}

=== Animation Tag ===
The animation tag section sets the type of the animation.

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || String || [[#Animation Types|Animation '''type''']].
|-
| 0x04 || Byte || '''N''' = Number of '''[[#Animation Entry|animation entries]]'''.
|-
| 0x05 || Byte[3] || {{Unknown-left|Padding?}}
|-
| 0x08 || UInt32['''N'''] || Offsets to the '''[[#Animation Entry|animation entries]]'''. Relative to the start of this section.
|}

=== Animation Types ===
These are the 6 different animation types found in BRLAN files:

{| class="wikitable sortable"
! Name !! Description
|-
| align=center | RLPA || '''R'''evolution '''L'''ayout '''PA'''ne SRT (Scale/Rotate/Translate) animation.
|-
| align=center | RLTS || '''R'''evolution '''L'''ayout '''T'''exture '''S'''RT animation.
|-
| align=center | RLVI || '''R'''evolution '''L'''ayout '''VI'''sibility animation.
|-
| align=center | RLVC || '''R'''evolution '''L'''ayout '''V'''ertex '''C'''olor animation.
|-
| align=center | RLMC || '''R'''evolution '''L'''ayout '''M'''aterial '''C'''olor animation.
|-
| align=center | RLTP || '''R'''evolution '''L'''ayout '''T'''exture '''P'''attern animation.
|}

=== Animation Entry ===
An animation entry stores the key frames and some settings for the animation.

{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Byte || {{Unknown-left|Index.}}
|-
| 0x01 || Byte || '''Target'''. Sets the target of the animation. Different for different types. See [[BRLAN (File Format)/Targets|this page]] for more info.
|-
| 0x02 || Byte || '''Key frame type'''. Only types 1 and 2 are known.
|-
| 0x03 || Byte || {{Unknown-left|'''Unknown'''.}}
|-
| 0x04 || UInt16 || Number of '''[[#Key Frame|key frames]]'''.
|-
| 0x06 || UInt16 || {{Unknown-left|'''Unknown'''.}}
|-
| 0x08 || UInt32 || Offset to the first '''[[#Key Frame|key frames]]''', relative to the start of this section. Always 0x0C.
|}

==== Key Frame ====
The key frames contains the actual animations. The type of the key frame is set by the [[#Animation Entry|animation entry]]. Currently only two types have been seen, 1 and 2.

; Type 1
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Float || '''Frame index'''. Can be negative.
|-
| 0x04 || UInt16 || Value.
|-
| 0x06 || UInt16 || Padding.
|}

; Type 2
{| class="wikitable"
|-
! Offset !! Type !! Description
|-
| 0x00 || Float || '''Frame index'''. Can be negative.
|-
| 0x04 || Float || Value.
|-
| 0x08 || Float || Blend.
|}

== Tools ==
The following tools can handle BRLAN files:
* [http://wiibrew.org/wiki/Benzin Benzin], by [http://wiibrew.org/wiki/User:SquidMan SquidMan], [http://wiibrew.org/wiki/User:Comex comex], [http://wiibrew.org/wiki/User:Megazig megazig] and [http://wiibrew.org/wiki/User:Yossi Yossi] (converts BRLAN to XML and viceversa)
* [[Wexos's Toolbox]], by [[Wexos]]
* [[Wii Layout Editor]], by [[Gericom]] (only plays animation, not editable)

[[Category:Wii File Formats]]

BRLAN (File Format) - Revision history

Wexos: Imported from avsys wiki