Retro Modding Wiki - User contributions [en]

DSP (File Format)

2023-10-11T16:28:53Z

Encounter: Fix syntaxhighlight

The '''.dsp format''' is a common GameCube/Wii format for audio that comes with the SDK. It encodes sound using Nintendo's ADPCM codec. The same ADPCM codec is also embedded into several Retro Studios format, like [[AGSC (File Format)|AGSC]]; the [[CSMP (File Format)|CSMP]] format actually embeds the entire DSP format within it.

{{todo|An explanation of how ADPCM works would be nice to have somewhere on this page. Also, a better text explanation for the decoding process to go along with the example code.}}

__TOC__

== Header ==

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u32
| 4
| '''Sample count'''
|-
| 0x4
| u32
| 4
| '''ADPCM nibble count'''; includes frame headers
|-
| 0x8
| u32
| 4
| '''Sample rate'''
|-
| 0xC
| u16
| 2
| '''Loop flag'''; 1 means looped, 0 means not looped
|-
| 0xE
| u16
| 2
| '''Format'''; always 0
|-
| 0x10
| u32
| 4
| '''Loop start offset'''
|-
| 0x14
| u32
| 4
| '''Loop end offset'''
|-
| 0x18
| u32
| 4
| '''Current address'''; always 0
|-
| 0x1C
| s16[16]
| 2 × 16
| '''Decode coefficients'''; this is 8 pairs of signed 16-bit values
|-
| 0x3C
| u16
| 2
| '''Gain'''; always 0
|-
| 0x3E
| u16
| 2
| '''Initial predictor/scale'''; always matches first frame header
|-
| 0x40
| s16
| 2
| '''Initial sample history 1'''
|-
| 0x42
| s16
| 2
| '''Initial sample history 2'''
|-
| 0x44
| u16
| 2
| '''Loop context predictor/scale'''
|-
| 0x46
| s16
| 2
| '''Loop context sample history 1'''
|-
| 0x48
| s16
| 2
| '''Loop context sample history 2'''
|-
| 0x4A
| u16[11]
| 2 × 11
| '''Reserved'''
|-
| 0x60
| colspan=3 {{unknown|End of DSP header}}
|}

== ADPCM Data ==

The ADPCM audio data is split up into multiple ''frames''. Each frame is 8 bytes; it starts with a one-byte header, then has 7 bytes (or 14 samples) of audio data. For each frame header, the bottom 4 bits are the scale value, and the top 4 bits are the coefficient index to use for the current frame.

=== Example C Decoding Function ===

[https://github.com/kode54/vgmstream/blob/master/src/coding/ngc_dsp_decoder.c vgmstream] used as reference:

<syntaxhighlight lang="c">static const s8 nibble_to_s8[16] = {0,1,2,3,4,5,6,7,-8,-7,-6,-5,-4,-3,-2,-1};

s8 get_low_nibble(u8 byte) {
return nibble_to_s8[byte & 0xF];
}

s8 get_high_nibble(u8 byte) {
return nibble_to_s8[(byte >> 4) & 0xF];
}

s16 clamp(s32 val) {
if (val < -32768) val = -32768;
if (val > 32767) val = 32767;
return s16(val);
}

void DecodeADPCM(u8 *src, s16 *dst, const DSPHeader& d)
{
s16 hist1 = d.initial_hist1;
s16 hist2 = d.initial_hist2;
s16 *dst_end = dst + d.num_samples;

while (dst < dst_end)
{
// Each frame, we need to read the header byte and use it to set the scale and coefficient values:
u8 header = *src++;

u16 scale = 1 << (header & 0xF);
u8 coef_index = (header >> 4);
s16 coef1 = d.coefs[coef_index][0];
s16 coef2 = d.coefs[coef_index][1];

// 7 bytes per frame
for (u32 b = 0; b < 7; b++)
{
u8 byte = *src++;

// 2 samples per byte
for (u32 s = 0; s < 2; s++)
{
s8 adpcm_nibble = (s == 0) ? get_high_nibble(byte) : get_low_nibble(byte);
s16 sample = clamp(((adpcm_nibble * scale) << 11) + 1024 + ((coef1 * hist1) + (coef2 * hist2)) >> 11);

hist2 = hist1;
hist1 = sample;
*dst++ = sample;

if (dst >= dst_end) break;
}
if (dst >= dst_end) break;
}
}
}</syntaxhighlight>

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

DSP (File Format)

2023-10-11T16:27:42Z

Encounter: Fix syntaxhighlight

The '''.dsp format''' is a common GameCube/Wii format for audio that comes with the SDK. It encodes sound using Nintendo's ADPCM codec. The same ADPCM codec is also embedded into several Retro Studios format, like [[AGSC (File Format)|AGSC]]; the [[CSMP (File Format)|CSMP]] format actually embeds the entire DSP format within it.

{{todo|An explanation of how ADPCM works would be nice to have somewhere on this page. Also, a better text explanation for the decoding process to go along with the example code.}}

__TOC__

== Header ==

{| class="wikitable"
! Offset
! Type
! Size
! Description
|-
| 0x0
| u32
| 4
| '''Sample count'''
|-
| 0x4
| u32
| 4
| '''ADPCM nibble count'''; includes frame headers
|-
| 0x8
| u32
| 4
| '''Sample rate'''
|-
| 0xC
| u16
| 2
| '''Loop flag'''; 1 means looped, 0 means not looped
|-
| 0xE
| u16
| 2
| '''Format'''; always 0
|-
| 0x10
| u32
| 4
| '''Loop start offset'''
|-
| 0x14
| u32
| 4
| '''Loop end offset'''
|-
| 0x18
| u32
| 4
| '''Current address'''; always 0
|-
| 0x1C
| s16[16]
| 2 × 16
| '''Decode coefficients'''; this is 8 pairs of signed 16-bit values
|-
| 0x3C
| u16
| 2
| '''Gain'''; always 0
|-
| 0x3E
| u16
| 2
| '''Initial predictor/scale'''; always matches first frame header
|-
| 0x40
| s16
| 2
| '''Initial sample history 1'''
|-
| 0x42
| s16
| 2
| '''Initial sample history 2'''
|-
| 0x44
| u16
| 2
| '''Loop context predictor/scale'''
|-
| 0x46
| s16
| 2
| '''Loop context sample history 1'''
|-
| 0x48
| s16
| 2
| '''Loop context sample history 2'''
|-
| 0x4A
| u16[11]
| 2 × 11
| '''Reserved'''
|-
| 0x60
| colspan=3 {{unknown|End of DSP header}}
|}

== ADPCM Data ==

The ADPCM audio data is split up into multiple ''frames''. Each frame is 8 bytes; it starts with a one-byte header, then has 7 bytes (or 14 samples) of audio data. For each frame header, the bottom 4 bits are the scale value, and the top 4 bits are the coefficient index to use for the current frame.

=== Example C Decoding Function ===

[https://github.com/kode54/vgmstream/blob/master/src/coding/ngc_dsp_decoder.c vgmstream] used as reference:

<syntaxhighlight lang="c">
static const s8 nibble_to_s8[16] = {0,1,2,3,4,5,6,7,-8,-7,-6,-5,-4,-3,-2,-1};

s8 get_low_nibble(u8 byte) {
return nibble_to_s8[byte & 0xF];
}

s8 get_high_nibble(u8 byte) {
return nibble_to_s8[(byte >> 4) & 0xF];
}

s16 clamp(s32 val) {
if (val < -32768) val = -32768;
if (val > 32767) val = 32767;
return s16(val);
}

void DecodeADPCM(u8 *src, s16 *dst, const DSPHeader& d)
{
s16 hist1 = d.initial_hist1;
s16 hist2 = d.initial_hist2;
s16 *dst_end = dst + d.num_samples;

while (dst < dst_end)
{
// Each frame, we need to read the header byte and use it to set the scale and coefficient values:
u8 header = *src++;

u16 scale = 1 << (header & 0xF);
u8 coef_index = (header >> 4);
s16 coef1 = d.coefs[coef_index][0];
s16 coef2 = d.coefs[coef_index][1];

// 7 bytes per frame
for (u32 b = 0; b < 7; b++)
{
u8 byte = *src++;

// 2 samples per byte
for (u32 s = 0; s < 2; s++)
{
s8 adpcm_nibble = (s == 0) ? get_high_nibble(byte) : get_low_nibble(byte);
s16 sample = clamp(((adpcm_nibble * scale) << 11) + 1024 + ((coef1 * hist1) + (coef2 * hist2)) >> 11);

hist2 = hist1;
hist1 = sample;
*dst++ = sample;

if (dst >= dst_end) break;
}
if (dst >= dst_end) break;
}
}
}
</syntaxhighlight>

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

Metroid Prime

2021-10-08T18:20:53Z

Encounter: /* Formats */

'''Metroid Prime''' is the first game developed by Retro Studios.

__TOC__

== Builds ==

{| class="wikitable"
! Build
! Date/Time
! Version
|-
| {{none}}
| Jul 24 2002 14:11:18
| Multi-Game Demo Disc v7-9
|-
| v1.088
| 10/29/2002 2:21:25
| GameCube 0-00 NTSC (Original Release)
|-
| v1.093
| 11/5/2002 19:50:01
| GameCube 0-01 NTSC
|-
| v1.097
| 12/19/2002 16:03:43
| GameCube 0-30 NTSC-K
|-
| v1.101
| 1/14/2003 17:57:24
| EUR Interactive Multi-Game Demo Disc: February 2003
|-
| v1.110
| 2/4/2003 22:16:07
| GameCube 0-00 PAL
|-
| v1.111
| 2/11/2003 10:03:22
| GameCube 0-00 NTSC-J (Original JP Release)
|-
| v1.111
| 3/10/2003 17:56:21
| GameCube 0-02 NTSC (Player's Choice)
|-
| v3.570
| 2008/07/22 12:23
| Wii de Asobu
|-
| v3.593
| 2008/08/21 17:09
| Metroid Prime: Trilogy NTSC
|-
| v3.629
| 2009/01/15 14:08
| Metroid Prime: Trilogy PAL
|}

== Formats ==

{| class="wikitable"
! Format
! Contents
|-
| [[AFSM (File Format)|AFSM]]
| AI Finite State Machine
|-
| [[AGSC (File Format)|AGSC]]
| Audio Group Set
|-
| [[ANCS (File Format)|ANCS]]
| Animation/Character Set
|-
| [[ANIM (Metroid Prime)|ANIM]]
| Animation
|-
| [[ATBL (File Format)|ATBL]]
| Audio Lookup Table
|-
| [[CINF (File Format)|CINF]]
| Skeleton
|-
| [[CMDL (Metroid Prime)|CMDL]]
| Model
|-
| [[CRSC (File Format)|CRSC]]
| Collision Response Particle System
|-
| [[CSKR (File Format)|CSKR]]
| Skin Rules
|-
| [[CSNG (File Format)|CSNG]]
| MusyX MIDI File
|-
| [[CTWK (File Format)|CTWK]]
| Tweaks
|-
| [[DCLN (Metroid Prime)|DCLN]]
| Dynamic Collision
|-
| [[DGRP (File Format)|DGRP]]
| Dependency Group
|-
| [[DPSC (File Format)|DPSC]]
| Decal Particle System
|-
| [[DSP (File Format)|DSP]]
| Music
|-
| [[DUMB (File Format)|DUMB]]
| Binary Data
|-
| [[ELSC (File Format)|ELSC]]
| Electric Particle System
|-
| [[EVNT (File Format)|EVNT]]
| Animation Event Data
|-
| [[FONT (File Format)|FONT]]
| Font
|-
| [[FRME (File Format)|FRME]]
| GUI Frame
|-
| [[HINT (File Format)|HINT]]
| Hint System
|-
| [[MAPA (File Format)|MAPA]]
| Area Map
|-
| [[MAPU (File Format)|MAPU]]
| Universe Map
|-
| [[MAPW (File Format)|MAPW]]
| World Map
|-
| [[MLVL (File Format)|MLVL]]
| World
|-
| [[MREA (Metroid Prime)|MREA]]
| Area
|-
| [[PAK (Metroid Prime)|PAK]]
| Package
|-
| [[PART (File Format)|PART]]
| Particle System
|-
| [[PATH (File Format)|PATH]]
| Pathfinding
|-
| [[REL (File Format)|REL]]
| Relocatable Module
|-
| [[SAVW (File Format)|SAVW]]
| World Save Info
|-
| [[SCAN (Metroid Prime)|SCAN]]
| Scannable Object Info
|-
| [[STRG (File Format)|STRG]]
| String Table
|-
| [[SWHC (File Format)|SWHC]]
| Swoosh Particle System
|-
| [[THP (File Format)|THP]]
| Video
|-
| [[TXTR (Metroid Prime)|TXTR]]
| Texture
|-
| [[WPSC (File Format)|WPSC]]
| Weapon Particle System
|}

[[Category:Games]]
[[Category:Metroid Prime]]

Category:Retro Modding Wiki

2021-10-07T13:42:12Z

Encounter: Created blank page

MAPA (File Format)

2021-10-07T13:39:19Z

Encounter: /* Mappable Objects */

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, Mappable Object entries, Vertices, Primitive Headers, and the primitives.

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

__TOC__
== Format ==
=== Header ===
The header is very straightforward, and has some minor differences depending on version.

{| class="wikitable"
!Type
!Description
!MP1
!MP2
!MP3
|-
|u32
|'''Magic'''; Always 0xDEADD00D
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Version'''; See below
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Type'''; unknown function in MP1/3, specifies whether the area appears on the Light (0) or Dark (1) map in MP2
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Visibility Mode'''; <ol start=0><li>Always Visible (Map Universe Area)</li><li>Visible on Visit or Map Station (most MP1 areas)</li><li>Visible on Visit only (latter areas of Ruins and Phendrana)</li><li>Never Visible</li></ol>
|{{check}}
|{{check}}
|{{check}}
|-
|{{AABox}}
|'''Bounding Box'''
|{{check}}
|{{check}}
|{{check}}
|-
|{{Vector3f}}
|'''Map Adjustment'''
|{{nocheck}}
|{{check}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{nocheck}}
|{{nocheck}}
|{{check}}
|-
|u32
|'''Mappable Object Count'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Vertex Count'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Primitive Count'''
|{{check}}
|{{check}}
|{{check}}
|-
|u32
|'''Environment Variable Section Size'''
|{{nocheck}}
|{{nocheck}}
|{{check}}
|-
|u32
|'''Environment Variable Count'''
|{{nocheck}}
|{{nocheck}}
|{{check}}
|-
| colspan=5 {{unknown|End of Header}}
|}

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

=== Environment Variables ===
Only exists in Corruption; used for some areas with Landing Sites.
{|class="wikitable"
!Type
!Count
!Description
|-
|string
|Environment Variable Count
|'''Environment Variable'''
|-
| colspan=3 {{unknown|Pad to 4 bytes}}
|-
| colspan=3 {{unknown|End of Environment Variables}}
|}

=== Mappable Objects ===
A Mappable Object in the Metroid Prime series can include: Elevators, Doors, and Save/Missile Stations. Each Mappable Object entry consists of the following struct:
{|class="wikitable"
!Type
!Description
!MP1 & MP2
!MP3
|-
|u32
|'''Type'''; See table below for MP1 types
|{{check}}
|{{check}}
|-
|u32
|'''Visibility Mode'''; <ol start=0><li>Always Visible</li><li>Visible on Map Station or Area Visit</li><li>Visible on Door Visit</li><li>Never Visible</li><li>Visible on Map Station or Area Visit</li></ol>
|{{check}}
|{{check}}
|-
|u32
|'''Editor ID'''; Same ID format as SCLY, indicates associated world object
|{{check}}
|{{check}}
|-
|[[GUID]]
|'''Saved State ID'''
|{{nocheck}}
|{{check}}
|-
|u32
|{{unknown|Unknown}}
|{{check}}
|{{check}}
|-
|{{Transform4f}}
|'''Transform Matrix''' The Mappable Object's position in '''world''' space.
|{{check}}
|{{check}}
|-
|u32 * 4
|{{unknown|Unknown}}
|{{check}}
|{{check}}
|-
| colspan=4 {{unknown|End of Mappable Object}}
|}

==== MP1 Types ====
{|class="wikitable"
!Type
!Description
|-
|0
|Normal Door
|-
|1
|Shield Door
|-
|2
|Ice Door
|-
|3
|Wave Door
|-
|4
|Plasma Door
|-
|5
|Big Door
|-
|6
|Big Door 2
|-
|7
|Ice Door Ceiling
|-
|8
|Ice Door Floor
|-
|9
|Wave Door Ceiling
|-
|10
|Wave Door Floor
|-
|11
|Plasma Door Ceiling
|-
|12
|Plasma Door Floor
|-
|13
|Ice Door Floor 2
|-
|14
|Wave Door Floor 2
|-
|15
|Plasma Door Floor 2
|-
|27
|Down Arrow Yellow (Maintenance Tunnel)
|-
|28
|Up Arrow Yellow (Phazon Processing Center)
|-
|29
|Down Arrow Green (Elevator A)
|-
|30
|Up Arrow Green (Elite Control Access)
|-
|31
|Down Arrow Red (Elevator B)
|-
|32
|Up Arrow Red (Fungal Hall Access)
|-
|33
|Elevator
|-
|34
|Save Station
|-
|37
|Missile Station
|}

=== 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
|-
|{{Vector3f}}
|'''Normal'''
|-
|{{Vector3f}}
|'''Center of Mass'''
|-
|u32
|'''Primitive Table Start'''; relative to the end of the header
|-
|u32
|'''Border Table Start'''; relative to the end of the 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]]

Switch (Metroid Prime)

2021-10-07T13:35:30Z

Encounter: Encounter moved page Switch to Switch (Metroid Prime) without leaving a redirect

A Switch is a script object that can be in one of two states: Open or Closed.

* Send an "Open" message to set its state to Open
* Send a "Close" message to set its state to Closed
* Send a "SetToZero" message to activate the switch.
* When activated, the switch will send messages using the "Closed" state if it's closed, or the "Open" state if it's open.

SpecialFunction (Metroid Prime)

2021-10-07T13:35:23Z

Encounter: Encounter moved page SpecialFunction to SpecialFunction (Metroid Prime) without leaving a redirect

SpecialFunctions are script objects that can do a multitude of things depending what the Function enum is set to.

=== PlayerInArea ===

* Sends messages on the "Entered" state when the player enters the area.
* Sends messages on the "Exited" state when the player leaves the area.

Tweaks (Metroid Prime)

2021-10-07T13:18:51Z

Encounter:

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

== Player ==
{| class="wikitable"
! Offset
! Type
! Description
! Value
|-
| 0x0
| float
| '''MaxTranslationalAcceleration0'''
| 35000.0
|-
| 0x4
| float
| '''MaxTranslationalAcceleration1'''
| 8000.0
|-
| 0x8
| float
| '''MaxTranslationalAcceleration2'''
| 35000.0
|-
| 0xC
| float
| '''MaxTranslationalAcceleration3'''
| 35000.0
|-
| 0x10
| float
| '''MaxTranslationalAcceleration4'''
| 20000.0
|-
| 0x14
| float
| '''MaxTranslationalAcceleration5'''
| 20000.0
|-
| 0x18
| float
| '''MaxTranslationalAcceleration6'''
| 20000.0
|-
| 0x1C
| float
| '''MaxTranslationalAcceleration7'''
| 20000.0
|-
| 0x20
| float
| '''MaxRotationalAcceleration0'''
| 14000.0
|-
| 0x24
| float
| '''MaxRotationalAcceleration1'''
| 14000.0
|-
| 0x28
| float
| '''MaxRotationalAcceleration2'''
| 14000.0
|-
| 0x2C
| float
| '''MaxRotationalAcceleration3'''
| 14000.0
|-
| 0x30
| float
| '''MaxRotationalAcceleration4'''
| 14000.0
|-
| 0x34
| float
| '''MaxRotationalAcceleration5'''
| 14000.0
|-
| 0x38
| float
| '''MaxRotationalAcceleration6'''
| 14000.0
|-
| 0x3C
| float
| '''MaxRotationalAcceleration7'''
| 14000.0
|-
| 0x40
| float
| '''TranslationFriction0'''; Ground Translation Friction
| 1.0
|-
| 0x44
| float
| '''TranslationFriction1'''; Air Translation Friction
| 0.75
|-
| 0x48
| float
| '''TranslationFriction2'''
| 1.0
|-
| 0x4C
| float
| '''TranslationFriction3'''
| 1.0
|-
| 0x50
| float
| '''TranslationFriction4'''
| 1.0
|-
| 0x54
| float
| '''TranslationFriction5'''
| 1.0
|-
| 0x58
| float
| '''TranslationFriction6'''
| 1.0
|-
| 0x5C
| float
| '''TranslationFriction7'''
| 1.0
|-
| 0x60
| float
| '''RotationFriction0'''; Ground Rotation Friction
| 0.44999999
|-
| 0x64
| float
| '''RotationFriction1'''; Air Rotation Friction
| 0.44999999
|-
| 0x68
| float
| '''RotationFriction2'''
| 0.44999999
|-
| 0x6C
| float
| '''RotationFriction3'''
| 0.44999999
|-
| 0x70
| float
| '''RotationFriction4'''
| 0.44999999
|-
| 0x74
| float
| '''RotationFriction5'''
| 0.44999999
|-
| 0x78
| float
| '''RotationFriction6'''
| 0.44999999
|-
| 0x7C
| float
| '''RotationFriction7'''
| 0.44999999
|-
| 0x80
| float
| '''RotationMaxSpeed0'''; Ground Rotation Max Speed
| 2.5
|-
| 0x84
| float
| '''RotationMaxSpeed1'''; Air Rotation Max Speed
| 2.5
|-
| 0x88
| float
| '''RotationMaxSpeed2'''
| 2.5
|-
| 0x8C
| float
| '''RotationMaxSpeed3'''
| 2.5
|-
| 0x90
| float
| '''RotationMaxSpeed4'''
| 2.5
|-
| 0x94
| float
| '''RotationMaxSpeed5'''
| 2.5
|-
| 0x98
| float
| '''RotationMaxSpeed6'''
| 2.5
|-
| 0x9C
| float
| '''RotationMaxSpeed7'''
| 2.5
|-
| 0xA0
| float
| '''TranslationMaxSpeed0'''
| 16.5
|-
| 0xA4
| float
| '''TranslationMaxSpeed1'''
| 16.5
|-
| 0xA8
| float
| '''TranslationMaxSpeed2'''
| 16.5
|-
| 0xAC
| float
| '''TranslationMaxSpeed3'''
| 16.5
|-
| 0xB0
| float
| '''TranslationMaxSpeed4'''
| 12.5
|-
| 0xB4
| float
| '''TranslationMaxSpeed5'''
| 12.5
|-
| 0xB8
| float
| '''TranslationMaxSpeed6'''
| 12.5
|-
| 0xBC
| float
| '''TranslationMaxSpeed7'''
| 12.5
|-
| 0xC0
| float
| '''NormalGravityAccel'''
| -35.0
|-
| 0xC4
| float
| '''FluidGravityAccel'''
| -10.0
|-
| 0xC8
| float
| '''VerticalJumpAccel'''
| 50.0
|-
| 0xCC
| float
| '''HorizontalJumpAccel'''
| 50.0
|-
| 0xD0
| float
| '''VerticalDoubleJumpAccel'''
| 60.0
|-
| 0xD4
| float
| '''HorizontalDoubleJumpAccel'''
| 60.0
|-
| 0xD8
| float
| '''WaterJumpFactor'''
| 0.37
|-
| 0xDC
| float
| '''WaterBallJumpFactor'''
| 0.37
|-
| 0xE0
| float
| '''LavaJumpFactor'''
| 0.37
|-
| 0xE4
| float
| '''LavaBallJumpFactor'''
| 0.37
|-
| 0xE8
| float
| '''PhazonJumpFactor'''
| 0.37
|-
| 0xEC
| float
| '''PhazonBallJumpFactor'''
| 0.37
|-
| 0xF0
| float
| '''AllowedJumpTime'''
| 0.235
|-
| 0xF4
| float
| '''AllowedDoubleJumpTime'''
| 0.1
|-
| 0xF8
| float
| '''MinDoubleJumpWindow'''
| 0.0
|-
| 0xFC
| float
| '''MaxDoubleJumpWindow'''
| 2.0
|-
| 0x100
| float
| {{unknown|'''Unknown'''}}
| 0.0
|-
| 0x104
| float
| '''MinJumpTime'''
| 0.235
|-
| 0x108
| float
| '''MinDoubleJumpTime'''
| 0.1
|-
| 0x10C
| float
| '''AllowedLedgeTime'''
| 0.050000001
|-
| 0x110
| float
| '''DoubleJumpImpulse'''
| 8.0
|-
| 0x114
| float
| '''BackwardsForceMultiplier'''
| 1.0
|-
| 0x118
| float
| '''BombJumpRadius'''
| 7.9000001
|-
| 0x11C
| float
| '''BombJumpHeight'''
| 1.5
|-
| 0x120
| float
| '''EyeOffset'''
| 0.2
|-
| 0x124
| float
| '''TurnSpeedMultiplier'''
| 1.0
|-
| 0x128
| float
| '''FreeLookTurnSpeedMultiplier'''
| 1.0
|-
| 0x12C
| float
| '''HorizontalFreeLookAngleVel'''
| 100.0
|-
| 0x130
| float
| '''VerticalFreeLookAngleVel'''
| 70.0
|-
| 0x134
| float
| '''FreeLookSpeed'''
| 100.0
|-
| 0x138
| float
| '''FreeLookSnapSpeed'''
| 200.0
|-
| 0x13C
| float
| {{unknown|'''Unknown'''}}
| 5.0
|-
| 0x140
| float
| '''FreeLookCenteredThresholdAngle'''
| 0.1
|-
| 0x144
| float
| '''FreeLookCenteredTime'''
| 0.25
|-
| 0x148
| float
| '''FreeLookDampenFactor'''
| 80.0
|-
| 0x14C
| float
| '''LeftDiv'''
| 1.0
|-
| 0x150
| float
| '''RightDiv'''
| 1.0
|-
| 0x154
| bool
| '''FreeLookTurnsPlayer'''
| true
|-
| 0x155
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x156
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x157
| bool
| '''MoveDuringFreeLook'''
| false
|-
| 0x158
| bool
| '''HoldButtonsForFreeLook'''
| true
|-
| 0x159
| bool
| '''TwoButtonsForFreeLook'''
| false
|-
| 0x15A
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x15B
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x15C
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x15D
| bool
| '''AimWhenOrbitingPoint'''
| true
|-
| 0x15E
| bool
| '''StayInFreeLookWhileFiring'''
| true
|-
| 0x15F
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x160
| bool
| {{unknown|'''Unknown'''}}
| false
|-
| 0x161
| bool
| '''OrbitFixedOffset'''
| false
|-
| 0x162
| bool
| '''GunButtonTogglesHolster'''
| false
|-
| 0x163
| bool
| '''GunNotFiringTogglesHolster'''
| true
|-
| 0x164
| bool
| '''FallingDoubleJump'''
| false
|-
| 0x165
| bool
| '''ImpulseDoubleJump'''
| true
|-
| 0x166
| bool
| '''FiringCancelsCameraPitch'''
| true
|-
| 0x167
| bool
| '''AssistedAimingIgnoreHorizontal'''
| true
|-
| 0x168
| bool
| '''AssistedAimingIgnoreVertical'''
| true
|-
| 0x169
| float
| {{unknown|'''Unknown'''}}
| 0.1
|-
| 0x16D
| float
| {{unknown|'''Unknown'''}}
| 0.25
|-
| 0x171
| float
| '''AimMaxDistance'''
| 100.0
|-
| 0x175
| float
| {{unknown|'''Unknown'''}}
| 30.0
|-
| 0x179
| float
| {{unknown|'''Unknown'''}}
| 30.0
|-
| 0x17D
| float
| {{unknown|'''Unknown'''}}
| 50.0
|-
| 0x181
| float
| {{unknown|'''Unknown'''}}
| 60.0
|-
| 0x185
| float
| {{unknown|'''Unknown'''}}
| 110.0
|-
| 0x189
| float
| '''AimThresholdDistance'''
| 5.0
|-
| 0x18D
| float
| {{unknown|'''Unknown'''}}
| 360.0
|-
| 0x191
| float
| {{unknown|'''Unknown'''}}
| 10.0
|-
| 0x195
| float
| '''AimBoxWidth'''
| 20.0
|-
| 0x199
| float
| '''AimBoxHeight'''
| 10.0
|-
| 0x19D
| float
| '''AimTargetTimer'''
| 0.0099999998
|-
| 0x1A1
| float
| '''AimAssistHorizontalAngle'''
| 5.0
|-
| 0x1A5
| float
| '''AimAssistVerticalAngle'''
| 5.0
|-
| 0x1A9
| float
| '''OrbitMinDistance0'''
| 27.0
|-
| 0x1AD
| float
| '''OrbitNormalDistance0'''
| 75.0
|-
| 0x1B1
| float
| '''OrbitMaxDistance0'''
| 100.0
|-
| 0x1B5
| float
| '''OrbitMinDistance1'''
| 27.0
|-
| 0x1B9
| float
| '''OrbitNormalDistance1'''
| 75.0
|-
| 0x1BD
| float
| '''OrbitMaxDistance1'''
| 100.0
|-
| 0x1C1
| float
| '''OrbitMinDistance2'''
| 2.5
|-
| 0x1C5
| float
| '''OrbitNormalDistance2'''
| 75.0
|-
| 0x1C9
| float
| '''OrbitMaxDistance2'''
| 100.0
|-
| 0x1CD
| float
| {{unknown|'''Unknown'''}}
| 360.0
|-
| 0x1D1
| float
| '''OrbitModeTimer'''
| 0.2
|-
| 0x1D5
| float
| '''OrbitCameraSpeed'''
| 360.0
|-
| 0x1D9
| float
| '''OrbitUpperAngle'''
| 70.0
|-
| 0x1DD
| float
| '''OrbitLowerAngle'''
| 70.0
|-
| 0x1E1
| float
| '''OrbitHorizAngle'''
| 45.0
|-
| 0x1E5
| float
| {{unknown|'''Unknown'''}}
| 25.0
|-
| 0x1E9
| float
| {{unknown|'''Unknown'''}}
| 25.0
|-
| 0x1ED
| float
| '''OrbitMaxTargetDistance'''
| 100.0
|-
| 0x1F1
| float
| '''OrbitMaxLockDistance'''
| 100.0
|-
| 0x1F5
| float
| '''OrbitDistanceThreshold'''
| 2.0
|-
| 0x1F9
| int
| '''OrbitScreenBoxHalfExtentX0'''
| 180
|-
| 0x1FD
| int
| '''OrbitScreenBoxHalfExtentY0'''
| 180
|-
| 0x201
| int
| '''OrbitScreenBoxCenterX0'''
| 320
|-
| 0x205
| int
| '''OrbitScreenBoxCenterY0'''
| 224
|-
| 0x209
| int
| '''OrbitZoneIdealX0'''
| 320
|-
| 0x20D
| int
| '''OrbitZoneIdealY0'''
| 224
|-
| 0x211
| int
| '''OrbitScreenBoxHalfExtentX1'''
| 126
|-
| 0x215
| int
| '''OrbitScreenBoxHalfExtentY1'''
| 44
|-
| 0x219
| int
| '''OrbitScreenBoxCenterX1'''
| 320
|-
| 0x21D
| int
| '''OrbitScreenBoxCenterY1'''
| 224
|-
| 0x221
| int
| '''OrbitZoneIdealX1'''
| 320
|-
| 0x225
| int
| '''OrbitZoneIdealY1'''
| 224
|-
| 0x229
| float
| '''OrbitNearX'''
| 20.0
|-
| 0x22D
| float
| '''OrbitNearZ'''
| 10.0
|-
| 0x231
| float
| {{unknown|'''Unknown'''}}
| 3.0
|-
| 0x235
| float
| {{unknown|'''Unknown'''}}
| 6.0
|-
| 0x239
| float
| '''OrbitFixedOffsetZDiff'''
| 0.2
|-
| 0x23D
| float
| '''OrbitZRange'''
| 0.2
|-
| 0x241
| float
| {{unknown|'''Unknown'''}}
| 5.0
|-
| 0x245
| float
| {{unknown|'''Unknown'''}}
| 90.0
|-
| 0x249
| float
| {{unknown|'''Unknown'''}}
| 2.0
|-
| 0x24D
| float
| '''OrbitPreventionTime'''
| 2.0
|-
| 0x251
| bool
| '''DashEnabled'''
| true
|-
| 0x252
| bool
| '''DashOnButtonRelease'''
| true
|-
| 0x253
| float
| '''DashButtonHoldCancelTime'''
| 0.30000001
|-
| 0x257
| float
| '''DashStrafeInputThreshold'''
| 0.40000001
|-
| 0x25B
| float
| '''SidewaysDoubleJumpImpulse'''
| 8.0
|-
| 0x25F
| float
| '''SidewaysVerticalDoubleJumpAccel'''
| 5.0
|-
| 0x263
| float
| '''SidewaysHorizontalDoubleJumpAccel'''
| 50.0
|-
| 0x267
| float
| '''ScanningRange'''
| 50.0
|-
| 0x26B
| bool
| '''ScanRetention'''
| true
|-
| 0x26C
| bool
| '''ScanFreezesGame'''
| true
|-
| 0x26D
| bool
| '''OrbitWhileScanning'''
| true
|-
| 0x26E
| float
| '''ScanMaxTargetDistance'''
| 100.0
|-
| 0x272
| float
| '''ScanMaxLockDistance'''
| 100.0
|-
| 0x276
| float
| '''OrbitDistanceMax'''
| 25.0
|-
| 0x27A
| float
| '''GrappleSwingLength'''
| 10.0
|-
| 0x27E
| float
| '''GrappleSwingPeriod'''
| 3.3
|-
| 0x282
| float
| '''GrapplePullSpeedMin'''
| 23.0
|-
| 0x286
| float
| '''GrappleCameraSpeed'''
| 90.0
|-
| 0x28A
| float
| '''MaxGrappleLockedTurnAlignDistance'''
| 0.5
|-
| 0x28E
| float
| '''GrapplePullSpeedProportion'''
| 2.0
|-
| 0x292
| float
| '''GrapplePullSpeedMax'''
| 30.0
|-
| 0x296
| float
| '''GrappleLookCenterSpeed'''
| 90.0
|-
| 0x29A
| float
| '''MaxGrappleTurnSpeed'''
| 35.0
|-
| 0x29E
| float
| '''GrappleJumpForce'''
| 13.0
|-
| 0x2A2
| float
| '''GrappleReleaseTime'''
| 1.0
|-
| 0x2A6
| int
| '''GrappleJumpMode'''
| 2
|-
| 0x2AA
| bool
| '''OrbitReleaseBreaksGrapple'''
| true
|-
| 0x2AB
| bool
| '''InvertGrappleTurn'''
| true
|-
| 0x2AC
| float
| '''GrappleBeamSpeed'''
| 30.0
|-
| 0x2B0
| float
| '''GrappleBeamXWaveAmplitude'''
| 0.25
|-
| 0x2B4
| float
| '''GrappleBeamZWaveAmplitude'''
| 0.125
|-
| 0x2B8
| float
| '''GrappleBeamAnglePhaseDelta'''
| 0.875
|-
| 0x2BC
| float
| '''PlayerHeight'''
| 2.7
|-
| 0x2C0
| float
| '''PlayerXYHalfExtent'''
| 0.5
|-
| 0x2C4
| float
| '''StepUpHeight'''
| 1.0
|-
| 0x2C8
| float
| '''StepDownHeight'''
| 0.80000001
|-
| 0x2CC
| float
| '''PlayerBallHalfExtent'''
| 0.69999999
|-
| 0x2D0
| float
| '''FirstPersonCameraSpeed'''
| 60.0
|-
| 0x2D4
| float
| {{unknown|'''Unknown'''}}
| 0.0
|-
| 0x2D8
| float
| '''JumpCameraPitchDownStart'''
| 0.1
|-
| 0x2DC
| float
| '''JumpCameraPitchDownFull'''
| 4.0
|-
| 0x2E0
| float
| '''JumpCameraPitchDownAngle'''
| 73.0
|-
| 0x2E4
| float
| '''FallCameraPitchDownStart'''
| 0.30000001
|-
| 0x2E8
| float
| '''FallCameraPitchDownFull'''
| 4.0
|-
| 0x2EC
| float
| '''FallCameraPitchDownAngle'''
| 73.0
|-
| 0x2F0
| float
| {{unknown|'''Unknown'''}}
| 2.0
|-
| 0x2F4
| float
| {{unknown|'''Unknown'''}}
| 1.5
|-
| 0x2F8
| float
| {{unknown|'''Unknown'''}}
| 0.5
|-
| 0x2FC
| bool
| {{unknown|'''Unknown'''}}
| true
|-
| 0x2FD
| float
| '''FrozenTimeout'''
| 18.0
|-
| 0x301
| int
| '''IceBreakJumpCount'''
| 4
|-
| 0x305
| float
| '''VariaDamageReduction'''
| 0.1
|-
| 0x309
| float
| '''GravityDamageReduction'''
| 0.2
|-
| 0x30D
| float
| '''PhazonDamageReduction'''
| 0.5

[[Category:Metroid Prime]]

Retro Modding Wiki:About

2021-10-06T23:47:29Z

Encounter: Created page with "300px'''Retro Modding Wiki''' is the definitive resource containing all of the information gathered on formats used throughout Retro Studios' g..."

[[File:RetroModding.png|right|300px]]'''Retro Modding Wiki''' is the definitive resource containing all of the information gathered on formats used throughout Retro Studios' games: the critically-acclaimed Metroid Prime trilogy and the Donkey Kong Country Returns games. Our goal is to have a complete understanding of every file format and function in Retro Studio's games so that we can build level editors, import brand new assets, and create mods.

If you want to contribute and help us research these game files, [[Special:UserLogin|create an account]] and join our community devoted to modding Retro Studios titles. [https://m2k2.taigaforum.com/post/metroid_prime_hacking_research.html Be sure to also check out the main discussion thread in the forum as well!]

==History==

RMW started out as a [https://m2k2.taigaforum.com/post/metroid_prime_hacking_research.html forum post about hacking and modding Metroid Prime] created by [[User:Parax0|Parax]]. Over the course of the thread, a lot of progress has been made; many file formats were able to be read and edited, and a number of tools began development.

Eventually, the thread grew so large that it had become rather difficult to find information and collaborate on hacking files, so it was decided that a Wiki would be needed to document all the file formats and progress made. Since Retro Studios, the team behind the Metroid Prime trilogy and Donkey Kong Country Returns series, utilizes the same game engine for all of their games, we chose to name our wiki the Retro Modding Wiki, as the progress made so far encompasses all of their games.

On January 22nd, [[User:Nate|Nate]], owner of Metroid2002.com, was gracious enough to host this wiki on his website. Several contributors from the forum soon joined to further support this challenging hacking endeavor and expand the Wiki to its current state.

File:RetroModding.png

2021-10-06T23:46:54Z

Encounter:

File:Scan offset 12.png

2021-10-06T23:43:19Z

Encounter:

File:Scan offset 11.png

2021-10-06T23:43:01Z

Encounter:

File:Scan position 99.png

2021-10-06T23:42:42Z

Encounter:

File:Scan position 10000.png

2021-10-06T23:42:23Z

Encounter:

File:Scan offsets 10.png

2021-10-06T23:42:03Z

Encounter:

File:Scan offset 101.png

2021-10-06T23:41:26Z

Encounter:

File:Scan offsets 3.png

2021-10-06T23:41:09Z

Encounter:

File:Scan offsets 1.png

2021-10-06T23:40:53Z

Encounter:

File:AnimatedscanFinal.gif

2021-10-06T23:39:58Z

Encounter:

File:ATEX example crunchy.gif

2021-10-06T23:39:18Z

Encounter:

File:ATEX example.png

2021-10-06T23:39:05Z

Encounter:

File:Morphball model.png

2021-10-06T23:38:32Z

Encounter:

Category:Hub Articles

2021-10-06T23:38:00Z

Encounter: Created blank page

Category:Games

2021-10-06T23:37:51Z

Encounter: Created blank page

Category:File Formats

2021-10-06T23:37:39Z

Encounter: Created blank page

File:Morphball render.png

2021-10-06T23:37:10Z

Encounter:

File:Morphball wirerender.png

2021-10-06T23:36:46Z

Encounter:

File:Powercannon render3.png

2021-10-06T23:36:25Z

Encounter:

File:Morphball wire.png

2021-10-06T23:33:34Z

Encounter:

File:GravitySuitIcon.png

2021-10-06T23:31:02Z

Encounter:

Retro Modding Wiki

2021-10-06T23:27:04Z

Encounter: Encounter moved page Retro Modding Wiki to Main Page

#REDIRECT [[Main Page]]

Main Page

2021-10-06T23:27:04Z

Encounter: Encounter moved page Retro Modding Wiki to Main Page

<br>
<div style="overflow-x:auto;">
{| cellspacing="3" style="padding:0px; margin:0px; width:100%; background-color: transparent; white-space:nowrap;"
|colspan=2|
{| width=100% style="padding:0px; background-color: transparent;"
|style="width:40%; text-align:center; white-space:nowrap;"|
<div style="font-size:162%">Welcome to the [[Retro Modding Wiki:About|Retro Modding Wiki]]</div>
<div style="font-size: 95%">an encyclopedia about modding and hacking games from Retro Studios.</div>
<div style="font-size: 75%">With [[Special:Statistics|{{NUMBEROFARTICLES}}]] articles and counting.</div>
|style="width:16%"|
*[[Metroid Prime]]
*[[Metroid Prime 2: Echoes]]
*[[Metroid Prime 3: Corruption‏‎]]
|style="width:16%"|
*[[Donkey Kong Country Returns]]
*[[Donkey Kong Country Returns 3D]]
*[[Donkey Kong Country: Tropical Freeze‏‎]]
|style="width:16%"|
*[[:Category:File Formats‏‎|File Formats‏‎]]
*'''[[Special:Categories|All categories]]'''
|}
|}
</div>
<br>
{{Mainpagelinks}}
<noinclude>[[Category:Retro Modding Wiki]]</noinclude>

Main Page

2021-10-06T23:26:13Z

Encounter: