Retro Modding Wiki - User contributions [en]

DCLN (Metroid Prime)

2018-08-17T01:24:45Z

Antidote: /* Collision Mesh */

''This article is for the DCLN format from the Metroid Prime series and Donkey Kong Country Returns. See [[DCLN (File Format)]] for other revisions of this format.''

The '''DCLN format''' stores one or more collision meshes, each partitioned via an OBB tree. These are used as dynamic collision data for actors and platforms. Most of the format is shared with the [[Area Collision (File Format)|MREA format]], but there are some sections that are unique to DCLN.

__TOC__

== Format ==

The file can store multiple collision meshes; each one has its own chunk in the file.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Collision Mesh Count'''
| Number of collision meshes in the file.
|-
| [[#Collision Mesh|Collision Mesh]]
| ''Collision Mesh Count''
| '''Collision Mesh Array'''
| Array of collision meshes.
|-
| colspan=4 {{unknown|End of File}}
|}

=== Collision Mesh ===

{| class="wikitable"
! Offset
! Type
! Count
! Name
! Notes
! MP1/2/3
! DKCR
|-
| 0x0
| u32
| 1
| '''Magic'''
| Always <code>0xDEAFBABE</code>
| {{check}}
| {{check}}
|-
| 0x4
| u32
| 1
| '''Version'''
| Possible values:
* 0x2: Metroid Prime
* 0x4: Metroid Prime 2/3
* 0x5: Donkey Kong Country Returns
| {{check}}
| {{check}}
|-
| 0x8
| {{AABox}}
| 1
| '''Mesh Bounding Box'''
| Bounding box of the collision mesh.
| {{nocheck}}
| {{check}}
|-
| {{none}}
| u32
| 1
| '''Internal Memory Allocation Size'''
| Used to build CNode/CLeafData from the stored representation. Each node/leaf's size is aligned to the nearest 4-byte boundary.
| {{check}}
| {{check}}
|-
| {{none}}
| [[Collision Index Data (File Format)|Collision Index Data]]
| 1
| '''Collision Index Data'''
| Index data for the collision mesh. This data section is what actually defines the collision mesh itself. This part of the format is shared with [[Area Collision (File Format)|MREA]].
| {{check}}
| {{check}}
|-
| {{none}}
| [[#OBB Tree|OBB Tree]]
| 1
| '''Collision OBB Tree'''
| OBB tree for the collision mesh. This is used to quickly locate triangles that an actor could potentially be colliding with.
| {{check}}
| {{check}}
|-
| colspan=7 {{unknown|End of Collision Mesh}}
|}

==== OBB Tree ====

{{todo|OBB tree format documentation}}

[[Category:File Formats]]
[[Category:Metroid Prime Demo]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2 Demo]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3 Prototype]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

DCLN (Metroid Prime)

2018-08-17T01:22:52Z

Antidote: /* Collision Mesh */

''This article is for the DCLN format from the Metroid Prime series and Donkey Kong Country Returns. See [[DCLN (File Format)]] for other revisions of this format.''

The '''DCLN format''' stores one or more collision meshes, each partitioned via an OBB tree. These are used as dynamic collision data for actors and platforms. Most of the format is shared with the [[Area Collision (File Format)|MREA format]], but there are some sections that are unique to DCLN.

__TOC__

== Format ==

The file can store multiple collision meshes; each one has its own chunk in the file.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Collision Mesh Count'''
| Number of collision meshes in the file.
|-
| [[#Collision Mesh|Collision Mesh]]
| ''Collision Mesh Count''
| '''Collision Mesh Array'''
| Array of collision meshes.
|-
| colspan=4 {{unknown|End of File}}
|}

=== Collision Mesh ===

{| class="wikitable"
! Offset
! Type
! Count
! Name
! Notes
! MP1/2/3
! DKCR
|-
| 0x0
| u32
| 1
| '''Magic'''
| Always <code>0xDEAFBABE</code>
| {{check}}
| {{check}}
|-
| 0x4
| u32
| 1
| '''Version'''
| Possible values:
* 0x2: Metroid Prime
* 0x4: Metroid Prime 2/3
* 0x5: Donkey Kong Country Returns
| {{check}}
| {{check}}
|-
| 0x8
| {{AABox}}
| 1
| '''Mesh Bounding Box'''
| Bounding box of the collision mesh.
| {{nocheck}}
| {{check}}
|-
| {{none}}
| u32
| 1
| '''Memory Allocation Size'''
| Internal memory allocation size, used to build CNode/CLeafData from the stored representation. Each node/leaf is aligned to the nearest 4-byte boundary.
| {{check}}
| {{check}}
|-
| {{none}}
| [[Collision Index Data (File Format)|Collision Index Data]]
| 1
| '''Collision Index Data'''
| Index data for the collision mesh. This data section is what actually defines the collision mesh itself. This part of the format is shared with [[Area Collision (File Format)|MREA]].
| {{check}}
| {{check}}
|-
| {{none}}
| [[#OBB Tree|OBB Tree]]
| 1
| '''Collision OBB Tree'''
| OBB tree for the collision mesh. This is used to quickly locate triangles that an actor could potentially be colliding with.
| {{check}}
| {{check}}
|-
| colspan=7 {{unknown|End of Collision Mesh}}
|}

==== OBB Tree ====

{{todo|OBB tree format documentation}}

[[Category:File Formats]]
[[Category:Metroid Prime Demo]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2 Demo]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3 Prototype]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

AGSC (File Format)

2018-07-18T02:33:37Z

Antidote: /* SoundMacros */

'''AGSC''' is the sound effect format for Metroid Prime and Metroid Prime 2: Echoes. Each AGSC file contains a group of sound effects. The first two Metroid Prime games utilize the MusyX audio engine created by Factor5 and as a result, AGSC files are essentially just embedded MusyX files.

The audio codec used in AGSC is the standard GameCube DSP-ADPCM codec, but MusyX itself also offers uncompressed PCM as an option.

{{todo|Better descriptions for how SoundMacros work and a description for what each command does.}}
{{research|minor|The proj and sdir chunks have a couple unknowns left.}}

__TOC__

== Format ==

The AGSC format is essentially four data chunks combined into one resource, each of which is a standard MusyX file. Of the four data chunks (pool, proj, samp, and sdir), there's one for sound engine scripts, one for sound properties, one for actual ADPCM sound data, and one for sound metadata. The main difference between Prime 1 and 2 is the header, and some slight changes in the way the four chunks are organized. In Metroid Prime, each chunk begins with its own size value; in Metroid Prime 2, every chunk instead has its size listed at the beginning of the file, at the end of the header. In addition, in Metroid Prime, the third chunk is samp, and the fourth is sdir; in Metroid Prime 2, it's the other way around.

=== Header ===

==== Metroid Prime ====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| '''D'''
| '''Audio Directory'''. Always "Audio/". Zero-terminated.
|-
| 0x0 + D
| '''N'''
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x0 + D + N
|colspan=2 {{unknown|End of header}}
|}

==== Metroid Prime 2 ====

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| {{unknown|'''Unknown'''; always 1}}
|-
| 0x4
| D
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x4 + D
| 2
| '''Group ID'''; 0xFFFF if unspecified
|-
| 0x6 + D
| 4
| '''Pool size'''
|-
| 0xA + D
| 4
| '''Project size'''
|-
| 0xE + D
| 4
| '''Sample directory size'''
|-
| 0x12 + D
| 4
| '''Sample size'''
|-
| 0x16 + D
| colspan=2 {{unknown|End of header}}
|}

=== Pool ===

The Pool chunk contains sub-chunk tables for SoundMacros, ADSR, keymaps, and layers, if applicable. It starts with a 16-byte header before the different data tables begin.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''SoundMacros Offset''' (always 0x10)
|-
| 0x4
| 4
| '''Tables Offset'''
|-
| 0x8
| 4
| '''Keymaps Offset'''
|-
| 0xC
| 4
| '''Layers Offset'''
|-
| 0x10
| colspan=2 {{unknown|End of entry}}
|}

==== ObjectID ====

After this are four tables of objects. Each object is identified with a 16-bit '''ObjectID''':

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Sound object type''' <ol start="0"><li>SoundMacro</li><li>Table</li><li value=4>Keymap</li><li value=8>Layer</li></ol>
|-
| 0x1
| 1
| '''Unique ID''' (per type namespacing)
|-
| 0x2
| colspan=2 {{unknown|End of ObjectID}}
|}

'''Note:''' This is the ID structure produced by MusyX data export tool used for ''Metroid Prime''
(which allocates all group ObjectIDs on export). The ObjectID structure is actually an arbitrary 16-bits in MusyX
(limited to 14-bit uniqueness). Based on findings from other games, this upper-byte type source is not 100% reliable,
since Factor5 updated the tool during the console's lifetime.

==== SoundMacros ====

The first Pool table denotes MusyX's '''SoundMacros''', small scripts that apply various effects on the sounds in the game. Each macro is composed of a header followed by a number of commands; each command specifies its type through a single-byte command ID, then specifies the parameters of that particular command, which vary.

The header of each SoundMacro is eight bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size''' ''(note: includes the size value itself)''
|-
| 0x4
| 2
| '''SoundMacro ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| 0x8
| colspan=2 {{unknown|Commands begin}}
|}

On the commands, each 4 bytes were originally little endian, but have been swapped to big endian in the AGSC files (despite not being longs). To read the data as originally formatted, every four bytes needs to be byte-swapped. Each command is 8 bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Command ID''' (varies; there are 79 known commands in the MusyX audio engine.)
|-
| 0x1
| 7
| '''Command arguments''' (varies between commands)
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

The SoundMacro will continue with commands until it terminates when the END command is executed. The command ID for END is 0 and has null command arguments; the next SoundMacro begins after reading it.

These are the possible commands:

{| class="wikitable"
! width="2%" | ID
! width="7%" | Name
! colspan="91%" | Arguments
|-
| 0x1
| STOP
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
|-
| 0x2
| SPLITKEY
| Keynumber
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x3
| SPLITVEL
| Velocity
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x4
| WAIT_TICKS
| Keyoff
| Random
| Sampleend
| Absolute
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x5
| LOOP
| Keyoff
| Random
| Sampleend
| colspan="2" | SoundMacro step
| colspan="2" | Times
|-
| 0x6
| GOTO
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x7
| WAIT_MS
| Keyoff
| Random
| Sample end
| Absolute
| {{unknown|}}
| colspan="2" | Millisec.
|-
| 0x8
| PLAYMACRO
| Addnote
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| Priority
| MaxVoices
|-
| 0x9
| SENDKEYOFF
| Variable
| Last started
| colspan="5" {{unknown|}}
|-
| 0xA
| SPLITMOD
| Mod value
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0xB
| PIANOPAN
| Scale
| Centerkey
| Centerpan
| colspan="4" {{unknown|}}
|-
| 0xC
| SETADSR
| colspan="2" | Table-ID (ADSR)
| DLS mode
| colspan="4" {{unknown|}}
|-
| 0xD
| SCALEVOLUME
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0xE
| PANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0xF
| ENVELOPE
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0x10
| STARTSAMPLE
| colspan="2" | Sample-ID
| Mode
| colspan="4" | Offset
|-
| 0x11
| STOPSAMPLE
| colspan="7" {{unknown|}}
|-
| 0x12
| KEYOFF
| colspan="7" {{unknown|}}
|-
| 0x13
| SPLITRND
| RND
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x14
| FADE-IN
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x15
| SPANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0x16
| SETADSRCTRL
| Attack
| Decay
| Sustain
| Relase
| colspan="3" {{unknown|}}
|-
| 0x17
| RNDNOTE
| Note Lo
| Detune
| Note Hi
| Fixed/Free
| Abs/Rel
| colspan="2" {{unknown|}}
|-
| 0x18
| ADDNOTE
| Add
| Detune
| org key
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x19
| SETNOTE
| Key
| Detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1A
| LASTNOTE
| Add
| detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1B
| PORTAMENTO
| Port. State
| Port. Type
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1C
| VIBRATO
| Level note
| Level fine
| Modwheel flag
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1D
| PITCHSWEEP1
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1E
| PITCHSWEEP2
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1F
| SETPITCH
| colspan="3" | Frequency (Hz)
| colspan="2" | Fine
| colspan="2" {{unknown|}}
|-
| 0x20
| SETPITCHADSR
| colspan="2" | Table-ID (ADSR)
| {{unknown|}}
| Note range
| Detune range
| colspan="2" {{unknown|}}
|-
| 0x21
| SCALEVOLUME DLS
| colspan="2" | Scale
| Org vol
| colspan="4" {{unknown|}}
|-
| 0x22
| MOD2VIBRANGE
| Key range
| Cent range
| colspan="5" {{unknown|}}
|-
| 0x23
| SETUP TREMOLO
| colspan="2" | Tremolo scale
| {{unknown|}}
| colspan="2" | Modw. add scale
| colspan="2" {{unknown|}}
|-
| 0x24
| RETURN
| colspan="7" {{unknown|}}
|-
| 0x25
| GOSUB
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x28
| TRAP_EVENT
| Event
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x29
| UNTRAP_EVENT
| Event
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
|-
| 0x2A
| SEND_MESSAGE
| IsVar
| colspan="2" | Macro
| VID
| Variable
| colspan="2" {{unknown|}}
|-
| 0x2B
| GET_MESSAGE
| Variable
| colspan="6" {{unknown|}}
|-
| 0x2C
| GET_VID
| Variable
| PLAY_MACRO
| colspan="5" {{unknown|}}
|-
| 0x30
| ADDAGECOUNT
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x31
| SETAGECOUNT
| {{unknown|}}
| colspan="2" | Counter
| colspan="4" {{unknown|}}
|-
| 0x32
| SENDFLAG
| Flag-ID
| Value
| colspan="5" {{unknown|}}
|-
| 0x33
| PITCHWHEELR
| Range up
| Range down
| colspan="5" {{unknown|}}
|-
| 0x36
| SETPRIORITY
| Prio
| colspan="6" {{unknown|}}
|-
| 0x37
| ADDPRIORITY
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x38
| AGECNTSPEED
| colspan="3" {{unknown|}}
| colspan="4" | Time
|-
| 0x39
| AGECNTVEL
| {{unknown|}}
| colspan="2" | AGE Base
| colspan="2" | AGE Scale
| colspan="2" {{unknown|}}
|-
| 0x40
| VOL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x41
| PAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x42
| PitchW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x43
| ModW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x44
| PEDAL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x45
| PORTA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x46
| REVERB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x47
| SPAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x48
| DOPPLER_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x49
| TREMOLO_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4A
| PREA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4B
| PREB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4C
| POSTB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4D
| AUXAFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4E
| AUXBFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x50
| SETUP_LFO
| LFO Nr.
| colspan="2" | Period in ms
| colspan="4" {{unknown|}}
|-
| 0x58
| MODE_SELECT
| DLS vol
| ITD
| colspan="5" {{unknown|}}
|-
| 0x59
| SET_KEYGROUP
| group
| kill
| colspan="5" {{unknown|}}
|-
| 0x5A
| SRCMODE_SELECT
| SRC type
| Type 0 SRC filter
| colspan="5" {{unknown|}}
|-
| 0x60
| ADD_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x61
| SUB_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B -
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x62
| MUL_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B *
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x63
| DIV_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B /
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x64
| ADDI_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| colspan="2" | Immediate
| {{unknown|}}
|-
| 0x65
| SET_VAR
| Ctrl
| A =
| colspan="1" {{unknown|}}
| colspan="2" | Immediate
| colspan="2" {{unknown|}}
|-
| 0x70
| IF_EQUAL
| Ctrl
| A ==
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x71
| IF_LESS
| Ctrl
| A <
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x0
| END
| colspan="7" {{unknown|}}
|}

After the last soundmacro, the table terminated by a value of 0xFFFF.

==== Tables ====

'''Tables''' have two functions: for defining curves for volume scaling, or to be used as ADSR envelopes.

The tables continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Table ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|ADSR/Curve data}}
|}

===== ADSR =====

When the size of the table data is exactly 8, it may represent ADSR envelopes with this structure:

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Attack time'''; in milliseconds
|-
| 0x2
| 2
| '''Decay time'''; in milliseconds
|-
| 0x4
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0x6
| 2
| '''Release time'''; in milliseconds
|-
| 0x8
| colspan=2 {{unknown|End of ADSR}}
|}

===== DLS ADSR =====

MusyX can also express more advanced envelopes using a modified [[wikipedia:DLS format|DLS]] representation.
This representation includes scaling coefficients to respond to played note and velocity
(so slamming down a key harder plays longer).

The attack and decay members are expressed in ''time-cents''. This may be converted to seconds using:
<code>2timecents / (1200.0 * 65536.0)</code>

The attack and decay scale members are expressed as 0.1% increments in 16.16 fixed-point.
This may be converted to a normalized factor using:
<code>scale / (1000.0 * 65536.0)</code>

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Attack time'''; in time-cents
|-
| 0x4
| 4
| '''Decay time'''; in time-cents
|-
| 0x8
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0xA
| 2
| '''Release'''; in milliseconds
|-
| 0xC
| 4
| '''Velocity to Attack Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x10
| 4
| '''Key to Decay Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x14
| colspan=2 {{unknown|End of DLS ADSR}}
|}

===== Curves =====

To express a volume curve, the table data is simply an arbitrarily-sized table of <code>uint8_t</code> values (although typically in MIDI range [0,127])

==== Keymaps ====

'''Keymaps''' are swappable, fixed-length tables mapping 128 MIDI keys to sound-producing objects.

The keymaps continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''; (usually 0x1032)
|-
| 0x4
| 2
| '''Keymap ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|128 Keymap entries}}
|}

===== Keymap Entry =====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Transpose'''
|-
| 0x3
| 1
| '''Pan'''
|-
| 0x4
| 1
| '''Priority Offset'''
|-
| 0x8
| colspan=2 {{Unknown|Padded to 8 bytes}}
|}

==== Layers ====

'''Layers''' are one-to-many, ranged keyboard mappings to sound-producing objects.

The layers continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Layer ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|Layer data}}
|}

===== Layer Data =====

Within the layer data, there is a '''u32 count''' of layer range structs:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Key Lo'''
|-
| 0x3
| 1
| '''Key Hi'''
|-
| 0x4
| 1
| '''Transpose'''
|-
| 0x5
| 1
| '''Volume'''
|-
| 0x6
| 1
| '''Priority Offset'''
|-
| 0x7
| 1
| '''Surround Pan'''; (0: extreme forward, 64: center, 127: extreme rearward)
|-
| 0x8
| 1
| '''Pan'''; (0: extreme left, 64: center, 127: extreme right)
|-
| 0xC
| colspan=2 {{Unknown|Padded to 12 bytes}}
|}

The entire Pool chunk is terminated by a value of 0xFFFF.

=== Project ===

The Project properties chunk contains values for the sounds, including priority, polyphony, volume, etc.

Structurally, the Project is the root of the Audio Group tree, defining one or more ''Song Groups'' or ''SFX Groups''

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Group end offset''' (points to next group in project)
|-
| 0x2
| 2
| '''Group ID'''
|-
| 0x4
| 2
| '''Group Type'''; 0 for SongGroup (for use with [[CSNG (File Format)|CSNG]]), 1 for SFXGroup.
|-
| 0x8
| 4
| '''SoundMacro ID table offset'''
|-
| 0xC
| 4
| '''Sample ID table offset'''
|-
| 0x10
| 4
| '''Tables table offset'''
|-
| 0x14
| 4
| '''Keymaps table offset'''
|-
| 0x18
| 4
| '''Layers table offset'''
|-
| 0x1C
| 4
| '''Normal page table''' (SongGroup) / '''SFX table offset''' (SFXGroup)
|-
| 0x20
| 4
| '''Drum page table offset''' (SongGroup)
|-
| 0x24
| 4
| '''MIDI Setup table offset''' (SongGroup)
|-
| 0x20
| colspan=2 {{unknown|End of group header}}
|}

After the header are a number of data tables.

==== SoundMacro ID Table ====

This is a ranged-table of shorts; there's no count value, so it's terminated with a value of 0xFFFF. It's a list of SoundMacro IDs present in the file. Contiguous ranges are expressed by IDs with most-significant bit set (0x8000). The range begins on the marked ID and incrementally reaches the next ID in the list, including that ID. All other IDs are singular.

==== Sample ID / Table / Keymap / Layer Tables ====

These function the same way as the SoundMacro ID table, but indexes other types of entities instead.

==== Normal / Drum Page Entry ====

Used to map [https://www.midi.org/specifications/item/gm-level-1-sound-set General MIDI program numbers] (instruments)
to sound entities (macros, keymaps, layers)

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x3
| 1
| '''Max number of voices'''
|-
| 0x4
| 1
| '''GM Program Number'''
|-
| 0x5
| 1
| '''Padding'''
|}

==== SFX Entry ====

Used to map auto-generated <code>#define</code> IDs (used by game code) to sound entities (macros, keymaps, layers)

This table begins with a 16-bit count value, then 16 bits of padding. Each entry in the table is 10 bytes.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''DefineID'''; referenced by game code
|-
| 0x2
| 2
| '''ObjectID'''
|-
| 0x4
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x5
| 1
| '''Max number of voices'''
|-
| 0x6
| 1
| '''Definite Velocity'''; volume (usually 7F)
|-
| 0x7
| 1
| '''Panning'''
|-
| 0x8
| 2
| '''Definite Key'''; The default pitch (usually 0x3C00... the second byte may possibly be the MIDI channel)
|}

==== MIDI Setup Entry ====

Table of fixed-length tables to map all 16 MIDI channels to program numbers
(in-turn resolving to sound entities via the page table).

Multiple MIDI Setups may be created to support Song data requiring totally different
banks of instruments.

Each MIDI Setup starts with a u16 '''MIDI-Setup-ID''', then 16-bits padding, then 16 entries of the following structure (one for each channel):

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Program Number'''
|-
| 0x1
| 1
| '''Volume'''
|-
| 0x2
| 1
| '''Panning'''
|-
| 0x3
| 1
| '''Reverb'''
|-
| 0x4
| 1
| '''Chorus'''
|}

MIDI setups continue until the ''group end offset'' is reached.

=== Sample ===

The Sample chunk is all the sound data encoded using the standard Gamecube DSP ADPCM codec. It can be decoded the same way as a [[DSP (File Format)|DSP]] file. Each sound's size is padded to 32 bytes before the next sound's data begins.

=== Sample Directory ===

The Sample Directory chunk (chunk 4 in Metroid Prime, chunk 3 in Metroid Prime 2) is made up of two sets of tables. The structure of both these tables is identical between both games.

==== Table A ====

The first metadata table has one entry per sound, and is terminated with 0xFFFFFFFF; since there's no known sound count anywhere in the file, the only way to read this correctly is to read until you reach the terminator value. Each entry is 0x20 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Sound ID'''
|-
| 0x2
| 2
| '''Padding'''; always 0
|-
| 0x4
| 4
| '''Sound start offset''', relative to the start of the ADPCM chunk
|-
| 0x8
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| 1
| '''Base Note'''; Corresponds to the MIDI note played in the sample, at the native sample-rate (which MusyX obtains from the INST chunk of .aiff files or SMPL chunk of .wav files, along with looping info). To play at a specified pitch in [[wikipedia:Cent (music)|cents]], set the playback sample rate using this formula: <code>sampleRate * 2((pitch - baseNote * 100) / 1200.0)</code>
|-
| 0xD
| 1
| '''Padding'''; always 0
|-
| 0xE
| 2
| '''Sample rate'''
|-
| 0x10
| 1
| '''Audio format''' <ol start="0"><li>DSP-ADPCM</li><li>DSP-ADPCM (Drum Sample)</li><li>PCM</li><li>N64-VADPCM (Legacy Format)</li></ol>
|-
| 0x11
| 3
| '''Number of samples'''
|-
| 0x14
| 4
| '''Loop start sample'''
|-
| 0x18
| 4
| '''Loop length''', in samples. To get the loop end sample, add this to the start sample and subtract 1.
|-
| 0x1C
| 4
| '''Table B entry offset''', relative to the start of the sound metadata chunk
|-
| 0x20
| colspan=2 {{unknown|End of entry}}
|}

==== Table B ====

These are accessed through the offsets in table A's entries; note that it might not match the sound count, because the same entry in this table can be used with multiple sounds. Each entry is 0x28 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| {{unknown|'''Unknown'''; always 8}}
|-
| 0x2
| 1
| '''Initial predictor/scale''' (matches first frame header)
|-
| 0x3
| 1
| '''Loop predictor/scale''' (matches loop start frame header)
|-
| 0x4
| 2
| '''Loop context sample history 2'''
|-
| 0x6
| 2
| '''Loop context sample history 1'''
|-
| 0x8
| 2 × 16
| '''Decode coefficients'''
|-
| 0x28
| colspan=2 {{unknown|End of entry}}
|}

== Tools ==

* [https://drive.google.com/file/d/0B9MLV21H7SDvemgwN1daYnliSjA/view?usp=sharing Prime Audio Decoder] by Aruki will dump all sound effects contained in a given AGSC file.

[[Category:File Formats]]
[[Category:Audio]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

AGSC (File Format)

2018-07-18T02:33:12Z

Antidote:

'''AGSC''' is the sound effect format for Metroid Prime and Metroid Prime 2: Echoes. Each AGSC file contains a group of sound effects. The first two Metroid Prime games utilize the MusyX audio engine created by Factor5 and as a result, AGSC files are essentially just embedded MusyX files.

The audio codec used in AGSC is the standard GameCube DSP-ADPCM codec, but MusyX itself also offers uncompressed PCM as an option.

{{todo|Better descriptions for how SoundMacros work and a description for what each command does.}}
{{research|minor|The proj and sdir chunks have a couple unknowns left.}}

__TOC__

== Format ==

The AGSC format is essentially four data chunks combined into one resource, each of which is a standard MusyX file. Of the four data chunks (pool, proj, samp, and sdir), there's one for sound engine scripts, one for sound properties, one for actual ADPCM sound data, and one for sound metadata. The main difference between Prime 1 and 2 is the header, and some slight changes in the way the four chunks are organized. In Metroid Prime, each chunk begins with its own size value; in Metroid Prime 2, every chunk instead has its size listed at the beginning of the file, at the end of the header. In addition, in Metroid Prime, the third chunk is samp, and the fourth is sdir; in Metroid Prime 2, it's the other way around.

=== Header ===

==== Metroid Prime ====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| '''D'''
| '''Audio Directory'''. Always "Audio/". Zero-terminated.
|-
| 0x0 + D
| '''N'''
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x0 + D + N
|colspan=2 {{unknown|End of header}}
|}

==== Metroid Prime 2 ====

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| {{unknown|'''Unknown'''; always 1}}
|-
| 0x4
| D
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x4 + D
| 2
| '''Group ID'''; 0xFFFF if unspecified
|-
| 0x6 + D
| 4
| '''Pool size'''
|-
| 0xA + D
| 4
| '''Project size'''
|-
| 0xE + D
| 4
| '''Sample directory size'''
|-
| 0x12 + D
| 4
| '''Sample size'''
|-
| 0x16 + D
| colspan=2 {{unknown|End of header}}
|}

=== Pool ===

The Pool chunk contains sub-chunk tables for SoundMacros, ADSR, keymaps, and layers, if applicable. It starts with a 16-byte header before the different data tables begin.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''SoundMacros Offset''' (always 0x10)
|-
| 0x4
| 4
| '''Tables Offset'''
|-
| 0x8
| 4
| '''Keymaps Offset'''
|-
| 0xC
| 4
| '''Layers Offset'''
|-
| 0x10
| colspan=2 {{unknown|End of entry}}
|}

==== ObjectID ====

After this are four tables of objects. Each object is identified with a 16-bit '''ObjectID''':

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Sound object type''' <ol start="0"><li>SoundMacro</li><li>Table</li><li value=4>Keymap</li><li value=8>Layer</li></ol>
|-
| 0x1
| 1
| '''Unique ID''' (per type namespacing)
|-
| 0x2
| colspan=2 {{unknown|End of ObjectID}}
|}

'''Note:''' This is the ID structure produced by MusyX data export tool used for ''Metroid Prime''
(which allocates all group ObjectIDs on export). The ObjectID structure is actually an arbitrary 16-bits in MusyX
(limited to 14-bit uniqueness). Based on findings from other games, this upper-byte type source is not 100% reliable,
since Factor5 updated the tool during the console's lifetime.

==== SoundMacros ====

The first Pool table denotes MusyX's '''SoundMacros''', small scripts that apply various effects on the sounds in the game. Each macro is composed of a header followed by a number of commands; each command specifies its type through a single-byte command ID, then specifies the parameters of that particular command, which vary.

The header of each SoundMacro is eight bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size''' ''(note: includes the size value itself)''
|-
| 0x4
| 2
| '''SoundMacro ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| 0x8
| colspan=2 {{unknown|Commands begin}}
|}

On the commands, each 4 bytes were originally little endian, but have been swapped to big endian in the AGSC files (despite not being longs). To read the data as originally formatted, every four bytes needs to be byte-swapped. Each command is 8 bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Command ID''' (varies; there are 79 known commands in the MusyX audio engine.)
|-
| 0x1
| 7
| '''Command arguments''' (varies between commands)
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

The SoundMacro will continue with commands until it terminates when the END command is executed. The command ID for END is 0 and has null command arguments; the next SoundMacro begins after reading it.

These are the possible commands:

{| class="wikitable"
! width="2%" | ID
! width="7%" | Name
! colspan="91%" | Arguments
|-
| 0x1
| STOP
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
|-
| 0x2
| SPLITKEY
| Keynumber
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x3
| SPLITVEL
| Velocity
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x4
| WAIT_TICKS
| Keyoff
| Random
| Sampleend
| Absolute
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x5
| LOOP
| Keyoff
| Random
| Sampleend
| colspan="2" | SoundMacro step
| colspan="2" | Times
|-
| 0x6
| GOTO
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x7
| WAIT_MS
| Keyoff
| Random
| Sample end
| Absolute
| {{unknown|}}
| colspan="2" | Millisec.
|-
| 0x8
| PLAYMACRO
| Addnote
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| Priority
| MaxVoices
|-
| 0x9
| SENDKEYOFF
| Variable
| Last started
| colspan="5" {{unknown|}}
|-
| 0xA
| SPLITMOD
| Mod value
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0xB
| PIANOPAN
| Scale
| Centerkey
| Centerpan
| colspan="4" {{unknown|}}
|-
| 0xC
| SETADSR
| colspan="2" | Table-ID (ADSR)
| DLS mode
| colspan="4" {{unknown|}}
|-
| 0xD
| SCALEVOLUME
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0xE
| PANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0xF
| ENVELOPE
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0x10
| STARTSAMPLE
| colspan="2" | Sample-ID
| Mode
| colspan="4" | Offset
|-
| 0x11
| STOPSAMPLE
| colspan="7" {{unknown|}}
|-
| 0x12
| KEYOFF
| colspan="7" {{unknown|}}
|-
| 0x13
| SPLITRND
| RND
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x14
| FADE-IN
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x15
| SPANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0x16
| SETADSRCTRL
| Attack
| Decay
| Sustain
| Relase
| colspan="3" {{unknown|}}
|-
| 0x17
| RNDNOTE
| Note Lo
| Detune
| Note Hi
| Fixed/Free
| Abs/Rel
| colspan="2" {{unknown|}}
|-
| 0x18
| ADDNOTE
| Add
| Detune
| org key
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x19
| SETNOTE
| Key
| Detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1A
| LASTNOTE
| Add
| detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1B
| PORTAMENTO
| Port. State
| Port. Type
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1C
| VIBRATO
| Level note
| Level fine
| Modwheel flag
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1D
| PITCHSWEEP1
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1E
| PITCHSWEEP2
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1F
| SETPITCH
| colspan="3" | Frequency (Hz)
| colspan="2" | Fine
| colspan="2" {{unknown|}}
|-
| 0x20
| SETPITCHADSR
| colspan="2" | Table-ID (ADSR)
| {{unknown|}}
| Note range
| Detune range
| colspan="2" {{unknown|}}
|-
| 0x21
| SCALEVOLUME DLS
| colspan="2" | Scale
| Org vol
| colspan="4" {{unknown|}}
|-
| 0x22
| MOD2VIBRANGE
| Key range
| Cent range
| colspan="5" {{unknown|}}
|-
| 0x23
| SETUP TREMOLO
| colspan="2" | Tremolo scale
| {{unknown|}}
| colspan="2" | Modw. add scale
| colspan="2" {{unknown|}}
|-
| 0x24
| RETURN
| colspan="7" {{unknown|}}
|-
| 0x25
| GOSUB
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x28
| TRAP_EVENT
| Event
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x29
| UNTRAP_EVENT
| Event
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
|-
| 0x2A
| SEND_MESSAGE
| IsVar
| colspan="2" | Macro
| VID
| Variable
| colspan="2" {{unknown|}}
|-
| 0x2B
| GET_MESSAGE
| Variable
| colspan="6" {{unknown|}}
|-
| 0x2C
| GET_VID
| Variable
| PLAY_MACRO
| colspan="5" {{unknown|}}
|-
| 0x30
| ADDAGECOUNT
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x31
| SETAGECOUNT
| {{unknown|}}
| colspan="2" | Counter
| colspan="4" {{unknown|}}
|-
| 0x32
| SENDFLAG
| Flag-ID
| Value
| colspan="5" {{unknown|}}
|-
| 0x33
| PITCHWHEELR
| Range up
| Range down
| colspan="5" {{unknown|}}
|-
| 0x36
| SETPRIORITY
| Prio
| colspan="6" {{unknown|}}
|-
| 0x37
| ADDPRIORITY
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x38
| AGECNTSPEED
| colspan="3" {{unknown|}}
| colspan="4" | Time
|-
| 0x39
| AGECNTVEL
| {{unknown|}}
| colspan="2" | AGE Base
| colspan="2" | AGE Scale
| colspan="2" {{unknown|}}
|-
| 0x40
| VOL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x41
| PAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x42
| PitchW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x43
| ModW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x44
| PEDAL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x45
| PORTA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x46
| REVERB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x47
| SPAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x48
| DOPPLER_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x49
| TREMOLO_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4A
| PREA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4B
| PREB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4C
| POSTB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4D
| AUXAFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4E
| AUXBFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x50
| SETUP_LFO
| LFO Nr.
| colspan="2" | Period in ms
| colspan="4" {{unknown|}}
|-
| 0x58
| MODE_SELECT
| DLS vol
| ITD
| colspan="5" {{unknown|}}
|-
| 0x59
| SET_KEYGROUP
| group
| kill
| colspan="5" {{unknown|}}
|-
| 0x5A
| SRCMODE_SELECT
| SRC type
| Type 0 SRC filter
| colspan="5" {{unknown|}}
|-
| 0x60
| ADD_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x61
| SUB_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B -
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x62
| MUL_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B *
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x63
| DIV_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B /
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x64
| ADDI_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| colspan="2" | Immediate
| {{unknown|}}
|-
| 0x65
| SET_VAR
| Ctrl
| A =
| colspan="1" {{unknown}}
| colspan="2" | Immediate
| colspan="2" {{unknown|}}
|-
| 0x70
| IF_EQUAL
| Ctrl
| A ==
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x71
| IF_LESS
| Ctrl
| A <
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x0
| END
| colspan="7" {{unknown|}}
|}

After the last soundmacro, the table terminated by a value of 0xFFFF.

==== Tables ====

'''Tables''' have two functions: for defining curves for volume scaling, or to be used as ADSR envelopes.

The tables continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Table ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|ADSR/Curve data}}
|}

===== ADSR =====

When the size of the table data is exactly 8, it may represent ADSR envelopes with this structure:

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Attack time'''; in milliseconds
|-
| 0x2
| 2
| '''Decay time'''; in milliseconds
|-
| 0x4
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0x6
| 2
| '''Release time'''; in milliseconds
|-
| 0x8
| colspan=2 {{unknown|End of ADSR}}
|}

===== DLS ADSR =====

MusyX can also express more advanced envelopes using a modified [[wikipedia:DLS format|DLS]] representation.
This representation includes scaling coefficients to respond to played note and velocity
(so slamming down a key harder plays longer).

The attack and decay members are expressed in ''time-cents''. This may be converted to seconds using:
<code>2timecents / (1200.0 * 65536.0)</code>

The attack and decay scale members are expressed as 0.1% increments in 16.16 fixed-point.
This may be converted to a normalized factor using:
<code>scale / (1000.0 * 65536.0)</code>

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Attack time'''; in time-cents
|-
| 0x4
| 4
| '''Decay time'''; in time-cents
|-
| 0x8
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0xA
| 2
| '''Release'''; in milliseconds
|-
| 0xC
| 4
| '''Velocity to Attack Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x10
| 4
| '''Key to Decay Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x14
| colspan=2 {{unknown|End of DLS ADSR}}
|}

===== Curves =====

To express a volume curve, the table data is simply an arbitrarily-sized table of <code>uint8_t</code> values (although typically in MIDI range [0,127])

==== Keymaps ====

'''Keymaps''' are swappable, fixed-length tables mapping 128 MIDI keys to sound-producing objects.

The keymaps continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''; (usually 0x1032)
|-
| 0x4
| 2
| '''Keymap ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|128 Keymap entries}}
|}

===== Keymap Entry =====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Transpose'''
|-
| 0x3
| 1
| '''Pan'''
|-
| 0x4
| 1
| '''Priority Offset'''
|-
| 0x8
| colspan=2 {{Unknown|Padded to 8 bytes}}
|}

==== Layers ====

'''Layers''' are one-to-many, ranged keyboard mappings to sound-producing objects.

The layers continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Layer ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|Layer data}}
|}

===== Layer Data =====

Within the layer data, there is a '''u32 count''' of layer range structs:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Key Lo'''
|-
| 0x3
| 1
| '''Key Hi'''
|-
| 0x4
| 1
| '''Transpose'''
|-
| 0x5
| 1
| '''Volume'''
|-
| 0x6
| 1
| '''Priority Offset'''
|-
| 0x7
| 1
| '''Surround Pan'''; (0: extreme forward, 64: center, 127: extreme rearward)
|-
| 0x8
| 1
| '''Pan'''; (0: extreme left, 64: center, 127: extreme right)
|-
| 0xC
| colspan=2 {{Unknown|Padded to 12 bytes}}
|}

The entire Pool chunk is terminated by a value of 0xFFFF.

=== Project ===

The Project properties chunk contains values for the sounds, including priority, polyphony, volume, etc.

Structurally, the Project is the root of the Audio Group tree, defining one or more ''Song Groups'' or ''SFX Groups''

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Group end offset''' (points to next group in project)
|-
| 0x2
| 2
| '''Group ID'''
|-
| 0x4
| 2
| '''Group Type'''; 0 for SongGroup (for use with [[CSNG (File Format)|CSNG]]), 1 for SFXGroup.
|-
| 0x8
| 4
| '''SoundMacro ID table offset'''
|-
| 0xC
| 4
| '''Sample ID table offset'''
|-
| 0x10
| 4
| '''Tables table offset'''
|-
| 0x14
| 4
| '''Keymaps table offset'''
|-
| 0x18
| 4
| '''Layers table offset'''
|-
| 0x1C
| 4
| '''Normal page table''' (SongGroup) / '''SFX table offset''' (SFXGroup)
|-
| 0x20
| 4
| '''Drum page table offset''' (SongGroup)
|-
| 0x24
| 4
| '''MIDI Setup table offset''' (SongGroup)
|-
| 0x20
| colspan=2 {{unknown|End of group header}}
|}

After the header are a number of data tables.

==== SoundMacro ID Table ====

This is a ranged-table of shorts; there's no count value, so it's terminated with a value of 0xFFFF. It's a list of SoundMacro IDs present in the file. Contiguous ranges are expressed by IDs with most-significant bit set (0x8000). The range begins on the marked ID and incrementally reaches the next ID in the list, including that ID. All other IDs are singular.

==== Sample ID / Table / Keymap / Layer Tables ====

These function the same way as the SoundMacro ID table, but indexes other types of entities instead.

==== Normal / Drum Page Entry ====

Used to map [https://www.midi.org/specifications/item/gm-level-1-sound-set General MIDI program numbers] (instruments)
to sound entities (macros, keymaps, layers)

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x3
| 1
| '''Max number of voices'''
|-
| 0x4
| 1
| '''GM Program Number'''
|-
| 0x5
| 1
| '''Padding'''
|}

==== SFX Entry ====

Used to map auto-generated <code>#define</code> IDs (used by game code) to sound entities (macros, keymaps, layers)

This table begins with a 16-bit count value, then 16 bits of padding. Each entry in the table is 10 bytes.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''DefineID'''; referenced by game code
|-
| 0x2
| 2
| '''ObjectID'''
|-
| 0x4
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x5
| 1
| '''Max number of voices'''
|-
| 0x6
| 1
| '''Definite Velocity'''; volume (usually 7F)
|-
| 0x7
| 1
| '''Panning'''
|-
| 0x8
| 2
| '''Definite Key'''; The default pitch (usually 0x3C00... the second byte may possibly be the MIDI channel)
|}

==== MIDI Setup Entry ====

Table of fixed-length tables to map all 16 MIDI channels to program numbers
(in-turn resolving to sound entities via the page table).

Multiple MIDI Setups may be created to support Song data requiring totally different
banks of instruments.

Each MIDI Setup starts with a u16 '''MIDI-Setup-ID''', then 16-bits padding, then 16 entries of the following structure (one for each channel):

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Program Number'''
|-
| 0x1
| 1
| '''Volume'''
|-
| 0x2
| 1
| '''Panning'''
|-
| 0x3
| 1
| '''Reverb'''
|-
| 0x4
| 1
| '''Chorus'''
|}

MIDI setups continue until the ''group end offset'' is reached.

=== Sample ===

The Sample chunk is all the sound data encoded using the standard Gamecube DSP ADPCM codec. It can be decoded the same way as a [[DSP (File Format)|DSP]] file. Each sound's size is padded to 32 bytes before the next sound's data begins.

=== Sample Directory ===

The Sample Directory chunk (chunk 4 in Metroid Prime, chunk 3 in Metroid Prime 2) is made up of two sets of tables. The structure of both these tables is identical between both games.

==== Table A ====

The first metadata table has one entry per sound, and is terminated with 0xFFFFFFFF; since there's no known sound count anywhere in the file, the only way to read this correctly is to read until you reach the terminator value. Each entry is 0x20 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Sound ID'''
|-
| 0x2
| 2
| '''Padding'''; always 0
|-
| 0x4
| 4
| '''Sound start offset''', relative to the start of the ADPCM chunk
|-
| 0x8
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| 1
| '''Base Note'''; Corresponds to the MIDI note played in the sample, at the native sample-rate (which MusyX obtains from the INST chunk of .aiff files or SMPL chunk of .wav files, along with looping info). To play at a specified pitch in [[wikipedia:Cent (music)|cents]], set the playback sample rate using this formula: <code>sampleRate * 2((pitch - baseNote * 100) / 1200.0)</code>
|-
| 0xD
| 1
| '''Padding'''; always 0
|-
| 0xE
| 2
| '''Sample rate'''
|-
| 0x10
| 1
| '''Audio format''' <ol start="0"><li>DSP-ADPCM</li><li>DSP-ADPCM (Drum Sample)</li><li>PCM</li><li>N64-VADPCM (Legacy Format)</li></ol>
|-
| 0x11
| 3
| '''Number of samples'''
|-
| 0x14
| 4
| '''Loop start sample'''
|-
| 0x18
| 4
| '''Loop length''', in samples. To get the loop end sample, add this to the start sample and subtract 1.
|-
| 0x1C
| 4
| '''Table B entry offset''', relative to the start of the sound metadata chunk
|-
| 0x20
| colspan=2 {{unknown|End of entry}}
|}

==== Table B ====

These are accessed through the offsets in table A's entries; note that it might not match the sound count, because the same entry in this table can be used with multiple sounds. Each entry is 0x28 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| {{unknown|'''Unknown'''; always 8}}
|-
| 0x2
| 1
| '''Initial predictor/scale''' (matches first frame header)
|-
| 0x3
| 1
| '''Loop predictor/scale''' (matches loop start frame header)
|-
| 0x4
| 2
| '''Loop context sample history 2'''
|-
| 0x6
| 2
| '''Loop context sample history 1'''
|-
| 0x8
| 2 × 16
| '''Decode coefficients'''
|-
| 0x28
| colspan=2 {{unknown|End of entry}}
|}

== Tools ==

* [https://drive.google.com/file/d/0B9MLV21H7SDvemgwN1daYnliSjA/view?usp=sharing Prime Audio Decoder] by Aruki will dump all sound effects contained in a given AGSC file.

[[Category:File Formats]]
[[Category:Audio]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

AGSC (File Format)

2018-07-18T02:03:27Z

Antidote: /* SoundMacros */

'''AGSC''' is the sound effect format for Metroid Prime and Metroid Prime 2: Echoes. Each AGSC file contains a group of sound effects. The first two Metroid Prime games utilize the MusyX audio engine created by Factor5 and as a result, AGSC files are essentially just embedded MusyX files.

The audio codec used in AGSC is the standard GameCube DSP-ADPCM codec, but MusyX itself also offers uncompressed PCM as an option.

{{todo|Better descriptions for how SoundMacros work and a description for what each command does.}}
{{research|minor|The proj and sdir chunks have a couple unknowns left.}}

__TOC__

== Format ==

The AGSC format is essentially four data chunks combined into one resource, each of which is a standard MusyX file. Of the four data chunks (pool, proj, samp, and sdir), there's one for sound engine scripts, one for sound properties, one for actual ADPCM sound data, and one for sound metadata. The main difference between Prime 1 and 2 is the header, and some slight changes in the way the four chunks are organized. In Metroid Prime, each chunk begins with its own size value; in Metroid Prime 2, every chunk instead has its size listed at the beginning of the file, at the end of the header. In addition, in Metroid Prime, the third chunk is samp, and the fourth is sdir; in Metroid Prime 2, it's the other way around.

=== Header ===

==== Metroid Prime ====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| '''D'''
| '''Audio Directory'''. Always "Audio/". Zero-terminated.
|-
| 0x0 + D
| '''N'''
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x0 + D + N
|colspan=2 {{unknown|End of header}}
|}

==== Metroid Prime 2 ====

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| {{unknown|'''Unknown'''; always 1}}
|-
| 0x4
| D
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x4 + D
| 2
| '''Group ID'''; 0xFFFF if unspecified
|-
| 0x6 + D
| 4
| '''Pool size'''
|-
| 0xA + D
| 4
| '''Project size'''
|-
| 0xE + D
| 4
| '''Sample directory size'''
|-
| 0x12 + D
| 4
| '''Sample size'''
|-
| 0x16 + D
| colspan=2 {{unknown|End of header}}
|}

=== Pool ===

The Pool chunk contains sub-chunk tables for SoundMacros, ADSR, keymaps, and layers, if applicable. It starts with a 16-byte header before the different data tables begin.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''SoundMacros Offset''' (always 0x10)
|-
| 0x4
| 4
| '''Tables Offset'''
|-
| 0x8
| 4
| '''Keymaps Offset'''
|-
| 0xC
| 4
| '''Layers Offset'''
|-
| 0x10
| colspan=2 {{unknown|End of entry}}
|}

==== ObjectID ====

After this are four tables of objects. Each object is identified with a 16-bit '''ObjectID''':

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Sound object type''' <ol start="0"><li>SoundMacro</li><li>Table</li><li value=4>Keymap</li><li value=8>Layer</li></ol>
|-
| 0x1
| 1
| '''Unique ID''' (per type namespacing)
|-
| 0x2
| colspan=2 {{unknown|End of ObjectID}}
|}

'''Note:''' This is the ID structure produced by MusyX data export tool used for ''Metroid Prime''
(which allocates all group ObjectIDs on export). The ObjectID structure is actually an arbitrary 16-bits in MusyX
(limited to 14-bit uniqueness). Based on findings from other games, this upper-byte type source is not 100% reliable,
since Factor5 updated the tool during the console's lifetime.

==== SoundMacros ====

The first Pool table denotes MusyX's '''SoundMacros''', small scripts that apply various effects on the sounds in the game. Each macro is composed of a header followed by a number of commands; each command specifies its type through a single-byte command ID, then specifies the parameters of that particular command, which vary.

The header of each SoundMacro is eight bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size''' ''(note: includes the size value itself)''
|-
| 0x4
| 2
| '''SoundMacro ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| 0x8
| colspan=2 {{unknown|Commands begin}}
|}

On the commands, each 4 bytes were originally little endian, but have been swapped to big endian in the AGSC files (despite not being longs). To read the data as originally formatted, every four bytes needs to be byte-swapped. Each command is 8 bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Command ID''' (varies; there are 79 known commands in the MusyX audio engine.)
|-
| 0x1
| 7
| '''Command arguments''' (varies between commands)
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

The SoundMacro will continue with commands until it terminates when the END command is executed. The command ID for END is 0 and has null command arguments; the next SoundMacro begins after reading it.

These are the possible commands:

{| class="wikitable"
! width="2%" | ID
! width="7%" | Name
! colspan="91%" | Arguments
|-
| 0x1
| STOP
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
|-
| 0x2
| SPLITKEY
| Keynumber
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x3
| SPLITVEL
| Velocity
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x4
| WAIT_TICKS
| Keyoff
| Random
| Sampleend
| Absolute
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x5
| LOOP
| Keyoff
| Random
| Sampleend
| colspan="2" | SoundMacro step
| colspan="2" | Times
|-
| 0x6
| GOTO
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x7
| WAIT_MS
| Keyoff
| Random
| Sample end
| Absolute
| {{unknown|}}
| colspan="2" | Millisec.
|-
| 0x8
| PLAYMACRO
| Addnote
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| Priority
| MaxVoices
|-
| 0x9
| SENDKEYOFF
| Variable
| Last started
| colspan="5" {{unknown|}}
|-
| 0xA
| SPLITMOD
| Mod value
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0xB
| PIANOPAN
| Scale
| Centerkey
| Centerpan
| colspan="4" {{unknown|}}
|-
| 0xC
| SETADSR
| colspan="2" | Table-ID (ADSR)
| DLS mode
| colspan="4" {{unknown|}}
|-
| 0xD
| SCALEVOLUME
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0xE
| PANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0xF
| ENVELOPE
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0x10
| STARTSAMPLE
| colspan="2" | Sample-ID
| Mode
| colspan="4" | Offset
|-
| 0x11
| STOPSAMPLE
| colspan="7" {{unknown|}}
|-
| 0x12
| KEYOFF
| colspan="7" {{unknown|}}
|-
| 0x13
| SPLITRND
| RND
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x14
| FADE-IN
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x15
| SPANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0x16
| SETADSRCTRL
| Attack
| Decay
| Sustain
| Relase
| colspan="3" {{unknown|}}
|-
| 0x17
| RNDNOTE
| Note Lo
| Detune
| Note Hi
| Fixed/Free
| Abs/Rel
| colspan="2" {{unknown|}}
|-
| 0x18
| ADDNOTE
| Add
| Detune
| org key
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x19
| SETNOTE
| Key
| Detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1A
| LASTNOTE
| Add
| detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1B
| PORTAMENTO
| Port. State
| Port. Type
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1C
| VIBRATO
| Level note
| Level fine
| Modwheel flag
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1D
| PITCHSWEEP1
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1E
| PITCHSWEEP2
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1F
| SETPITCH
| colspan="3" | Frequency (Hz)
| colspan="2" | Fine
| colspan="2" {{unknown|}}
|-
| 0x20
| SETPITCHADSR
| colspan="2" | Table-ID (ADSR)
| {{unknown|}}
| Note range
| Detune range
| colspan="2" {{unknown|}}
|-
| 0x21
| SCALEVOLUME DLS
| colspan="2" | Scale
| Org vol
| colspan="4" {{unknown|}}
|-
| 0x22
| MOD2VIBRANGE
| Key range
| Cent range
| colspan="5" {{unknown|}}
|-
| 0x23
| SETUP TREMOLO
| colspan="2" | Tremolo scale
| {{unknown|}}
| colspan="2" | Modw. add scale
| colspan="2" {{unknown|}}
|-
| 0x24
| RETURN
| colspan="7" {{unknown|}}
|-
| 0x25
| GOSUB
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x28
| TRAP_EVENT
| Event
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x29
| UNTRAP_EVENT
| Event
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
|-
| 0x2A
| SEND_MESSAGE
| IsVar
| colspan="2" | Macro
| VID
| Variable
| colspan="2" {{unknown|}}
|-
| 0x2B
| GET_MESSAGE
| Variable
| colspan="6" {{unknown|}}
|-
| 0x2C
| GET_VID
| Variable
| PLAY_MACRO
| colspan="5" {{unknown|}}
|-
| 0x30
| ADDAGECOUNT
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x31
| SETAGECOUNT
| {{unknown|}}
| colspan="2" | Counter
| colspan="4" {{unknown|}}
|-
| 0x32
| SENDFLAG
| Flag-ID
| Value
| colspan="5" {{unknown|}}
|-
| 0x33
| PITCHWHEELR
| Range up
| Range down
| colspan="5" {{unknown|}}
|-
| 0x36
| SETPRIORITY
| Prio
| colspan="6" {{unknown|}}
|-
| 0x37
| ADDPRIORITY
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x38
| AGECNTSPEED
| colspan="3" {{unknown|}}
| colspan="4" | Time
|-
| 0x39
| AGECNTVEL
| {{unknown|}}
| colspan="2" | AGE Base
| colspan="2" | AGE Scale
| colspan="2" {{unknown|}}
|-
| 0x40
| VOL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x41
| PAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x42
| PitchW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x43
| ModW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x44
| PEDAL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x45
| PORTA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x46
| REVERB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x47
| SPAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x48
| DOPPLER_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x49
| TREMOLO_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4A
| PREA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4B
| PREB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4C
| POSTB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4D
| AUXAFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4E
| AUXBFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x50
| SETUP_LFO
| LFO Nr.
| colspan="2" | Period in ms
| colspan="4" {{unknown|}}
|-
| 0x58
| MODE_SELECT
| DLS vol
| ITD
| colspan="5" {{unknown|}}
|-
| 0x59
| SET_KEYGROUP
| group
| kill
| colspan="5" {{unknown|}}
|-
| 0x5A
| SRCMODE_SELECT
| SRC type
| Type 0 SRC filter
| colspan="5" {{unknown|}}
|-
| 0x60
| ADD_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x61
| SUB_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B -
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x62
| MUL_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B *
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x63
| DIV_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B /
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x64
| ADDI_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| colspan="2" | Immediate
| {{unknown|}}
|-
| 0x65
| SET_VAR
| Ctrl
| A =
| colspan="2" | Immediate
| colspan="3" {{unknown|}}
|-
| 0x70
| IF_EQUAL
| Ctrl
| A ==
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x71
| IF_LESS
| Ctrl
| A <
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x0
| END
| colspan="7" {{unknown|}}
|}

After the last soundmacro, the table terminated by a value of 0xFFFF.

==== Tables ====

'''Tables''' have two functions: for defining curves for volume scaling, or to be used as ADSR envelopes.

The tables continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Table ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|ADSR/Curve data}}
|}

===== ADSR =====

When the size of the table data is exactly 8, it may represent ADSR envelopes with this structure:

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Attack time'''; in milliseconds
|-
| 0x2
| 2
| '''Decay time'''; in milliseconds
|-
| 0x4
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0x6
| 2
| '''Release time'''; in milliseconds
|-
| 0x8
| colspan=2 {{unknown|End of ADSR}}
|}

===== DLS ADSR =====

MusyX can also express more advanced envelopes using a modified [[wikipedia:DLS format|DLS]] representation.
This representation includes scaling coefficients to respond to played note and velocity
(so slamming down a key harder plays longer).

The attack and decay members are expressed in ''time-cents''. This may be converted to seconds using:
<code>2timecents / (1200.0 * 65536.0)</code>

The attack and decay scale members are expressed as 0.1% increments in 16.16 fixed-point.
This may be converted to a normalized factor using:
<code>scale / (1000.0 * 65536.0)</code>

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Attack time'''; in time-cents
|-
| 0x4
| 4
| '''Decay time'''; in time-cents
|-
| 0x8
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0xA
| 2
| '''Release'''; in milliseconds
|-
| 0xC
| 4
| '''Velocity to Attack Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x10
| 4
| '''Key to Decay Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x14
| colspan=2 {{unknown|End of DLS ADSR}}
|}

===== Curves =====

To express a volume curve, the table data is simply an arbitrarily-sized table of <code>uint8_t</code> values (although typically in MIDI range [0,127])

==== Keymaps ====

'''Keymaps''' are swappable, fixed-length tables mapping 128 MIDI keys to sound-producing objects.

The keymaps continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''; (usually 0x1032)
|-
| 0x4
| 2
| '''Keymap ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|128 Keymap entries}}
|}

===== Keymap Entry =====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Transpose'''
|-
| 0x3
| 1
| '''Pan'''
|-
| 0x4
| 1
| '''Priority Offset'''
|-
| 0x8
| colspan=2 {{Unknown|Padded to 8 bytes}}
|}

==== Layers ====

'''Layers''' are one-to-many, ranged keyboard mappings to sound-producing objects.

The layers continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Layer ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|Layer data}}
|}

===== Layer Data =====

Within the layer data, there is a '''u32 count''' of layer range structs:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Key Lo'''
|-
| 0x3
| 1
| '''Key Hi'''
|-
| 0x4
| 1
| '''Transpose'''
|-
| 0x5
| 1
| '''Volume'''
|-
| 0x6
| 1
| '''Priority Offset'''
|-
| 0x7
| 1
| '''Surround Pan'''; (0: extreme forward, 64: center, 127: extreme rearward)
|-
| 0x8
| 1
| '''Pan'''; (0: extreme left, 64: center, 127: extreme right)
|-
| 0xC
| colspan=2 {{Unknown|Padded to 12 bytes}}
|}

The entire Pool chunk is terminated by a value of 0xFFFF.

=== Project ===

The Project properties chunk contains values for the sounds, including priority, polyphony, volume, etc.

Structurally, the Project is the root of the Audio Group tree, defining one or more ''Song Groups'' or ''SFX Groups''

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Group end offset''' (points to next group in project)
|-
| 0x2
| 2
| '''Group ID'''
|-
| 0x4
| 2
| '''Group Type'''; 0 for SongGroup (for use with [[CSNG (File Format)|CSNG]]), 1 for SFXGroup.
|-
| 0x8
| 4
| '''SoundMacro ID table offset'''
|-
| 0xC
| 4
| '''Sample ID table offset'''
|-
| 0x10
| 4
| '''Tables table offset'''
|-
| 0x14
| 4
| '''Keymaps table offset'''
|-
| 0x18
| 4
| '''Layers table offset'''
|-
| 0x1C
| 4
| '''Normal page table''' (SongGroup) / '''SFX table offset''' (SFXGroup)
|-
| 0x20
| 4
| '''Drum page table offset''' (SongGroup)
|-
| 0x24
| 4
| '''MIDI Setup table offset''' (SongGroup)
|-
| 0x20
| colspan=2 {{unknown|End of group header}}
|}

After the header are a number of data tables.

==== SoundMacro ID Table ====

This is a ranged-table of shorts; there's no count value, so it's terminated with a value of 0xFFFF. It's a list of SoundMacro IDs present in the file. Contiguous ranges are expressed by IDs with most-significant bit set (0x8000). The range begins on the marked ID and incrementally reaches the next ID in the list, including that ID. All other IDs are singular.

==== Sample ID / Table / Keymap / Layer Tables ====

These function the same way as the SoundMacro ID table, but indexes other types of entities instead.

==== Normal / Drum Page Entry ====

Used to map [https://www.midi.org/specifications/item/gm-level-1-sound-set General MIDI program numbers] (instruments)
to sound entities (macros, keymaps, layers)

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x3
| 1
| '''Max number of voices'''
|-
| 0x4
| 1
| '''GM Program Number'''
|-
| 0x5
| 1
| '''Padding'''
|}

==== SFX Entry ====

Used to map auto-generated <code>#define</code> IDs (used by game code) to sound entities (macros, keymaps, layers)

This table begins with a 16-bit count value, then 16 bits of padding. Each entry in the table is 10 bytes.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''DefineID'''; referenced by game code
|-
| 0x2
| 2
| '''ObjectID'''
|-
| 0x4
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x5
| 1
| '''Max number of voices'''
|-
| 0x6
| 1
| '''Definite Velocity'''; volume (usually 7F)
|-
| 0x7
| 1
| '''Panning'''
|-
| 0x8
| 2
| '''Definite Key'''; The default pitch (usually 0x3C00... the second byte may possibly be the MIDI channel)
|}

==== MIDI Setup Entry ====

Table of fixed-length tables to map all 16 MIDI channels to program numbers
(in-turn resolving to sound entities via the page table).

Multiple MIDI Setups may be created to support Song data requiring totally different
banks of instruments.

Each MIDI Setup starts with a u16 '''MIDI-Setup-ID''', then 16-bits padding, then 16 entries of the following structure (one for each channel):

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Program Number'''
|-
| 0x1
| 1
| '''Volume'''
|-
| 0x2
| 1
| '''Panning'''
|-
| 0x3
| 1
| '''Reverb'''
|-
| 0x4
| 1
| '''Chorus'''
|}

MIDI setups continue until the ''group end offset'' is reached.

=== Sample ===

The Sample chunk is all the sound data encoded using the standard Gamecube DSP ADPCM codec. It can be decoded the same way as a [[DSP (File Format)|DSP]] file. Each sound's size is padded to 32 bytes before the next sound's data begins.

=== Sample Directory ===

The Sample Directory chunk (chunk 4 in Metroid Prime, chunk 3 in Metroid Prime 2) is made up of two sets of tables. The structure of both these tables is identical between both games.

==== Table A ====

The first metadata table has one entry per sound, and is terminated with 0xFFFFFFFF; since there's no known sound count anywhere in the file, the only way to read this correctly is to read until you reach the terminator value. Each entry is 0x20 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Sound ID'''
|-
| 0x2
| 2
| '''Padding'''; always 0
|-
| 0x4
| 4
| '''Sound start offset''', relative to the start of the ADPCM chunk
|-
| 0x8
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| 1
| '''Base Note'''; Corresponds to the MIDI note played in the sample, at the native sample-rate (which MusyX obtains from the INST chunk of .aiff files or SMPL chunk of .wav files, along with looping info). To play at a specified pitch in [[wikipedia:Cent (music)|cents]], set the playback sample rate using this formula: <code>sampleRate * 2((pitch - baseNote * 100) / 1200.0)</code>
|-
| 0xD
| 1
| '''Padding'''; always 0
|-
| 0xE
| 2
| '''Sample rate'''
|-
| 0x10
| 1
| '''Audio format''' <ol start="0"><li>DSP-ADPCM</li><li>DSP-ADPCM (Drum Sample)</li><li>PCM</li><li>N64-VADPCM (Legacy Format)</li></ol>
|-
| 0x11
| 3
| '''Number of samples'''
|-
| 0x14
| 4
| '''Loop start sample'''
|-
| 0x18
| 4
| '''Loop length''', in samples. To get the loop end sample, add this to the start sample and subtract 1.
|-
| 0x1C
| 4
| '''Table B entry offset''', relative to the start of the sound metadata chunk
|-
| 0x20
| colspan=2 {{unknown|End of entry}}
|}

==== Table B ====

These are accessed through the offsets in table A's entries; note that it might not match the sound count, because the same entry in this table can be used with multiple sounds. Each entry is 0x28 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| {{unknown|'''Unknown'''; always 8}}
|-
| 0x2
| 1
| '''Initial predictor/scale''' (matches first frame header)
|-
| 0x3
| 1
| '''Loop predictor/scale''' (matches loop start frame header)
|-
| 0x4
| 2
| '''Loop context sample history 2'''
|-
| 0x6
| 2
| '''Loop context sample history 1'''
|-
| 0x8
| 2 × 16
| '''Decode coefficients'''
|-
| 0x28
| colspan=2 {{unknown|End of entry}}
|}

== Tools ==

* [https://drive.google.com/file/d/0B9MLV21H7SDvemgwN1daYnliSjA/view?usp=sharing Prime Audio Decoder] by Aruki will dump all sound effects contained in a given AGSC file.

[[Category:File Formats]]
[[Category:Audio]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

AGSC (File Format)

2018-07-18T01:55:25Z

Antidote: /* SoundMacros */

'''AGSC''' is the sound effect format for Metroid Prime and Metroid Prime 2: Echoes. Each AGSC file contains a group of sound effects. The first two Metroid Prime games utilize the MusyX audio engine created by Factor5 and as a result, AGSC files are essentially just embedded MusyX files.

The audio codec used in AGSC is the standard GameCube DSP-ADPCM codec, but MusyX itself also offers uncompressed PCM as an option.

{{todo|Better descriptions for how SoundMacros work and a description for what each command does.}}
{{research|minor|The proj and sdir chunks have a couple unknowns left.}}

__TOC__

== Format ==

The AGSC format is essentially four data chunks combined into one resource, each of which is a standard MusyX file. Of the four data chunks (pool, proj, samp, and sdir), there's one for sound engine scripts, one for sound properties, one for actual ADPCM sound data, and one for sound metadata. The main difference between Prime 1 and 2 is the header, and some slight changes in the way the four chunks are organized. In Metroid Prime, each chunk begins with its own size value; in Metroid Prime 2, every chunk instead has its size listed at the beginning of the file, at the end of the header. In addition, in Metroid Prime, the third chunk is samp, and the fourth is sdir; in Metroid Prime 2, it's the other way around.

=== Header ===

==== Metroid Prime ====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| '''D'''
| '''Audio Directory'''. Always "Audio/". Zero-terminated.
|-
| 0x0 + D
| '''N'''
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x0 + D + N
|colspan=2 {{unknown|End of header}}
|}

==== Metroid Prime 2 ====

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| {{unknown|'''Unknown'''; always 1}}
|-
| 0x4
| D
| '''Audio Group Name'''. Zero-terminated.
|-
| 0x4 + D
| 2
| '''Group ID'''; 0xFFFF if unspecified
|-
| 0x6 + D
| 4
| '''Pool size'''
|-
| 0xA + D
| 4
| '''Project size'''
|-
| 0xE + D
| 4
| '''Sample directory size'''
|-
| 0x12 + D
| 4
| '''Sample size'''
|-
| 0x16 + D
| colspan=2 {{unknown|End of header}}
|}

=== Pool ===

The Pool chunk contains sub-chunk tables for SoundMacros, ADSR, keymaps, and layers, if applicable. It starts with a 16-byte header before the different data tables begin.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''SoundMacros Offset''' (always 0x10)
|-
| 0x4
| 4
| '''Tables Offset'''
|-
| 0x8
| 4
| '''Keymaps Offset'''
|-
| 0xC
| 4
| '''Layers Offset'''
|-
| 0x10
| colspan=2 {{unknown|End of entry}}
|}

==== ObjectID ====

After this are four tables of objects. Each object is identified with a 16-bit '''ObjectID''':

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Sound object type''' <ol start="0"><li>SoundMacro</li><li>Table</li><li value=4>Keymap</li><li value=8>Layer</li></ol>
|-
| 0x1
| 1
| '''Unique ID''' (per type namespacing)
|-
| 0x2
| colspan=2 {{unknown|End of ObjectID}}
|}

'''Note:''' This is the ID structure produced by MusyX data export tool used for ''Metroid Prime''
(which allocates all group ObjectIDs on export). The ObjectID structure is actually an arbitrary 16-bits in MusyX
(limited to 14-bit uniqueness). Based on findings from other games, this upper-byte type source is not 100% reliable,
since Factor5 updated the tool during the console's lifetime.

==== SoundMacros ====

The first Pool table denotes MusyX's '''SoundMacros''', small scripts that apply various effects on the sounds in the game. Each macro is composed of a header followed by a number of commands; each command specifies its type through a single-byte command ID, then specifies the parameters of that particular command, which vary.

The header of each SoundMacro is eight bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size''' ''(note: includes the size value itself)''
|-
| 0x4
| 2
| '''SoundMacro ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| 0x8
| colspan=2 {{unknown|Commands begin}}
|}

On the commands, each 4 bytes were originally little endian, but have been swapped to big endian in the AGSC files (despite not being longs). To read the data as originally formatted, every four bytes needs to be byte-swapped. Each command is 8 bytes, and is structured as follows:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Command ID''' (varies; there are 79 known commands in the MusyX audio engine.)
|-
| 0x1
| 7
| '''Command arguments''' (varies between commands)
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

The SoundMacro will continue with commands until it terminates when the END command is executed. The command ID for END is 0 and has null command arguments; the next SoundMacro begins after reading it.

These are the possible commands:

{| class="wikitable"
! width="2%" | ID
! width="7%" | Name
! colspan="91%" | Arguments
|-
| 0x1
| STOP
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
| width="13%" {{unknown|}}
|-
| 0x2
| SPLITKEY
| Keynumber
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x3
| SPLITVEL
| Velocity
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x4
| WAIT_TICKS
| Keyoff
| Random
| Sampleend
| Absolute
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x5
| LOOP
| Keyoff
| Random
| Sampleend
| colspan="2" | SoundMacro step
| colspan="2" | Times
|-
| 0x6
| GOTO
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x7
| WAIT_MS
| Keyoff
| Random
| Sample end
| Absolute
| {{unknown|}}
| colspan="2" | Millisec.
|-
| 0x8
| PLAYMACRO
| Addnote
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| Priority
| MaxVoices
|-
| 0x9
| SENDKEYOFF
| Variable
| Last started
| colspan="5" {{unknown|}}
|-
| 0xA
| SPLITMOD
| Mod value
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0xB
| PIANOPAN
| Scale
| Centerkey
| Centerpan
| colspan="4" {{unknown|}}
|-
| 0xC
| SETADSR
| colspan="2" | Table-ID (ADSR)
| DLS mode
| colspan="4" {{unknown|}}
|-
| 0xD
| SCALEVOLUME
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0xE
| PANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0xF
| ENVELOPE
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| Org vol
| colspan="2" {{unknown|}}
|-
| 0x10
| STARTSAMPLE
| colspan="2" | Sample-ID
| Mode
| colspan="4" | Offset
|-
| 0x11
| STOPSAMPLE
| colspan="7" {{unknown|}}
|-
| 0x12
| KEYOFF
| colspan="7" {{unknown|}}
|-
| 0x13
| SPLITRND
| RND
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x14
| FADE-IN
| Scale
| Add
| colspan="2" | Table-ID (Curve)
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x15
| SPANNING
| Pan position
| colspan="2" | Time ms
| Width
| colspan="3" {{unknown|}}
|-
| 0x16
| SETADSRCTRL
| Attack
| Decay
| Sustain
| Relase
| colspan="3" {{unknown|}}
|-
| 0x17
| RNDNOTE
| Note Lo
| Detune
| Note Hi
| Fixed/Free
| Abs/Rel
| colspan="2" {{unknown|}}
|-
| 0x18
| ADDNOTE
| Add
| Detune
| org key
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x19
| SETNOTE
| Key
| Detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1A
| LASTNOTE
| Add
| detune
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1B
| PORTAMENTO
| Port. State
| Port. Type
| colspan="2" {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1C
| VIBRATO
| Level note
| Level fine
| Modwheel flag
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1D
| PITCHSWEEP1
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1E
| PITCHSWEEP2
| Times
| colspan="2" | Add
| {{unknown|}}
| ms switch
| colspan="2" | Ticks/Millisec.
|-
| 0x1F
| SETPITCH
| colspan="3" | Frequency (Hz)
| colspan="2" | Fine
| colspan="2" {{unknown|}}
|-
| 0x20
| SETPITCHADSR
| colspan="2" | Table-ID (ADSR)
| {{unknown|}}
| Note range
| Detune range
| colspan="2" {{unknown|}}
|-
| 0x21
| SCALEVOLUME DLS
| colspan="2" | Scale
| Org vol
| colspan="4" {{unknown|}}
|-
| 0x22
| MOD2VIBRANGE
| Key range
| Cent range
| colspan="5" {{unknown|}}
|-
| 0x23
| SETUP TREMOLO
| colspan="2" | Tremolo scale
| {{unknown|}}
| colspan="2" | Modw. add scale
| colspan="2" {{unknown|}}
|-
| 0x24
| RETURN
| colspan="7" {{unknown|}}
|-
| 0x25
| GOSUB
| {{unknown|}}
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x28
| TRAP_EVENT
| Event
| colspan="2" | SoundMacro ID
| colspan="2" | SoundMacro step
| colspan="2" {{unknown|}}
|-
| 0x29
| UNTRAP_EVENT
| Event
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
| colspan="2" {{unknown|}}
|-
| 0x2A
| SEND_MESSAGE
| IsVar
| colspan="2" | Macro
| VID
| Variable
| colspan="2" {{unknown|}}
|-
| 0x2B
| GET_MESSAGE
| Variable
| colspan="6" {{unknown|}}
|-
| 0x2C
| GET_VID
| Variable
| PLAY_MACRO
| colspan="5" {{unknown|}}
|-
| 0x30
| ADDAGECOUNT
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x31
| SETAGECOUNT
| {{unknown|}}
| colspan="2" | Counter
| colspan="4" {{unknown|}}
|-
| 0x32
| SENDFLAG
| Flag-ID
| Value
| colspan="5" {{unknown|}}
|-
| 0x33
| PITCHWHEELR
| Range up
| Range down
| colspan="5" {{unknown|}}
|-
| 0x34
| SETPRIORITY
| Prio
| colspan="6" {{unknown|}}
|-
| 0x35
| ADDPRIORITY
| {{unknown|}}
| colspan="2" | Add
| colspan="4" {{unknown|}}
|-
| 0x36
| AGECNTSPEED
| colspan="3" {{unknown|}}
| colspan="4" | Time
|-
| 0x37
| AGECNTVEL
| {{unknown|}}
| colspan="2" | AGE Base
| colspan="2" | AGE Scale
| colspan="2" {{unknown|}}
|-
| 0x40
| VOL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x41
| PAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x42
| PitchW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x43
| ModW_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x44
| PEDAL_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x45
| PORTA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x46
| REVERB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x47
| SPAN_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x48
| DOPPLER_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x49
| TREMOLO_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4A
| PREA_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4B
| PREB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4C
| POSTB_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4D
| AUXAFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x4E
| AUXBFX_SELECT
| MIDI Contr.
| colspan="2" | Scaling percentage
| Combine
| is var.
| Fine scaling
| {{unknown|}}
|-
| 0x50
| SETUP_LFO
| LFO Nr.
| colspan="2" | Period in ms
| colspan="4" {{unknown|}}
|-
| 0x58
| MODE_SELECT
| DLS vol
| ITD
| colspan="5" {{unknown|}}
|-
| 0x59
| SET_KEYGROUP
| group
| kill
| colspan="5" {{unknown|}}
|-
| 0x5A
| SRCMODE_SELECT
| SRC type
| Type 0 SRC filter
| colspan="5" {{unknown|}}
|-
| 0x60
| ADD_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x61
| SUB_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B -
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x62
| MUL_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B *
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x63
| DIV_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B /
| Var/Ctrl
| C
| {{unknown|}}
|-
| 0x64
| ADDI_VARS
| Var/Ctrl
| A =
| Var/Ctrl
| B +
| colspan="2" | Immediate
| {{unknown|}}
|-
| 0x65
| SET_VAR
| Ctrl
| A =
| colspan="2" | Immediate
| colspan="3" {{unknown|}}
|-
| 0x70
| IF_EQUAL
| Ctrl
| A ==
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x71
| IF_LESS
| Ctrl
| A <
| Ctrl
| B
| Not
| colspan="2" | SoundMacro Step
|-
| 0x0
| END
| colspan="7" {{unknown|}}
|}

After the last soundmacro, the table terminated by a value of 0xFFFF.

==== Tables ====

'''Tables''' have two functions: for defining curves for volume scaling, or to be used as ADSR envelopes.

The tables continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Table ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|ADSR/Curve data}}
|}

===== ADSR =====

When the size of the table data is exactly 8, it may represent ADSR envelopes with this structure:

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Attack time'''; in milliseconds
|-
| 0x2
| 2
| '''Decay time'''; in milliseconds
|-
| 0x4
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0x6
| 2
| '''Release time'''; in milliseconds
|-
| 0x8
| colspan=2 {{unknown|End of ADSR}}
|}

===== DLS ADSR =====

MusyX can also express more advanced envelopes using a modified [[wikipedia:DLS format|DLS]] representation.
This representation includes scaling coefficients to respond to played note and velocity
(so slamming down a key harder plays longer).

The attack and decay members are expressed in ''time-cents''. This may be converted to seconds using:
<code>2timecents / (1200.0 * 65536.0)</code>

The attack and decay scale members are expressed as 0.1% increments in 16.16 fixed-point.
This may be converted to a normalized factor using:
<code>scale / (1000.0 * 65536.0)</code>

'''Note:''' All fields of the envelope are ''little endian''.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Attack time'''; in time-cents
|-
| 0x4
| 4
| '''Decay time'''; in time-cents
|-
| 0x8
| 2
| '''Sustain'''; percentage mapped between [0x0,0x1000]
|-
| 0xA
| 2
| '''Release'''; in milliseconds
|-
| 0xC
| 4
| '''Velocity to Attack Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x10
| 4
| '''Key to Decay Scale'''; 0.1% increments as 16.16 fixed-point
|-
| 0x14
| colspan=2 {{unknown|End of DLS ADSR}}
|}

===== Curves =====

To express a volume curve, the table data is simply an arbitrarily-sized table of <code>uint8_t</code> values (although typically in MIDI range [0,127])

==== Keymaps ====

'''Keymaps''' are swappable, fixed-length tables mapping 128 MIDI keys to sound-producing objects.

The keymaps continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''; (usually 0x1032)
|-
| 0x4
| 2
| '''Keymap ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|128 Keymap entries}}
|}

===== Keymap Entry =====

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Transpose'''
|-
| 0x3
| 1
| '''Pan'''
|-
| 0x4
| 1
| '''Priority Offset'''
|-
| 0x8
| colspan=2 {{Unknown|Padded to 8 bytes}}
|}

==== Layers ====

'''Layers''' are one-to-many, ranged keyboard mappings to sound-producing objects.

The layers continue until 0xffffffff terminator is reached.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Chunk Size'''
|-
| 0x4
| 2
| '''Layer ObjectID'''
|-
| 0x6
| 2
| '''Padding'''
|-
| Chunk Size
| colspan=2 {{Unknown|Layer data}}
|}

===== Layer Data =====

Within the layer data, there is a '''u32 count''' of layer range structs:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Key Lo'''
|-
| 0x3
| 1
| '''Key Hi'''
|-
| 0x4
| 1
| '''Transpose'''
|-
| 0x5
| 1
| '''Volume'''
|-
| 0x6
| 1
| '''Priority Offset'''
|-
| 0x7
| 1
| '''Surround Pan'''; (0: extreme forward, 64: center, 127: extreme rearward)
|-
| 0x8
| 1
| '''Pan'''; (0: extreme left, 64: center, 127: extreme right)
|-
| 0xC
| colspan=2 {{Unknown|Padded to 12 bytes}}
|}

The entire Pool chunk is terminated by a value of 0xFFFF.

=== Project ===

The Project properties chunk contains values for the sounds, including priority, polyphony, volume, etc.

Structurally, the Project is the root of the Audio Group tree, defining one or more ''Song Groups'' or ''SFX Groups''

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Group end offset''' (points to next group in project)
|-
| 0x2
| 2
| '''Group ID'''
|-
| 0x4
| 2
| '''Group Type'''; 0 for SongGroup (for use with [[CSNG (File Format)|CSNG]]), 1 for SFXGroup.
|-
| 0x8
| 4
| '''SoundMacro ID table offset'''
|-
| 0xC
| 4
| '''Sample ID table offset'''
|-
| 0x10
| 4
| '''Tables table offset'''
|-
| 0x14
| 4
| '''Keymaps table offset'''
|-
| 0x18
| 4
| '''Layers table offset'''
|-
| 0x1C
| 4
| '''Normal page table''' (SongGroup) / '''SFX table offset''' (SFXGroup)
|-
| 0x20
| 4
| '''Drum page table offset''' (SongGroup)
|-
| 0x24
| 4
| '''MIDI Setup table offset''' (SongGroup)
|-
| 0x20
| colspan=2 {{unknown|End of group header}}
|}

After the header are a number of data tables.

==== SoundMacro ID Table ====

This is a ranged-table of shorts; there's no count value, so it's terminated with a value of 0xFFFF. It's a list of SoundMacro IDs present in the file. Contiguous ranges are expressed by IDs with most-significant bit set (0x8000). The range begins on the marked ID and incrementally reaches the next ID in the list, including that ID. All other IDs are singular.

==== Sample ID / Table / Keymap / Layer Tables ====

These function the same way as the SoundMacro ID table, but indexes other types of entities instead.

==== Normal / Drum Page Entry ====

Used to map [https://www.midi.org/specifications/item/gm-level-1-sound-set General MIDI program numbers] (instruments)
to sound entities (macros, keymaps, layers)

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''ObjectID'''
|-
| 0x2
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x3
| 1
| '''Max number of voices'''
|-
| 0x4
| 1
| '''GM Program Number'''
|-
| 0x5
| 1
| '''Padding'''
|}

==== SFX Entry ====

Used to map auto-generated <code>#define</code> IDs (used by game code) to sound entities (macros, keymaps, layers)

This table begins with a 16-bit count value, then 16 bits of padding. Each entry in the table is 10 bytes.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''DefineID'''; referenced by game code
|-
| 0x2
| 2
| '''ObjectID'''
|-
| 0x4
| 1
| '''Priority'''; voices are limited, so priority is used to play more important sounds over others
|-
| 0x5
| 1
| '''Max number of voices'''
|-
| 0x6
| 1
| '''Definite Velocity'''; volume (usually 7F)
|-
| 0x7
| 1
| '''Panning'''
|-
| 0x8
| 2
| '''Definite Key'''; The default pitch (usually 0x3C00... the second byte may possibly be the MIDI channel)
|}

==== MIDI Setup Entry ====

Table of fixed-length tables to map all 16 MIDI channels to program numbers
(in-turn resolving to sound entities via the page table).

Multiple MIDI Setups may be created to support Song data requiring totally different
banks of instruments.

Each MIDI Setup starts with a u16 '''MIDI-Setup-ID''', then 16-bits padding, then 16 entries of the following structure (one for each channel):

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 1
| '''Program Number'''
|-
| 0x1
| 1
| '''Volume'''
|-
| 0x2
| 1
| '''Panning'''
|-
| 0x3
| 1
| '''Reverb'''
|-
| 0x4
| 1
| '''Chorus'''
|}

MIDI setups continue until the ''group end offset'' is reached.

=== Sample ===

The Sample chunk is all the sound data encoded using the standard Gamecube DSP ADPCM codec. It can be decoded the same way as a [[DSP (File Format)|DSP]] file. Each sound's size is padded to 32 bytes before the next sound's data begins.

=== Sample Directory ===

The Sample Directory chunk (chunk 4 in Metroid Prime, chunk 3 in Metroid Prime 2) is made up of two sets of tables. The structure of both these tables is identical between both games.

==== Table A ====

The first metadata table has one entry per sound, and is terminated with 0xFFFFFFFF; since there's no known sound count anywhere in the file, the only way to read this correctly is to read until you reach the terminator value. Each entry is 0x20 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Sound ID'''
|-
| 0x2
| 2
| '''Padding'''; always 0
|-
| 0x4
| 4
| '''Sound start offset''', relative to the start of the ADPCM chunk
|-
| 0x8
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| 1
| '''Base Note'''; Corresponds to the MIDI note played in the sample, at the native sample-rate (which MusyX obtains from the INST chunk of .aiff files or SMPL chunk of .wav files, along with looping info). To play at a specified pitch in [[wikipedia:Cent (music)|cents]], set the playback sample rate using this formula: <code>sampleRate * 2((pitch - baseNote * 100) / 1200.0)</code>
|-
| 0xD
| 1
| '''Padding'''; always 0
|-
| 0xE
| 2
| '''Sample rate'''
|-
| 0x10
| 1
| '''Audio format''' <ol start="0"><li>DSP-ADPCM</li><li>DSP-ADPCM (Drum Sample)</li><li>PCM</li><li>N64-VADPCM (Legacy Format)</li></ol>
|-
| 0x11
| 3
| '''Number of samples'''
|-
| 0x14
| 4
| '''Loop start sample'''
|-
| 0x18
| 4
| '''Loop length''', in samples. To get the loop end sample, add this to the start sample and subtract 1.
|-
| 0x1C
| 4
| '''Table B entry offset''', relative to the start of the sound metadata chunk
|-
| 0x20
| colspan=2 {{unknown|End of entry}}
|}

==== Table B ====

These are accessed through the offsets in table A's entries; note that it might not match the sound count, because the same entry in this table can be used with multiple sounds. Each entry is 0x28 bytes long.

{|class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| {{unknown|'''Unknown'''; always 8}}
|-
| 0x2
| 1
| '''Initial predictor/scale''' (matches first frame header)
|-
| 0x3
| 1
| '''Loop predictor/scale''' (matches loop start frame header)
|-
| 0x4
| 2
| '''Loop context sample history 2'''
|-
| 0x6
| 2
| '''Loop context sample history 1'''
|-
| 0x8
| 2 × 16
| '''Decode coefficients'''
|-
| 0x28
| colspan=2 {{unknown|End of entry}}
|}

== Tools ==

* [https://drive.google.com/file/d/0B9MLV21H7SDvemgwN1daYnliSjA/view?usp=sharing Prime Audio Decoder] by Aruki will dump all sound effects contained in a given AGSC file.

[[Category:File Formats]]
[[Category:Audio]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

Dock (Metroid Prime)

2018-05-28T00:51:45Z

Antidote: /* Parameters */

A '''Dock''' is a script object that handles inter-area transitions. It is responsible for loading adjacent areas and for transitioning Samus from one to the other when she passes through it. Docks are often accompanied by doors, but this is not required.

__TOC__

== Parameters ==

{| class="wikitable"
! Offset
! Data Type
! Length
! Name
! Description
|-
| 0x0
| string
| N
| '''Instance Name'''
|
|-
| N+0x0
| bool
| 1
| '''Active'''
|
|-
| N+0x1
| CVector3f
| 12
| '''Position'''
|
|-
| N+0xD
| CVector3f
| 12
| '''Scale'''
|
|-
| N+0x19
| long
| 4
| '''Dock ID'''
| ID number for this dock instance in this area.
|-
| N+0x1D
| long
| 4
| '''Area ID'''
| [[MLVL (File Format)|MLVL]] index for this area
|-
| N+0x21
| bool
| 1
| '''Load Connected On Initialization'''
| Loads the connected area upon area initialization
|}

== States ==

== Messages ==

{| class="wikitable"
! ID
! Name
! Effect
|-
| 0x5
| Decrement
| Stop rendering attached area
|-
| 0x7
| Increment
| Start rendering attached area
|-
| 0xC
| SetToMax
| Load attached area
|-
| 0xD
| SetToZero
| Unload attached area
|}

Tweaks (Metroid Prime)

2017-08-23T00:19:17Z

Antidote: /* Game */

The tweaks system allows for easy modification of different game values that would normally be hardcoded. In Metroid Prime, this is handled by the CTWK files located in Tweaks.Pak. The tweaks are loaded on startup. Things that can be modified through the tweaks includes:

* The amount and type of damage done by each weapon
* The Hard Mode damage multiplier
* The field of view
* The world pak prefix

...and a lot more.

__TOC__

== CTWK List ==

These are all the CTWK files:

{| class="wikitable"
! File
! Name
|-
| 1d180d7c.CTWK
| Particle
|-
| 264a4972.CTWK
| Player
|-
| 33b3323a.CTWK
| GunRes
|-
| 39ad28d3.CTWK
| CameraBob
|-
| 3faec012.CTWK
| PlayerControls2
|-
| 5ed56350.CTWK
| Ball
|-
| 5f24eff8.CTWK
| SlideShow
|-
| 6907a32d.CTWK
| PlayerGun
|-
| 85ca11e9.CTWK
| PlayerRes
|-
| 94c76ecd.CTWK
| Targeting
|-
| 953a7c63.CTWK
| Game
|-
| c9954e56.CTWK
| GuiColors
|-
| e66a4f86.CTWK
| AutoMapper
|-
| ed2e48a9.CTWK
| Gui
|-
| f1ed8fd7.CTWK
| PlayerControls
|}

== Game ==

{| class="wikitable"
! Offset
! Type
! Description
! Value
|-
| 0x0
| string
| '''World pak prefix'''
| "Metroid"
|-
| 0x8
| string
| {{unknown|'''Unknown'''}}
| "ruin_area22"
|-
| 0x14
| float
| '''Field of View'''
| 55.0
|-
| 0x18
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x19
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x1A
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x1B
| bool
| '''Disable Splash Screens'''; Game hard codes this value to false.
| true
|-
| 0x1C
| float
| {{unknown|'''Unknown'''}}
| 25.0
|-
| 0x20
| float
| '''Press Start Delay'''
| 1.0
|-
| 0x24
| float
| '''Normal Water Wavecap Intensity'''
| 450.0
|-
| 0x28
| float
| '''Poison Water Wavecap Intensity'''
| 400.0
|-
| 0x2C
| float
| '''Lava Wavecap Intensity'''
| 1750.0
|-
| 0x30
| float
| '''Normal Water Ripple Intensity'''
| 1.0
|-
| 0x34
| float
| '''Poison Water Ripple Intensity'''
| 1.2
|-
| 0x38
| float
| '''Lava Ripple Intensity'''
| 0.5
|-
| 0x3C
| float
| '''Fluid Environment Bump Scale'''
| 0.25
|-
| 0x40
| float
| {{unknown|'''Unknown'''}}
| 30.0
|-
| 0x44
| float
| {{unknown|'''Unknown'''}}
| 125.0
|-
| 0x48
| float
| {{unknown|'''Unknown'''}}
| 150.0
|-
| 0x4C
| float
| {{unknown|'''Unknown'''}}
| 300.0
|-
| 0x50
| float
| '''Hard Mode damage multiplier'''
| 1.53
|-
| 0x54
| float
| '''Hard Mode weapons multiplier'''
| 0.5
|}

Tweaks (Metroid Prime)

2017-08-22T23:51:59Z

Antidote:

The tweaks system allows for easy modification of different game values that would normally be hardcoded. In Metroid Prime, this is handled by the CTWK files located in Tweaks.Pak. The tweaks are loaded on startup. Things that can be modified through the tweaks includes:

* The amount and type of damage done by each weapon
* The Hard Mode damage multiplier
* The field of view
* The world pak prefix

...and a lot more.

__TOC__

== CTWK List ==

These are all the CTWK files:

{| class="wikitable"
! File
! Name
|-
| 1d180d7c.CTWK
| Particle
|-
| 264a4972.CTWK
| Player
|-
| 33b3323a.CTWK
| GunRes
|-
| 39ad28d3.CTWK
| CameraBob
|-
| 3faec012.CTWK
| PlayerControls2
|-
| 5ed56350.CTWK
| Ball
|-
| 5f24eff8.CTWK
| SlideShow
|-
| 6907a32d.CTWK
| PlayerGun
|-
| 85ca11e9.CTWK
| PlayerRes
|-
| 94c76ecd.CTWK
| Targeting
|-
| 953a7c63.CTWK
| Game
|-
| c9954e56.CTWK
| GuiColors
|-
| e66a4f86.CTWK
| AutoMapper
|-
| ed2e48a9.CTWK
| Gui
|-
| f1ed8fd7.CTWK
| PlayerControls
|}

== Game ==

{| class="wikitable"
! Offset
! Type
! Description
! Value
|-
| 0x0
| string
| '''World pak prefix'''
| "Metroid"
|-
| 0x8
| string
| {{unknown|'''Unknown'''}}
| "ruin_area22"
|-
| 0x14
| float
| '''Field of View'''
| 55.0
|-
| 0x18
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x19
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x1A
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x1B
| bool
| '''Disable Splash Screens'''; Game hard codes this value to false.
| true
|-
| 0x1C
| float
| {{unknown|'''Unknown'''}}
| 25.0
|-
| 0x20
| float
| '''Press Start Delay'''
| 1.0
|-
| 0x24
| float
| '''Normal Water Wavecap Intensity'''
| 450.0
|-
| 0x28
| float
| '''Poison Water Wavecap Intensity'''
| 400.0
|-
| 0x2C
| float
| '''Lava Wavecap Intensity'''
| 1750.0
|-
| 0x30
| float
| '''Normal Water Ripple Intensity'''
| 1.0
|-
| 0x34
| float
| '''Normal Water Ripple Intensity'''
| 1.2
|-
| 0x38
| float
| '''Lava Ripple Intensity'''
| 0.5
|-
| 0x3C
| float
| '''Fluid Environment Bump Scale'''
| 0.25
|-
| 0x40
| float
| {{unknown|'''Unknown'''}}
| 30.0
|-
| 0x44
| float
| {{unknown|'''Unknown'''}}
| 125.0
|-
| 0x48
| float
| {{unknown|'''Unknown'''}}
| 150.0
|-
| 0x4C
| float
| {{unknown|'''Unknown'''}}
| 300.0
|-
| 0x50
| float
| '''Hard Mode damage multiplier'''
| 1.53
|-
| 0x54
| float
| '''Hard Mode weapons multiplier'''
| 0.5
|}

HINT (File Format)

2017-05-25T11:45:57Z

Antidote:

The '''HINT format''' is used to manage the hint system, controlling what hints pop up, what they say, and where they point to.

{{research|1|There are a couple unknown fields.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Magic'''; always 0x00BADBAD
|-
| 0x4
| 4
| '''Version'''; 1 in Prime/Echoes, 3 in Corruption
|-
| 0x8
| 4
| '''Hint count'''
|-
| 0xC
| colspan=2 {{unknown|Hint entries start}}
|}

=== Hint ===

{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Hint name'''
|-
| float
| 1
| '''Immediate Time'''
|-
| float
| 1
| '''Normal time'''; the amount of time that passes from when the hint is activated to when it appears on the HUD
|-
| u32/u64
| 1
| '''Pop-up text STRG ID'''; u32 in Metroid Prime 1/2, u64 in Metroid Prime 3
|-
| float
| 1
| '''Text Time'''
|-
| u32
| 1
| '''Location Count'''
|-
| [[#HintLocation|HintLocation]]
| locationCount
| '''Hint Locations'''; Areas where this hint appears.
|}

===HintLocation===

{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| '''Target world MLVL ID'''
|-
| u32
| 1
| '''Target room MREA ID'''
|-
| u32
| 1
| '''Target room index'''
|-
| u32
| 1
| '''Map text STRG ID'''
|-
| colspan=5 {{unknown|End of entry}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]

HINT (File Format)

2017-05-25T11:45:20Z

Antidote: /* Hint */

The '''HINT format''' is used to manage the hint system, controlling what hints pop up, what they say, and where they point to.

{{research|1|There are a couple unknown fields.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Magic'''; always 0x00BADBAD
|-
| 0x4
| 4
| '''Version'''; 1 in Prime/Echoes, 3 in Corruption
|-
| 0x8
| 4
| '''Hint count'''
|-
| 0xC
| colspan=2 {{unknown|Hint entries start}}
|}

=== Hint ===

{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Hint name'''
|-
| float
| 1
| '''Immediate Time'''
|-
| float
| 1
| '''Normal time'''; the amount of time that passes from when the hint is activated to when it appears on the HUD
|-
| u32/u64
| 1
| '''Pop-up text STRG ID'''; u32 in Metroid Prime 1/2, u64 in Metroid Prime 3
|-
| float
| 1
| '''Text Time'''
|-
| u32
| 1
| '''Location Count'''
|-
| [[#SHintLocation|SHintLocation]]
| locationCount
| '''Hint Locations'''; Areas where this hint appears.
|}

===SHintLocation===

{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| '''Target world MLVL ID'''
|-
| u32
| 1
| '''Target room MREA ID'''
|-
| u32
| 1
| '''Target room index'''
|-
| u32
| 1
| '''Map text STRG ID'''
|-
| colspan=5 {{unknown|End of entry}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]

Animation Events (File Format)

2017-03-03T22:01:16Z

Antidote: /* Event Base */

{{research|1|Some event parameters need research}}
'''Animation events''' control functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. The events can be found in different places in each game; in Prime 1, they are stored in their own file format, the '''EVNT format'''. In Echoes, the format is the same as Prime 1, but was merged in to the [[ANCS (File Format)|ANCS format]] instead of getting its own file. In Prime 3 and the Donkey Kong Country series, events can be found in the [[CHAR (File Format)|CHAR format]], as well as Prime 3's [[SAND (File Format)|SAND format]].

== Format ==

=== File Structure (Metroid Prime 1/2) ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1/2
! MP3
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{check}}
| {{check}}
|-
| string
| 1
| '''Event Name'''
|
| {{check}}
| {{check}}
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
| {{check}}
| {{check}}
|-
| [[Char Anim Time]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| bool
| 1
| {{unknown|Unknown}}
|
| {{check}}
| {{check}}
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
| {{check}}
| {{check}}
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

==== Metroid Prime 1/2 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

==== Metroid Prime 3 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u8
| 1
| {{unknown}}
|
|-
| u16
| 1
| {{unknown}}
|
|-
| u16
| 1
| {{unknown}}
|
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
! MP3
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
| {{nocheck}}
|-
| {{FourCC}}
| 1
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
| {{nocheck}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
| {{nocheck}}
|-
| float
| 1
| {{unknown}}
| Probably effect scale?
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
| Probably bone ID?
| {{nocheck}}
| {{nocheck}}
| {{check}}
|}

=== Sound Event ===

==== Metroid Prime 1/2 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

==== Metroid Prime 3 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| Asset ID ([[CAUD (File Format)|CAUD]])
| 1
| '''Sound Effect'''
| Sound to be played.
|-
| u32
| 1
| {{unknown}}
|
|-
| u32
| 1
| {{unknown}}
|
|-
| [[#Unknown Typed Structure|Unknown Typed Structure]]
| 1
| {{unknown}}
|
|-
| [[#Unknown Typed Structure|Unknown Typed Structure]]
| 1
| {{unknown}}
|
|}

===== Unknown Typed Structure =====

Contains a 32-bit type value, followed by either:

* Type 0: Nothing
* Type 1: A float
* Type 2: A [[Maya Spline]]

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

Animation Events (File Format)

2017-03-03T22:01:00Z

Antidote: /* Event Base */

{{research|1|Some event parameters need research}}
'''Animation events''' control functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. The events can be found in different places in each game; in Prime 1, they are stored in their own file format, the '''EVNT format'''. In Echoes, the format is the same as Prime 1, but was merged in to the [[ANCS (File Format)|ANCS format]] instead of getting its own file. In Prime 3 and the Donkey Kong Country series, events can be found in the [[CHAR (File Format)|CHAR format]], as well as Prime 3's [[SAND (File Format)|SAND format]].

== Format ==

=== File Structure (Metroid Prime 1/2) ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1/2
! MP3
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{check}}
| {{check}}
|-
| string
| 1
| '''Event Name'''
|
| {{check}}
| {{check}}
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
| {{check}}
| {{check}}
|-
| [[Char Anim Time]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| bool
| 1
| {{unknown|Unknown}}
|
| {{check}}
| {{check}}
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
| {{check}}
| {{check}}
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown}
|
| {{nocheck}}
| {{check}}
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

==== Metroid Prime 1/2 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

==== Metroid Prime 3 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u8
| 1
| {{unknown}}
|
|-
| u16
| 1
| {{unknown}}
|
|-
| u16
| 1
| {{unknown}}
|
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
! MP3
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
| {{nocheck}}
|-
| {{FourCC}}
| 1
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
| {{nocheck}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
| {{nocheck}}
|-
| float
| 1
| {{unknown}}
| Probably effect scale?
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| u32
| 1
| {{unknown}}
| Probably bone ID?
| {{nocheck}}
| {{nocheck}}
| {{check}}
|}

=== Sound Event ===

==== Metroid Prime 1/2 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

==== Metroid Prime 3 ====

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| Asset ID ([[CAUD (File Format)|CAUD]])
| 1
| '''Sound Effect'''
| Sound to be played.
|-
| u32
| 1
| {{unknown}}
|
|-
| u32
| 1
| {{unknown}}
|
|-
| [[#Unknown Typed Structure|Unknown Typed Structure]]
| 1
| {{unknown}}
|
|-
| [[#Unknown Typed Structure|Unknown Typed Structure]]
| 1
| {{unknown}}
|
|}

===== Unknown Typed Structure =====

Contains a 32-bit type value, followed by either:

* Type 0: Nothing
* Type 1: A float
* Type 2: A [[Maya Spline]]

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

PAS Database

2017-03-03T21:51:28Z

Antidote:

The '''Parameterized Animation State Database''' is an animation-related thing that appears in every Retro game. It can be found in the [[ANCS (File Format)|ANCS format]] in Metroid Prime 1 and 2, and the [[CHAR (File Format)|CHAR format]] in Metroid Prime 3, Donkey Kong Country Returns, and Donkey Kong Country: Tropical Freeze.

__TOC__

== Format ==

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| {{FourCC}}
| 1
| '''Magic'''
| Always <code>PAS4</code>
|-
| u32
| 1
| '''Anim State Count'''
| Number of anim states
|-
| u32
| 1
| '''Default Anim State'''
| Anim state used by the character by default. If there are no anim states, this will be set to -1.
|-
| [[#Anim State|Anim State]]
| ''Anim State Count''
| '''Anim State Array'''
| Array of anim states.
|}

=== Anim State ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| {{unknown|Unknown}}
|
|-
| u32
| 1
| '''Parm Info Count'''
| Number of parameters
|-
| u32
| 1
| '''Anim Info Count'''
| Number of animations
|-
| [[#Parm Info|Parm Info]]
| ''Parm Info Count''
| '''Parm Info Array'''
| Describes parameters in this anim state
|-
| [[#Anim Info|Anim Info]]
| ''Anim Info Count''
| '''Anim Info Array'''
| Describes animations in this anim state
|}

=== Parm Info ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| [[#Parm Type|'''Parm Type''']]
| Parameter type. This value controls the type of other values in the Parm Info and Anim Info structures.
|-
| u32
| 1
| [[#Weight Function|'''Weight Function''']]
| Specifies the weighting algorithm used for this parameter during selection.
|-
| float
| 1
| Weight
| Specifies how much influence this parameter has during selection.
|-
| ''Parm Type''
| 1
| Min Value
| Minimum value this parameter can represent, the exact meaning depends on the context within the class implementation that uses it.
|-
| ''Parm Type''
| 1
| Max Value
| Maximum value this parameter can represent, the exact meaning depends on the context within the class implementation that uses it.
|}

=== Anim Info ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Anim ID'''
| This is a character-relative anim index. This should be indexed into the character's anim list to get the animset-relative index.
|-
| ''Parm Type''
| ''Parm Info Count''
| '''Parm Values Array'''
| This array contains one value per Parm Info. The type of each value is determined by the corresponding Parm Info's ''Parm Type'' value.
|}

=== Parm Type ===

{| class="wikitable"
! ID
! Type
|-
| 0
| Int32
|-
| 1
| Uint32
|-
| 2
| Real
|-
| 3
| Bool
|-
| 4
| Enum
|}

=== Weight Function ===

{| class="wikitable"
! ID
! Type
|-
| 0
| ExactMatch
|-
| 1
| PercentError
|-
| 2
| AngularPercent
|-
| 3
| NoWeight
|}

[[Category:File Formats]]
[[Category:Metroid Prime Demo]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2 Demo]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3 Prototype]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]
[[Category:Donkey Kong Country: Tropical Freeze]]

ANCS (File Format)

2016-09-10T02:29:21Z

Antidote: /* MetaAnimation */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| Scale
|-
| u32
| Parented Mode
|-
| u32
| Flags
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Play|Play]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Play
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Play====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-09-10T02:28:53Z

Antidote: /* Primitive */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| Scale
|-
| u32
| Parented Mode
|-
| u32
| Flags
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Play
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Play====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-09-10T02:28:36Z

Antidote: /* EMetaAnimationType */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| Scale
|-
| u32
| Parented Mode
|-
| u32
| Flags
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Play
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-09-10T02:26:58Z

Antidote: /* EffectComponent */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| Scale
|-
| u32
| Parented Mode
|-
| u32
| Flags
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-09-10T02:21:51Z

Antidote: /* EffectComponent */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| Scale
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

UV Animations

2016-09-03T07:27:20Z

Antidote: /* Animation Modes */

'''UV animations''' are used to animate texture coordinates. They're present in the material data of the Metroid Prime trilogy and Donkey Kong Country Returns. There are 13 animation types across those four games.

{{research|moderate|Modes 8/10/11/12/13 are unknown}}

__TOC__

== Format ==

UV animations generally contain an int indicating what animation type they are, followed by float parameters. The number of parameters depends on the animation mode; some modes don't have any parameters while some have as many as 9.

=== Metroid Prime 1/2 ===

At the end of the material data, there's a 32-bit animations size value, then an animation count. Each animation is structured as:

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u32
| 4
| '''Animation type'''
|-
| 0x4
| float[]
| -
| '''Parameters'''
|}

=== Metroid Prime 3/Donkey Kong Country Returns ===

Animations are located at the end of each PASS section. There's no animation count; instead, one animation can be supplied per pass and can be directly associated with that pass. Like Prime 1, the animation data follows a 32-bit animations size value.

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| {{unknown|'''Unknown'''}}
|-
| 0x2
| u16
| 2
| {{unknown|'''Unknown'''}}
|-
| 0x4
| u32
| 4
| '''Animation Mode'''
|-
| 0x8
| float[]
| -
| '''Parameters'''
|}

== Animation Modes ==

{| class="wikitable"
! Mode
! Name
! Params
! MP1
! MP2
! MP3
! DKCR
|-
| 0
| [[#Mode_0:_Inverse ModelView Matrix (No Translation)|Inverse ModelView Matrix (No Translation)]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 1
| [[#Mode_1:_Inverse ModelView Matrix|Inverse ModelView Matrix]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 2
| [[#Mode_2:_UV Scroll|UV Scroll]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 3
| [[#Mode_3:_Rotation|Rotation]]
| 2
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 4
| [[#Mode_4/5:_Horizontal/Vertical_Filmstrip|Horizontal Filmstrip]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 5
| [[#Mode_4/5:_Horizontal/Vertical_Filmstrip|Vertical Filmstrip]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 6
| [[#Mode_6:_Model Matrix|Model Matrix]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| 7
| [[#Mode_7:_Cylinder Environment|Cylinder Environment]]
| 2
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 8
| {{unknown|Unknown mode}}
| 9
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 10
| {{unknown|[[#Mode_10:_Another_reflection_mode|Another reflection mode]]}}
| 0
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 11
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 12
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 13
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
|}

For all of the following modes, ''s'' refers to ''seconds mod 900''.

==== Mode 0: Inverse ModelView Matrix (No Translation) ====

This mode is commonly used with vertex normals to simulate reflective surfaces using spheremaps that move with the camera. It takes no parameters, and will generate both a texture matrix and a post-transform matrix. Translation is ignored.

The texture matrix is calculated like this. Note that the multiplication of the view matrix by the model matrix should be modified slightly rather than being a straight multiplication to ignore translation on the model matrix. (The game uses a function called MultiplyIgnoreTranslation for this.)

<pre>texmtx = inverse(ViewMatrix) * ModelMatrix;
texmtx[0][3] = texmtx[1][3] = texmtx[2][3] = 0;</pre>

The post-transform matrix is a constant value. The purpose of it is to adjust the normalized texture coordinates so that they range from 0 to 1.

<pre>0.5, 0.0, 0.0, 0.5,
0.0, 0.0, 0.5, 0.5,
0.0, 0.0, 0.0, 1.0</pre>

==== Mode 1: Inverse ModelView Matrix ====

This mode is nearly identical to mode 0; the only difference is that translation is left as-is. The multiplication of the view matrix by the model matrix actually is a straight multiplication in this mode, and the translation values on the texture matrix aren't set to 0.

==== Mode 2: UV Scroll ====

This mode is used to scroll both U and V at the same time. It will only generate a texture matrix. It has four float parameters: ''offsetA'', ''offsetB'', ''scaleA'', and ''scaleB''.

<pre>uOffset = (s * scaleA) + offsetA;
vOffset = (s * scaleB) + offsetB;</pre>

==== Mode 3: Rotation ====

This mode rotates the texture. It will only generate a texture matrix. It has two float parameters: ''offset'' and ''scale''.

<pre>float angle = (s * scale) + offset;
float acos = cos(angle);
float asin = sin(angle);
float translateX = (1.0 - (acos - asin)) * 0.5;
float translateY = (1.0 - (asin + acos)) * 0.5;</pre>

The resulting texture matrix is laid out as:

<pre>acos, -asin, 0.0, translateX,
asin, acos, 0.0, translateY,
0.0, 0.0, 1.0, 0.0</pre>

==== Mode 4/5: Horizontal/Vertical Filmstrip ====

These modes can be used to create a filmstrip-like effect. The texture steps a set distance each animation frame, rather than the scroll being smoothly interpolated every game frame. The same calculation is done for both modes, with the only difference being whether the calculated offset is applied to the U or V coordinate. It will only generate a texture matrix. There are four float parameters: ''scale'', ''numFrames'', ''step'', and ''offset''.

The animation is made up of a number of pseudo-frames, where ''step'' controls the amount that the texture scrolls by each frame, and ''numFrames'' sets how many frames are iterated through before resetting back to 0. ''scale'' roughly controls animation playback speed, and ''offset'' modifies the time input value.

<pre>float value = step * scale * (offset + s);
float uv_offset = (float)(short)(float)(numFrames * fmod(value, 1.0f)) * step;</pre>

==== Mode 6: Model Matrix ====

This mode is similar to modes 0 and 1 in that it simulates reflective surfaces, but it only takes the model matrix into account, which means camera movement doesn't affect the reflection. It takes no parameters and it generates both a texture matrix and a post-transform matrix.

The texture matrix is simply the model matrix, with the translation values set to 0. The post-transform matrix is set to the following:

<pre>0.5, 0.0, 0.0, ModelMatrix[0][3] * 0.50000001,
0.0, 0.0, 0.5, ModelMatrix[1][3] * 0.5</pre>

==== Mode 7: Cylinder Environment ====

Mode 7 takes two parameters and generates both a texture matrix and a post-transform matrix, projecting the UVs onto the surface of a cylinder, used almost exclusively on pipes.

The texture matrix is generated the same way as in mode 0; translation is ignored.

<pre>texmtx = inverse(ViewMatrix) * ModelMatrix;
texmtx[0][3] = texmtx[1][3] = texmtx[2][3] = 0;</pre>

The post-transform matrix is where it gets a little complicated. A little math is required to calculate some values:

<pre>float xy = ((ViewMatrix[0][3] + ViewMatrix[1][3]) * 0.025f * ParamB;
xy = (xy - (int) xy); // This truncates the integer portion of the value, leaving only the fractional part (mantissa).

float z = ViewMatrix[2][3] * 0.05f * ParamB;
z = (z - (int) z);

float halfA = ParamA * 0.5f;</pre>

The post-transform matrix is then constructed as:

<pre>halfA, 0.0f, 0.0f, xy,
0.0f, 0.0f, halfA, z,
0.0f, 0.0f, 0.0f, 1.0f</pre>

==== Mode 10: Another reflection mode ====

This one needs more research done, but the only thing the game does with this mode is load this post-transform matrix:

<pre>0.5, 0.0, 0.0, 0.5,
0.0, 0.0, 0.5, 0.5,
0.0, 0.0, 0.0, 1.0</pre>

The function of this matrix is to transform normalized texture coords so that they range from 0 to 1, instead of from -1 to 1. This mode seems to work well with mode 0's settings, though, so it's possible that the game is creating a texture matrix somewhere else. This needs some looking into.

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

UV Animations

2016-09-03T07:26:42Z

Antidote: /* Mode 7: Convoluted reflection mode */

'''UV animations''' are used to animate texture coordinates. They're present in the material data of the Metroid Prime trilogy and Donkey Kong Country Returns. There are 13 animation types across those four games.

{{research|moderate|Modes 8/10/11/12/13 are unknown}}

__TOC__

== Format ==

UV animations generally contain an int indicating what animation type they are, followed by float parameters. The number of parameters depends on the animation mode; some modes don't have any parameters while some have as many as 9.

=== Metroid Prime 1/2 ===

At the end of the material data, there's a 32-bit animations size value, then an animation count. Each animation is structured as:

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u32
| 4
| '''Animation type'''
|-
| 0x4
| float[]
| -
| '''Parameters'''
|}

=== Metroid Prime 3/Donkey Kong Country Returns ===

Animations are located at the end of each PASS section. There's no animation count; instead, one animation can be supplied per pass and can be directly associated with that pass. Like Prime 1, the animation data follows a 32-bit animations size value.

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| {{unknown|'''Unknown'''}}
|-
| 0x2
| u16
| 2
| {{unknown|'''Unknown'''}}
|-
| 0x4
| u32
| 4
| '''Animation Mode'''
|-
| 0x8
| float[]
| -
| '''Parameters'''
|}

== Animation Modes ==

{| class="wikitable"
! Mode
! Name
! Params
! MP1
! MP2
! MP3
! DKCR
|-
| 0
| [[#Mode_0:_Inverse ModelView Matrix (No Translation)|Inverse ModelView Matrix (No Translation)]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 1
| [[#Mode_1:_Inverse ModelView Matrix|Inverse ModelView Matrix]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 2
| [[#Mode_2:_UV Scroll|UV Scroll]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 3
| [[#Mode_3:_Rotation|Rotation]]
| 2
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 4
| [[#Mode_4/5:_Horizontal/Vertical_Filmstrip|Horizontal Filmstrip]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 5
| [[#Mode_4/5:_Horizontal/Vertical_Filmstrip|Vertical Filmstrip]]
| 4
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 6
| [[#Mode_6:_Model Matrix|Model Matrix]]
| 0
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| 7
| [[#Mode_7:_Convoluted reflection mode|Convoluted reflection mode]]
| 2
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 8
| {{unknown|Unknown mode}}
| 9
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 10
| {{unknown|[[#Mode_10:_Another_reflection_mode|Another reflection mode]]}}
| 0
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 11
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 12
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| 13
| {{unknown|Unknown mode}}
| 2
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
|}

For all of the following modes, ''s'' refers to ''seconds mod 900''.

==== Mode 0: Inverse ModelView Matrix (No Translation) ====

This mode is commonly used with vertex normals to simulate reflective surfaces using spheremaps that move with the camera. It takes no parameters, and will generate both a texture matrix and a post-transform matrix. Translation is ignored.

The texture matrix is calculated like this. Note that the multiplication of the view matrix by the model matrix should be modified slightly rather than being a straight multiplication to ignore translation on the model matrix. (The game uses a function called MultiplyIgnoreTranslation for this.)

<pre>texmtx = inverse(ViewMatrix) * ModelMatrix;
texmtx[0][3] = texmtx[1][3] = texmtx[2][3] = 0;</pre>

The post-transform matrix is a constant value. The purpose of it is to adjust the normalized texture coordinates so that they range from 0 to 1.

<pre>0.5, 0.0, 0.0, 0.5,
0.0, 0.0, 0.5, 0.5,
0.0, 0.0, 0.0, 1.0</pre>

==== Mode 1: Inverse ModelView Matrix ====

This mode is nearly identical to mode 0; the only difference is that translation is left as-is. The multiplication of the view matrix by the model matrix actually is a straight multiplication in this mode, and the translation values on the texture matrix aren't set to 0.

==== Mode 2: UV Scroll ====

This mode is used to scroll both U and V at the same time. It will only generate a texture matrix. It has four float parameters: ''offsetA'', ''offsetB'', ''scaleA'', and ''scaleB''.

<pre>uOffset = (s * scaleA) + offsetA;
vOffset = (s * scaleB) + offsetB;</pre>

==== Mode 3: Rotation ====

This mode rotates the texture. It will only generate a texture matrix. It has two float parameters: ''offset'' and ''scale''.

<pre>float angle = (s * scale) + offset;
float acos = cos(angle);
float asin = sin(angle);
float translateX = (1.0 - (acos - asin)) * 0.5;
float translateY = (1.0 - (asin + acos)) * 0.5;</pre>

The resulting texture matrix is laid out as:

<pre>acos, -asin, 0.0, translateX,
asin, acos, 0.0, translateY,
0.0, 0.0, 1.0, 0.0</pre>

==== Mode 4/5: Horizontal/Vertical Filmstrip ====

These modes can be used to create a filmstrip-like effect. The texture steps a set distance each animation frame, rather than the scroll being smoothly interpolated every game frame. The same calculation is done for both modes, with the only difference being whether the calculated offset is applied to the U or V coordinate. It will only generate a texture matrix. There are four float parameters: ''scale'', ''numFrames'', ''step'', and ''offset''.

The animation is made up of a number of pseudo-frames, where ''step'' controls the amount that the texture scrolls by each frame, and ''numFrames'' sets how many frames are iterated through before resetting back to 0. ''scale'' roughly controls animation playback speed, and ''offset'' modifies the time input value.

<pre>float value = step * scale * (offset + s);
float uv_offset = (float)(short)(float)(numFrames * fmod(value, 1.0f)) * step;</pre>

==== Mode 6: Model Matrix ====

This mode is similar to modes 0 and 1 in that it simulates reflective surfaces, but it only takes the model matrix into account, which means camera movement doesn't affect the reflection. It takes no parameters and it generates both a texture matrix and a post-transform matrix.

The texture matrix is simply the model matrix, with the translation values set to 0. The post-transform matrix is set to the following:

<pre>0.5, 0.0, 0.0, ModelMatrix[0][3] * 0.50000001,
0.0, 0.0, 0.5, ModelMatrix[1][3] * 0.5</pre>

==== Mode 7: Cylinder Environment ====

Mode 7 takes two parameters and generates both a texture matrix and a post-transform matrix, projecting the UVs onto the surface of a cylinder, used almost exclusively on pipes.

The texture matrix is generated the same way as in mode 0; translation is ignored.

<pre>texmtx = inverse(ViewMatrix) * ModelMatrix;
texmtx[0][3] = texmtx[1][3] = texmtx[2][3] = 0;</pre>

The post-transform matrix is where it gets a little complicated. A little math is required to calculate some values:

<pre>float xy = ((ViewMatrix[0][3] + ViewMatrix[1][3]) * 0.025f * ParamB;
xy = (xy - (int) xy); // This truncates the integer portion of the value, leaving only the fractional part (mantissa).

float z = ViewMatrix[2][3] * 0.05f * ParamB;
z = (z - (int) z);

float halfA = ParamA * 0.5f;</pre>

The post-transform matrix is then constructed as:

<pre>halfA, 0.0f, 0.0f, xy,
0.0f, 0.0f, halfA, z,
0.0f, 0.0f, 0.0f, 1.0f</pre>

==== Mode 10: Another reflection mode ====

This one needs more research done, but the only thing the game does with this mode is load this post-transform matrix:

<pre>0.5, 0.0, 0.0, 0.5,
0.0, 0.0, 0.5, 0.5,
0.0, 0.0, 0.0, 1.0</pre>

The function of this matrix is to transform normalized texture coords so that they range from 0 to 1, instead of from -1 to 1. This mode seems to work well with mode 0's settings, though, so it's possible that the game is creating a texture matrix somewhere else. This needs some looking into.

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

Animation Events (File Format)

2016-09-02T07:25:39Z

Antidote: /* TimeType */

{{research|1|Some event parameters need research}}
The '''EVNT format''' is a companion to [[ANIM (File Format)|ANIM]] resources. It controls functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. In Echoes, this format was merged in to the end of the [[ANCS (File Format)|ANCS]] format, but the structure of the file is mostly the same (with a couple changes).

== Format ==

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u16
| 1
| {{unknown|Unknown}}
|
|-
| string
| 1
| '''Event Name'''
|
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
|-
| [[#CCharAnimTime|CCharAnimTime]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
|-
| bool
| 1
| {{unknown|Unknown}}
|
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
|-
| u32
| 1
| {{unknown|Unknown}}
|
|}

====CCharAnimTime====
{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| float
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| [[#TimeType|TimeType]]
| 1
| Value Type
| Describes the current status of the time value
|}

=====TimeType=====
TimeType describes the current status of the animation time, e.g: Non-zero, Increasing from zero, Staying at zero, Decreasing to zero, or Infinity,

{| class="wikitable"
! Name
! Value
|-
| NonZero
| 0
|-
| ZeroIncreasing
| 1
|-
| ZeroSteady
| 2
|-
| ZeroDecreasing
| 3
|-
| Infinity
| 4
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
|-
| char
| 4
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
|}

=== Sound Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

Animation Events (File Format)

2016-09-02T07:24:09Z

Antidote: /* ==TimeType */

{{research|1|Some event parameters need research}}
The '''EVNT format''' is a companion to [[ANIM (File Format)|ANIM]] resources. It controls functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. In Echoes, this format was merged in to the end of the [[ANCS (File Format)|ANCS]] format, but the structure of the file is mostly the same (with a couple changes).

== Format ==

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u16
| 1
| {{unknown|Unknown}}
|
|-
| string
| 1
| '''Event Name'''
|
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
|-
| [[#CCharAnimTime|CCharAnimTime]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
|-
| bool
| 1
| {{unknown|Unknown}}
|
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
|-
| u32
| 1
| {{unknown|Unknown}}
|
|}

====CCharAnimTime====
{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| float
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| [[#TimeType|TimeType]]
| 1
| Value Type
| Describes the current status of the time value
|}

=====TimeType=====
TimeType describes the current status of the animation time, e.g: Non-zero, Increasing from zero, Staying at zero, Decreasing to zero, or Infinity,
the ordering fo

{| class="wikitable"
! Name
! Value
|-
| NonZero
| 0
|-
| ZeroIncreasing
| 1
|-
| ZeroSteady
| 2
|-
| ZeroDecreasing
| 3
|-
| Infinity
| 4
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
|-
| char
| 4
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
|}

=== Sound Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

Animation Events (File Format)

2016-09-02T07:23:58Z

Antidote: /* =CCharAnimTime */

{{research|1|Some event parameters need research}}
The '''EVNT format''' is a companion to [[ANIM (File Format)|ANIM]] resources. It controls functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. In Echoes, this format was merged in to the end of the [[ANCS (File Format)|ANCS]] format, but the structure of the file is mostly the same (with a couple changes).

== Format ==

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u16
| 1
| {{unknown|Unknown}}
|
|-
| string
| 1
| '''Event Name'''
|
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
|-
| [[#CCharAnimTime|CCharAnimTime]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
|-
| bool
| 1
| {{unknown|Unknown}}
|
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
|-
| u32
| 1
| {{unknown|Unknown}}
|
|}

====CCharAnimTime====
{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| float
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| [[#TimeType|TimeType]]
| 1
| Value Type
| Describes the current status of the time value
|}

=====TimeType===
TimeType describes the current status of the animation time, e.g: Non-zero, Increasing from zero, Staying at zero, Decreasing to zero, or Infinity,
the ordering fo

{| class="wikitable"
! Name
! Value
|-
| NonZero
| 0
|-
| ZeroIncreasing
| 1
|-
| ZeroSteady
| 2
|-
| ZeroDecreasing
| 3
|-
| Infinity
| 4
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
|-
| char
| 4
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
|}

=== Sound Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

Animation Events (File Format)

2016-09-02T07:23:37Z

Antidote: /* Event Base */

{{research|1|Some event parameters need research}}
The '''EVNT format''' is a companion to [[ANIM (File Format)|ANIM]] resources. It controls functional events synchronized to rigged animations for things like sound effects, visual effects, character messages, and playback control. In Echoes, this format was merged in to the end of the [[ANCS (File Format)|ANCS]] format, but the structure of the file is mostly the same (with a couple changes).

== Format ==

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u32
| 1
| '''Version'''
| Either 1 or 2. Both can appear in Prime 1, while Echoes uses version 2 (the version number wasn't updated in Echoes despite format changes).
|-
| u32
| 1
| '''Loop Event Count'''
|
|-
| [[#Loop Event|Loop Event]]
| ''Loop Event Count''
| '''Loop Events'''
|
|-
| u32
| 1
| '''User Event Count'''
|
|-
| [[#User Event|User Event]]
| ''User Event Count''
| '''User Events'''
|
|-
| u32
| 1
| '''Effect Event Count'''
|
|-
| [[#Effect Event|Effect Event]]
| ''Effect Event Count''
| '''Effect Events'''
|
|-
| u32
| 1
| '''Sound Event Count'''
| Not present in version 1
|-
| [[#Sound Event|Sound Event]]
| ''Sound Event Count''
| '''Sound Events'''
| Not present in version 1
|}

=== Event Base ===

These parameters are common to every event type.

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| u16
| 1
| {{unknown|Unknown}}
|
|-
| string
| 1
| '''Event Name'''
|
|-
| u16
| 1
| '''Event Type'''
| Enumerated event type (unknown values)
|-
| [[#CCharAnimTime|CCharAnimTime]]
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| u32
| 1
| '''Event Index'''
| Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
|-
| bool
| 1
| {{unknown|Unknown}}
|
|-
| float
| 1
| '''Weight'''
| The likelihood of this event being selected
|-
| s32
| 1
| '''Character Index'''
| Character index that this event should trigger for. If -1, this event triggers for all characters.
|-
| u32
| 1
| {{unknown|Unknown}}
|
|}

====CCharAnimTime===
{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| float
| 1
| '''Event Timestamp'''
| Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
| [[#TimeType|TimeType]]
| 1
| Value Type
| Describes the current status of the time value
|}

=====TimeType===
TimeType describes the current status of the animation time, e.g: Non-zero, Increasing from zero, Staying at zero, Decreasing to zero, or Infinity,
the ordering fo

{| class="wikitable"
! Name
! Value
|-
| NonZero
| 0
|-
| ZeroIncreasing
| 1
|-
| ZeroSteady
| 2
|-
| ZeroDecreasing
| 3
|-
| Infinity
| 4
|}

=== Loop Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| bool
| 1
| {{unknown|Unknown}}
|
|}

=== User Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
|-
| u32
| 1
| '''User Event Type'''
| Enumerated user event type (unknown values)
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this event to (for applicable events)
|}

=== Effect Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Frame Count'''
| Number of frames to run the effect emitter for
| {{check}}
| {{check}}
|-
| char
| 4
| '''Effect Type'''
| FourCC of effect's type; either [[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], or [[ELSC (File Format)|ELSC]]
| {{check}}
| {{check}}
|-
| Asset ID
| 1
| '''Effect ID'''
| Asset ID of the effect resource
| {{check}}
| {{check}}
|-
| string
| 1
| '''Bone Name'''
| Name of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Bone ID'''
| ID of the [[CINF (File Format)|CINF]] bone to attach this effect to
| {{nocheck}}
| {{check}}
|-
| float
| 1
| '''Effect Scale'''
| Uniform scale of the particle effect
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Transform Type'''
| Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Emitter transformed to bone for initial frame, then retained</li>
<li>Emitter continuously transformed to bone</li>
<li>Entire effect (including particle instances) continuously transformed to bone</li>
</ol>
| {{check}}
| {{check}}
|}

=== Sound Event ===

{| class="wikitable"
! Type
! Count
! Name
! Notes
! MP1
! MP2
|-
| [[#Event Base|Event Base]]
| 1
| '''Event Base'''
|
| {{check}}
| {{check}}
|-
| u32
| 1
| '''Sound ID'''
| Lower 16 bits are an [[AGSC (File Format)|AGSC]] sound ID indirected via the [[ATBL (File Format)|ATBL]]; most significant bit is a ''looped'' flag
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Amplitude'''
| Reference amplitude for audio attenuation
| {{check}}
| {{check}}
|-
| float
| 1
| '''Reference Distance'''
| Reference distance for audio attenuation
| {{check}}
| {{check}}
|-
| u32
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| u16
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|-
| float
| 1
| {{unknown|Unknown}}
|
| {{nocheck}}
| {{check}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

CHAR (Metroid Prime 3)

2016-08-23T20:58:55Z

Antidote: Grammar

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions, Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|-
| u32
| 1
| Animation AABB count
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
|-
| u8
| 1
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| 1
| Additive Animation count
|-
| bool
| additive_animation_count
| A true/false value map for additive animations, true if an animation is additive, false otherwise.
|-
| u32
| 1
| [[#HitboxSet|HitboxSet]] count
|-
| [[#HitboxSet|HitboxSet]]
| hitbox_set_count
| Hitbox Sets for animations
|-
| u32
| 1
| [[ANIM (File Format)|ANIM]] count
|-
| u64
| anim_count
| [[ANIM (File Format)|ANIM]] ids
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

=====ParticlePOINode=====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
=====SoundPOINode=====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

=====POI Header=====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}
====AnimationAABB====
{| class="wikitable"
! Type
! Description
|-
| u64
| [[ANIM (File Format)|ANIM]]
|-
| float2x3
| Axis Aligned Bounding Box
|}

====HitboxSet====
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| [[#Hitbox|Hitbox]] count
|-
| [[#Hitbox|Hitbox]]
| hitbox_count
| Hitboxes for bones used in an animation
|}

=====Hitbox=====
{| class="wikitable"
! Type
! Description
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| string
| Bone name
|-
| float
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

TXTR (Metroid Prime)

2016-07-21T17:03:52Z

Antidote:

''See [[TXTR (File Format)]] for the other revisions of this format.''

'''TXTR''' is, as the name suggests, the Retro Studios texture format. The format remains completely unchanged from Metroid Prime all the way up to Donkey Kong Country Returns.

{{todo|Could possibly use some more information on how the formats work and how to decode them, but then again the Custom Mario Kart Wiiki has this covered pretty nicely already.}}

__TOC__

== Format ==

TXTR files contain a very short 12-byte header, followed by the image data.

=== Header ===

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Image format'''. Possible values range from 0x0 to 0xA; see below for more details.
|-
| 0x4
| 2
| '''Width'''
|-
| 0x6
| 2
| '''Height'''
|-
| 0x8
| 4
| '''Mipmap count'''
|-
| 0xC
| colspan=2 {{unknown|End of header}}
|}

=== Palettes ===

The C4 and C8 image formats contain a palette table after the header, before the image data begins.

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Palette format'''. Possible values range from 0 to 2.
|-
| 0x4
| 2
| '''Width'''. always 1 in C4, 256 in C8
|-
| 0x6
| 2
| '''Height'''. always 16 in C4, 1 in C8
|-
| 0x8
| Varies
| '''Palette colors'''. 16-bit color values; 16 colors in C4, 256 in C8.
|-
| colspan=3 {{unknown|End of palette table; image data begins immediately after}}
|}

== Image Formats ==

There are 11 different image formats; these are built directly into GX, so they remain the same across all GameCube and Wii games. Rather than storing pixels in a linear left-to-right order, GX textures encode pixels in large blocks. The size of the block varies depending on the image format.

For example, suppose you have a format that stores 4x4 blocks. Pixels 1-4 of the image will make up the first row of the first block; pixels 5-8 will make up the second row; 9-12 will make up the third row; 13-16 will make up the fourth row, completing the block; and then 17-20 will begin the first row of the second block, appearing directly to the right of the first row of the first block.

{| class="wikitable"
! ID
! Name
! Bits per pixel
! Block size
! Description
|-
| 0x0
| I4
| 4
| 8x8
| 4-bit greyscale intensity values. Two pixels per byte.
|-
| 0x1
| I8
| 8
| 8x4
| 8-bit greyscale intensity values.
|-
| 0x2
| IA4
| 8
| 8x4
| 4-bit greyscale intensity values with an additional 4-bit alpha channel.
|-
| 0x3
| IA8
| 16
| 4x4
| 8-bit greyscale intensity values with an additional 8-bit alpha channel.
|-
| 0x4
| C4
| 4
| 8x8
| 4-bit palette indices.
|-
| 0x5
| C8
| 8
| 8x4
| 8-bit palette indices.
|-
| 0x6
| C14x2
| 16
| 4x4
| Another palette format. Not used by any official textures.
|-
| 0x7
| RGB565
| 16
| 4x4
| 16-bit colors without alpha.
|-
| 0x8
| RGB5A3
| 16
| 4x4
| 16-bit colors with alpha.
|-
| 0x9
| RGBA8
| 32
| 4x4
| Uncompressed 32-bit colors with alpha.
|-
| 0xA
| CMPR
| 4
| 8x8
| DXT1-compressed textures.
|}

== External links ==

* [http://wiki.tockdom.com/wiki/Image_Formats Custom Mario Kart Wiki]: More detailed information on each format, and how to decode them.

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

MLVL (File Format)

2016-07-16T09:27:08Z

Antidote: /* Audio Groups */

The '''MLVL format''' defines worlds in the Metroid Prime trilogy and Donkey Kong Country Returns. While the [[MREA (File Format)|MREA format]] defines individual areas, the MLVL is what links together all the areas to create a single cohesive world.

{{research|moderate|There's still a fair number of unknowns left in this format.}}

__TOC__

== Format ==

The format largely defines properties related to each area in general and how they link together, as well as things that apply to the world on a global scale across all areas, such as the skybox.

Remember that all resource IDs are 32 bits in Prime 1/2, and 64 bits in Prime 3/DKCR.

=== Header ===

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Magic'''; always 0xDEAFBABE
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| u32
| 4
| '''Version'''; see below
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| [[STRG (File Format)|STRG]]
| 4/8
| '''World name'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| [[STRG (File Format)|STRG]]
| 4
| '''Dark World Name'''
| {{nocheck}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| u32
| 4
| {{unknown|'''Unknown'''}}
| {{nocheck}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| bool
| 1
| {{unknown|Sets whether the next five values exist}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| string
| 1
| '''Level number''' (such as 1-2, 2-2, etc)
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| float
| 4
| {{unknown|'''Unknown'''}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| float
| 4
| {{unknown|'''Unknown'''}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| float
| 4
| {{unknown|'''Unknown'''}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| float
| 4
| {{unknown|'''Unknown'''}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| [[SAVW (File Format)|SAVW]]
| 4/8
| '''SaveWorld ID'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| [[CMDL (File Format)|CMDL]]
| 4/8
| '''World skybox CMDL ID'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|}

==== Version ====

These are the known version numbers:

{| class="wikitable"
! ID
! Game
|-
| 0xD
| Metroid Prime Demo
|-
| 0x11
| Metroid Prime
|-
| 0x14
| Metroid Prime 2 Demo
|-
| 0x17
| Metroid Prime 2
|-
| 0x19
| Metroid Prime 3
|-
| 0x1B
| Donkey Kong Country Returns
|}

=== Memory Relays ===

This section is only present in Prime 1. It contains a list of all Memory Relay objects used in the world and what objects they're connected to. If a Memory Relay is connected to multiple objects, it will show up multiple times.

The section starts with a 32-bit count value, then each relay is structured as:

{| class="wikitable"
! Offset
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| 0x0
| u32
| 4
| '''Memory Relay instance ID'''
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|-
| 0x4
| u32
| 4
| '''Target instance ID'''
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|-
| 0x8
| u16
| 2
| '''Message'''
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|-
| 0x10
| u8
| 1
| {{unknown|'''Unknown''' (always 0)}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|}

=== Areas ===

This section defines every area in the world and how they connect to other areas.

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Area count'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| u32
| 4
| {{unknown|'''Unknown'''}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|}

==== Area Header ====

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| [[STRG (File Format)|STRG]]
| 4/8
| '''Area name'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| float[12]
| 0x30
| '''Transform matrix'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| float[6]
| 0x18
| '''Bounding box'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| [[MREA (File Format)|MREA]]
| 4/8
| '''Area MREA'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| u32/u64
| 4/8
| '''Area ID'''; used by layer-switching objects
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|}

==== Attached Areas ====

This part contains a small table listing what areas within the world are attached (connected) to this one. This is done by using indices into the MLVL's area table; so an index of 0 indicates the first area listed in the MLVL, for example.

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Attached area index count''' (AC)
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u16[]
| 2 × AC
| '''Attached area indices'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|}

==== Dependency List ====

This section is only present in Prime 1 and 2. It starts with what's essentially 2 embedded [[DGRP (File Format)|DGRP]] files: a 32-bit count value followed by a list of resources used by the area. There are two of these tables, and the first is always empty in release versions.

Following that is a small array. The purpose of this array is to distinguish which resources are used by which layers, to avoid wasting time loading resources used by objects that aren't active. It's an array of offsets into the dependency table, each one marking the start of that layer's dependency list.

{| class="wikitable"
! Offset
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| 0x0
| u32
| 4
| '''Layer count''' (LC)
| {{check}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| 0x4
| u32[]
| 4 × LC
| '''Layer dependency offsets'''
| {{check}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|}

==== Docks ====

This section is only present in the Prime trilogy.

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''Dock count''' (DC)
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| [[#Dock|Dock]]
| DC
| '''Docks'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|}

===== Dock =====

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''Connecting dock count''' (DC)
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| [[#Connecting Dock|Connecting dock]]
| DC
| '''Connecting docks'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Dock coordinate count''' (CC)
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| vec3
| CC
| '''Dock coordinates'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|}

===== Connecting Dock =====

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''Area index'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u32
| 1
| '''Dock index'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|}

==== .rel List ====

This section is only present in Echoes. It contains a list of .rel files used by the area. Like the dependencies, it is followed by an array of offsets to distinguish which .rels are used by which layers. There are two offsets per layer; the reason for this is currently unknown.

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''.rel count''' (RC)
| {{nocheck}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| string
| RC
| '''.rel filenames''' (all zero-terminated)
| {{nocheck}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| u32
| 1
| '''.rel offset count''' (OC)
| {{nocheck}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|-
| u32
| OC
| '''.rel offsets'''
| {{nocheck}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
|}

==== Area Footer ====

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| {{unknown|'''Unknown'''; always 0}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|-
| string
| 1
| '''Internal area name''' (zero-terminated)
| {{nocheck}}
| {{check}}
| {{check}}
| {{check}}
|}

=== World Map ===

This section is only present in the Prime trilogy. It sets the [[MAPW (File Format)|MAPW]] file used for this world.

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| [[MAPW (File Format)|MAPW]]
| 4/8
| '''World map'''
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u8
| 1
| {{unknown|'''Unknown'''; always 0}}
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|-
| u32
| 4
| {{unknown|'''Unknown'''; always 0}}
| {{check}}
| {{check}}
| {{check}}
| {{nocheck}}
|}

=== Audio Groups ===

This section is only present in Prime 1. It contains a list of audio groups (AGSC files) used in this world. It begins with a 32-bit count value, then each audio group is defined as:

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Studio ID'''
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|-
| [[AGSC (File Format)|AGSC]]
| 4
| '''Audio Group file'''
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|}

There's a string following this, at the end of the AGSC table.

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| string
| 1
| {{unknown|'''Unknown'''; always empty}}
| {{check}}
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
|}

=== Layer Info ===

The final section of the file contains some metadata related to each layer.

==== Layer Flags ====

This part attaches a set of 64-bit flags to every area, where each bit corresponds to a layer; if the bit is set, then that indicates that the corresponding layer will be enabled by default (on a new save file). Since the flags are 64 bits, that means the maximum number of layers that can be present in one area is 64.

After a 32-bit area count, the following structure is repeated for each area:

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Area layer count'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| u64
| 8
| '''Area layer flags'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|}

==== Layer Names ====

This is a very simple list of layer name strings. For info on how each layer is actually attached to its corresponding area, check the [[#Layer Name Offsets|Layer Name Offsets]] section.

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''Layer count''' (LC)
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| string
| LC
| '''Layer names''' (zero-terminated)
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|}

==== Layer IDs ====

This array is only present in Prime 3 and DKCR, and is used by layer-switching objects.

{| class="wikitable"
! Type
! Size
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 4
| '''Layer ID count''' (IC)
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| u128
| 0x10 × IC
| '''Layer ID'''
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|}

==== Layer Name Offsets ====

The final layer info section provides one offset into the layer name table per area. This can be used to attach a layer's name to its corresponding data within the area.

{| class="wikitable"
! Type
! Count
! Description
! MP1
! MP2
! MP3
! DKCR
|-
| u32
| 1
| '''Area count''' (AC)
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| u32
| AC
| '''Area layer names offsets'''
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

MAPA (File Format)

2016-05-25T02:34:45Z

Antidote: /* Header */

The '''.MAPA file format''' defines the minimap models used in the Metroid Prime series. MAPA or '''MAP A'''rea consists of several sections: The header, Point Of Interest entries, Vertices, Primitive Headers, and the primitives.

{{research|2|A few things are unknown in the header and POI Entries}}

__TOC__
== Format ==
=== Header ===
The header is very straight forward, and has some minor differences depending on version, the unknown values don't seem to do anything, however not much research has been put into them.

{| class="wikitable"
!Type
!Description
!MP1
!MP2
!MP3
|-
|u32
|'''Magic'''; Always 0xDEADD00D
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Version'''; See below
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{check}}
|{{check}}
|{{check}}
|-
|CAABox
|'''Bounding Box'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{nocheck}}
|{{check}}
|-
|u32
|'''POI Count'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Vertex Count'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Primitive Count'''
|{{check}}
|{{check}}
|{{check}}
|}

==== Version ====
The version value listed above can have the following values:
{|class="wikitable"
!Game
!Value
|-
|Metroid Prime 1
|2
|-
|Metroid Prime 2: Echoes
|3
|-
|Metroid Prime 3: Corruption
|5
|}

=== Point of Interest ===
A Point of Interest in the Metroid Prime series can include: Mission Objectives, Elevators, Doors, Map Stations, and Missile Stations. Each Point of Interest entry consists of the following struct:
{|class="wikitable"
!Type
!Description
!MP1 & MP2
!MP3
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{check}}
|-
|u32
|'''Type'''; All valid values are not currently known
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{check}}
|{{check}}
|-
|u16
|{{unknown|Unknown}}
|{{check}}
|{{nocheck}}
|-
|u16
|'''ID'''; Which door, elevator etc.
|{{check}}
|{{nocheck}}
|-
|CVector4f
|{{unknown|Unknown}}
|{{nocheck}}
|{{check}}
|-
|u32
|'''Padding'''; always -1
|{{check}}
|{{check}}
|-
|CTransform4f
|'''Tranform Matrix''' The Point of Interest's position in '''world''' space.
|{{check}}
|{{check}}
|-
|u32 * 4
|'''Padding'''; four values of -1
|{{check}}
|{{check}}
|}

=== Vertices ===

Vertices are a simple array of CVector3f. Geometry in MAPAs is, almost always, centered around the origin (0, 0, 0) and are simplified, full sized, versions of the map they replicate. Each vertex is referenced at least twice: once for the primitive, once for the line border.

=== Primitive Headers ===

The Primitive headers are extremely simple, they merely have a bounding box followed by the primitive table start and end point, relative to the end of the current primitive header. In other words: read in the header, seek to the start of the table from the '''current''' position, then read the primitives tables.

{|class="wikitable"
!Type
!Description
|-
|CVector3f
|'''Normal'''
|-
|CVector3f
|'''Center of Mass'''
|-
|u32
|'''Primitive Table Start'''; relative to the end of this header
|-
|u32
|'''Primitive Table End'''; relative to the end of this header
|}

=== Primitive Table ===

The Primitive is also fairly simple, each one consists of two parts: The GX Primitive list, and the Border list.
{|class="wikitable"
!Type
!Description
|-
|u32
|'''Primitive Count (PC)'''
|-
|Primitive * PC
|'''Primitives'''
|-
|u32
|'''Border Count (BC)'''
|-
|Border * (BC)
|'''Borders'''
|}

=== Primitive ===

A primitive in a MAPA is a simple 4 byte aligned list of indices into the vertex list, starting with the GX Primitive type, a count, then an array of indices, each index taking up one byte.

=== Border ===

A border in a MAPA is a simple count followed by a 4 byte aligned list indices into the vertex list, each index taking up one byte. A border is simply drawn using GX_LINESTRIP.

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]

ANIM (Metroid Prime)

2016-05-19T02:03:31Z

Antidote: /* Layout */

''This article is for the ANIM format used in ''Metroid Prime'' and ''Metroid Prime 2: Echoes''. See [[ANIM (File Format)]] for the other revisions of this format.''

The '''ANIM format''' is used in conjunction with [[CINF (File Format)|CINF]] + [[CSKR (File Format)|CSKR]] rigging to animate [[CMDL (Metroid Prime)|CMDL meshes]]. The format is largely the same between the two games, with the main difference being that starting in ''Metroid Prime 2'', support for animating scale was added.

There are two versions of the ANIM format (indicated by the file's first u32 value), one with compressed animations and one with uncompressed ones:

{| class="wikitable"
!Version
!Description
|-
|0x0
|[[#Quaternion Array Format (Uncompressed)|Quaternion Array Format (Uncompressed)]]
|-
|0x2
|[[#Rotation Vector Bitstream Format (Compressed)|Rotation Vector Bitstream Format (Compressed)]]
|}

== Quaternion Array Format (Uncompressed) ==

The '''Quaternion Array Format''' (0x0) is a less common animation format. In ''Metroid Prime'', it only appears in a Ridley intro animation and the rotating pirate data artifact hologram above the Impact Crater, as well as some unused Samus animations, while in ''Metroid Prime 2'', it only seems to show up in some draft/test animations not used in the final game.

This format stores uncompressed animations by mapping animation channels to bones, supplying rotations as an array of [[wikipedia:Quaternion|quaternion]] (WXYZ) keys and translations/scales as an array of XYZ keys. Translations may be specified for a subset of bones as an array of XYZ keys. In ''Metroid Prime'', rotation keys are required on every channel, while translations may be specified for a subset of bones. In ''Metroid Prime 2'', all three transform components are opt-in.

=== Layout ===

{| class="wikitable"
!Offset
!Type
!style="width: 215px;"|Element Count
!style="width: 240px;"|Name
!Notes
!MP1
!MP2
|-
|0x4
|float
|1
|'''Duration'''
|'''[1/2 in CCharAnimTime]''' Time in seconds that the animation plays for
|{{check}}
|{{check}}
|-
|0x8
|u32
|1
|'''Differential State Enum'''
|'''[2/2 in CCharAnimTime]''' State of ''Duration'' time point for proper integration control <ol start="0"><li>Non Zero</li><li>Zero Increasing</li><li>Zero Steady</li><li>Zero Decreasing</li><li>Infinity</li></ol>
|{{check}}
|{{check}}
|-
|0xC
|float
|1
|'''Key Interval'''
|'''[1/2 in CCharAnimTime]''' Time in seconds between keys of each bone channel (reciprocal of frame-rate)
|{{check}}
|{{check}}
|-
|0x10
|u32
|1
|'''Differential State Enum'''
|'''[2/2 in CCharAnimTime]''' State of ''Key Interval'' time point for proper integration control
|{{check}}
|{{check}}
|-
|0x14
|u32
|1
|'''Key Count'''
|Count of keys for each bone channel (keys are set for every frame of the animation)
|{{check}}
|{{check}}
|-
|0x18
|u32
|1
|'''Root Bone ID'''
|ID of the root bone in this ANIM
|{{check}}
|{{check}}
|-
|0x1C
|u32
|1
|'''Bone Channel Count'''
|Count of bone channel indices in the next array. Always 100.
|{{check}}
|{{check}}
|-
|0x20
|u8
|''Bone Channel Count''
|'''Bone Channel Index Array'''
|This table maps each bone to a bone channel, with the index-position corresponding to a ''Bone ID'' in the associated [[CINF (File Format)|CINF]], while the value corresponds to a bone channel index. The value is 0xFF if the bone is not animated by this ANIM.
|{{check}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Rotation Channel Index Count'''
|Count of rotation channel indices in the next array. Matches the number of valid bone channels.
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|u8
|''Rotation Channel Index Count''
|'''Rotation Channel Index Array'''
|This table maps each bone channel to a rotation channel, with the index-position corresponding to an entry in the ''Bone Channel Index Array'' above (disregarding 0xFF entries), while the value corresponds to the index of a rotation channel. The value is 0xFF if the bone is not rotated by this ANIM. '''Note:''' In ''Metroid Prime'', every bone channel always has rotations, so this array is omitted.
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Translation Channel Index Count'''
|Count of translation channel indices in the next array. Matches the number of valid bone channels.
|{{check}}
|{{check}}
|-
|{{unknown|}}
|u8
|''Translation Channel Index Count''
|'''Translation Channel Index Array'''
|This table maps each bonechannel to a translation channel, with the index-position corresponding to an entry in the ''Bone Channel Index Array'' above (disregarding 0xFF entries), while the value corresponds to the index of a translation channel. The value is 0xFF if the bone is not translated by this ANIM.
|{{check}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Scale Channel Index Count'''
|Count of scale channel indices in the next array. Matches the number of valid bone channels.
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|u8
|''Scale Channel Index Count''
|'''Scale Channel Index Array'''
|This table maps each bone channel to a scale channel, with the index-position corresponding to an entry in the ''Bone Channel Index Array'' above (disregarding 0xFF entries), while the value corresponds to the index of a scale channel. The value is 0xFF if the bone is not scaled by this ANIM.
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Scale Key Count'''
|Count of elements in ''Scale Key Array'' below
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|float3
|''Scale Key Count''
|'''Scale Key Array'''
|The scale keys are interleaved as such (bone-major):
<pre>
|------------|------------|-----|------------|
| bone0/key0 | bone0/key1 | ... | bone0/keyN |
| bone1/key0 | bone1/key1 | ... | bone1/keyN |
| .......... | .......... | ... | .......... |
| boneN/key0 | boneN/key1 | ... | boneN/keyN |
|------------|------------|-----|------------|
</pre>
|{{nocheck}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Rotation Key Count'''
|Count of elements in ''Rotation Key Array'' below
|{{check}}
|{{check}}
|-
|{{unknown|}}
|float4
|''Rotation Key Count''
|'''Rotation Key Array'''
|The rotation keys are interleaved the same way as the scale keys. In ''Metroid Prime 2'', any bone channels that were marked 0xFF in the ''Rotation Channel Index Array'' are skipped.
|{{check}}
|{{check}}
|-
|{{unknown|}}
|u32
|1
|'''Translation Key Count'''
|Count of elements in ''Translation Key Array'' below
|{{check}}
|{{check}}
|-
|{{unknown|}}
|float3
|''Translation Key Count''
|'''Translation Key Array'''
|The translation keys are interleaved the same way as the scale keys. Any bone channels that were marked 0xFF in the ''Translation Channel Index Array'' are skipped.
|{{check}}
|{{check}}
|-
|{{unknown|}}
|[[EVNT (File Format)|EVNT]]
|1
|'''EVNT Ref'''
|ID for this ANIM's [[EVNT (File Format)|EVNT]] resource, or 0xFFFFFFFF if no events triggered
|{{check}}
|{{nocheck}}
|}

== Rotation Vector Bitstream Format (Compressed) ==

The '''Rotation Vector Bitstream Format''' (0x2) is the most widely used animation format.
The format uses a compressed [[wikipedia:Bitstream|bitstream]] to store keys that have been
[[wikipedia:Delta encoding|delta encoded]] and [[wikipedia:Quantization (signal processing)|quantized]]
to make for a very compact, compressed animation. The data is processed sequentially to reconstruct the
uncompressed bone channel data as quaternions.

In addition to the bitstream quantization, the format includes a bitmap specifying which frames of the animation have
keys added. Consequently, the runtime generates missing keys via interpolation (reducing animation size further).

=== Key Values ===
When decoding the animation, each bone's attribute values are initialized to the ''Initial *''
values in the ''bone channel descriptors''. For every frame of every bone channel, the key value in the bitstream is ''added''
with the previous key value (to resolve the delta encoding).

Once resolved, rotation components are divided by ''Rotation Divisor'', resulting in an axis-angle
[[wikipedia:Axis–angle_representation#Rotation_vector|rotation vector]]. This rotation vector is converted
to quaternion imaginary components with the W component derived via normalized-difference and a ''sign-bit''
packed into the bitstream:

<pre>
q = π / 2.0 / rotation_divisor
X = sin(rx * q)
Y = sin(ry * q)
Z = sin(rz * q)
W = sqrt(MAX((1.0 - (X*X + Y*Y + Z*Z)), 0.0))
W = sign_bit ? -W : W
</pre>

Translation components are multiplied by ''Translation Multiplier'', and scale components are multiplied by ''Scale Multiplier''.

=== Layout ===

{| class="wikitable"
!Type
!style="width: 220px;"|Element Count
!style="width: 240px;"|Name
!Notes
!MP1
!MP2
|-
|u32
|1
|'''Scratch Size'''
|Amount of memory that the animation system needs to allocate to process animation
|{{check}}
|{{check}}
|-
|[[EVNT (File Format)|EVNT]]
|1
|'''EVNT Ref'''
|ID for this ANIM's [[EVNT (File Format)|EVNT]] resource, or 0xFFFFFFFF if no events triggered
|{{check}}
|{{nocheck}}
|-
|u32
|1
|{{unknown|Unknown 1}}
|Always 0x1
|{{check}}
|{{nocheck}}
|-
|u16
|1
|{{unknown|Unknown 2}}
|
|{{nocheck}}
|{{check}}
|-
|float
|1
|'''Duration'''
|Time in seconds that the animation plays for
|{{check}}
|{{check}}
|-
|float
|1
|'''Interval'''
|Time in seconds between frames (reciprocal of frame-rate, typically 30-fps)
|{{check}}
|{{check}}
|-
|u32
|1
|'''Root Bone ID'''
|ID of the root bone in this ANIM
|{{check}}
|{{check}}
|-
|u32
|1
|{{unknown|Unknown 3}}
|Always 0x0
|{{check}}
|{{check}}
|-
|u32
|1
|'''Rotation Divisor'''
|Rotation vectors are divided by this value before being applied
|{{check}}
|{{check}}
|-
|float
|1
|'''Translation Multiplier'''
|Translation vectors are multiplied by this value before being applied
|{{check}}
|{{check}}
|-
|float
|1
|'''Scale Multiplier'''
|Scale vectors are multiplied by this value before being applied
|{{nocheck}}
|{{check}}
|-
|u32
|1
|'''Bone Channel Count'''
|Count of bone channels present in ANIM
|{{check}}
|{{check}}
|-
|u32
|1
|{{unknown|Unknown 4}}
|Always 0x1
|{{check}}
|{{check}}
|-
|u32
|1
|'''Key Bitmap Length'''
|Number of bits in ''Key Bitmap''
|{{check}}
|{{check}}
|-
|u32
|round_up(''Key Bitmap Length'' / 32)
|'''Key Bitmap'''
|Word-packed bitmap. Each word is read from least-significant to most-significant bit. A set bit indicates the frame at the bit's position has keys for each bone channel. If the bit is unset, the keys must be generated via interpolation.
|{{check}}
|{{check}}
|-
|u32
|1
|'''Bone Channel Count'''
|Count of animated bone channels (matches the previous bone channel count)
|{{check}}
|{{nocheck}}
|-
|u32
|1
|'''Bone Channel Descriptor Count'''
|Count of bone channel descriptors in ''Bone Channel Descriptor Table''. Matches the ''Bone Channel Counts''.
|{{check}}
|{{check}}
|-
|[[#Bone Channel Descriptor|Bone Channel Descriptor]]
|''Bone Channel Descriptor Count''
|'''Bone Channel Descriptor Table'''
|Table describing animated bone channels
|{{check}}
|{{check}}
|-
|u32
|<remainder of file>
|'''Key Bitstream'''
|Word-packed bitstream laid out as described by the descriptor table. The bitstream is unpacked just like ''Key Bitmap'' (least-significant to most-significant).
Key values are tightly-packed, quantized integers whose bit-depth is specified by the ''* Bits'' values in the descriptor table.
Each bone-channel key-set starts with a single bit providing the ''W sign-bit'' (1 for negative, 0 for positive).

The key integers are signed using [[wikipedia:Two's complement|Two's complement]] representation.

The keys are interleaved as such (key-major):
<pre>
|------------|------------|-----|------------|
| bone0/key0 | bone1/key0 | ... | boneN/key0 |
| bone0/key1 | bone1/key1 | ... | boneN/key1 |
| .......... | .......... | ... | .......... |
| bone0/keyN | bone1/keyN | ... | boneN/keyN |
|------------|------------|-----|------------|
</pre>
|{{check}}
|{{check}}
|}

=== Bone Channel Descriptor ===

{| class="wikitable"
!Offset
!Type
!Name
!Notes
!MP1
!MP2
|-
|0x0
|u32
|'''Bone ID'''
|''Bone ID'' in the associated [[CINF (File Format)|CINF]] for this bone channel
|{{check}}
|{{check}}
|-
|0x4
|u16
|'''Rotation Key Count'''
|Number of rotation keys in the bitstream for this bone channel.
'''In MP2, if this value is 0, the remaining Rotation fields aren't present'''
|{{check}}
|{{check}}
|-
|0x6
|s16
|'''Initial Rotation X'''
|Initial X value of bone's rotation vector
|{{check}}
|{{check}}
|-
|0x8
|u8
|'''Rotation Bits X'''
|Number of bits allocated to bone's rotation delta X in bitstream
|{{check}}
|{{check}}
|-
|0x9
|s16
|'''Initial Rotation Y'''
|Initial Y value of bone's rotation vector
|{{check}}
|{{check}}
|-
|0xB
|u8
|'''Rotation Bits Y'''
|Number of bits allocated to bone's rotation delta Y in bitstream
|{{check}}
|{{check}}
|-
|0xC
|s16
|'''Initial Rotation Z'''
|Initial Z value of bone's rotation vector
|{{check}}
|{{check}}
|-
|0xE
|u8
|'''Rotation Bits Z'''
|Number of bits allocated to bone's rotation delta Z in bitstream
|{{check}}
|{{check}}
|-
|0xF
|u16
|'''Translation Key Count'''
|If this bone channel has an animated translation, its value will match ''Rotation Key Count''; otherwise the value will be 0.
'''If the value is 0, the remaining Translation fields aren't present'''
|{{check}}
|{{check}}
|-
|0x11
|s16
|'''Initial Translation X'''
|Initial X value of bone's translation vector
|{{check}}
|{{check}}
|-
|0x13
|u8
|'''Translation Bits X'''
|Number of bits allocated to bone's translation delta X in bitstream
|{{check}}
|{{check}}
|-
|0x14
|s16
|'''Initial Translation Y'''
|Initial Y value of bone's translation vector
|{{check}}
|{{check}}
|-
|0x16
|u8
|'''Translation Bits Y'''
|Number of bits allocated to bone's translation delta Y in bitstream
|{{check}}
|{{check}}
|-
|0x17
|s16
|'''Initial Translation Z'''
|Initial Z value of bone's translation vector
|{{check}}
|{{check}}
|-
|0x19
|u8
|'''Translation Bits Z'''
|Number of bits allocated to bone's translation delta Z in bitstream
|{{check}}
|{{check}}
|-
|0x1A
|u16
|'''Scale Key Count'''
|If this bone channel has an animated scale, its value will match ''Scale Key Count''; otherwise the value will be 0.
'''If the value is 0, the remaining Scale fields aren't present'''
|{{nocheck}}
|{{check}}
|-
|0x1C
|s16
|'''Initial Scale X'''
|Initial X value of bone's scale vector
|{{nocheck}}
|{{check}}
|-
|0x1E
|u8
|'''Scale Bits X'''
|Number of bits allocated to bone's scale delta X in bitstream
|{{nocheck}}
|{{check}}
|-
|0x1F
|s16
|'''Initial Scale Y'''
|Initial Y value of bone's scale vector
|{{nocheck}}
|{{check}}
|-
|0x21
|u8
|'''Scale Bits Y'''
|Number of bits allocated to bone's scale delta Y in bitstream
|{{nocheck}}
|{{check}}
|-
|0x22
|s16
|'''Initial Scale Z'''
|Initial Z value of bone's scale vector
|{{nocheck}}
|{{check}}
|-
|0x24
|u8
|'''Scale Bits Z'''
|Number of bits allocated to bone's scale delta Z in bitstream
|{{nocheck}}
|{{check}}
|-
|0x25
|colspan=5 {{unknown|End of descriptor}}
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

CHAR (Metroid Prime 3)

2016-05-02T02:23:20Z

Antidote: /* AnimationSet */

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|-
| u32
| 1
| Animation AABB count
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
|-
| u8
| 1
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| 1
| Additive Animation count
|-
| bool
| additive_animation_count
| A true/false value map for additive animations, true if an animation is additive, false otherwise.
|-
| u32
| 1
| [[#HitboxSet|HitboxSet]] count
|-
| [[#HitboxSet|HitboxSet]]
| hitbox_set_count
| Hitbox Sets for animations
|-
| u32
| 1
| [[ANIM (File Format)|ANIM]] count
|-
| u64
| anim_count
| [[ANIM (File Format)|ANIM]] ids
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

=====ParticlePOINode=====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
=====SoundPOINode=====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

=====POI Header=====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}
====AnimationAABB====
{| class="wikitable"
! Type
! Description
|-
| u64
| [[ANIM (File Format)|ANIM]]
|-
| float2x3
| Axis Aligned Bounding Box
|}

====HitboxSet====
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| [[#Hitbox|Hitbox]] count
|-
| [[#Hitbox|Hitbox]]
| hitbox_count
| Hitboxes for bones used in an animation
|}

=====Hitbox=====
{| class="wikitable"
! Type
! Description
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| string
| Bone name
|-
| float
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

CHAR (Metroid Prime 3)

2016-05-02T02:23:02Z

Antidote:

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|-
| u32
| 1
| Animation AABB count
|-
| [[AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
|-
| u8
| 1
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| 1
| Additive Animation count
|-
| bool
| additive_animation_count
| A true/false value map for additive animations, true if an animation is additive, false otherwise.
|-
| u32
| 1
| [[#HitboxSet|HitboxSet]] count
|-
| [[#HitboxSet|HitboxSet]]
| hitbox_set_count
| Hitbox Sets for animations
|-
| u32
| 1
| [[ANIM (File Format)|ANIM]] count
|-
| u64
| anim_count
| [[ANIM (File Format)|ANIM]] ids
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

=====ParticlePOINode=====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
=====SoundPOINode=====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

=====POI Header=====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}
====AnimationAABB====
{| class="wikitable"
! Type
! Description
|-
| u64
| [[ANIM (File Format)|ANIM]]
|-
| float2x3
| Axis Aligned Bounding Box
|}

====HitboxSet====
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| [[#Hitbox|Hitbox]] count
|-
| [[#Hitbox|Hitbox]]
| hitbox_count
| Hitboxes for bones used in an animation
|}

=====Hitbox=====
{| class="wikitable"
! Type
! Description
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| string
| Bone name
|-
| float
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

CHAR (Metroid Prime 3)

2016-05-02T02:19:37Z

Antidote:

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|-
| u32
| 1
| Animation AABB count
|-
| [[AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
|-
| u8
| 1
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| 1
| Additive Animation count
|-
| bool
| additive_animation_count
| A true/false value map for additive animations, true if an animation is additive, false otherwise.
|-
| u32
| 1
| [[#HitboxSet|HitboxSet]] count
|-
| [[#HitboxSet|HitboxSet]]
| hitbox_set_count
| Hitbox Sets for animations
|-
| u32
| 1
| [[ANIM (File Format)|ANIM]] count
|-
| u64
| anim_count
| [[ANIM (File Format)|ANIM]] ids
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

=====ParticlePOINode=====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
=====SoundPOINode=====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

=====POI Header=====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}

====HitboxSet====
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| [[#Hitbox|Hitbox]] count
|-
| [[#Hitbox|Hitbox]]
| hitbox_count
| Hitboxes for bones used in an animation
|}

=====Hitbox=====
{| class="wikitable"
! Type
! Description
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| string
| Bone name
|-
| float
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

CHAR (Metroid Prime 3)

2016-05-02T02:18:28Z

Antidote:

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|-
| u32
| 1
| Animation AABB count
|-
| [[AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
|-
| u8
| 1
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| 1
| Additive Animation count
|-
| bool
| additive_animation_count
| A true/false value map for additive animations, true if an animation is additive, false otherwise.
|-
| u32
| 1
| [[#HitboxSet|HitboxSet]] count
|-
| [[#HitboxSet|HitboxSet]]
| hitbox_set_count
| Hitbox Sets for animations
|-
| u32
| 1
| [[ANIM (File Format)|ANIM]] count
|-
| u64
| anim_count
| [[ANIM (File Format)|ANIM]] ids
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

====ParticlePOINode====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
====SoundPOINode====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

====POI Header====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}

====HitboxSet====
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| [[#Hitbox|Hitbox]] count
|-
| [[#Hitbox|Hitbox]]
| hitbox_count
| Hitboxes for bones used in an animation
|}

=====Hitbox=====
{| class="wikitable"
! Type
! Description
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| string
| Bone name
|-
| float
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

CHAR (Metroid Prime 3)

2016-05-02T02:08:17Z

Antidote: /* SoundPOINode */

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

====ParticlePOINode====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
====SoundPOINode====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#POI Header|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

====Shared Header====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

CHAR (Metroid Prime 3)

2016-05-02T02:03:11Z

Antidote:

The '''CHAR format''' defines animated characters; it's the successor to the [[ANCS (File Format)|ANCS format]] from Prime 1 and 2, and the format is extremely similar.

{{research|major|This format hasn't been researched/documented very well yet, but it appears to be extremely similar to ANCS.}}

__TOC__

== Format ==

=== Header ===

{| class="wikitable"
! Type
! Description
|-
| char
| {{unknown|Unknown}}
|-
| char
| {{unknown|Unknown}}
|-
| [[#CharacterInfo|Character Info]]
| Specific settings and resources used by this character
|-
| [[#AnimationSet|Animation Set]]
| Events, Animations, and Hitbox related settings
|}

===CharacterInfo===
{| class="wikitable"
! Type
! Count
! Description
|-
| string
| 1
| '''Character name'''
|-
| [[CMDL (File Format)|CMDL]]
| 1
| '''Character model'''
|-
| [[CSKR (File Format)|CSKR]]
| 1
| '''Character skin'''
|-
| u64
| 1
| Overlay count
|-
| [[#Overlay|Overlays]]
| overlay_count
| Overlays used for various status effects, such as Frozen, Hazard, or Hyper
|-
| [[CINF (File Format)|CINF]]
| 1
| '''Character skeleton'''
|-
| [[SAND (File Format)|SAND]]
| 1
| '''Character sand'''
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation Set Database
|-
| [[#ParticleResData|Particle Resource Data]]
| 1
| Various Particle Systems used by this character.
|}

====Overlay====
Overlays are external models that are skinned and attached to the rig for certain status effects, the layout simply consists of a FourCC value, a CMDL reference, and a CSKR reference.
{| class="wikitable"
! Type
! Description
|-
| FourCC
| The type of status effect this overlay is for, <code>FRZN</code>, <code>HYPR</code>, or <code>HZRD</code> are known values, there may be more
|-
| u64
| [[CMDL (File Format)|CMDL]] id
|-
| u64
| [[CSKR (File Format)|CSKR]] id
|}

===ParticleResData===
Particle Resource data is simply a list of particle systems that can be used with this character.
{| class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[PART (File Format)|PART]] count
|-
| u64
| part_count
| [[PART (File Format)|PART]] ids
|-
| u32
| 1
| [[SWHC (File Format)|SWHC]] count
|-
| u64
| swhc_count
| [[SWHC (File Format)|SWHC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|-
| u32
| 1
| [[ELSC (File Format)|ELSC]] count
|-
| u64
| elsc_count
| [[ELSC (File Format)|ELSC]] ids
|-
| u32
| 1
| [[SPSC (File Format)|SPSC]] count
|-
| u64
| spsc_count
| [[SPSC (File Format)|SPSC]] ids
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}} count
|-
| u64
| unk_count
| {{unknown|'''UNKNOWN'''}} ids
|}

===AnimationSet===
The Animation Set saw the largest change from Metroid Prime 1/2, gone are Transitions and Half Transitions and AdditiveInfo, EVNT was overhauled, AABBs were moved from CharacterInfo, and Hitboxes were added.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| [[#EVNT|EVNT]] count
|-
| [[#EVNT|EVNT]]
| evnt_count
| Events available for use by various animations, how events are linked to animations is currently unknown
|-
| u32
| 1
| [[ANCS (File Format)#Animation|Animation]] count
|-
| [[ANCS (File Format)#Animation|Animation]]
| animation_count
| Animations used by this character
|}

====EVNT====
Not much is currently known about the actual structure of the new EVNT format, so much of the structure is a complete guess.
{|class="wikitable"
! Type
! Count
! Description
|-
| u32
| 1
| Index of this particular event, how it's currently used is unknown
|-
| u32
| 1
| [[#ParticlePOINode|ParticlePOINode]] count
|-
| [[#ParticlePOINode|ParticlePOINode]]
| particle_poi_node_count
| Particle effects events that can be triggered during the course of the animation
|-
| u32
| 1
| [[#SoundPOINode|SoundPOINode]] count
|-
| [[#SoundPOINode|SoundPOINode]]
| sound_poi_node_count
| Sound effect events that can be triggered during the course of the animation
|}

====ParticlePOINode====
{| class="wikitable"
! Type
! Description
|-
| [[#SharedHeader|POI Header]]
| Basic information about this particular event
|-
| FourCC
| Type, <code>PART</code> is the most common, not aware of any others being used
|-
| u64
| Particle ID, file type corresponds to the previous value.
|-
| float
| Scale of the particle system.
|-
| u32
| Parent Mode
|}
====SoundPOINode====
{| class="wikitable"
! Type
! Count
! Description
! Notes
|-
| [[#SharedHeader|POI Header]]
| 1
| Basic information about this particular event
|
|-
| u64
| 1
| [[CAUD (File Format)|CAUD]] id
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
|
|-
| u32
| 1
| {{unknown|'''UNKNOWN'''}}
| Dictates the presence of the following values, if 1, the following float exists, otherwise 35 unknown bytes.
|-
| float
| 1
| {{unknown|'''UNKNOWN'''}}
| Only present if the previous value is 1
|-
| u8
| 35
| {{unknown|'''UNKNOWN'''}}
| Only present if the value above does not exist
|}

====Shared Header====
{| class="wikitable"
! Type
! Description
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| string
| {{unknown|'''UNKNOWN'''}}
|-
| u16
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u8
| {{unknown|'''UNKNOWN'''}}
|-
| float
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|-
| u32
| {{unknown|'''UNKNOWN'''}}
|}

[[Category:Metroid Prime 3: Corruption]]
[[Category:File Formats]]

ANCS (File Format)

2016-04-30T01:01:31Z

Antidote: /* AnimationSet */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimationPair|AdditiveAnimationPair]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| 1
| Default additive
|
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimationPair===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#AdditiveAnimaton|AdditiveAnimation]]
| Additive Animation fade-in, fade-out values
|}

===AdditiveAnimation===
Describes how animations are additively blended together.

{| class="wikitable"
! Data Type
! Description
|-
| float
| Fade In Duration
|-
| float
| Fade Out Duration
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-13T21:34:52Z

Antidote: /* CharacterSet */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfoPair|CharacterInfoPair]] count
| Number of characters in this set.
|-
| [[#CharacterInfoPair|CharacterInfoPair]]
| character_info_count
| Character Info Pairs
|
|}

=== CharacterInfoPair ===
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Id
|-
| [[#CharacterInfo|CharacterInfo]]
| Character Info
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T17:46:56Z

Antidote: /* Transition */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T17:46:29Z

Antidote: /* Blend */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T17:45:47Z

Antidote: /* Blend */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T03:14:30Z

Antidote: /* ParticleResData */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
| Only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T03:14:04Z

Antidote: /* ParticleResData */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character, only present if info_type_count > 5
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character, only present if info_type_count > 5
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T03:03:37Z

Antidote: /* AnimationResource */

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation Asset ID
|-
| [[EVNT_(File_Format)|EVNT]]
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

ANCS (File Format)

2016-04-08T02:53:51Z

Antidote:

The '''ANCS format''' defines characters for animation in Metroid Prime 1 and 2. Starting in Metroid Prime 3, it was replaced by the [[CHAR (Metroid Prime 3)|CHAR]] format. The extension stands for '''AN'''imation '''C'''haracter '''S'''et.

{{research|3|Most of the file structure is known, but we still don't know what any of it actually is! Also, the table at the end of the file is unknown.}}

__TOC__

== Root Structure ==
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u16
| Version
| Always 1
|-
| [[#CharacterSet|CharacterSet]]
| Character Set
| Contains multiple [[#CharacterInfo|CharacterInfo]] Entries
|-
| [[#AnimationSet|AnimationSet]]
| Animation Set
| Describes Meta Animations, Meta Transitions, Half Transitions, and Resource association
|-
|}

== CharacterSet ==

{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Version
| Always 1
|-
| u32
| 1
| [[#CharacterInfo|CharacterInfo]] count
| Number of characters in this set.
|-
| [[#CharacterInfo|CharacterInfo]]
| character_info_count
| Characters
|
|}

=== CharacterInfo ===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| id
| Used by the engine to as a unique identifier within the Character Set.
|-
| u16
| 1
| Info Type Count
| Informs the engine which info types are present within the CharacterSet
|-
| string
| 1
| Character Name
| Human readable name, useful for editors, the engine does not use this internally.
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Character Model
|
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Character Skin
|
|-
| [[CINF_(File_Format)|CINF]]
| 1
| Character Rig
|
|-
| u32
| 1
| Animation Count
| Animations in AnimationSet that specifically relate to this character, some characters make heavy use of this abstraction, Space Pirates being the biggest culprit.
|-
| [[#AnimationName|AnimationName]]
| animation_count
| Animation Names
| Animations linked to this character by name and index.
|-
| [[PASDatabase|PASDatabase]]
| 1
| Parameterized Animation State Data
| Not much is known about how this data is used.
|-
| [[#ParticleResData|ParticleResData]]
| 1
| Particle systems used by this character
|
|-
| u32
| 1
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count <= 9
|-
| u32
| 1
| Animation AABB count
| Only present when info_type_count > 1
|-
| [[#AnimationAABB|AnimationAABB]]
| animation_aabb_count
| Animation bounds
| Only present when info_type_count > 1
|-
| u32
| 1
| Effect Count
| Only present when info_type_count > 1
|-
| [[#Effect|Effect]]
| effect_count
| Effects used by this character, including which bones they're attached to
| Only present when info_type_count > 1
|-
| [[CMDL_(Metroid_Prime)|CMDL]]
| 1
| Overlay Model for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| [[CSKR_(File_Format)|CSKR]]
| 1
| Overlay Skin for status effects, such as ice when frozen
| Only present when info_type_count > 3
|-
| u32
| 1
| Animation Index Count
| The total number of animations used by this, only present when info_type_count > 4
|-
| u32
| animation_index_count
| Indices of each animation used by this character
| Only present when info_type_count > 4
|-
| u32
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u8
| 1
| {{unknown|'''Unknown'''}}
| Only present when info_type_count > 9
|-
| u32
| 1
| Animation AABB Indexed Count
| Only present when info_type_count > 9
|-
| [[#AnimationAABB_Indexed|AnimationAABB]]
| animation_aabb_indexed_count
| Animation bounds, referenced by index
| Only present when info_type_count > 9
|}

====AnimationName====
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Index
| The index into AnimationSet's MetaAnimation table.
|-
| string
| 1
| {{unknown|'''Unknown'''}}
| Not present when info_type_count >= 10
|-
| string
| 1
| Animation Name
| The name of the index ref'd Animation
|}

===ParticleResData===
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| [[PART_(File_Format)|PART]] count
| How many particle systems are used by this character
|-
| [[PART_(File_Format)|PART]]
| part_count
| The particle systems used by this character
|-
| u32
| 1
| [[SWHC_(File_Format)|SWHC]] count
| How many swooshes are used by this character
|-
| [[SWHC_(File_Format)|SWHC]]
| swhc_count
| The swooshes used by this character
|-
| u32
| 1
| {{unknown|'''Unknown Count'''}}
| How many unknown systems are used by this character
|-
| UniqueID32
| unknown_count
| The unknown systems used by this character
|-
| u32
| 1
| [[ELSC_(File_Format)|ELSC]] count
| How many electric systems are used by this character
|-
| [[ELSC_(File_Format)|ELSC]]
| else_count
| The electric systems used by this character
|}

===AnimationAABB===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| CAABox
| Animation bounds
|}

===Effect===
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| string
| 1
| Name
|-
| u32
| 1
| Component Count
|-
| [[#EffectComponent|EffectComponent]]
| component_count
| Effect Components
|}

====EffectComponent====
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| FourCC
| Type
|-
| UniqueID32
| Resource as defined by Type
|-
| string
| Bone to attach the effect to
|-
| float
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AnimationAABB Indexed===
The only difference between this and the previous [[#AnimationAABB|AnimationAABB]] is the fact that animations are referenced by index, rather than by name.

==AnimationSet==
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u16
| 1
| Info Count
| Enumeration of the presence of certain sections
|-
| u32
| 1
| Animation Count
| How many animations there are in the set
|-
| [[#Animation|Animation]]
| animation_count
| Animations that can be referenced by characters
|
|-
| u32
| 1
| Transition Count
| How many transitions there are in the set
|-
| [[#Transition|Transition]]
| transition_count
| Transitions that can be referenced by characters
|
|-
| [[#MetaTransition|MetaTransition]]
| 1
| Default Transition
|
|-
| u32
| 1
| Additive Animation Count
| How many additive animations there are
|-
| [[#AdditiveAnimation|AdditiveAnimation]]
| additive_animation_count
| Additive animations that can be referenced in some fashion
| Reference method is currently unknown, presumably PASDatabase.
|-
| float
| 1
| Time A
| {{unknown|'''Unknown'''}}
|-
| float
| 1
| Time B
| {{unknown|'''Unknown'''}}
|-
| u32
| 1
| Half Transition Count
| How many half transitions there in the set, Only present if info_count > 2
|-
| [[#HalfTransition|HalfTransition]]
| half_transition_Count
| Half Transitions
| Only present if info_count > 2
|-
| u32
| 1
| Animation Resource Count
| Only present if info_count > 3, and not present at all in MP2
|-
| [[#AnimationResource|AnimationResource]]
| animation_resource_count
| Animation Resources
| Only present if info_count > 3, and not present at all in MP2
|-
| u32
| 1
| Event Count
| Only present in MP2
|-
| [[EVNT_(File_Format)|EVNT]]
| event_count
| Animation Events
| Only present in MP2
|}

===Animation===
{| class="wikitable"
! Data Type
! Description
|-
| string
| Name
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation configuration
|}

===MetaAnimation===
MetaAnimations can be one of five types, and may contain children.
{| class="wikitable"
! Data Type
! Description
|-
| [[#EMetaAnimationType|EMetaAnimationType]]
| The Animation type
|-
| [[#Primitive|Primitive]], [[#Blend|Blend]], [[#Blend|PhaseBlend]], [[#Random|Random]] or [[#Sequence|Sequence]]
| The animation description, including name, animation ID, and index used to connect character animations references to actual animations.
|}

====EMetaAnimationType====
{| class="wikitable"
! Name
! Value
|-
| Primitive
| 0
|-
| Blend
| 1
|-
| PhaseBlend
| 2
|-
| Random
| 3
|-
| Sequence
| 4
|}

====Primitive====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[ANIM_(File_Format)|ANIM]]
| Animation ID
| The asset ID for this particular animation
|-
| u32
| Index
| The ID used by characters to reference this animation
|-
| string
| Name
| The animations name
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| u32
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Blend====
Blend's structure is shared between Blend and PhaseBlend, with the only currently known difference being the animation type value.
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation A
| The animation to, presumably, blend from
|-
| [[#MetaAnimation|MetaAnimation]]
| Animation B
| The animation to, presumably, blend to
|-
| float
| colspan=2 {{unknown|'''Unknown'''}}
|-
| bool
| colspan=2 {{unknown|'''Unknown'''}}
|}

====Random====
Random may contain one or more children in an Animation -> Probability pair following this structure:
{| class="wikitable"
! Data Type
! Element Count
! Description
! Notes
|-
| u32
| 1
| Animation Count
| The number of child animations
|-
| [[#AnimProbabilityPair|AnimProbabilityPair]]
| animation_count
| The animations to select from
| The exact manner these are used is currently unknown
|}

=====AnimProbabilityPair=====
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation use if the probability factor is met
|
|-
| u32
| Probability
| How probability is used is not currently known
|}

====Sequence====
Sequence is a fairly easy to understand type, it simply plays a list of animations in succession as each animation finishes
{| class="wikitable"
! Data Type
! Element Count
! Description
|-
| u32
| 1
| Animation Count
|-
| [[#MetaAnimation|MetaAnimation]]
| animation_count
| The animations to play in a sequence
|}

===Transition===
{| class="wikitable"
! Data Type
! Description
! Notes
|-
| u32
| Animation Index A
| The animation to transition from
|-
| u32
| Animation Index B
| The animation to transition to
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration
| Describes how the transition is performed
|}

===MetaTransition===
Meta Transitions can be one of four types, and may contain animations.
{| class="wikitable"
! Data Type
! Description
|-
| [[#ETransitionType|EMetaTransitionType]]
| The type of transition
|-
| [[#TransAnimation|TransAnimation]], [[#TransTransition|TransTransition]], [[#TransTransition|TransPhaseTransition]], TransNoTransition
| The transition configuration
|}
====EMetaTransitionType====
{| class="wikitable"
! Name
! Value
|-
| TransAnimation
| 0
|-
| TransTransition
| 1
|-
| TransPhaseTransition
| 2
|-
| TransNoTransition
| 3
|}

====TransAnimation====
{| class="wikitable"
! Data Type
! Description
|-
| [[#MetaAnimation|MetaAnimation]]
| The animation to use while transitioning
|}

====TransTransition====
{| class="wikitable"
! Data Type
! Description
|-
| float
| Time
|-
| u32
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| bool
| {{unknown|'''Unknown'''}}
|-
| u32
| {{unknown|'''Unknown'''}}
|}

===AdditiveAnimation===
Additive animations simply reference an existing animation within the above animation table, and has two unknown floats.
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| float
| {{unknown|'''Unknown'''}}
|-
| float
| {{unknown|'''Unknown'''}}
|}

===Half Transition===
A half transition is very similar to a regular transition, but has less configuration information, any other differences are currently unknown
{| class="wikitable"
! Data Type
! Description
|-
| u32
| Animation Index
|-
| [[#MetaTransition|MetaTransition]]
| Transition configuration.
|}

===AnimationResource===
{| class="wikitable"
! Data Type
! Description
|-
| UniqueID32
| Animation Asset ID
|-
| UniqueID32
| Event Asset ID
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]

FONT (File Format)

2016-03-11T20:10:33Z

Antidote:

The '''FONT format''' defines fonts that can be used to display text in-game.

{{research|2|There's some unknowns in the header. Also, some version 4/5 fonts have outlines on their textures - how do these work?}}

__TOC__

== Format ==

Note: All measurements are in points.

=== Header ===

The header has a couple minor differences depending on the version. Version 1 (MP1 Kiosk Demo) is missing the value at 0x18, and starting in Version 5 (MP3/DKCR), the texture ID is 64 bits. Those are the only changes, though (and for that matter, those are the only differences in version 1/5).

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| char[4]
| 4
| '''"FONT" magic fourCC'''
|-
| 0x4
| u32
| 4
| '''Version'''; see below
|-
| 0x8
| u32
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| s32
| 4
| '''Line height'''
|-
| 0x10
| u32
| 4
| '''Vertical offset''' ''(note: not present in version 1)''
|-
| 0x14
| s32
| 4
| '''Line margin'''
|-
| 0x18
| bool
| 1
| {{unknown|'''Unknown'''}}
|-
| 0x19
| bool
| 1
| {{unknown|'''Unknown'''}}
|-
| 0x1A
| u32
| 4
| {{unknown|'''Unknown'''}}
|-
| 0x1E
| u32
| 4
| '''Font size'''
|-
| 0x22
| string
| N
| '''Font name'''; zero-terminated string
|-
| -
| [[TXTR (Metroid Prime)|TXTR]]
| 4/8
| '''Texture ID'''
|-
| -
| u32
| 4
| '''Texture format''' (see [[#Textures|Textures]])
|-
| -
| u32
| 4
| '''Glyph count'''
|}

==== Version ====

{| class="wikitable"
! Version
! Game
|-
| 1
| ''Metroid Prime'' Kiosk Demo
|-
| 2
| ''Metroid Prime'' NTSC
|-
| 4
| ''Metroid Prime'' PAL and ''Metroid Prime 2''
|-
| 5
| ''Metroid Prime 3'', ''DKCR''
|}

=== Glyphs ===

This section of the file details each glyph making up the font. One glyph corresponds to one character. To map the character with the part of the font texture that contains that character, each glyph contains a set of texture coordinates. Since the UV map is always rectangular, the file only stores the min/max X/Y coordinates; they should be mixed and matched to get the absolute values.

In addition, glyphs contain a vertical offset. This offset is necessary because the textures are usually so tightly packed that there's no extra space for vertical spacing. After applying the offset, the vertical offset from the FONT header is applied. This aligns the glyphs at their intended position.

The kerning index value is the index of the first kerning table entry for the given character. Since the table is sorted in alphabetical order, this can be used to speed up lookup time.

This section of the file changes somewhat from version 2 to 4. Starting in version 4, font textures are able to be split up into multiple layers, which allows multiple glyphs to be encoded in the same space on the texture. A "layer index" value was introduced to track which layer the glyph is on. Additionally, a lot of 32-bit values were reduced to 8- or 16-bit. Aside from that, though, the actual layout is still the same, with the same values in the same places.

==== Version 2 (Metroid Prime NTSC) ====

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| '''UTF-16 character'''
|-
| 0x2
| float
| 4
| '''Left UV coordinate'''
|-
| 0x6
| float
| 4
| '''Top UV coordinate'''
|-
| 0xA
| float
| 4
| '''Right UV coordinate'''
|-
| 0xE
| float
| 4
| '''Bottom UV coordinate'''
|-
| 0x12
| u32
| 4
| '''Left padding'''
|-
| 0x16
| u32
| 4
| '''Print head advance'''
|-
| 0x1A
| u32
| 4
| '''Right padding'''
|-
| 0x1E
| u32
| 4
| '''Width'''
|-
| 0x22
| u32
| 4
| '''Height'''
|-
| 0x26
| u32
| 4
| '''Vertical offset'''
|-
| 0x2A
| u32
| 4
| '''Kerning start index'''
|-
| 0x2E
| colspan=3 {{unknown|End of glyph definition}}
|}

==== Version 4 (Metroid Prime PAL/Trilogy) ====

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| '''UTF-16 character'''
|-
| 0x2
| float
| 4
| '''Left UV coordinate'''
|-
| 0x6
| float
| 4
| '''Top UV coordinate'''
|-
| 0xA
| float
| 4
| '''Right UV coordinate'''
|-
| 0xE
| float
| 4
| '''Bottom UV coordinate'''
|-
| 0x12
| u8
| 1
| '''Layer index'''
|-
| 0x13
| u8
| 1
| '''Glyph left padding'''
|-
| 0x14
| u8
| 1
| '''Print head advance'''
|-
| 0x15
| u8
| 1
| '''Glyph right padding'''
|-
| 0x16
| u8
| 1
| '''Glyph width'''
|-
| 0x17
| u8
| 1
| '''Glyph height'''
|-
| 0x18
| u8
| 1
| '''Vertical offset'''
|-
| 0x19
| u16
| 2
| '''Kerning start index'''
|-
| 0x1B
| colspan=3 {{unknown|End of glyph definition}}
|}

=== Kerning Table ===

This table is at the end of the file, and defines kerning pairs. Kerning pairs horizontally adjust the second character of the pair whenever that particular sequence of characters is encountered. The table is case-sensitively sorted in alphabetical order, which allows for fast lookup times using the glyph kerning indices. After a 32-bit count value, each pair follows this simple structure:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Character 1'''
|-
| 0x2
| 2
| '''Character 2'''
|-
| 0x4
| 4
| '''Kerning adjust'''
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

== Textures ==

{{research|minor|Someone should look at the code to make sure the info in this section is accurate.}}

Textures used by FONT files are encoded in a bit of an unorthodox manner. The font format allows for multiple glyphs to be encoded in the same spot on the texture by splitting up the texture into multiple layers. The way this is handled on the textures is by encoding the textures with palettes (as C4), but modifying the palette indices at runtime and loading each layer one at a time as a separate texture. Each bit of the palette index corresponds to a layer, so up to four layers per font are supported. The MSB refers to layer 0, while the LSB refers to layer 3. In DKCR, font textures are encoded as C8, so theoretically the game could use up to eight layers per font; however, it still never actually uses more than four.

The texture format is determined by a value in the header. These are the possible settings:

{| class="wikitable"
! Value
! Description
! V1
! V2
! V4
! V5
|-
| 0
| One glyph layer, no outlines; fill on layer 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 1
| One glyph layer, with outlines; fill on layer 0, outline on layer 1
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 2
| Four glyph layers, no outlines
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 3
| Two glyph layers, with outlines; fill on layers 0/2, outlines on layers 1/3
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 4
| Two glyph layers, no outlines; copies on layers 0/1, and layers 2/3
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 8
| Two glyph layers, with outlines; fill on layers 2/3, outlines on layers 0/1
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|}

To dump out every layer into a single texture by encoding each layer on a separate RGBA channel, the following palette colors could be substituted into the texture:

{| class="wikitable"
! Index
! Binary
! Color
! Description
|-
| 0
| 0000
| 0x8000
| None
|-
| 1
| 0001
| 0x7000
| Alpha
|-
| 2
| 0010
| 0xFC00
| Blue
|-
| 3
| 0011
| 0x7F00
| Blue/Alpha
|-
| 4
| 0100
| 0x83E0
| Green
|-
| 5
| 0101
| 0x70F0
| Green/Alpha
|-
| 6
| 0110
| 0xFFE0
| Green/Blue
|-
| 7
| 0111
| 0x7FF0
| Green/Blue/Alpha
|-
| 8
| 1000
| 0x801F
| Red
|-
| 9
| 1001
| 0x700F
| Red/Alpha
|-
| 10
| 1010
| 0xFC1F
| Red/Blue
|-
| 11
| 1011
| 0x7F0F
| Red/Blue/Alpha
|-
| 12
| 1100
| 0x83FF
| Red/Green
|-
| 13
| 1101
| 0x70FF
| Red/Green/Alpha
|-
| 14
| 1110
| 0xFFFF
| Red/Green/Blue
|-
| 15
| 1111
| 0x7FFF
| Red/Green/Blue/Alpha
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

Animation Events (File Format)

2016-01-16T07:06:46Z

Antidote:

{{research|1|Some event parameters need research}}
The '''EVNT format''' is a companion to [[ANIM (File Format)|ANIM]] resources.
Animators are able to synchronize functional events to rigged animations for things like sound effects, visual effects, character messages, and playback control.

{| class="wikitable"
!Data Type
!Element Count
!Identifier
!Notes
|-
|long
|1
|version
|0x1 or 0x2
|-
|long
|1
|loop_event_count
|
|-
|[[#Loop Event|Loop Event]]
|loop_event_count
|loop_events
|
|-
|long
|1
|uevt_event_count
|
|-
|[[#UEVT Event|UEVT Event]]
|uevt_event_count
|uevt_events
|
|-
|long
|1
|effect_event_count
|
|-
|[[#Effect Event|Effect Event]]
|effect_event_count
|effect_events
|
|-
|long
|1
|sound_event_count
|Version 0x2 only
|-
|[[#Sound Event|Sound Event]]
|sound_event_count
|sound_events
|Version 0x2 only
|}

=== Event Base ===

{| class="wikitable"
!Offset
!Length
!Data Type
!Identifier
!Notes
|-
|<start>
|2
|short
|unknown0
|
|-
|+0x2
|<null-term>
|string
|event_name
|
|-
|++0x0
|2
|short
|event_type
|Enumerated event type (unknown values)
|-
|++0x2
|4
|float
|event_timestamp
|Time (in seconds) from start of [[ANIM (File Format)|ANIM]] to trigger event
|-
|++0x6
|4
|long
|unknown1
|
|-
|++0xA
|4
|long
|event_index
|Index of event unique from other events (perhaps used to maintain a ''triggered'' bitmap)
|-
|++0xE
|1
|bool
|unknown2
|Unknown Flag
|-
|++0xF
|4
|float
|unknown3
|
|-
|++0x13
|4
|float
|unknown4
|
|-
|++0x17
|4
|long
|unknown5
|
|-
|}

'''RWK Note:''' The ''props'' string is formatted as:
<code>
Type:<event_type> <unknown1> <unknown2> <unknown3> <unknown4> <unknown5>
</code>

=== Loop Event ===

{| class="wikitable"
!Offset
!Length
!Data Type
!Identifier
!Notes
|-
|<start>
|<varies>
|[[#Event Base|Event Base]]
|event_base
|
|-
|+0x0
|1
|bool
|unknown_flag
|
|}

=== UEVT Event ===

{| class="wikitable"
!Offset
!Length
!Data Type
!Identifier
!Notes
|-
|<start>
|<varies>
|[[#Event Base|Event Base]]
|event_base
|
|-
|+0x0
|4
|long
|uevt_type
|Enumerated UEVT type (unknown values)
|-
|+0x4
|<null-term>
|string
|bone_name
|[[CINF (File Format)|CINF]] Bone Name (for applicable events)
|}

=== Effect Event ===

{| class="wikitable"
!Offset
!Length
!Data Type
!Identifier
!Notes
|-
|<start>
|<varies>
|[[#Event Base|Event Base]]
|event_base
|
|-
|+0x0
|4
|long
|frame_count
|Number of frames to run effect-emitter for
|-
|+0x4
|4
|long
|effect_type
|FourCC of effect's type ([[PART (File Format)|PART]], [[SWHC (File Format)|SWHC]], [[ELSC (File Format)|ELSC]])
|-
|+0x8
|4
|long
|effect_ref
|ID of [[Effect Script|effect]] resource
|-
|+0xC
|<null-term>
|string
|bone_name
|[[CINF (File Format)|CINF]] Bone Name (for transforming effects)
|-
|++0x0
|4
|float
|effect_scale
|Proportional-scale to apply with effect in scene
|-
|++0x4
|4
|long
|transform_type
|Enumerated transform-mode relating effect to actor's bone:
<ol start="0">
<li>Effect-emitter transformed to bone for initial frame, then retained</li>
<li>Effect-emitter continuously transformed to bone</li>
<li>Entire effect (particle instances and all) continuously transformed to bone</li>
</ol>
|}

=== Sound Event ===

{| class="wikitable"
!Offset
!Length
!Data Type
!Identifier
!Notes
|-
|<start>
|<varies>
|[[#Event Base|Event Base]]
|event_base
|
|-
|+0x0
|4
|long
|sound_id
|Lower 16-bits are [[AGSC (File Format)|AGSC]] ''sound-id'' indirected via [[ATBL (File Format)|ATBL]]. Most-significant bit is a ''looped'' flag
|-
|+0x4
|4
|float
|ref_amplitude
|Reference amplitude for audio attenuation
|-
|+0x8
|4
|float
|ref_distance
|Reference distance for audio attenuation
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]

FONT (File Format)

2015-10-21T05:08:01Z

Antidote:

The '''FONT format''' defines fonts that can be used to display text in-game.

{{research|2|There's some unknowns in the header. Also, some version 4/5 fonts have outlines on their textures - how do these work?}}

__TOC__

== Format ==

Note: All measurements are in points.

=== Header ===

The header has a couple minor differences depending on the version. Version 1 (MP1 Kiosk Demo) is missing the value at 0x18, and starting in Version 5 (MP3/DKCR), the texture ID is 64 bits. Those are the only changes, though (and for that matter, those are the only differences in version 1/5).

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| char[4]
| 4
| '''"FONT" magic fourCC'''
|-
| 0x4
| u32
| 4
| '''Version'''; see below
|-
| 0x8
| u32
| 4
| {{unknown|'''Unknown'''}}
|-
| 0xC
| s32
| 4
| '''Line height'''
|-
| 0x10
| u32
| 4
| '''Vertical offset''' ''(note: not present in version 1)''
|-
| 0x14
| s32
| 4
| '''Line margin'''
|-
| 0x18
| bool
| 1
| {{unknown|'''Unknown'''}}
|-
| 0x19
| bool
| 1
| {{unknown|'''Unknown'''}}
|-
| 0x1A
| u32
| 4
| {{unknown|'''Unknown'''}}
|-
| 0x1E
| u32
| 4
| '''Font size'''
|-
| 0x22
| string
| N
| '''Font name'''; zero-terminated string
|-
| -
| [[TXTR (Metroid Prime)|TXTR]]
| 4/8
| '''Texture ID'''
|-
| -
| u32
| 4
| '''Texture format''' (see [[#Textures|Textures]])
|-
| -
| u32
| 4
| '''Glyph count'''
|}

==== Version ====

{| class="wikitable"
! Version
! Game
|-
| 1
| ''Metroid Prime'' Kiosk Demo
|-
| 2
| ''Metroid Prime'' NTSC
|-
| 4
| ''Metroid Prime'' PAL and ''Metroid Prime 2''
|-
| 5
| ''Metroid Prime 3'', ''DKCR''
|}

=== Glyphs ===

This section of the file details each glyph making up the font. One glyph corresponds to one character. To map the character with the part of the font texture that contains that character, each glyph contains a set of texture coordinates. Since the UV map is always rectangular, the file only stores the min/max X/Y coordinates; they should be mixed and matched to get the absolute values.

In addition, glyphs contain a vertical offset. This offset is necessary because the textures are usually so tightly packed that there's no extra space for vertical spacing. After applying the offset, the vertical offset from the FONT header is applied. This aligns the glyphs at their intended position.

The kerning index value is the index of the first kerning table entry for the given character. Since the table is sorted in alphabetical order, this can be used to speed up lookup time.

This section of the file changes somewhat from version 2 to 4. Starting in version 4, glyphs are able to be encoded to only one particular RGBA channel, which allows multiple glyphs to be encoded in the same space on the texture. A "channel index" value was introduced to track which channel the glyph is on. Additionally, a lot of 32-bit values were reduced to 8- or 16-bit. Aside from that, though, the actual layout is still the same, with the same values in the same places.

==== Version 2 (Metroid Prime NTSC) ====

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| '''UTF-16 character'''
|-
| 0x2
| float
| 4
| '''Left UV coordinate'''
|-
| 0x6
| float
| 4
| '''Top UV coordinate'''
|-
| 0xA
| float
| 4
| '''Right UV coordinate'''
|-
| 0xE
| float
| 4
| '''Bottom UV coordinate'''
|-
| 0x12
| u32
| 4
| '''Left padding'''
|-
| 0x16
| u32
| 4
| '''Print head advance'''
|-
| 0x1A
| u32
| 4
| '''Right padding'''
|-
| 0x1E
| u32
| 4
| '''Width'''
|-
| 0x22
| u32
| 4
| '''Height'''
|-
| 0x26
| u32
| 4
| '''Vertical offset'''
|-
| 0x2A
| u32
| 4
| '''Kerning index'''
|-
| 0x2E
| colspan=3 {{unknown|End of glyph definition}}
|}

==== Version 4 (Metroid Prime PAL/Trilogy) ====

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u16
| 2
| '''UTF-16 character'''
|-
| 0x2
| float
| 4
| '''Left UV coordinate'''
|-
| 0x6
| float
| 4
| '''Top UV coordinate'''
|-
| 0xA
| float
| 4
| '''Right UV coordinate'''
|-
| 0xE
| float
| 4
| '''Bottom UV coordinate'''
|-
| 0x12
| u8
| 1
| '''RGBA channel index'''
|-
| 0x13
| u8
| 1
| '''Glyph left padding'''
|-
| 0x14
| u8
| 1
| '''Print head advance'''
|-
| 0x15
| u8
| 1
| '''Glyph right padding'''
|-
| 0x16
| u8
| 1
| '''Glyph width'''
|-
| 0x17
| u8
| 1
| '''Glyph height'''
|-
| 0x18
| u8
| 1
| '''Vertical offset'''
|-
| 0x19
| u16
| 2
| '''Kerning index'''
|-
| 0x1B
| colspan=3 {{unknown|End of glyph definition}}
|}

=== Kerning Table ===

This table is at the end of the file, and defines kerning pairs. Kerning pairs horizontally adjust the second character of the pair whenever that particular sequence of characters is encountered. The table is case-sensitively sorted in alphabetical order, which allows for fast lookup times using the glyph kerning indices. After a 32-bit count value, each pair follows this simple structure:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 2
| '''Character 1'''
|-
| 0x2
| 2
| '''Character 2'''
|-
| 0x4
| 4
| '''Kerning adjust'''
|-
| 0x8
| colspan=2 {{unknown|End of entry}}
|}

== Textures ==

{{research|minor|Someone should look at the code to make sure the info in this section is accurate.}}

Textures used by FONT files are encoded in a bit of an unorthodox manner. The font format allows for multiple glyphs to be encoded in the same spot on the texture by splitting up the texture into multiple layers. The way this is handled on the textures is by encoding the textures with palettes (as C4), but modifying the palette indices at runtime and loading each layer one at a time as a separate texture. Each bit of the palette index corresponds to a layer, so up to four layers per font are supported. The MSB refers to layer 0, while the LSB refers to layer 3. In DKCR, font textures are encoded as C8, so theoretically the game could use up to eight layers per font; however, it still never actually uses more than four.

The texture format is determined by a value in the header. These are the possible settings:

{| class="wikitable"
! Value
! Description
! V1
! V2
! V4
! V5
|-
| 0
| One glyph layer, no outlines; fill on layer 0
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 1
| One glyph layer, with outlines; fill on layer 0, outline on layer 1
| {{check}}
| {{check}}
| {{check}}
| {{check}}
|-
| 2
| Four glyph layers, no outlines
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 3
| Two glyph layers, with outlines; fill on layers 0/2, outlines on layers 1/3
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 4
| Two glyph layers, no outlines; copies on layers 0/1, and layers 2/3
| {{nocheck}}
| {{nocheck}}
| {{check}}
| {{check}}
|-
| 8
| Two glyph layers, with outlines; fill on layers 2/3, outlines on layers 0/1
| {{nocheck}}
| {{nocheck}}
| {{nocheck}}
| {{check}}
|}

To dump out every layer into a single texture by encoding each layer on a separate RGBA channel, the following palette colors could be substituted into the texture:

{| class="wikitable"
! Index
! Binary
! Color
! Description
|-
| 0
| 0000
| 0x8000
| None
|-
| 1
| 0001
| 0x7000
| Alpha
|-
| 2
| 0010
| 0xFC00
| Blue
|-
| 3
| 0011
| 0x7F00
| Blue/Alpha
|-
| 4
| 0100
| 0x83E0
| Green
|-
| 5
| 0101
| 0x70F0
| Green/Alpha
|-
| 6
| 0110
| 0xFFE0
| Green/Blue
|-
| 7
| 0111
| 0x7FF0
| Green/Blue/Alpha
|-
| 8
| 1000
| 0x801F
| Red
|-
| 9
| 1001
| 0x700F
| Red/Alpha
|-
| 10
| 1010
| 0xFC1F
| Red/Blue
|-
| 11
| 1011
| 0x7F0F
| Red/Blue/Alpha
|-
| 12
| 1100
| 0x83FF
| Red/Green
|-
| 13
| 1101
| 0x70FF
| Red/Green/Alpha
|-
| 14
| 1110
| 0xFFFF
| Red/Green/Blue
|-
| 15
| 1111
| 0x7FFF
| Red/Green/Blue/Alpha
|}

[[Category:File Formats]]
[[Category:Metroid Prime]]
[[Category:Metroid Prime 2: Echoes]]
[[Category:Metroid Prime 3: Corruption]]
[[Category:Donkey Kong Country Returns]]

SCAN (Metroid Prime)

2015-09-25T22:19:45Z

Antidote:

''This article is for the SCAN format from Metroid Prime. For other revisions of this format, see [[SCAN (File Format)]].''

The '''SCAN file format''' describes scannable objects. It is a relatively simple format and has a static size.

__TOC__

== Format ==

The SCAN format is very simple; it has a header with data that contains general settings related to the scan, and then four structs defining how the scan images work. Even if a scan doesn't use four images, there are always four image structs, which means that the SCAN format has a static size; every SCAN file is 0x89 bytes (or 0xA0 bytes padded).

=== Header ===

The header is rather simple, and consists of the following:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Version'''; 3 for the demo, 5 for the final
|-
| 0x4
| 4
| '''Magic'''; always 0x0BADBEEF
|-
| 0x8
| 4
| '''[[FRME (File Format)|FRME]] ID'''
|-
| 0xC
| 4
| '''Scan text [[STRG (File Format)|STRG]] ID'''
|-
| 0x10
| 4
| '''Scan Speed Flag'''; 0 = normal fast scan, 1 = slower scan (usually found in boss fights)
|-
| 0x14
| 4
| '''Logbook Category'''; see below
|-
| 0x18
| 1
| '''Scan Icon Flag'''; 0 = orange icon, 1 = red icon
|-
| 0x19
| colspan=2 {{unknown|End of header}}
|}

==== Logbook Category ====

There are five possible values:

{| class="wikitable"
! ID
! Category
|-
| 0
| Not a logbook scan
|-
| 1
| Space Pirate Data
|-
| 2
| Chozo Lore
|-
| 3
| Creatures
|-
| 4
| Research
|}

=== Scan Images ===
Following the header is an array of four structs that contain settings for up to four scan images. Although there can be anywhere from 0 to 4 scan images attached to a scan, there are always four scan image entries here. Entries that aren't used have their TXTR ID set to 0xFFFFFFFF, with the rest of the settings mostly left at defaults. They follow this format:

{| class="wikitable"
! Offset
! Size
! Type
! Description
|-
| 0x0
| 4
| long
| '''[[TXTR (Metroid Prime)|TXTR]] ID'''
|-
| 0x4
| 4
| float
| '''Appearance %'''; image will appear when the scan is this% complete. Should range from 0 to 1.
|-
| 0x8
| 4
| long
| '''Image Position'''; See below.
|-
| 0xC
| 4
| long
| '''Width'''; 0 = no animation
|-
| 0x10
| 4
| long
| '''Height'''; 0 = no animation
|-
| 0x14
| 4
| float
| '''Interval'''; 0.0 = no animation
|-
| 0x18
| 4
| float
| '''Fade Duration'''; 0.0 = no fade
|-
| 0x1C
| colspan=3 {{unknown|End of entry}}
|}

==== Image Position ====

There are 20 possible values for the scan image's position; there are ten for the left side, and ten for the right:
{| class="wikitable"
! Value
! Size
! Position
! FRME_ScanHud Widget
|-
| 0x00
| 1/4
| Top-left corner
| imagepane_pane0
|-
| 0x01
| 1/4
| Upper-middle-left
| imagepane_pane1
|-
| 0x02
| 1/4
| Lower-middle-left
| imagepane_pane2
|-
| 0x03
| 1/4
| Bottom-left corner
| imagepane_pane3
|-
| 0x04
| 1/2
| Top-left corner
| imagepane_pane01
|-
| 0x05
| 1/2
| Middle-left
| imagepane_pane12
|-
| 0x06
| 1/2
| Bottom-left corner
| imagepane_pane23
|-
| 0x07
| 3/4
| Top-left corner
| imagepane_pane012
|-
| 0x08
| 3/4
| Bottom-left corner
| imagepane_pane123
|-
| 0x09
| 1
| Left side
| imagepane_pane0123
|-
| 0x0A
| 1/4
| Top-right corner
| imagepane_pane4
|-
| 0x0B
| 1/4
| Upper-middle-right
| imagepane_pane5
|-
| 0x0C
| 1/4
| Lower-middle-right
| imagepane_pane6
|-
| 0x0D
| 1/4
| Bottom-right corner
| imagepane_pane7
|-
| 0x0E
| 1/2
| Top-right corner
| imagepane_pane45
|-
| 0x0F
| 1/2
| Middle-right
| imagepane_pane56
|-
| 0x10
| 1/2
| Bottom-right corner
| imagepane_pane67
|-
| 0x11
| 3/4
| Top-right corner
| imagepane_pane456
|-
| 0x12
| 3/4
| Bottom-right corner
| imagepane_pane567
|-
| 0x13
| 1
| Right side
| imagepane_pane4567
|-
|}

<gallery mode=packed heights=200px>
File:Scan_offsets_1.png|Image positions 0x00, 0x01, and 0x02
File:Scan_offsets_3.png|Image positions for 0x04, 0x06, 0x0E, and 0x10
File:Scan_offset_101.png|Image positions for 0x03, 0x05, and 0x0F. Note that 0x03 appears only for this scan (Omega Pirate's projectiles) and no others.
File:Scan_offsets_10.png|Image positions for 0x09 and 0x13
File:Scan_position_10000.png|This unused Chozo Elder scan (hacked onto Parasite Queen) shows image positions 0x0A and 0x0D. This scan is the only one where these positions are used.
File:Scan_position_99.png|Image positions for 0x0B and 0x0C (unused)
File:Scan_offset_11.png|Image positions for 0x07 and 0x11 (unused)
File:Scan_offset_12.png|Image positions for 0x08 and 0x12 (unused)
</gallery>

==== Fly In Behavior ====

The first scan image to appear (based on the appearance percent value) will "fly in" from the side of the screen toward the center. The remaining images will "fade in" without moving. The only exception to this is when the first image to appear is a "blank" image with no associated [[TXTR (Metroid Prime)|TXTR]]. In this case, no image will fly in (i.e., all images will fade in).

==== Scan Animations ====
[[Image:AnimatedscanFinal.gif|thumb|The terminal with an animated scan image in the Map Facility.]]
An extremely small number of scans display animated images in Metroid Prime. In the final version of the game, only a terminal in the Map Facility displays an animated image. In the demo version of the game, the aforementioned terminal scan and the Parasite Queen scan both display animated images. For most SCAN files, the last 32 bits of the scan image entry are zeroed out, but for the animated scans, these 32 bits have actual values in them. Strangely, the terminal directly to the left of the animated terminal in the Map Facility also has non-zero values for these 32 bits, even though it does not display any animated images.

[[Category:File Formats]]
[[Category:Metroid Prime]]

SCAN (Metroid Prime)

2015-09-25T22:18:46Z

Antidote:

''This article is for the SCAN format from Metroid Prime. For other revisions of this format, see [[SCAN (File Format)]].''

The '''SCAN file format''' describes scannable objects. It is a relatively simple format and has a static size.

__TOC__

== Format ==

The SCAN format is very simple; it has a header with data that contains general settings related to the scan, and then four structs defining how the scan images work. Even if a scan doesn't use four images, there are always four image structs, which means that the SCAN format has a static size; every SCAN file is 0x89 bytes (or 0xA0 bytes padded).

=== Header ===

The header is rather simple, and consists of the following:

{| class="wikitable"
! Offset
! Size
! Description
|-
| 0x0
| 4
| '''Version'''; 3 for the demo, 5 for the final
|-
| 0x4
| 4
| '''Magic'''; always 0x0BADBEEF
|-
| 0x8
| 4
| '''[[FRME (File Format)|FRME]] ID'''
|-
| 0xC
| 4
| '''Scan text [[STRG (File Format)|STRG]] ID'''
|-
| 0x10
| 4
| '''Scan Speed Flag'''; 0 = normal fast scan, 1 = slower scan (usually found in boss fights)
|-
| 0x14
| 4
| '''Logbook Category'''; see below
|-
| 0x18
| 1
| '''Scan Icon Flag'''; 0 = orange icon, 1 = red icon
|-
| 0x19
| colspan=2 {{unknown|End of header}}
|}

==== Logbook Category ====

There are five possible values:

{| class="wikitable"
! ID
! Category
|-
| 0
| Not a logbook scan
|-
| 1
| Space Pirate Data
|-
| 2
| Chozo Lore
|-
| 3
| Creatures
|-
| 4
| Research
|}

=== Scan Images ===
Following the header is an array of four structs that contain settings for up to four scan images. Although there can be anywhere from 0 to 4 scan images attached to a scan, there are always four scan image entries here. Entries that aren't used have their TXTR ID set to 0xFFFFFFFF, with the rest of the settings mostly left at defaults. They follow this format:

{| class="wikitable"
! Offset
! Size
! Type
! Description
|-
| 0x0
| 4
| long
| '''[[TXTR (Metroid Prime)|TXTR]] ID'''
|-
| 0x4
| 4
| float
| '''Appearance %'''; image will appear when the scan is this% complete. Should range from 0 to 1.
|-
| 0x8
| 4
| long
| '''Image Position'''; See below.
|-
| 0xC
| 4
| long
| '''Width'''; 0 = no animation
|-
| 0x10
| 4
| long
| '''Height'''; 0 = no animation
|-
| 0x14
| 4
| float
| '''Interval'''; 0.0 = no animation
|-
| 0x18
| 4
| float
| '''Fade Duration'''; 0.0 = no fade
|-
| 0x1C
| colspan=3 {{unknown|End of entry}}
|}

==== Image Position ====

There are 20 possible values for the scan image's position; there are ten for the left side, and ten for the right:
{| class="wikitable"
! Value
! Size
! Position
! FRME_ScanHud Widget
|-
| 0x00
| 1/4
| Top-left corner
| imagepane_pane0
|-
| 0x01
| 1/4
| Upper-middle-left
| imagepane_pane1
|-
| 0x02
| 1/4
| Lower-middle-left
| imagepane_pane2
|-
| 0x03
| 1/4
| Bottom-left corner
| imagepane_pane3
|-
| 0x04
| 1/2
| Top-left corner
| imagepane_pane01
|-
| 0x05
| 1/2
| Middle-left
| imagepane_pane12
|-
| 0x06
| 1/2
| Bottom-left corner
| imagepane_pane23
|-
| 0x07
| 3/4
| Top-left corner
| imagepane_pane012
|-
| 0x08
| 3/4
| Bottom-left corner
| imagepane_pane123
|-
| 0x09
| 1
| Left side
| imagepane_pane0123
|-
| 0x0A
| 1/4
| Top-right corner
| imagepane_pane4
|-
| 0x0B
| 1/4
| Upper-middle-right
| imagepane_pane5
|-
| 0x0C
| 1/4
| Lower-middle-right
| imagepane_pane6
|-
| 0x0D
| 1/4
| Bottom-right corner
| imagepane_pane7
|-
| 0x0E
| 1/2
| Top-right corner
| imagepane_pane45
|-
| 0x0F
| 1/2
| Middle-right
| imagepane_pane56
|-
| 0x10
| 1/2
| Bottom-right corner
| imagepane_pane67
|-
| 0x11
| 3/4
| Top-right corner
| imagepane_pane456
|-
| 0x12
| 3/4
| Bottom-right corner
| imagepane_pane567
|-
| 0x13
| 1
| Right side
| imagepane_pane4567
|-
|}

<gallery mode=packed heights=200px>
File:Scan_offsets_1.png|Image positions 0x00, 0x01, and 0x02
File:Scan_offsets_3.png|Image positions for 0x04, 0x06, 0x0E, and 0x10
File:Scan_offset_101.png|Image positions for 0x03, 0x05, and 0x0F. Note that 0x03 appears only for this scan (Omega Pirate's projectiles) and no others.
File:Scan_offsets_10.png|Image positions for 0x09 and 0x13
File:Scan_position_10000.png|This unused Chozo Elder scan (hacked onto Parasite Queen) shows image positions 0x0A and 0x0D. This scan is the only one where these positions are used.
File:Scan_position_99.png|Image positions for 0x0B and 0x0C (unused)
File:Scan_offset_11.png|Image positions for 0x07 and 0x11 (unused)
File:Scan_offset_12.png|Image positions for 0x08 and 0x12 (unused)
</gallery>

==== Fly In Behavior ====

The first scan image to appear (based on the appearance percent value) will "fly in" from the side of the screen toward the center. The remaining images will "fade in" without moving. The only exception to this is when the first image to appear is a "blank" image with no associated [[TXTR (Metroid Prime)|TXTR]]. In this case, no image will fly in (i.e., all images will fade in).

==== Scan Animations ====
{{todo|Investigate what each of the four unknowns actually controls. The files are 3be96f49.SCAN, fe4e51c7.SCAN, and 1e4b491f.SCAN, though the latter only has non-zero values for the unknowns in the demo.}}

[[Image:AnimatedscanFinal.gif|thumb|The terminal with an animated scan image in the Map Facility.]]
An extremely small number of scans display animated images in Metroid Prime. In the final version of the game, only a terminal in the Map Facility displays an animated image. In the demo version of the game, the aforementioned terminal scan and the Parasite Queen scan both display animated images. For most SCAN files, the last 32 bits of the scan image entry are zeroed out, but for the animated scans, these 32 bits have actual values in them. Strangely, the terminal directly to the left of the animated terminal in the Map Facility also has non-zero values for these 32 bits, even though it does not display any animated images.

[[Category:File Formats]]
[[Category:Metroid Prime]]