Merge remote-tracking branch 'origin/update-docs'

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e41613e939dfe6ab7008de864b4e64a8
+config: 9e8b58068fa2090b104690bfc9c25e35
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/index.rst.txt

@@ -20,6 +20,7 @@ Porymap Documentation
     manual/region-map-editor
     manual/scripting-capabilities
     manual/project-files
+    manual/settings-and-options
 
 .. toctree::
     :maxdepth: 2

docs/_sources/manual/editing-map-events.rst.txt

@@ -229,3 +229,25 @@ Clicking the ``Open Map Scripts`` button |open-map-scripts-button| will open the
 
 .. |open-map-scripts-button|
    image:: images/editing-map-events/open-map-scripts-button.png
+
+Tool Buttons
+------------
+
+The event editing tab also extends functionality to a few of the tool buttons described in :ref:`Editing Map Tiles <editing-map-tiles>`.
+A brief description and animation is listed for each of the available tools below:
+
+Pencil
+    When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to "draw" events in a certain location. The event created will be a default-valued event of the same type as the currently selected event.
+
+.. figure:: images/editing-map-events/event-tool-pencil.gif
+    :alt: Drawing Object Events with the Pencil Tool
+
+    Drawing Object Events with the Pencil Tool
+
+Shift
+    You can use the shift tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.
+
+.. figure:: images/editing-map-events/event-tool-shift.gif
+    :alt: Moving Events with the Shift Tool
+
+    Moving Events with the Shift Tool

docs/_sources/manual/editing-map-tiles.rst.txt

@@ -1,3 +1,5 @@
+.. _editing-map-tiles:
+
 *****************
 Editing Map Tiles
 *****************

docs/_sources/manual/settings-and-options.rst.txt

@@ -0,0 +1,40 @@
+.. _settings-and-options:
+
+****************
+Porymap Settings
+****************
+
+Porymap uses config files to read and store user and project settings.
+A global settings file is stored in a platform-dependent location for app configuration files 
+(``%Appdata%\pret\porymap\porymap.cfg`` on Windows, ``~/Library/Application\ Support/pret/porymap/porymap.cfg`` on macOS).
+
+A config file is also created when opening a project in porymap for the first time. It is stored in
+your project root as ``porymap.project.cfg``. There are several project-specific settings that are
+determined by this file.
+
+.. csv-table::
+   :header: Setting,Default,Location,Can Edit?,Description
+   :widths: 10, 3, 5, 5, 20
+
+   ``recent_project``, , global, yes, The project that will be opened on launch
+   ``recent_map``, , global, yes, The map that will be opened on launch
+   ``pretty_cursors``, 1, global, yes, Whether to use custom crosshair cursors
+   ``map_sort_order``, group, global, yes, The order map list is sorted in
+   ``window_geometry``, , global, no, For restoring window sizes
+   ``window_state``, , global, no, For restoring window sizes
+   ``map_splitter_state``, , global, no, For restoring window sizes
+   ``main_splitter_state``, , global, no, For restoring window sizes
+   ``collision_opacity``, 50, global, yes, Opacity of collision overlay
+   ``metatiles_zoom``, 30, global, yes, Scale of map metatiles
+   ``show_player_view``, 0, global, yes, Display a rectangle for the GBA screen radius
+   ``show_cursor_tile``, 0, global, yes, Display a rectangle around the hovered metatile(s)
+   ``monitor_files``, 1, global, yes, Whether porymap will monitor changes to project files
+   ``region_map_dimensions``, 32x20, global, yes, The dimensions of the region map tilemap
+   ``theme``, default, global, yes, The color theme for porymap windows and widgets
+   ``base_game_version``, , project, no, The base pret repo for this project
+   ``use_encounter_json``, 1, project, yes, Enables wild encounter table editing
+   ``use_poryscript``, 0, project, yes, Whether to open .pory files for scripts
+   ``use_custom_border_size``, 0, project, yes, Whether to allow variable border sizes
+   ``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
+
+Some of these settings can be toggled manually in porymap via the *Options* menu.

docs/genindex.html

@@ -125,6 +125,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -168,6 +169,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/index.html

@@ -125,6 +125,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -168,6 +169,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -349,6 +351,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -381,6 +384,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">

docs/manual/creating-new-maps.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-collisions.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-connections.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-events.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -474,6 +476,27 @@ This event type is unavailable for pokefirered projects; secret bases do not exi
 <h2>Open Map Scripts<a class="headerlink" href="#open-map-scripts" title="Permalink to this headline">¶</a></h2>
 <p>Clicking the <code class="docutils literal notranslate"><span class="pre">Open</span> <span class="pre">Map</span> <span class="pre">Scripts</span></code> button <img alt="open-map-scripts-button" src="../_images/open-map-scripts-button.png" /> will open the map’s scripts file in your default text editor.  If nothing happens when this button is clicked, you may need to associate a text editor with the <cite>.inc</cite> file extension.</p>
 </div>
+<div class="section" id="tool-buttons">
+<h2>Tool Buttons<a class="headerlink" href="#tool-buttons" title="Permalink to this headline">¶</a></h2>
+<p>The event editing tab also extends functionality to a few of the tool buttons described in <a class="reference internal" href="editing-map-tiles.html#editing-map-tiles"><span class="std std-ref">Editing Map Tiles</span></a>.
+A brief description and animation is listed for each of the available tools below:</p>
+<dl class="simple">
+<dt>Pencil</dt><dd><p>When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to “draw” events in a certain location. The event created will be a default-valued event of the same type as the currently selected event.</p>
+</dd>
+</dl>
+<div class="figure align-default" id="id12">
+<img alt="Drawing Object Events with the Pencil Tool" src="../_images/event-tool-pencil.gif" />
+<p class="caption"><span class="caption-text">Drawing Object Events with the Pencil Tool</span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
+</div>
+<dl class="simple">
+<dt>Shift</dt><dd><p>You can use the shift tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.</p>
+</dd>
+</dl>
+<div class="figure align-default" id="id13">
+<img alt="Moving Events with the Shift Tool" src="../_images/event-tool-shift.gif" />
+<p class="caption"><span class="caption-text">Moving Events with the Shift Tool</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
+</div>
+</div>
 </div>
 
 

docs/manual/editing-map-header.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/editing-map-tiles.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -299,55 +301,55 @@
            <div itemprop="articleBody">
             
   <div class="section" id="editing-map-tiles">
-<h1>Editing Map Tiles<a class="headerlink" href="#editing-map-tiles" title="Permalink to this headline">¶</a></h1>
+<span id="id1"></span><h1>Editing Map Tiles<a class="headerlink" href="#editing-map-tiles" title="Permalink to this headline">¶</a></h1>
 <p>Editing map tiles takes place in Porymap’s Main Window.  The map is laid out in a grid of what are called “metatiles”.  The editing basic flow is to make a metatile selection, and then paint that metatile selection onto the map.</p>
 <div class="section" id="visual-options">
 <h2>Visual Options<a class="headerlink" href="#visual-options" title="Permalink to this headline">¶</a></h2>
 <p>Before getting into the details of editing map tiles, you should be aware of some settings that make your life easier.</p>
 <p>A grid can be displayed over the editable map area by using the <code class="docutils literal notranslate"><span class="pre">Grid</span></code> checkbox, which is located in the toolbar above the map area.</p>
-<div class="figure align-default" id="id1">
+<div class="figure align-default" id="id2">
 <img alt="Map Grid" src="../_images/map-grid.png" />
-<p class="caption"><span class="caption-text">Map Grid</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Map Grid</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
 </div>
 <p>The border’s visibility, including the surrounding map connections, can be toggled with the <code class="docutils literal notranslate"><span class="pre">Border</span></code> checkbox, which is located in the toolbar above the map area.</p>
-<div class="figure align-default" id="id2">
+<div class="figure align-default" id="id3">
 <img alt="Map Border Toggled Off" src="../_images/map-border-off.png" />
-<p class="caption"><span class="caption-text">Map Border Toggled Off</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Map Border Toggled Off</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
 </div>
 <p>You can zoom in and out on the map with <em>View -&gt; Zoom In</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl++</span></code> or <code class="docutils literal notranslate"><span class="pre">Ctrl+Mouse</span> <span class="pre">Wheel</span> <span class="pre">Scroll</span> <span class="pre">Up</span></code>) and <em>View -&gt; Zoom Out</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+-</span></code> or <code class="docutils literal notranslate"><span class="pre">Ctrl+Mouse</span> <span class="pre">Wheel</span> <span class="pre">Scroll</span> <span class="pre">Down</span></code>).</p>
 <p>By default, the mouse cursor will show a white indicator outline of the currently-hovered tile(s) of what will be painted.  You can disable this outline with <em>View -&gt; Cursor Tile Outline</em>.  Additionally, the cursor changes its appearance depending on which tool you currently have selected in the toolbar.  You can disable this with <em>View -&gt; Cursor Icons</em>.</p>
 <p>An indicator outline for the player’s in-game view radius can be toggled with <em>View -&gt; Player View Rectangle</em>.</p>
 <p>The Metatile Selection Pane can be zoomed in or out using the slider on the bottom.</p>
-<div class="figure align-default" id="id3">
+<div class="figure align-default" id="id4">
 <img alt="Metatile Selection Zoom Slider" src="../_images/metatile-selection-slider.png" />
-<p class="caption"><span class="caption-text">Metatile Selection Zoom Slider</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Metatile Selection Zoom Slider</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
 </div>
 </div>
 <div class="section" id="selecting-metatiles">
 <h2>Selecting Metatiles<a class="headerlink" href="#selecting-metatiles" title="Permalink to this headline">¶</a></h2>
 <p>Before you paint onto the map, you need to select which metatiles you will be painting.  The primary way to do this is to click on a metatile from the Metatile Selection Pane.  Whenever you change your selection, the selection preview will update so you can see exactly what you have selected at all times.</p>
-<div class="figure align-default" id="id4">
+<div class="figure align-default" id="id5">
 <img alt="Basic Metatile Selection" src="../_images/single-metatile-selection.gif" />
-<p class="caption"><span class="caption-text">Basic Metatile Selection</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Basic Metatile Selection</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
 </div>
 <p>You can select more than one tile at a time by clicking and dragging the desired region.  For example, it’s convenient to select the entire Pokémon Center at once.</p>
-<div class="figure align-default" id="id5">
+<div class="figure align-default" id="id6">
 <img alt="Multiple Metatile Selection" src="../_images/multiple-metatile-selection.gif" />
-<p class="caption"><span class="caption-text">Multiple Metatile Selection</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Multiple Metatile Selection</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
 </div>
 <p>Metatiles can also be selected from existing metatiles on the map area.  Use the Eyedropper Tool with <em>Tools -&gt; Eyedropper</em> (<code class="docutils literal notranslate"><span class="pre">E</span></code>), or simply click the Eyedropper button <img alt="eyedropper-tool" src="../_images/eyedropper-tool.png" /> in the toolbar above the map area.  A more powerful way to do this is to right-click on the map when using the Pencil Tool or Bucket Fill Tool.  You can even right-click and drag to copy a region from the map.  In this example GIF, we demonstrate how quick and easy it is to use the right-click method to copy and paint metatiles.</p>
-<div class="figure align-default" id="id6">
+<div class="figure align-default" id="id7">
 <img alt="Right-Click Metatile Selection" src="../_images/right-click-metatile-selection.gif" />
-<p class="caption"><span class="caption-text">Right-Click Metatile Selection</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Right-Click Metatile Selection</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
 </div>
 <p>Now, let’s learn how to use the various tools to paint your metatile selection onto the map.</p>
 </div>
 <div class="section" id="pencil-tool">
 <h2>Pencil Tool<a class="headerlink" href="#pencil-tool" title="Permalink to this headline">¶</a></h2>
 <p>The Pencil Tool <img alt="pencil-tool" src="../_images/pencil-tool.png" /> (<em>Tools -&gt; Pencil</em>, or <code class="docutils literal notranslate"><span class="pre">N</span></code>) is your bread and butter when editing maps.  Simply left-click to paint your current metatile selection onto the map.  You can click and drag to paint a bigger portion of the map.  When clicking and dragging, the metatiles will be painted as if they are snapping to a grid.  This simplifies things like painting large areas of trees.</p>
-<div class="figure align-default" id="id7">
+<div class="figure align-default" id="id8">
 <img alt="Painting a Large Metatile Selection" src="../_images/snapping-painting.gif" />
-<p class="caption"><span class="caption-text">Painting a Large Metatile Selection</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Painting a Large Metatile Selection</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
 </div>
 </div>
 <div class="section" id="pointer-tool">
@@ -357,51 +359,51 @@
 <div class="section" id="bucket-fill-tool">
 <h2>Bucket Fill Tool<a class="headerlink" href="#bucket-fill-tool" title="Permalink to this headline">¶</a></h2>
 <p>The Bucket Fill Tool <img alt="bucket-fill-tool" src="../_images/bucket-fill-tool.png" /> (<em>Tools -&gt; Bucket Fill</em>, or <code class="docutils literal notranslate"><span class="pre">B</span></code>) works just like you think it does.  It fills a contiguous region of identical metatiles.  If you have a large metatile selection, it will fill the region with that pattern.  A useful shortcut for the Bucket Fill Tool is to middle-click when using the Pencil Tool.</p>
-<div class="figure align-default" id="id8">
+<div class="figure align-default" id="id9">
 <img alt="Painting with Bucket Fill Tool" src="../_images/bucket-fill-painting.gif" />
-<p class="caption"><span class="caption-text">Painting with Bucket Fill Tool</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Painting with Bucket Fill Tool</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
 </div>
 <p>Holding down the <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> key while using the Bucket Fill Tool will fill <em>all</em> matching metatiles on the map, rather that just the contiguous region.</p>
 </div>
 <div class="section" id="map-shift-tool">
 <h2>Map Shift Tool<a class="headerlink" href="#map-shift-tool" title="Permalink to this headline">¶</a></h2>
 <p>The Map Shift Tool <img alt="map-shift-tool" src="../_images/map-shift-tool.png" /> (<em>Tools -&gt; Map Shift</em>, or <code class="docutils literal notranslate"><span class="pre">S</span></code>) lets you shift the metatile positions of the entire map at the same time.  This is useful after resizing a map.  (Though, simply right-click copying the entire map is another way of accomplishing the same thing.)  Metatiles are wrapped around to the other side of the map when using the Map Shift Tool.  Simply click and drag on the map to perform the map shift.</p>
-<div class="figure align-default" id="id9">
+<div class="figure align-default" id="id10">
 <img alt="Map Shift Tool" src="../_images/map-shift-painting.gif" />
-<p class="caption"><span class="caption-text">Map Shift Tool</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Map Shift Tool</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
 </div>
 </div>
 <div class="section" id="smart-paths">
 <h2>Smart Paths<a class="headerlink" href="#smart-paths" title="Permalink to this headline">¶</a></h2>
 <p>Smart Paths provide an easy way to paint pathways, ponds, and mountains.  If there is any formation of metatiles that have a basic outline and a “middle” tile, then smart paths can help save you time when painting.  <strong>Smart Paths can only be used when you have a 3x3 metatile selection.</strong>  Smart Paths is only available when using the Pencil Tool or the Bucket Fill Tool.  To enable Smart Paths, you must either check the Smart Paths checkbox above the map area, or you can hold down the <code class="docutils literal notranslate"><span class="pre">Shift</span></code> key.  Below are a few examples that illustrate the power of Smart Paths.</p>
-<div class="figure align-default" id="id10">
-<img alt="Regular vs. Smart Paths" src="../_images/smart-paths-1-painting.gif" />
-<p class="caption"><span class="caption-text">Regular vs. Smart Paths</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
-</div>
 <div class="figure align-default" id="id11">
-<img alt="Bucket Fill with Smart Paths" src="../_images/smart-paths-2-painting.gif" />
+<img alt="Regular vs. Smart Paths" src="../_images/smart-paths-1-painting.gif" />
-<p class="caption"><span class="caption-text">Bucket Fill with Smart Paths</span><a class="headerlink" href="#id11" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Regular vs. Smart Paths</span><a class="headerlink" href="#id11" title="Permalink to this image">¶</a></p>
 </div>
 <div class="figure align-default" id="id12">
+<img alt="Bucket Fill with Smart Paths" src="../_images/smart-paths-2-painting.gif" />
+<p class="caption"><span class="caption-text">Bucket Fill with Smart Paths</span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
+</div>
+<div class="figure align-default" id="id13">
 <img alt="Smart Paths from Right-Click Selection" src="../_images/smart-paths-3-painting.gif" />
-<p class="caption"><span class="caption-text">Smart Paths from Right-Click Selection</span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Smart Paths from Right-Click Selection</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
 </div>
 </div>
 <div class="section" id="change-map-border">
 <h2>Change Map Border<a class="headerlink" href="#change-map-border" title="Permalink to this headline">¶</a></h2>
 <p>The map’s border can be modified by painting on the Border image, which is located above the metatile selection pane.</p>
-<div class="figure align-default" id="id13">
+<div class="figure align-default" id="id14">
 <img alt="Change Map Border" src="../_images/map-border.png" />
-<p class="caption"><span class="caption-text">Change Map Border</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Change Map Border</span><a class="headerlink" href="#id14" title="Permalink to this image">¶</a></p>
 </div>
 <p>The dimensions of the map’s border can also be adjusted for pokefirered projects via the <code class="docutils literal notranslate"><span class="pre">Change</span> <span class="pre">Dimensions</span></code> button. If you have modified your pokeemerald or pokeruby project to support custom border sizes you can enable this option with the <code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code> field in your project’s <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> file.</p>
 </div>
 <div class="section" id="change-map-tilesets">
 <h2>Change Map Tilesets<a class="headerlink" href="#change-map-tilesets" title="Permalink to this headline">¶</a></h2>
 <p>Every map uses exactly two Tilesets–primary and secondary.  These can be changed by choosing a different value from the two Tileset dropdowns.</p>
-<div class="figure align-default" id="id14">
+<div class="figure align-default" id="id15">
 <img alt="Tileset Pickers" src="../_images/tileset-pickers.png" />
-<p class="caption"><span class="caption-text">Tileset Pickers</span><a class="headerlink" href="#id14" title="Permalink to this image">¶</a></p>
+<p class="caption"><span class="caption-text">Tileset Pickers</span><a class="headerlink" href="#id15" title="Permalink to this image">¶</a></p>
 </div>
 </div>
 <div class="section" id="undo-redo">

docs/manual/editing-wild-encounters.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/introduction.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/navigation.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/project-files.html

@@ -36,7 +36,7 @@
   <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Changelog" href="../reference/changelog.html" />
+    <link rel="next" title="Porymap Settings" href="settings-and-options.html" />
     <link rel="prev" title="Scripting Capabilities" href="scripting-capabilities.html" /> 
 </head>
 
@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -485,7 +487,7 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="settings-and-options.html" class="btn btn-neutral float-right" title="Porymap Settings" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="scripting-capabilities.html" class="btn btn-neutral float-left" title="Scripting Capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/manual/region-map-editor.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/scripting-capabilities.html

@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/settings-and-options.html

@@ -0,0 +1,502 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>Porymap Settings &mdash; porymap  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+  
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+    
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+    
+
+  
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Changelog" href="../reference/changelog.html" />
+    <link rel="prev" title="Project Files" href="project-files.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search"  style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
+          
+
+          
+            <a href="../index.html" class="icon icon-home"> porymap
+          
+
+          
+          </a>
+
+          
+            
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">User Manual</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="creating-new-maps.html#new-map-options">New Map Options</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
+<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
+<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
+<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
+<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
+<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
+<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Porymap Settings</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">porymap</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+        
+      <li>Porymap Settings</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/settings-and-options.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="porymap-settings">
+<span id="settings-and-options"></span><h1>Porymap Settings<a class="headerlink" href="#porymap-settings" title="Permalink to this headline">¶</a></h1>
+<p>Porymap uses config files to read and store user and project settings.
+A global settings file is stored in a platform-dependent location for app configuration files
+(<code class="docutils literal notranslate"><span class="pre">%Appdata%\pret\porymap\porymap.cfg</span></code> on Windows, <code class="docutils literal notranslate"><span class="pre">~/Library/Application\</span> <span class="pre">Support/pret/porymap/porymap.cfg</span></code> on macOS).</p>
+<p>A config file is also created when opening a project in porymap for the first time. It is stored in
+your project root as <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code>. There are several project-specific settings that are
+determined by this file.</p>
+<table class="colwidths-given docutils align-default">
+<colgroup>
+<col style="width: 23%" />
+<col style="width: 7%" />
+<col style="width: 12%" />
+<col style="width: 12%" />
+<col style="width: 47%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Setting</p></th>
+<th class="head"><p>Default</p></th>
+<th class="head"><p>Location</p></th>
+<th class="head"><p>Can Edit?</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">recent_project</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>The project that will be opened on launch</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">recent_map</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>The map that will be opened on launch</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">pretty_cursors</span></code></p></td>
+<td><p>1</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Whether to use custom crosshair cursors</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">map_sort_order</span></code></p></td>
+<td><p>group</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>The order map list is sorted in</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">window_geometry</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>no</p></td>
+<td><p>For restoring window sizes</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">window_state</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>no</p></td>
+<td><p>For restoring window sizes</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">map_splitter_state</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>no</p></td>
+<td><p>For restoring window sizes</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">main_splitter_state</span></code></p></td>
+<td></td>
+<td><p>global</p></td>
+<td><p>no</p></td>
+<td><p>For restoring window sizes</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">collision_opacity</span></code></p></td>
+<td><p>50</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Opacity of collision overlay</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">metatiles_zoom</span></code></p></td>
+<td><p>30</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Scale of map metatiles</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">show_player_view</span></code></p></td>
+<td><p>0</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Display a rectangle for the GBA screen radius</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">show_cursor_tile</span></code></p></td>
+<td><p>0</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Display a rectangle around the hovered metatile(s)</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">monitor_files</span></code></p></td>
+<td><p>1</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>Whether porymap will monitor changes to project files</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">region_map_dimensions</span></code></p></td>
+<td><p>32x20</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>The dimensions of the region map tilemap</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">theme</span></code></p></td>
+<td><p>default</p></td>
+<td><p>global</p></td>
+<td><p>yes</p></td>
+<td><p>The color theme for porymap windows and widgets</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">base_game_version</span></code></p></td>
+<td></td>
+<td><p>project</p></td>
+<td><p>no</p></td>
+<td><p>The base pret repo for this project</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">use_encounter_json</span></code></p></td>
+<td><p>1</p></td>
+<td><p>project</p></td>
+<td><p>yes</p></td>
+<td><p>Enables wild encounter table editing</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code></p></td>
+<td><p>0</p></td>
+<td><p>project</p></td>
+<td><p>yes</p></td>
+<td><p>Whether to open .pory files for scripts</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code></p></td>
+<td><p>0</p></td>
+<td><p>project</p></td>
+<td><p>yes</p></td>
+<td><p>Whether to allow variable border sizes</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">custom_scripts</span></code></p></td>
+<td></td>
+<td><p>project</p></td>
+<td><p>yes</p></td>
+<td><p>A list of script files to load into the scripting engine</p></td>
+</tr>
+</tbody>
+</table>
+<p>Some of these settings can be toggled manually in porymap via the <em>Options</em> menu.</p>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="project-files.html" class="btn btn-neutral float-left" title="Project Files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, huderlem
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+  
+  
+    
+   
+
+</body>
+</html>

docs/reference/changelog.html

@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Related Projects" href="related-projects.html" />
-    <link rel="prev" title="Project Files" href="../manual/project-files.html" /> 
+    <link rel="prev" title="Porymap Settings" href="../manual/settings-and-options.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -126,6 +126,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -169,6 +170,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">
@@ -594,7 +596,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
         <a href="related-projects.html" class="btn btn-neutral float-right" title="Related Projects" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="../manual/project-files.html" class="btn btn-neutral float-left" title="Project Files" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="../manual/settings-and-options.html" class="btn btn-neutral float-left" title="Porymap Settings" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

docs/reference/related-projects.html

@@ -125,6 +125,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -168,6 +169,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">

docs/search.html

@@ -125,6 +125,7 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
@@ -168,6 +169,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docsrc/index.rst

@@ -20,6 +20,7 @@ Porymap Documentation
     manual/region-map-editor
     manual/scripting-capabilities
     manual/project-files
+    manual/settings-and-options
 
 .. toctree::
     :maxdepth: 2

docsrc/manual/editing-map-events.rst

@@ -229,3 +229,25 @@ Clicking the ``Open Map Scripts`` button |open-map-scripts-button| will open the
 
 .. |open-map-scripts-button|
    image:: images/editing-map-events/open-map-scripts-button.png
+
+Tool Buttons
+------------
+
+The event editing tab also extends functionality to a few of the tool buttons described in :ref:`Editing Map Tiles <editing-map-tiles>`.
+A brief description and animation is listed for each of the available tools below:
+
+Pencil
+    When clicking on an existing event, the pencil tool will behave normally (as the standard cursor). It can also be used to "draw" events in a certain location. The event created will be a default-valued event of the same type as the currently selected event.
+
+.. figure:: images/editing-map-events/event-tool-pencil.gif
+    :alt: Drawing Object Events with the Pencil Tool
+
+    Drawing Object Events with the Pencil Tool
+
+Shift
+    You can use the shift tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.
+
+.. figure:: images/editing-map-events/event-tool-shift.gif
+    :alt: Moving Events with the Shift Tool
+
+    Moving Events with the Shift Tool

docsrc/manual/editing-map-tiles.rst

@@ -1,3 +1,5 @@
+.. _editing-map-tiles:
+
 *****************
 Editing Map Tiles
 *****************

docsrc/manual/settings-and-options.rst

@@ -0,0 +1,40 @@
+.. _settings-and-options:
+
+****************
+Porymap Settings
+****************
+
+Porymap uses config files to read and store user and project settings.
+A global settings file is stored in a platform-dependent location for app configuration files 
+(``%Appdata%\pret\porymap\porymap.cfg`` on Windows, ``~/Library/Application\ Support/pret/porymap/porymap.cfg`` on macOS).
+
+A config file is also created when opening a project in porymap for the first time. It is stored in
+your project root as ``porymap.project.cfg``. There are several project-specific settings that are
+determined by this file.
+
+.. csv-table::
+   :header: Setting,Default,Location,Can Edit?,Description
+   :widths: 10, 3, 5, 5, 20
+
+   ``recent_project``, , global, yes, The project that will be opened on launch
+   ``recent_map``, , global, yes, The map that will be opened on launch
+   ``pretty_cursors``, 1, global, yes, Whether to use custom crosshair cursors
+   ``map_sort_order``, group, global, yes, The order map list is sorted in
+   ``window_geometry``, , global, no, For restoring window sizes
+   ``window_state``, , global, no, For restoring window sizes
+   ``map_splitter_state``, , global, no, For restoring window sizes
+   ``main_splitter_state``, , global, no, For restoring window sizes
+   ``collision_opacity``, 50, global, yes, Opacity of collision overlay
+   ``metatiles_zoom``, 30, global, yes, Scale of map metatiles
+   ``show_player_view``, 0, global, yes, Display a rectangle for the GBA screen radius
+   ``show_cursor_tile``, 0, global, yes, Display a rectangle around the hovered metatile(s)
+   ``monitor_files``, 1, global, yes, Whether porymap will monitor changes to project files
+   ``region_map_dimensions``, 32x20, global, yes, The dimensions of the region map tilemap
+   ``theme``, default, global, yes, The color theme for porymap windows and widgets
+   ``base_game_version``, , project, no, The base pret repo for this project
+   ``use_encounter_json``, 1, project, yes, Enables wild encounter table editing
+   ``use_poryscript``, 0, project, yes, Whether to open .pory files for scripts
+   ``use_custom_border_size``, 0, project, yes, Whether to allow variable border sizes
+   ``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
+
+Some of these settings can be toggled manually in porymap via the *Options* menu.