View source for How to fix Common Area Overlaps

When making use of ASM patches that rely on [[ExtraSpace]] that aren’t bundled with Skytemple, there is a reasonable chance you will encounter an “overlap” where multiple patches take up the same part of the common area, causing unexpected behavior and game crashes. Thankfully, it is easy to edit your ASM patches to write to a different part of the common area to avoid these overlaps.

Please note that this tutorial is primarily for those who are ''not'' using C-of-Time with their project, and this approach may cause issues if you add more C-of-Time based edits to your rom after patching.

<span id="prerequisites"></span>
== Prerequisites ==

Before starting this tutorial, you will need:

* A hex editor.
** [https://mh-nexus.de/en/hxd/ HxD] is a robust and commonly recommended choice.
** [https://hexed.it/ hexed.it] is a hex editor that runs in your browser.
* A text editor.
** If you are on Windows, [https://notepad-plus-plus.org/ Notepad++] is a solid choice.
* Everything else you need for manual patching, including;
** A DS Rom Unpacker (DSLazy, for example)
** Armips

Note that this is ''not'' a tutorial on manual patching in general. Please consult tutorials on manual patching elsewhere if you need to know how to do this, such as the [[SkySongBuilder Tutorial]].

<span id="instructions"></span>
== Instructions ==

<span id="prep-work"></span>
=== Prep Work ===

# Unpack your DS Rom using DSLazy.
# Open HxD or your hex editor of choice. Navigate to where you unpacked your ROM file. In your hex editor, open the “overlay” folder, and then open overlay_0036.bin.
# Navigate to your downloaded .asm patch and open it using your text editor.
# Scroll through the contents of your patch until you find where it patches to overlay_0036.bin. This generally is indicated using <code>.open &quot;overlay_0036.bin&quot;</code>, followed by an address for the start of the array.
# Look at the below line. If it begins with <code>.orga</code> followed by an address, navigate to [[#if-your-patch-uses-.orga|If your Patch uses .orga]]. If it instead begins with <code>.org</code> followed by an address plus another address, navigate to [[#if-your-patch-uses-.org|If your Patch uses .org]].

<span id="if-your-patch-uses-.orga"></span>
=== If your Patch uses .orga ===

<ol start="6" style="list-style-type: decimal;">
<li>In your hex editor, scroll down until the address in the leftmost column matches the indicated address next to <code>.orga</code> in your ASM patch. See if there is data already written to that space or not.</li>
<li>If that space is taken up, scroll down further through the common area until it returns to being entirely <code>00</code> addresses. Note down the address in the leftmost column.
<ul>
<li>Be aware that some patches may, rarely, deliberately leave trailing <code>00</code> addresses for functionality reasons. If you run into technical issues, you should consider leaving more space after the end of the previous patching area, or alternatively, consulting the patch author of other patches you may be using to see if you can find a safe starting address.</li>
<li>Also note that you will run into problems if you do not have enough patching space for your ASM patch ''below'' your starting address! If you think there is a risk of overwriting existing space below your starting address, consider scrolling further down to find a larger section of free ExtraSpace.</li></ul>
</li>
<li>Change the address next to <code>.orga</code> to the new starting address that you found.</li>
<li>Patch your ASM patch as you otherwise would.</li>
<li>Re-pack your ROM and test to see if your patch is working.</li></ol>

<span id="if-your-patch-uses-.org"></span>
=== If your Patch uses .org ===

<ol start="6" style="list-style-type: decimal;">
<li>In your hex editor, scroll down until the address in the leftmost column matches the address following the plus sign next to <code>.org</code> in your ASM patch. See if there is data already written to that space or not.</li>
<li>If that space is taken up, scroll down further through the common area until it returns to being entirely <code>00</code> addresses. Note down the address in the leftmost column.
<ul>
<li>Be aware that some patches may, rarely, deliberately leave trailing <code>00</code> addresses for functionality reasons. If you run into technical issues, you should consider leaving more space after the end of the previous patching area, or alternatively, consulting the patch author of other patches you may be using to see if you can find a safe starting address.</li>
<li>Also note that you will run into problems if you do not have enough patching space for your ASM patch ''below'' your starting address! If you think there is a risk of overwriting existing space below your starting address, consider scrolling further down to find a larger section of free ExtraSpace.</li></ul>
</li>
<li>Change the address next to the plus sign <code>.org</code> to the new starting address that you found.</li>
<li>Patch your ASM patch as you otherwise would.</li>
<li>Re-pack your ROM and test to see if your patch is working.</li></ol>
[[Category:Tutorials]]