View source for Actor Replacement

This tutorial will show you how to replace any actor, object, or variable in the game, with the exception of those which are dynamically spawned.

==Reference Material==

===Finding Room Headers===

To find room headers, you'll need a memory viewer. If your emulator doesn't come with one, enable the audio debugger and use its "memory dump" page.

# Open the specific version of Majora's Mask you're making codes for.
# Go to the room you whose header you wish to find.
# Go to '''80460DEC''' (Debug ROM) in the memory viewer
#* If not using the debug ROM, check the [[Room Pointers]] page for the version you are using.
# Go to the address at this location (4 bytes long, starts with '''80''') in the memory viewer.
# This will bring you to the room header.

===Understanding Room Headers===
More details about these commands can be found on the [[Scenes and Rooms]] page.

{| class="wikitable"
| <span style="color:black">18000000 bboooooo</span> || 
|-
| <span style="color:red">16000000 000000yy</span> || <span style="color:orange">08xx0000 0000yyzz</span>
|-
| <span style="color:green">12000000 xx010000</span> || <span style="color:blue">10000000 xxxxyy00</span>
|-
| <span style="color:navy">0A000000 bboooooo</span> || <span style="color:purple">0Bxx0000 bboooooo</span>
|-
| <span style="color:maroon">01xx0000 bboooooo</span> || <span style="color:magenta">14000000 00000000</span>
|}

* '''Alternate Setups List:''' <span style="color:black">18000000 bboooooo</span>
** Optional. If it doesn't exist, the scene only has one setup. If it does exist, it will have multiple scene setups

* '''Sound Settings:''' <span style="color:red">16000000 000000yy</span>
** '''y''' sets the echo level of the sound effects

* '''Room Behavior Settings:''' <span style="color:orange">08xx0000 0000yyzz</span>
** '''x''' and '''z''' affect various properties, such as Link's idling animation. This command hasn't been fully documented yet.

* '''Skybox Settings:''' <span style="color:green">12000000 xx000000</span>
** If '''x ≠ 0''', the skybox will be disabled.

* '''Time Settings:''' <span style="color:blue">10000000 xxxxyy00</span>
** '''x''' sets the time of day when entering the room.
*** If '''x = FFFF''', the room defaults to the current game time.
** '''y''' sets the speed at which time flows. The value can be negative.

* '''Mesh Header Location:''' <span style="color:navy">0A000000 bboooooo</span>
** '''b''' is the bank index. 03 is used to reference the current room file.
** '''o''' is the location of the room's mesh header, relative to the start of the file. This renders the room's model.
*** '''room header address''' + '''o''' = location of mesh header

* '''Object List:''' <span style="color:purple">0Bxx0000 bboooooo</span>
** '''x''' indicates the number of objects.
** '''b''' is the bank index. 03 is used to reference the current room file.
** '''o''' is the location of the room's object list, relative to the start of the file.
*** '''room header address''' + '''o''' = location of object list

* '''Actor List:''' <span style="color:maroon">01xx0000 bboooooo</span>
** '''x''' indicates the number of actors.
** '''b''' is the bank index. 03 is used to reference the current room file.
** '''o''' is the location of the room's actor list, relative to the start of the file.
*** '''room header address''' + '''o''' = location of actor list

* '''End of Header Command:''' <span style="color:magenta">14000000 00000000</span>
** This command tells the game that the header ends here.

===Understanding Actor Lists===

Each line represents a different actor.

{| class="wikitable"
| <span style="color:red">aaaaxxxx yyyyzzzz</span> || <span style="color:red">ccddee0B 0000vvvv</span>
|-
| <span style="color:orange">aaaaxxxx yyyyzzzz</span> || <span style="color:orange">ccddee00 0000vvvv</span>
|-
| <span style="color:green">aaaaxxxx yyyyzzzz</span> || <span style="color:green">ccddee9F 0000vvvv</span>
|-
| <span style="color:blue">aaaaxxxx yyyyzzzz</span> || <span style="color:blue">ccddee00 0000vvvv</span>
|-
| <span style="color:navy">aaaaxxxx yyyyzzzz</span> || <span style="color:navy">ccddee00 0000vvvv</span>
|-
| <span style="color:purple">aaaaxxxx yyyyzzzz</span> || <span style="color:purple">ccddee00 0000vvvv</span>
|-
| <span style="color:maroon">aaaaxxxx yyyyzzzz</span> || <span style="color:maroon">ccddee00 0000vvvv</span>
|}

* '''aaaa''' = [[Actor List|Actor Number]]
* '''xxxx''' = X Coordinates (Hex)
* '''yyyy''' = Y Coordinates (Hex)
* '''zzzz''' = Z Coordinates (Hex)
* '''cc''' = X Rotation (Hex)
* '''dd''' = Y Rotation (Hex)
* '''ee''' = Z Rotation (Hex)
* '''vvvv''' = [[Actor List (Variables)|Variable Number]]

===Understanding Object Lists===

Each group of four digits/two bytes (ex. 01A5) comprises an object number. If a room has an odd number of objects (05 in this example), you only need to pay attention to the first five groups of four digits.

{| class="wikitable"
|-
| <span style="color:red">aaaa</span><span style="color:green">bbbb</span> <span style="color:blue">cccc</span><span style="color:navy">dddd</span> || <span style="color:purple">eeee</span>0000 0163FFC8
|}

* <span style="color:red">aaaa</span> = Object #1
* <span style="color:green">bbbb</span> = Object #2
* <span style="color:blue">cccc</span> = Object #3
* <span style="color:navy">dddd</span> = Object #4
* <span style="color:purple">eeee</span> = Object #5
* 0000 = Padding

Look up the object numbers [[LINK|here]].

==Tutorial: Replacing the Happy Mask Salesman in the Clock Tower==

===What You'll Need===

# '''Majora's Mask Debug ROM'''
# '''Hex Calculator'''

Open Windows Calculator, change it to "Programmer" mode, and press the Hex button. Or, use an online calculator like [http://www.miniwebtool.com/hex-calculator/ this one].

===Room Header===

====Finding the Room Header====

# Go to '''Clock Tower Interior''' (Map 53-0 in Map Select) as Child Link.
# Go to '''80460DEC''' in the memory viewer.
# The address at that location will be '''80588CB0''', go to that location in the memory viewer.
# You will now see the room header for the Clock Tower Interior

====Deciphering the Room Header====

Below is the room header for Mido's House, located at '''80588CB0'''. Use it to find the number of scene setups, the number of objects, the address of the object list, the number of actors, and the address of the actor list.

{| class="wikitable"
| <span style="color:red">16000000 0000000A</span> || <span style="color:orange">08010000 00000000</span>
|-
| <span style="color:green">12000000 01010000</span> || <span style="color:blue">10000000 FFFF0000</span>
|-
| <span style="color:navy">0A000000 03000110</span> || <span style="color:purple">0B060000 03000040</span>
|-
| <span style="color:maroon">010C0000 0300004C</span> || <span style="color:magenta">14000000 00000000</span>
|}

* '''Scene Settings:''' <span style="color:red">xx000000 000000yy</span>
** If '''xx = 16''', the room has one scene setup.
** If '''xx = 18''', the room has multiple scene setups.

 '''<span style="color:red">xx = 16</span>''' - Mido's house has one scene setup.

* '''Object List:''' <span style="color:purple">0Bxx0000 000000yy</span>
** '''xx''' indicates the number of objects.
** '''yy''' is the location of the room's object list.
*** '''room header address''' + '''yy''' = location of object list

 '''<span style="color:purple">xx = 06</span>''' - There are 06 objects in the room.
 '''<span style="color:purple">yy = 40</span>''' - The location of the object list is '''80588CB0 + 40''', which is '''80588CF0'''.

* '''Actor List:''' <span style="color:maroon">01xx0000 000000yy</span>
** '''xx''' indicates the number of actors. 
** '''yy''' is the location of the room's actor list.
*** '''room header address''' + '''yy''' = location of actor list

 '''<span style="color:maroon">xx = 0C</span>''' - There are 0C actors in the room.
 '''<span style="color:maroon">yy = 4C</span>''' - The location of the actor list is '''80588CB0 + 4C''', which is '''80588CFC'''.

===Actors===

====Finding the Actor List====

# Go to '''80588CFC''', the location of the actor list, in the memory viewer.
# Look up the actor numbers.
# Look up the variables.
# Replace them with whatever you want.

====Deciphering the Actor List====

Below is the actor list for the Clock Tower Interior, located at '''80588CFC'''. Each line represents an actor. The Clock Town Interior has 0C actors, so there are 0C lines.

{| class="wikitable"
| <span style="color:red">01950000 FFE2FFE3</span> || <span style="color:red">0007007F 007F0000</span>
|-
| <span style="color:orangered">01B5FF96 FFE2FFB1</span> || <span style="color:orangered">0007078B 007F0000</span>
|-
| <span style="color:green">01A20000 002D0120</span> || <span style="color:green">00075A7F 007F0000</span>
|-
| <span style="color:blue">01B60000 FFE2FF38</span> || <span style="color:blue">0007007F 007F0003</span>
|-
| <span style="color:navy">01B6009B 01860000</span> || <span style="color:navy">0007007F 007F0000</span>
|-
| <span style="color:purple">01B6FF65 01860000</span> || <span style="color:purple">00075A7F 007F0000</span>
|-
| <span style="color:maroon">01B60000 00500000</span> || <span style="color:maroon">0007007F 007F0001</span>
|-
| <span style="color:red">01B60000 FEF2FFC8</span> || <span style="color:red">0007007F 007F0002</span>
|-
| <span style="color:orangered">0061FFD3 FED4FD3A</span> || <span style="color:orangered">00070009 007F0002</span>
|-
| <span style="color:green">0061002D FED4FD3A</span> || <span style="color:green">00070009 007F0001</span>
|-
| <span style="color:blue">01920000 002D00DA</span> || <span style="color:blue">00075A7F 007F0000</span>
|-
| <span style="color:navy">60D80000 003C0122</span> || <span style="color:navy">1687000A 007F0000</span>
|}

The first four digits in each line comprise an actor number. Cross-reference them with [[LINK|this list]].

{{todo|Correct this table.}}

{| class="wikitable"
! Actor # || Filename || Actor ID || X || Y || Z || Variable # || Variable ID || Object #
|-
| <span style="color:red">0163</span> || ovl_En_Ko || Kokiri Child || <span style="color:red">FFC8</span> || <span style="color:red">0010</span> || <span style="color:red">0080</span> || <span style="color:red">FF04</span> || ??? || 0001
|-
| <span style="color:orange">016D</span> || ovl_En_Md || Mido || <span style="color:orange">0003</span> || <span style="color:orange">0030</span> || <span style="color:orange">0086</span> || <span style="color:orange">FF00</span> || ??? || 00FB
|-
| <span style="color:green">0163</span> || ovl_En_Ko || Kokiri Child || <span style="color:green">FF83</span> || <span style="color:green">000C</span> || <span style="color:green">0048</span> || <span style="color:green">FF00</span> || ??? || 0001
|-
| <span style="color:blue">000A</span> || ovl_En_Box || Treasure Chest || <span style="color:blue">003A</span> || <span style="color:blue">0000</span> || <span style="color:blue">FFC9</span> || <span style="color:blue">59A0</span> || ??? || 000E
|-
| <span style="color:navy">000A</span> || ovl_En_Box || Treasure Chest || <span style="color:navy">003A</span> || <span style="color:navy">0000</span> || <span style="color:navy">0023</span> || <span style="color:navy">59A1</span> || ??? || 000E
|-
| <span style="color:purple">000A</span> || ovl_En_Box || Treasure Chest || <span style="color:purple">FFC4</span> || <span style="color:purple">0000</span> || <span style="color:purple">FFC9</span> || <span style="color:purple">5982</span> || ??? || 000E
|-
| <span style="color:maroon">000A</span> || ovl_En_Box || Treasure Chest || <span style="color:maroon">FFC4</span> || <span style="color:maroon">0000</span> || <span style="color:maroon">0023</span> || <span style="color:maroon">5903</span> || ??? || 000E
|}

====Replacing Actors====

# Find the actor number of the actor you wish to replace.
#* Let's replace the Happy Mask Salesman in line 2. ('''<span style="color:orangered">01B5</span>''')
# Find the [[Actor List|actor number]] of the actor you wish to replace it with.
#* Let's replace the treasure chest ('''<span style="color:orangered">01B5</span>''') with a sign ('''<span style="color:orange">00A8</span>''').
# Overwrite the old actor number with the new one.
#* '''<span style="color:orangered">01B5FF96 FFE2FFB1 0007078B 007F0000</span> -> <span style="color:orange">00A8</span><span style="color:orangered">FF96 FFE2FFB1 0007078B 007F0000</span>'''
#* Since the actor is one line 2, it starts at '''80588CFC + 10 * 1''' = '''80588D0C'''. The gameshark code to do the replacement is '''81588D0C 00A8'''.
#** The '''81''' in the gameshark code instead of '''80''' is for setting a 2-byte number. It's the same address.
# Find the variable number of the actor you wish to replace.
#* The variable of the Happy Mask Salesman in line 2 is <span style="color:orangered">'''0000'''</span>.
# Find the [[LINK|variable number]] you will use for the new actor.
#* Let's make our sign say "I'll be on vacation for a short while". ('''<span style="color:orange">0010</span>''')
# Overwrite the old variable number with the new one.
#* '''<span style="color:orange">00A8</span><span style="color:orangered">FF96 FFE2FFB1 0007078B 007F0000</span> -> <span style="color:orange">00A8</span><span style="color:orangered">FF96 FFE2FFB1 0007078B 007F</span><span style="color:orange">0010</span>'''
#* The variable is at '''80588CFC + 10 * 1 + 0E''' = '''80588D1A'''. The gameshark code to do the replacement is '''81588D1A 0010'''.

===Objects===

====Finding the Object List====

# Type '''802628C0''', the location of the object list, into the address box.
#* This will bring you to '''802628C0''', where you'll find a list of objects.
# Look up the object numbers.
# Replace them with whatever you want.

====Deciphering the Object List====

Below is the object list for Mido's House, located at '''80588CF0'''. Each group of four digits comprises an object number. Cross-reference them with [[LINK|this list]]. Mido's House has 05 objects, so we only need to pay attention to the first five groups of four digits.

{| class="wikitable"
|-
|<span style="color:red">0088</span> <span style="color:green">0197</span> <span style="color:blue">0051</span> <span style="color:navy">01A3</span> || <span style="color:purple">01BD</span> <span style="color:maroon">01C8</span> 0195 0000
|}

These numbers correspond to the following:

{{todo|fix this table}}

{| class="wikitable"
! Object # || Filename || Object ID
|-
| <span style="color:red">00C5</span> || object_os_anime || Required by human-like npcs
|-
| <span style="color:green">00FC</span> || object_km1 || Strawberry-Haired Kokiri Boy
|-
| <span style="color:blue">00FD</span> || object_kw1 || Strawberry-Haired Kokiri Girl
|-
| <span style="color:navy">00FB</span> || object_md || Mido
|-
| <span style="color:purple">000E</span> || object_box || Treasure Chest/Boss Key Chest/Light When Opening Chest
|}

====Replacing Objects====

# Use the [[Actor List|Actor List]] to find the object linked to the actor you wish to replace.
#* We've chosen to replace the Happy Mask Salesman, which is linked to object '''<span style="color:navy">01A3</span>'''.
# Use the [[Actor List|Actor List]] to find the object linked to the actor you wish to replace it with.
#* We've chosen to replace the Happy Mask Salesman (object '''<span style="color:navy">01A3</span>''') with a sign (object '''<span style="color:blue">00FC</span>''').
# Overwrite the old object number with the new one.
#* '''00880197 0051<span style="color:navy">01A3</span> 01BD01C8 01950000 -> 00880197 0051<span style="color:blue">00FC</span> 01BD01C8 01950000'''
#* Since this is the 4th object number, it's located at '''80588CF0 + 02 * 03''' = '''80588CF6'''. The gameshark code to do the replacement is '''81588CF6 00FC'''

==Gameshark Codes==

===Debug ROM===

====Happy Mask Salesman in Clock Tower Interior====

 81588CF6 oooo
 81588D0C aaaa
 81588D1A vvvv

For objects 0000 and 0001, either remove the object line, or set it to some other object. Actors using objects 0002 and 0003 can't be used with this code.

====Owl Statue Replacements====

For all of the following codes, objects 0000 and 0002 can't be set on the object line (that line must be removed or set to some other object), and actors using objects 0001 and 0003 can't be used with these codes.

=====Southern Swamp=====
This code changes the owl statue in the initial area of the swamp.

 815539B0 oooo
 81553C40 aaaa
 81553C4E vvvv

=====Mountain Village (Winter)=====
This code changes the owl statue in the initial area of the Mountain Village, during winter only.

 8157D4F4 oooo
 8157D750 aaaa
 8157D75E vvvv

=====Great Bay=====
This code changes the owl statue on the platform under the Marine Research Lab.

 81559B44 oooo
 81559F00 aaaa
 81559F0E vvvv

=====Ikana Canyon=====
This code changes the owl statue in the canyon, on the other side of the river.

 8154C0B4 oooo
 8154C464 aaaa
 8154C472 vvvv