Pre-release manual update

This commit is contained in:
GriffinR
2025-05-26 17:02:38 -04:00
parent 082f51e797
commit 27c7df1288
211 changed files with 12242 additions and 23381 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -1,88 +1,49 @@
<!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]-->
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Related Projects &mdash; porymap documentation</title>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Related Projects &mdash; porymap documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=eb07c574" />
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
<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 type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" 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" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="Changelog" href="changelog.html" />
</head>
<body class="wy-body-for-nav">
<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 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="text" name="q" placeholder="Search docs" aria-label="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>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User Manual</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../manual/introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/introduction.html#about-porymap">About Porymap</a></li>
@@ -90,10 +51,13 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/navigation.html#map-list">Map List</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/navigation.html#tabs">Tabs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/navigation.html#buttons">Buttons</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/navigation.html#status-icons">Status Icons</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
@@ -102,11 +66,17 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#move-tool">Move Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#straight-paths">Straight Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#change-dimensions">Change Dimensions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/editing-map-tiles.html#border-dimensions">Border Dimensions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#change-layout">Change Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
@@ -128,7 +98,8 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
<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#heal-locations">Heal Locations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#custom-attributes">Custom Attributes</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>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#ruler-tool">Ruler Tool</a></li>
@@ -138,7 +109,6 @@
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-wild-encounters.html">Editing Wild Encounters</a><ul>
@@ -146,10 +116,7 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/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="../manual/creating-new-maps.html">Creating New Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/creating-new-maps.html">Creating New Maps</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
@@ -176,10 +143,28 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#custom-scripts-editor">Custom Scripts Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onProjectOpened"><code class="docutils literal notranslate"><span class="pre">onProjectOpened</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onProjectClosed"><code class="docutils literal notranslate"><span class="pre">onProjectClosed</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onMapOpened"><code class="docutils literal notranslate"><span class="pre">onMapOpened</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onLayoutOpened"><code class="docutils literal notranslate"><span class="pre">onLayoutOpened</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBlockChanged"><code class="docutils literal notranslate"><span class="pre">onBlockChanged</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBorderMetatileChanged"><code class="docutils literal notranslate"><span class="pre">onBorderMetatileChanged</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBlockHoverChanged"><code class="docutils literal notranslate"><span class="pre">onBlockHoverChanged</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBlockHoverCleared"><code class="docutils literal notranslate"><span class="pre">onBlockHoverCleared</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onMapResized"><code class="docutils literal notranslate"><span class="pre">onMapResized</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBorderResized"><code class="docutils literal notranslate"><span class="pre">onBorderResized</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onMapShifted"><code class="docutils literal notranslate"><span class="pre">onMapShifted</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onTilesetUpdated"><code class="docutils literal notranslate"><span class="pre">onTilesetUpdated</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onMainTabChanged"><code class="docutils literal notranslate"><span class="pre">onMainTabChanged</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onMapViewTabChanged"><code class="docutils literal notranslate"><span class="pre">onMapViewTabChanged</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#onBorderVisibilityToggled"><code class="docutils literal notranslate"><span class="pre">onBorderVisibilityToggled</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
@@ -189,67 +174,66 @@
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#constants">Constants</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#constants">Constants</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.max_primary_tiles"><code class="docutils literal notranslate"><span class="pre">constants.max_primary_tiles</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.max_secondary_tiles"><code class="docutils literal notranslate"><span class="pre">constants.max_secondary_tiles</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.max_primary_metatiles"><code class="docutils literal notranslate"><span class="pre">constants.max_primary_metatiles</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.max_secondary_metatiles"><code class="docutils literal notranslate"><span class="pre">constants.max_secondary_metatiles</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.num_primary_palettes"><code class="docutils literal notranslate"><span class="pre">constants.num_primary_palettes</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.num_secondary_palettes"><code class="docutils literal notranslate"><span class="pre">constants.num_secondary_palettes</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.layers_per_metatile"><code class="docutils literal notranslate"><span class="pre">constants.layers_per_metatile</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.tiles_per_metatile"><code class="docutils literal notranslate"><span class="pre">constants.tiles_per_metatile</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.metatile_behaviors"><code class="docutils literal notranslate"><span class="pre">constants.metatile_behaviors</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.base_game_version"><code class="docutils literal notranslate"><span class="pre">constants.base_game_version</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.version.major"><code class="docutils literal notranslate"><span class="pre">constants.version.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.version.minor"><code class="docutils literal notranslate"><span class="pre">constants.version.minor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#constants.version.patch"><code class="docutils literal notranslate"><span class="pre">constants.version.patch</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/project-files.html#identifiers">Identifiers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/project-files.html#global-constants">Global Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/breaking-changes.html">Breaking Changes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/breaking-changes.html#versioning">Versioning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/breaking-changes.html#what-s-a-breaking-change">Whats a breaking change?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/breaking-changes.html#updating-your-project">Updating your project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/breaking-changes.html#from-5-x-x-to-6-x-x">From <code class="docutils literal notranslate"><span class="pre">5.x.x</span></code> to <code class="docutils literal notranslate"><span class="pre">6.x.x</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="../manual/breaking-changes.html#change">Change</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../manual/breaking-changes.html#from-4-x-x-to-5-x-x">From <code class="docutils literal notranslate"><span class="pre">4.x.x</span></code> to <code class="docutils literal notranslate"><span class="pre">5.x.x</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/breaking-changes.html#prior-to-4-x-x">Prior to <code class="docutils literal notranslate"><span class="pre">4.x.x</span></code></a></li>
</ul>
</li>
</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/shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/shortcuts.html#region-map-editor">Region Map Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/shortcuts.html#custom-scripts-editor">Custom Scripts Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/settings-and-options.html">Porymap Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#preferences">Preferences</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#use-poryscript">Use Poryscript</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#show-wild-encounters">Show Wild Encounters</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#default-tilesets">Default Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#new-map-defaults">New Map Defaults</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#border-metatiles">Border Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#fill-metatile">Fill Metatile</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#elevation">Elevation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#create-separate-text-file">Create separate text file</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#prefabs">Prefabs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#prefabs-path">Prefabs Path</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#base-game-version">Base game version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#tilesets-metatiles">Tilesets / Metatiles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-triple-layer-metatiles">Enable Triple Layer Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#attribute-size">Attribute size</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#behavior-mask">Behavior mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#layer-type-mask">Layer Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#encounter-type-mask">Encounter Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#terrain-type-mask">Terrain Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#output-callback-and-iscompressed-fields">Output <code class="docutils literal notranslate"><span class="pre">callback</span></code> and <code class="docutils literal notranslate"><span class="pre">isCompressed</span></code> fields</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#project-files">Project Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#events">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-clone-objects">Enable Clone Objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-secret-bases">Enable Secret Bases</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-weather-triggers">Enable Weather Triggers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-quantity-for-hidden-items">Enable <code class="docutils literal notranslate"><span class="pre">Quantity</span></code> for Hidden Items</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-requires-itemfinder-for-hidden-items">Enable <code class="docutils literal notranslate"><span class="pre">Requires</span> <span class="pre">Itemfinder</span></code> for Hidden Items</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-repsawn-map-npc-for-heal-locations">Enable <code class="docutils literal notranslate"><span class="pre">Repsawn</span> <span class="pre">Map/NPC</span></code> for Heal Locations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#maps">Maps</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-floor-number">Enable <code class="docutils literal notranslate"><span class="pre">Floor</span> <span class="pre">Number</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-allow-running-biking-escaping">Enable <code class="docutils literal notranslate"><span class="pre">Allow</span> <span class="pre">Running/Biking/Escaping</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#enable-custom-border-size">Enable Custom Border Size</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#global-settings">Global settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/settings-and-options.html#project-settings">Project settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#general">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#maps">Maps</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#tilesets">Tilesets</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="../manual/settings-and-options.html#files-identifiers">Files &amp; Identifiers</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a><ul>
@@ -258,234 +242,199 @@
<li class="toctree-l3"><a class="reference internal" href="changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">5.1.1 - 2023-02-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id4">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">5.4.1 - 2024-03-21</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">5.1.0 - 2023-01-22</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">5.4.0 - 2024-02-13</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id4">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">5.0.0 - 2022-10-30</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">5.3.0 - 2024-01-15</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">5.2.0 - 2024-01-02</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id13">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id15">5.1.1 - 2023-02-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id16">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id19">5.1.0 - 2023-01-22</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id21">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id23">5.0.0 - 2022-10-30</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id26">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id16">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id27">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id28">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id29">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id30">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id17">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id31">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id32">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id33">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id34">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id21">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id35">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id36">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id37">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id38">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id25">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id26">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id27">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id28">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id39">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id40">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id41">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id42">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id29">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id30">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id31">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id32">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id43">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id44">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id45">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id46">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id33">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id36">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id47">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id48">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id49">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id50">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id37">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id41">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id51">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id52">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id53">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id54">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id55">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id42">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id43">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id44">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id45">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id46">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id47">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id49">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id54">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id55">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id56">Changed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id56">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id57">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id58">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id59">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id60">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id58">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id59">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id60">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id61">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id62">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id61">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id62">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id63">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id64">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id65">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id63">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id64">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id65">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id66">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id67">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id66">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id67">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id68">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id69">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id70">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id68">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id69">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id70">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id71">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id71">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id72">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id73">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id74">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id75">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id76">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id77">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id78">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id79">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id80">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id81">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id82">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id83">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id84">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id85">1.0.0 - 2018-10-26</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">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">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
<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">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Related Projects</li>
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Related Projects</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/reference/related-projects.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="related-projects">
<h1>Related Projects<a class="headerlink" href="#related-projects" title="Permalink to this headline"></a></h1>
<section id="related-projects">
<h1>Related Projects<a class="headerlink" href="#related-projects" title="Link to this heading"></a></h1>
<p><a class="reference external" href="https://github.com/Rangi42/polished-map">Polished Map</a> - A map editor for pokecrystal, pokered, and other Gen 1/2 disassembly projects.</p>
<p><a class="reference external" href="https://github.com/huderlem/poryscript">Poryscript</a> - A high-level scripting language meant to be used with the decompilation projects.</p>
<p><a class="reference external" href="https://github.com/Kermalis/VGMusicStudio">VG Music Studio</a> - A program that lets you listen to the music from popular video game formats.</p>
<p><a class="reference external" href="https://github.com/Rangi42/tilemap-studio">Tilemap Studio</a> - A tilemap editor for Game Boy, Color, and Advance projects.</p>
</div>
</section>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="changelog.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="changelog.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2023, huderlem
</p>
<p>&#169; Copyright 2023, 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>.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/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">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>