porymap/docs/manual/region-map-editor.html

652 lines
39 KiB
HTML
Raw Normal View History

2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<!DOCTYPE html>
2024-01-02 19:55:25 +00:00
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
2019-04-29 23:12:59 +01:00
<head>
2024-01-02 19:55:25 +00:00
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2022-11-03 15:33:06 +00:00
<title>The Region Map Editor &mdash; porymap documentation</title>
2024-01-02 19:55:25 +00:00
2023-02-11 15:49:16 +00:00
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
2022-11-03 22:49:03 +00:00
2024-01-02 19:55:25 +00:00
<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" />
2019-04-29 23:12:59 +01:00
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
2022-09-10 19:08:48 +01:00
<link rel="next" title="The Tileset Editor" href="tileset-editor.html" />
2020-05-16 02:43:24 +01:00
<link rel="prev" title="Creating New Maps" href="creating-new-maps.html" />
2019-04-29 23:12:59 +01:00
</head>
2024-01-02 19:55:25 +00:00
<body class="wy-body-for-nav">
2019-04-29 23:12:59 +01:00
<div class="wy-grid-for-nav">
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<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%);" >
2024-01-02 19:55:25 +00:00
2022-11-03 22:49:03 +00:00
2024-01-02 19:55:25 +00:00
<a href="../index.html" class="icon icon-home"> porymap
2022-11-03 22:49:03 +00:00
2019-04-29 23:12:59 +01:00
</a>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
2024-01-02 19:55:25 +00:00
<input type="text" name="q" placeholder="Search docs" />
2019-04-29 23:12:59 +01:00
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
2024-01-02 19:55:25 +00:00
</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>
2019-04-29 23:12:59 +01:00
<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>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#straight-paths">Straight Paths</a></li>
2019-04-29 23:12:59 +01:00
<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>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
2019-04-29 23:12:59 +01:00
</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>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
2020-03-04 17:48:19 +00:00
<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>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
2020-03-04 17:48:19 +00:00
<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>
2020-05-16 02:43:24 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
2019-04-29 23:12:59 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
2020-05-16 20:35:42 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#ruler-tool">Ruler Tool</a></li>
2019-04-29 23:12:59 +01:00
</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>
2019-07-03 19:16:14 +01:00
<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>
2020-05-16 02:43:24 +01:00
<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>
2019-04-29 23:12:59 +01:00
<li class="toctree-l1 current"><a class="current reference internal" href="#">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#map-entries-tab">Map Entries Tab</a></li>
2022-09-10 19:08:48 +01:00
</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>
2019-04-29 23:12:59 +01:00
</ul>
</li>
2020-05-15 01:42:41 +01:00
<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>
2024-01-02 19:55:25 +00:00
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
2020-05-15 01:42:41 +01:00
<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>
2022-09-10 19:08:48 +01:00
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
2023-01-22 18:02:00 +00:00
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#overlay-functions">Overlay Functions</a></li>
2020-05-15 01:42:41 +01:00
<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>
2024-01-02 19:55:25 +00:00
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#constants">Constants</a></li>
2020-05-15 01:42:41 +01:00
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
2020-12-21 01:16:47 +00:00
<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>
2024-01-02 19:55:25 +00:00
<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>
2019-04-29 23:12:59 +01:00
</ul>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Reference</span></p>
2019-04-29 23:12:59 +01:00
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
2023-02-11 15:49:16 +00:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
2024-01-02 19:55:25 +00:00
<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>
2023-02-11 15:49:16 +00:00
<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>
2024-01-02 19:55:25 +00:00
<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>
2019-04-29 23:12:59 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2019-04-29 23:12:59 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2024-01-02 19:55:25 +00:00
<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>
2019-08-08 16:55:50 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2019-07-03 19:16:14 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-03-04 17:48:19 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-05-15 01:42:41 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-12-21 01:16:47 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-12-21 01:16:47 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-12-21 01:16:47 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-12-21 01:16:47 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-05-15 01:42:41 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2021-12-26 18:40:26 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2020-03-04 17:48:19 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2019-07-03 19:16:14 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2022-09-10 19:08:48 +01:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2023-01-22 18:02:00 +00:00
</ul>
</li>
2024-01-02 19:55:25 +00:00
<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>
2024-01-02 19:55:25 +00:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id71">1.0.0 - 2018-10-26</a></li>
2019-04-29 23:12:59 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
</ul>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</div>
</div>
</nav>
2024-01-02 19:55:25 +00:00
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
2019-04-29 23:12:59 +01:00
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">porymap</a>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</nav>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<div class="wy-nav-content">
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<div class="rst-content">
2024-01-02 19:55:25 +00:00
<div role="navigation" aria-label="breadcrumbs navigation">
2019-04-29 23:12:59 +01:00
<ul class="wy-breadcrumbs">
2024-01-02 19:55:25 +00:00
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>The Region Map Editor</li>
2019-04-29 23:12:59 +01:00
<li class="wy-breadcrumbs-aside">
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/region-map-editor.rst" class="fa fa-github"> Edit on GitHub</a>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</li>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</ul>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
2024-01-02 19:55:25 +00:00
<div class="section" id="the-region-map-editor">
<span id="rme-ref"></span><h1>The Region Map Editor<a class="headerlink" href="#the-region-map-editor" title="Permalink to this headline"></a></h1>
2022-09-10 19:08:48 +01:00
<p>This is where you edit the region maps for your game. You are able to edit the
background tilemap, the layout of map sections, and the array of map section entries
which determines the dimensions of each section.</p>
<p>To open the region map editor, navigate to <em>Tools -&gt; Region Map Editor</em> from
porymaps main window. There is also a keyboard shortcut which is by default <code class="docutils literal notranslate"><span class="pre">Ctrl+M</span></code>.</p>
<p>When you first open the region map editor, you will need to configure porymap to
read your region map data. There are defaults for every base game project available
which should be sufficient for most users.</p>
2024-01-02 19:55:25 +00:00
<div class="figure align-center" id="id4">
2022-09-10 19:08:48 +01:00
<a class="reference internal image-reference" href="../_images/new-configure-window.png"><img alt="RME Window" src="../_images/new-configure-window.png" style="width: 75%;" /></a>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Region Maps Configurator</span></p>
</div>
2022-09-10 19:08:48 +01:00
<p>Porymap supports multiple region maps for any project.
By default, pokeemerald and pokefirered use this feature.
For a more custom region map, you can use the <em>Add Region Map…</em> button to
create a new region map configuration from scratch. You can also double-click on any existing
region map in the list to bring this window up to make changes.</p>
2024-01-02 19:55:25 +00:00
<div class="figure align-center" id="id5">
2022-09-10 19:08:48 +01:00
<a class="reference internal image-reference" href="../_images/rme-config-properties.png"><img alt="RME Config Prop" src="../_images/rme-config-properties.png" style="width: 50%;" /></a>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Region Map Properties Window</span></p>
</div>
2022-09-10 19:08:48 +01:00
<p>This window has many options for users to define:</p>
2024-01-02 19:55:25 +00:00
<table border="1" class="colwidths-given docutils">
2022-09-10 19:08:48 +01:00
<colgroup>
2024-01-02 19:55:25 +00:00
<col width="17%" />
<col width="50%" />
<col width="33%" />
2022-09-10 19:08:48 +01:00
</colgroup>
2024-01-02 19:55:25 +00:00
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Explanation</th>
<th class="head">Restrictions</th>
2022-09-10 19:08:48 +01:00
</tr>
</thead>
2024-01-02 19:55:25 +00:00
<tbody valign="top">
<tr class="row-even"><td>alias</td>
<td>something for porymap to distinguish between your maps</td>
<td>unique &amp; valid json string</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td><strong>Tilemap Properties</strong></td>
<td>&#160;</td>
<td>&#160;</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>format</td>
<td>format of the tiles</td>
<td>Plain <em>or</em> 4bpp <em>or</em> 8bpp</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>width</td>
<td>width <em>in tiles</em> of the tilemap</td>
<td>16 <em>or</em> 32 <em>or</em> 64 <em>or</em> 128</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>height</td>
<td>height <em>in tiles</em> of the tilemap</td>
<td>valid corresponding height based on width</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>tileset path</td>
<td>the relative path to the tile image from project root</td>
<td>valid filepath string</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>tilemap path</td>
<td>the relative path to the tilemap binary from project root</td>
<td>valid filepath string</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>palette path</td>
<td><em>optional</em> relative path to <code class="docutils literal notranslate"><span class="pre">.pal</span></code> file from project root</td>
<td>valid filepath string</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td><strong>Layout Properties</strong></td>
<td><em>can be unchecked for maps without layouts</em></td>
<td>&#160;</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>format</td>
<td>the format to read the layout file</td>
<td>C array <em>or</em> binary</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>layout path</td>
<td>the relative path from project root to layout file</td>
<td>valid filepath string</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>width</td>
<td>the width of the layout</td>
<td>non-negative integer</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>left offset</td>
<td>the position on the tilemap which defines layout x=0</td>
<td>width + left offset &lt; tilemap width</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-odd"><td>height</td>
<td>the height of the layout</td>
<td>non-negative integer</td>
2022-09-10 19:08:48 +01:00
</tr>
2024-01-02 19:55:25 +00:00
<tr class="row-even"><td>top offset</td>
<td>the position on the tilemap which defines layout y=0</td>
<td>height + top offset &lt; tilemap height</td>
2022-09-10 19:08:48 +01:00
</tr>
</tbody>
</table>
<p>When you are finished configuring your region maps, you can select <em>OK</em>. This will
display the main editor window.</p>
2024-01-02 19:55:25 +00:00
<div class="figure align-center" id="id6">
2022-09-10 19:08:48 +01:00
<a class="reference internal image-reference" href="../_images/rme-main-window.png"><img alt="RME Config Prop" src="../_images/rme-main-window.png" style="width: 75%;" /></a>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Region Map Editor Window</span></p>
</div>
2022-09-10 19:08:48 +01:00
<p>This window has a combobox labeled “Region” which you can use to select the current
region map you want to edit.</p>
<p>You will notice
2019-04-29 23:12:59 +01:00
that there are three different tabs above the image of the region map
(<a class="reference internal" href="#background-image-tab"><span class="std std-ref">Background Image</span></a>,
<a class="reference internal" href="#map-layout-tab"><span class="std std-ref">Map Layout</span></a>,
<a class="reference internal" href="#map-entries-tab"><span class="std std-ref">Map Entries</span></a>). Lets take a look at each tabs
functionality in more detail…</p>
2024-01-02 19:55:25 +00:00
<div class="section" id="background-image-tab">
<span id="id1"></span><h2>Background Image Tab<a class="headerlink" href="#background-image-tab" title="Permalink to this headline"></a></h2>
2019-04-29 23:12:59 +01:00
<p>When this tab is selected, you can draw on the region map. Select tiles from
the tile selector on the right. You can single-click or drag your mouse around
to paint the selected tile onto the region map image. If you make a mistake, or
are unhappy with what you have done, you can undo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Z</span></code> or <em>Edit -&gt; Undo</em>)
and redo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Y</span></code> or <em>Edit -&gt; Redo</em>) your changes. Right-clicking on the map
2019-04-30 01:01:32 +01:00
image will select the tile under your mouse from the tile selector.</p>
2022-09-10 19:08:48 +01:00
<p>If your tilemap format is not “Plain”, then you can also select the palette,
h-flip, and v-flip of any tile you are painting with.</p>
2019-04-30 01:01:32 +01:00
<p>If you want to clear the background image, <em>Edit -&gt; Clear Background Image</em>
will set all tiles to the first tile in the tile selector.</p>
2022-09-10 19:08:48 +01:00
<p>You can use the sliders to zoom in and out on each of the view panes.</p>
2024-01-02 19:55:25 +00:00
</div>
<div class="section" id="map-layout-tab">
<span id="id2"></span><h2>Map Layout Tab<a class="headerlink" href="#map-layout-tab" title="Permalink to this headline"></a></h2>
2019-04-29 23:12:59 +01:00
<p>The layout tab is where map sections are placed on the region map. When the
2019-04-30 01:01:32 +01:00
player looks at the region map in-game, the layout determines the map under the
cursor.</p>
2024-01-02 19:55:25 +00:00
<div class="figure align-center" id="id7">
2022-09-10 19:08:48 +01:00
<a class="reference internal image-reference" href="../_images/rme-new-layout-tab.png"><img alt="RME Layout" src="../_images/rme-new-layout-tab.png" style="width: 75%;" /></a>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">RME Layout Tab</span></p>
</div>
2019-04-29 23:12:59 +01:00
<p>To modify the region map layout, select a position by clicking on the map image
and higlighting a single square. The “Map Section” combobox will be populated
2019-04-30 01:01:32 +01:00
with all of the map sections defined in <code class="docutils literal notranslate"><span class="pre">include/constants/region_map_sections.h</span></code>.
2019-04-29 23:12:59 +01:00
Select the map section you want to associate with the selected position on the
2022-09-10 19:08:48 +01:00
region map.</p>
<p>There are a couple of tools which make editing multiple layout squares simultaneously easier.</p>
<p><em>Edit -&gt; Clear Map Layout</em> will set all squares in the layout to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
<p><em>Edit -&gt; Swap Layout Sections…</em> will exchange two layout sections with each other.</p>
<p><em>Edit -&gt; Replace Layout Section…</em> will replace all instances of one section with another.</p>
2019-04-30 01:01:32 +01:00
<p>The “Delete Square” button simply resets a single layout square to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
2024-01-02 19:55:25 +00:00
</div>
<div class="section" id="map-entries-tab">
<span id="id3"></span><h2>Map Entries Tab<a class="headerlink" href="#map-entries-tab" title="Permalink to this headline"></a></h2>
2019-04-30 01:01:32 +01:00
<p>A region map entry is the area on the region map that spans an entire map section.
This determines, for example, where the players head appears on the region map
2022-09-10 19:08:48 +01:00
in-game. Entries are stored in <code class="docutils literal notranslate"><span class="pre">src/data/region_map/region_map_sections.json</span></code>.</p>
2024-01-02 19:55:25 +00:00
<div class="figure align-center" id="id8">
2022-09-10 19:08:48 +01:00
<a class="reference internal image-reference" href="../_images/rme-new-entries-tab.png"><img alt="RME Entries" src="../_images/rme-new-entries-tab.png" style="width: 75%;" /></a>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">RME Entries Tab</span></p>
</div>
2019-04-30 01:01:32 +01:00
<p>To edit an entry, select a map section from the “Map Section” combobox. You can
use the “Location” “x” and “y” spinboxes to change the coordinates of the entry.
You can also drag the entry around the map. The “x” and “y” values correspond to
the position of the entrys top-left square on the region map. The “Dimensions”
“width” and “height” spinboxes will change the size of the map entry.</p>
2022-09-10 19:08:48 +01:00
<p>To change the popup name of the map section when you enter the map, type it
into the “Map Name” box.</p>
2024-01-02 19:55:25 +00:00
</div>
</div>
2019-04-29 23:12:59 +01:00
</div>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</div>
2024-01-02 19:55:25 +00:00
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="tileset-editor.html" class="btn btn-neutral float-right" title="The Tileset Editor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="creating-new-maps.html" class="btn btn-neutral float-left" title="Creating New Maps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
2019-04-29 23:12:59 +01:00
</div>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
<hr/>
<div role="contentinfo">
2024-01-02 19:55:25 +00:00
<p>
&copy; Copyright 2023, huderlem
2023-02-11 15:49:16 +00:00
2024-01-02 19:55:25 +00:00
</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>.
2019-04-29 23:12:59 +01:00
2022-11-03 15:33:06 +00:00
</footer>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</div>
</div>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</section>
2024-01-02 19:55:25 +00:00
2019-04-29 23:12:59 +01:00
</div>
2024-01-02 19:55:25 +00:00
<script type="text/javascript">
2019-04-29 23:12:59 +01:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2024-01-02 19:55:25 +00:00
</script>
2019-04-29 23:12:59 +01:00
</body>
</html>