<h1>Introduction<aclass="headerlink"href="#introduction"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="about-porymap">
<h2>About Porymap<aclass="headerlink"href="#about-porymap"title="Permalink to this headline">¶</a></h2>
<p><strong>Porymap is a cross-platform map editor for the Gen 3 pret decompilation projects. Its primary functions are to allow editing map tiles, collision, events, connections, and properties. Porymap provides additional functionality, such as tileset editing and region map editing. Downloadable releases are available for Windows and Mac, and Linux users can build it from source.</strong></p>
<p>Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, except for Wild Pokemon editing, so Advance Map users shouldn’t have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.</p>
<p>Porymap reads and writes files in the decompilation projects. It <strong>does not</strong> read or write ROM files. <strong>Therefore, it is highly recommended to use Git for version control when working with Porymap.</strong></p>
</div>
<divclass="section"id="getting-started">
<h2>Getting Started<aclass="headerlink"href="#getting-started"title="Permalink to this headline">¶</a></h2>
<p>Before using Porymap, you must have your decompilation project setup. Porymap currently supports <aclass="reference external"href="https://github.com/pret/pokeemerald">pokeemerald</a> and <aclass="reference external"href="https://github.com/pret/pokeruby">pokeruby</a>. See their respective <codeclass="docutils literal notranslate"><spanclass="pre">INSTALL.md</span></code> files to get setup, and make sure you can successfully compile the ROM.</p>
<p>When launching Porymap for the first time, you will be greeted with the following empty window:</p>
<p>The first thing we’ll do is open a Gen 3 decompilation project with <em>File -> Open Project…</em> (<codeclass="docutils literal notranslate"><spanclass="pre">Ctrl+O</span></code>). A folder selection dialog will pop up. Choose the location of your existing decompilation project. After doing so, Porymap will take a few seconds to load the project, and the main window should now be displaying the first map. (In <codeclass="docutils literal notranslate"><spanclass="pre">pokeemerald</span></code>, it’s Petalburg City.)</p>
<divclass="figure"id="id2">
<imgalt="Porymap Main Window"src="../_images/porymap-loaded-project.png"/>
<pclass="caption"><spanclass="caption-text">Porymap Main Window</span></p>
</div>
<p>Now, let’s make our first basic edit using Porymap. We’ll use the Pencil Tool to draw some more flowers on the grass in Petalburg City. First, make sure the Pencil Tool is selected. You can click the Pencil Tool button, press the <codeclass="docutils literal notranslate"><spanclass="pre">N</span></code> shortcut, or select <em>Tools -> Pencil</em>. The various painting Tool buttons are found on the left side of the toolbar above the map area.</p>
<p>That looks great! Save your changes with <em>File -> Save</em> (<codeclass="docutils literal notranslate"><spanclass="pre">Ctrl+S</span></code>). Finally, compile the ROM and see the results in-game.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">When re-compiling your ROM, it is not recommended to use <codeclass="docutils literal notranslate"><spanclass="pre">NODEP=1</span></code>, since that can result in data changes being ignored.</p>
</div>
<divclass="figure"id="id7">
<imgalt="Petalburg City In-Game Changes"src="../_images/flower-petalburg-ingame.png"/>
<pclass="caption"><spanclass="caption-text">Petalburg City In-Game Changes</span></p>
</div>
<p>Now that you have the basic workflow down, it’s time to learn how to navigate the various windows and screens of Porymap.</p>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
