<liclass="toctree-l2"><aclass="reference internal"href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../manual/editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
<p>All notable changes to this project will be documented in this file.</p>
<p>The format is based on <aclass="reference external"href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
and this project somewhat adheres to <aclass="reference external"href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MINOR version number is bumped when there are breaking changes in the pret projects.</p>
<p>The <strong>“Breaking Changes”</strong> listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.</p>
<h2>Unreleased<aclass="headerlink"href="#unreleased"title="Permalink to this headline">¶</a></h2>
<p>Nothing, yet.</p>
</div>
<divclass="section"id="id1">
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<aclass="headerlink"href="#id1"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="fixed">
<h3>Fixed<aclass="headerlink"href="#fixed"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Fix bug on Mac where tileset images were corrupted when saving.</p></li>
</ul>
</div>
</div>
<divclass="section"id="id2">
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<aclass="headerlink"href="#id2"title="Permalink to this headline">¶</a></h2>
<li><p>pokeemerald and pokeruby both underwent a naming consistency update with respect to “object events”. As such, these naming changes break old versions of Porymap.</p>
<li><p>Add optional support for Poryscript script files via the <codeclass="docutils literal notranslate"><spanclass="pre">use_poryscript</span></code> config option.</p></li>
<li><p>Selecting a group of metatiles from the map area now also copies the collision properties, too.</p></li>
<li><p>Add keyboard shortcut <codeclass="docutils literal notranslate"><spanclass="pre">Ctrl</span><spanclass="pre">+</span><spanclass="pre">G</span></code> for toggling the map grid.</p></li>
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<aclass="headerlink"href="#id4"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="id5">
<h3>Breaking Changes<aclass="headerlink"href="#id5"title="Permalink to this headline">¶</a></h3>
<li><p>Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits <aclass="reference external"href="https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be">cdae0c1444bed98e652c87dc3e3edcecacfef8be</a> and <aclass="reference external"href="https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba">0e8ccfc4fd3544001f4c25fafd401f7558bdefba</a>.</p></li>
<li><p>New “field” key in wild encounter JSON data from pokeemerald and pokeruby commits <aclass="reference external"href="https://github.com/pret/pokeemerald/commit/adb0a444577b59eb02788c782a3d04bc285be0ba">adb0a444577b59eb02788c782a3d04bc285be0ba</a> and <aclass="reference external"href="c73de8bed752ca538d90cfc93c4a9e8c7965f8c9">https://github.com/pret/pokeruby/commit/c73de8bed752ca538d90cfc93c4a9e8c7965f8c9</a>.</p></li>
<li><p>Support metatile labels file introduced in pokeruby and pokeemerald commits <aclass="reference external"href="https://github.com/pret/pokeruby/commit/ad365a35c1536740cbcbc10bee66e5dd908c39e7">ad365a35c1536740cbcbc10bee66e5dd908c39e7</a> and <aclass="reference external"href="https://github.com/pret/pokeemerald/commit/c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e">c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e</a>.</p></li>
<li><p>Add warning when closing porymap with unsaved changes.</p></li>
<li><p>Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.</p></li>
<li><p>The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.</p></li>
<li><p>Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.</p></li>
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<aclass="headerlink"href="#id9"title="Permalink to this headline">¶</a></h2>
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<aclass="headerlink"href="#id13"title="Permalink to this headline">¶</a></h2>
<li><p>Fix crash when creating a new map from a layout that has no pre-existing maps that use it.</p></li>
<li><p>Fix bug where <codeclass="docutils literal notranslate"><spanclass="pre">var_value</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">trainer_type</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">trainer_sight_or_berry_tree_id</span></code> JSON fields were being interpreted as integers.</p></li>
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<aclass="headerlink"href="#id16"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="id17">
<h3>Breaking Changes<aclass="headerlink"href="#id17"title="Permalink to this headline">¶</a></h3>
<li><p>New JSON map data format in pokeemerald and pokeruby from commits <aclass="reference external"href="https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b">82abc164dc9f6a74fdf0c535cc1621b7ed05318b</a> and <aclass="reference external"href="https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d">a0ba1b7c6353f7e4f3066025514c05b323a0123d</a>.</p></li>
<li><p>Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.</p></li>
<li><p>Add ability to export tileset tiles as indexed .png images. The currently-selected palette is used.</p></li>
<li><p>Restore window sizes the next time the application is opened.</p></li>
<li><p>Add ability to import metatiles from Advance Map 1.92 (.bvd files).</p></li>
<li><p>Add About window that contains porymap information and changelog. (Found in file menu <codeclass="docutils literal notranslate"><spanclass="pre">Help</span><spanclass="pre">></span><spanclass="pre">About</span><spanclass="pre">Porymap</span></code>)</p></li>
<li><p>Add option to show player’s in-game view when hovering the mouse on the map.</p></li>
<li><p>Add option to show an outline around the currently-hovered map tile. Its size depends on the size of the current metatile selection.</p></li>
<li><p>Add ability to define custom fields for map header and all events.</p></li>
<h3>Changed<aclass="headerlink"href="#id19"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Collapse the map list by default.</p></li>
<li><p>Collision view now has a transparency slider to help make it easier to view the underlying metatiles.</p></li>
<li><p>When importing tileset tiles from an image that is not indexed, the user can also provide a palette for the image. This is for the scenario where the user exports tiles and a palette from Advance Map.</p></li>
<li><p>When creating a new map, the user specifies all of the map properties in a new window prompt.</p></li>
<li><p>New maps can be created using existing layouts by right-clicking on an existing layout folder in the map list panel when sorted by “Layout”.</p></li>
<li><p>The map list panel now has “expand-all” and “collapse-all” buttons.</p></li>
<li><p>Events without sprites are now partially transparent so the underlying metatile can be seen. (Warps, signs, etc.)</p></li>
<li><p>Changed the Trainer checkbox to a combobox, since there are actually 3 valid values for the trainer type.</p></li>
<li><p>Multiline comments are now respected when parsing C defines.</p></li>
<li><p>The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.</p></li>
<h3>Fixed<aclass="headerlink"href="#id20"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.</p></li>
<li><p>Fix crash that could occur when changing the palette id in the tileset palette editor.</p></li>
<li><p>Fix crash that could occur when shrinking the number of metatiles in a tileset.</p></li>
<li><p>Fix bug where exported tile images from Advance Map were not handled correctly due to Advance Map using incorrect file extensions.</p></li>
</ul>
</div>
</div>
<divclass="section"id="id21">
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<aclass="headerlink"href="#id21"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="id22">
<h3>Breaking Changes<aclass="headerlink"href="#id22"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>New map header format in pokeemerald from commit <aclass="reference external"href="https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7">a1ea3b5e394bc115ba9b86348c161094a00dcca7</a>.</p></li>
</ul>
</div>
<divclass="section"id="id23">
<h3>Added<aclass="headerlink"href="#id23"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Add <codeclass="docutils literal notranslate"><spanclass="pre">porymap.project.cfg</span></code> config file to project repos, in order to house project-specific settings, such as <codeclass="docutils literal notranslate"><spanclass="pre">base_game_version=pokeemerald</span></code>.</p></li>
<li><p>Write all logs to <codeclass="docutils literal notranslate"><spanclass="pre">porymap.log</span></code> file, so users can view any errors that porymap hits.</p></li>
<li><p>Changelog</p></li>
</ul>
</div>
<divclass="section"id="id24">
<h3>Changed<aclass="headerlink"href="#id24"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Add <codeclass="docutils literal notranslate"><spanclass="pre">porymap.cfg</span></code> base config file, rather than using built-in system settings (e.g. registry on Windows).</p></li>
<li><p>Properly read/write map headers for <codeclass="docutils literal notranslate"><spanclass="pre">pokeemerald</span></code>.</p></li>
<li><p>Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.</p></li>
</ul>
</div>
<divclass="section"id="id25">
<h3>Fixed<aclass="headerlink"href="#id25"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>Creating new hidden-item events now uses a valid default flag value.</p></li>
<li><p>Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.</p></li>
<li><p>Fix bug where porymap crashes on startup due to missing map headers.</p></li>
<li><p>Fix tileset editor crash that only happened on macOS.</p></li>
<li><p>Fix minor bug when parsing C defines.</p></li>
<li><p>Write <codeclass="docutils literal notranslate"><spanclass="pre">MAP_GROUPS_COUNT</span></code> define to <codeclass="docutils literal notranslate"><spanclass="pre">maps.h</span></code>.</p></li>
<li><p>Fix bug where opening multiple projects and saving would cause junk to be written to <codeclass="docutils literal notranslate"><spanclass="pre">layouts_table.inc</span></code>.</p></li>
<li><p>Fix porymap icon on macOS.</p></li>
</ul>
</div>
</div>
<divclass="section"id="id26">
<h2><aclass="reference external"href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<aclass="headerlink"href="#id26"title="Permalink to this headline">¶</a></h2>
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>.
