porymap/docs/manual/navigation.html
2024-01-02 14:55:25 -05:00

555 lines
No EOL
34 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Navigation &mdash; porymap documentation</title>
<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" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Editing Map Tiles" href="editing-map-tiles.html" />
<link rel="prev" title="Introduction" href="introduction.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 current"><a class="current reference internal" href="#">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="#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#straight-paths">Straight 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>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</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#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<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#clone-object-events">Clone 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#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>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#ruler-tool">Ruler Tool</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>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</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-header-editing-functions">Map Header Editing 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#overlay-functions">Overlay 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>
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#constants">Constants</a></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"><a class="reference internal" href="shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#preferences">Preferences</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#use-poryscript">Use Poryscript</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#show-wild-encounters">Show Wild Encounters</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#default-tilesets">Default Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#new-map-defaults">New Map Defaults</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#border-metatiles">Border Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#fill-metatile">Fill Metatile</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#elevation">Elevation</a></li>
<li class="toctree-l3"><a class="reference internal" href="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="settings-and-options.html#prefabs">Prefabs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#prefabs-path">Prefabs Path</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#base-game-version">Base game version</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#tilesets-metatiles">Tilesets / Metatiles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#enable-triple-layer-metatiles">Enable Triple Layer Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#attribute-size">Attribute size</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#behavior-mask">Behavior mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#layer-type-mask">Layer Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#encounter-type-mask">Encounter Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#terrain-type-mask">Terrain Type mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="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="settings-and-options.html#project-files">Project Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#events">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#enable-clone-objects">Enable Clone Objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#enable-secret-bases">Enable Secret Bases</a></li>
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#enable-weather-triggers">Enable Weather Triggers</a></li>
<li class="toctree-l3"><a class="reference internal" href="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="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="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="settings-and-options.html#maps">Maps</a><ul>
<li class="toctree-l3"><a class="reference internal" href="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="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="settings-and-options.html#enable-custom-border-size">Enable Custom Border Size</a></li>
</ul>
</li>
</ul>
</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#changed">Changed</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">5.1.1 - 2023-02-20</a><ul>
<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#id3">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">5.1.0 - 2023-01-22</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">5.0.0 - 2022-10-30</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#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.5.0 - 2021-12-26</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.4.0 - 2020-12-20</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">4.3.1 - 2020-07-17</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id29">4.2.0 - 2020-06-06</a><ul>
<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">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id44">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id58">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id59">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id60">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id61">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id62">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id63">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id64">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id65">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id66">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id68">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id69">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id70">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id71">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>Navigation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/navigation.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="navigation">
<h1>Navigation<a class="headerlink" href="#navigation" title="Permalink to this headline"></a></h1>
<p>Porymap can seem daunting at first because it has many buttons, tabs, panes, and windows. Lets briefly go over the different parts of the application.</p>
<div class="section" id="map-list">
<h2>Map List<a class="headerlink" href="#map-list" title="Permalink to this headline"></a></h2>
<p>The map list contains a hierarchical view of all of the maps in your project. It is situated on the left side of Porymaps main window. To switch to a different map, simply double-click or press <code class="docutils literal notranslate"><span class="pre">Enter</span></code> on the desired maps name. Larger maps can take a few seconds to load the first time, so be patient.</p>
<div class="figure" id="id1">
<img alt="Map List Pane" src="../_images/map-list-pane.png" />
<p class="caption"><span class="caption-text">Map List Pane</span></p>
</div>
<p>By default, the maps are organized by their map groups. The <em>Sort Map List</em> <img alt="sort-map-list-button" src="../_images/sort-map-list-button.png" /> button gives you some other options to organize the maps:</p>
<dl class="docutils">
<dt>Sort by Group</dt>
<dd>Organizes by map groups.</dd>
<dt>Sort by Area</dt>
<dd>Organizes by region map section.</dd>
<dt>Sort by Layout</dt>
<dd>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</dd>
</dl>
<p>Right-clicking on the folder name in any of the sort modes will bring up a dialog to create a new map in that folder. For more details, see: <a class="reference internal" href="creating-new-maps.html#creating-new-maps"><span class="std std-ref">Creating New Maps</span></a>.</p>
<p>The <em>Expand All</em> <img alt="expand-all-button" src="../_images/expand-all-button.png" /> and <em>Collapse All</em> <img alt="collapse-all-button" src="../_images/collapse-all-button.png" /> buttons will expand or collapse all of the map folders.</p>
<p>Type in the filter to show maps that contain the filter text.</p>
<div class="figure" id="id2">
<img alt="Filter Map List" src="../_images/filter-map-list.png" />
<p class="caption"><span class="caption-text">Filter Map List</span></p>
</div>
</div>
<div class="section" id="main-window">
<h2>Main Window<a class="headerlink" href="#main-window" title="Permalink to this headline"></a></h2>
<p>Most of the work you do in Porymap is in the center Main Window. It features 4 tabbed views which each have different purposes, but they all operate within the context of the currently-opened map in the Map List. Lets quickly summarize what each of these tabs is used for.</p>
<div class="figure" id="id3">
<img alt="Main Window Tabs" src="../_images/main-window-tabs.png" />
<p class="caption"><span class="caption-text">Main Window Tabs</span></p>
</div>
<dl class="docutils">
<dt>Map Tab</dt>
<dd>Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map. When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision. You can switch between these to paint either metatiles or collision properties onto the map.</dd>
<dt>Events Tab</dt>
<dd>Edit the interactable events on the map. This includes things like objects, warps, script triggers, and more.</dd>
<dt>Header Tab</dt>
<dd>Choose various gameplay properties to set for the map. This includes things like background music and weather.</dd>
<dt>Connections Tab</dt>
<dd>Change how the map connects with surrounding maps when the player walks from one to another.</dd>
<dt>Wild Pokémon Tab</dt>
<dd>Edit the wild Pokémon available in the map.</dd>
</dl>
</div>
<div class="section" id="tileset-editor">
<h2>Tileset Editor<a class="headerlink" href="#tileset-editor" title="Permalink to this headline"></a></h2>
<p>The Tileset Editor can be opened with <em>File -&gt; Tileset Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+T</span></code>).
Check out <a class="reference internal" href="tileset-editor.html#tse-ref"><span class="std std-ref">The Tileset Editor</span></a> section for more details.</p>
<div class="figure" id="id4">
<img alt="Tileset Editor" src="../_images/tileset-editor.png" />
<p class="caption"><span class="caption-text">Tileset Editor</span></p>
</div>
</div>
<div class="section" id="region-map-editor">
<h2>Region Map Editor<a class="headerlink" href="#region-map-editor" title="Permalink to this headline"></a></h2>
<p>The Region Map Editor can be opened with <em>File -&gt; Region Map Editor</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+M</span></code>).
This window will allow you to modify the look and layout of maps on the games region map.
Check out <a class="reference internal" href="region-map-editor.html#rme-ref"><span class="std std-ref">The Region Map Editor</span></a> section for more details.</p>
<div class="figure" id="id5">
<img alt="Region Map Editor" src="../_images/region-map-editor.png" />
<p class="caption"><span class="caption-text">Region Map Editor</span></p>
</div>
<p>We covered all of the basic views and windows of porymap above. Next, lets learn how to use Porymaps features to the fullest when editing map tiles.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="editing-map-tiles.html" class="btn btn-neutral float-right" title="Editing Map Tiles" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="introduction.html" class="btn btn-neutral float-left" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>