mirror of
https://github.com/huderlem/porymap.git
synced 2026-03-22 01:54:46 -05:00
6a982402d9
Some checks failed
Build Porymap / build-linux (5.14.2) (push) Has been cancelled
Build Porymap / build-linux (6.8.*) (push) Has been cancelled
Build Porymap / build-macos (macos-15-intel) (push) Has been cancelled
Build Porymap / build-macos (macos-latest) (push) Has been cancelled
Build Porymap / build-static-windows (push) Has been cancelled
645 lines
49 KiB
HTML
645 lines
49 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<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>The Region Map Editor — 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 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="next" title="The Tileset Editor" href="tileset-editor.html" />
|
||
<link rel="prev" title="Creating New Maps" href="creating-new-maps.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" 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="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">User Manual</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#tabs">Tabs</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#buttons">Buttons</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#status-icons">Status Icons</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</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#move-tool">Move 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-dimensions">Change Dimensions</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="editing-map-tiles.html#border-dimensions">Border Dimensions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-layout">Change Layout</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#change-map-border">Change Map Border</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo & 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 & 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-locations">Heal Locations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#custom-attributes">Custom Attributes</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 & Emerge Warps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror 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>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#summary-chart">Summary Chart</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#species-search">Species Search</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a></li>
|
||
<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>
|
||
</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#custom-scripts-editor">Custom Scripts Editor</a></li>
|
||
<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><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="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="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="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="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="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="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="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="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="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="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="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="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="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="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="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="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><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="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="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="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="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="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="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="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="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="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="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="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="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="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="project-files.html">Project Files</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="project-files.html#identifiers">Identifiers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="project-files.html#global-constants">Global Constants</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="breaking-changes.html">Breaking Changes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#versioning">Versioning</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#what-s-a-breaking-change">What’s a breaking change?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#updating-your-project">Updating your project</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="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="breaking-changes.html#map-num-map-group">1. <code class="docutils literal notranslate"><span class="pre">MAP_NUM</span></code>/<code class="docutils literal notranslate"><span class="pre">MAP_GROUP</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#heal-locations">2. Heal Locations</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#region-map-sections">3. Region Map Sections</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#local-ids">4. Local IDs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="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><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#map-none-renamed">1. <code class="docutils literal notranslate"><span class="pre">MAP_NONE</span></code> renamed</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#dest-warp-id">2. <code class="docutils literal notranslate"><span class="pre">dest_warp_id</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#clone-object-events">3. Clone Object events</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#region-map-editor">4. Region Map Editor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#additional-api-changes">5. Additional API changes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="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="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>
|
||
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#custom-scripts-editor">Custom Scripts 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#global-settings">Global settings</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#project-settings">Project settings</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#general">General</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#maps">Maps</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#tilesets">Tilesets</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#events">Events</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#files-identifiers">Files & Identifiers</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><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></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">6.3.0 - 2025-12-26</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#id2">6.2.0 - 2025-08-08</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">6.1.0 - 2025-06-09</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">6.0.0 - 2025-05-27</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#id11">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">5.4.1 - 2024-03-21</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">5.4.0 - 2024-02-13</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">5.3.0 - 2024-01-15</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id24">5.2.0 - 2024-01-02</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">5.1.1 - 2023-02-20</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">5.1.0 - 2023-01-22</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id36">5.0.0 - 2022-10-30</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id41">4.5.0 - 2021-12-26</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id42">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">4.4.0 - 2020-12-20</a><ul>
|
||
<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">4.3.1 - 2020-07-17</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id53">4.3.0 - 2020-06-27</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id57">4.2.0 - 2020-06-06</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id59">Changed</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">4.1.0 - 2020-05-18</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id62">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id63">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id64">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id65">4.0.0 - 2020-04-28</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id66">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id68">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id69">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id70">3.0.1 - 2020-03-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id71">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id72">3.0.0 - 2020-03-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id73">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id74">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id75">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id76">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id77">2.0.0 - 2019-10-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id78">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id79">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id80">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id81">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id82">1.2.2 - 2019-05-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id83">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id84">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id85">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id86">1.2.1 - 2019-02-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id87">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id88">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id89">1.2.0 - 2019-02-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id90">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id91">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id92">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id93">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id94">1.1.0 - 2018-12-27</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id95">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id96">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id97">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id98">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id99">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="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="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">The Region Map Editor</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/region-map-editor.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">
|
||
|
||
<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="Link to this heading"></a></h1>
|
||
<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 <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">></span> <span class="pre">Region</span> <span class="pre">Map</span> <span class="pre">Editor</span></code> from
|
||
porymap’s 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>
|
||
<figure class="align-center" id="id4">
|
||
<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>
|
||
<figcaption>
|
||
<p><span class="caption-text">Region Maps Configurator</span><a class="headerlink" href="#id4" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<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>
|
||
<figure class="align-center" id="id5">
|
||
<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>
|
||
<figcaption>
|
||
<p><span class="caption-text">Region Map Properties Window</span><a class="headerlink" href="#id5" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<p>This window has many options for users to define:</p>
|
||
<table class="docutils align-default">
|
||
<colgroup>
|
||
<col style="width: 16.7%" />
|
||
<col style="width: 50.0%" />
|
||
<col style="width: 33.3%" />
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Field</p></th>
|
||
<th class="head"><p>Explanation</p></th>
|
||
<th class="head"><p>Restrictions</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>alias</p></td>
|
||
<td><p>something for porymap to distinguish between your maps</p></td>
|
||
<td><p>unique & valid json string</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><strong>Tilemap Properties</strong></p></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>format</p></td>
|
||
<td><p>format of the tiles</p></td>
|
||
<td><p>Plain <em>or</em> 4bpp <em>or</em> 8bpp</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>width</p></td>
|
||
<td><p>width <em>in tiles</em> of the tilemap</p></td>
|
||
<td><p>16 <em>or</em> 32 <em>or</em> 64 <em>or</em> 128</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>height</p></td>
|
||
<td><p>height <em>in tiles</em> of the tilemap</p></td>
|
||
<td><p>valid corresponding height based on width</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>tileset path</p></td>
|
||
<td><p>the relative path to the tile image from project root</p></td>
|
||
<td><p>valid filepath string</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>tilemap path</p></td>
|
||
<td><p>the relative path to the tilemap binary from project root</p></td>
|
||
<td><p>valid filepath string</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>palette path</p></td>
|
||
<td><p><em>optional</em> relative path to <code class="docutils literal notranslate"><span class="pre">.pal</span></code> file from project root</p></td>
|
||
<td><p>valid filepath string</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><strong>Layout Properties</strong></p></td>
|
||
<td><p><em>can be unchecked for maps without layouts</em></p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>format</p></td>
|
||
<td><p>the format to read the layout file</p></td>
|
||
<td><p>C array <em>or</em> binary</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>layout path</p></td>
|
||
<td><p>the relative path from project root to layout file</p></td>
|
||
<td><p>valid filepath string</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>width</p></td>
|
||
<td><p>the width of the layout</p></td>
|
||
<td><p>non-negative integer</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>left offset</p></td>
|
||
<td><p>the position on the tilemap which defines layout x=0</p></td>
|
||
<td><p>width + left offset < tilemap width</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>height</p></td>
|
||
<td><p>the height of the layout</p></td>
|
||
<td><p>non-negative integer</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>top offset</p></td>
|
||
<td><p>the position on the tilemap which defines layout y=0</p></td>
|
||
<td><p>height + top offset < tilemap height</p></td>
|
||
</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>
|
||
<figure class="align-center" id="id6">
|
||
<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>
|
||
<figcaption>
|
||
<p><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id6" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<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
|
||
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>). Let’s take a look at each tab’s
|
||
functionality in more detail…</p>
|
||
<section id="background-image-tab">
|
||
<span id="id1"></span><h2>Background Image Tab<a class="headerlink" href="#background-image-tab" title="Link to this heading"></a></h2>
|
||
<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 <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Undo</span></code>)
|
||
and redo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Y</span></code> or <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Redo</span></code>) your changes. Right-clicking on the map
|
||
image will select the tile under your mouse from the tile selector.</p>
|
||
<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>
|
||
<p>If you want to clear the background image, <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Clear</span> <span class="pre">Background</span> <span class="pre">Image</span></code>
|
||
will set all tiles to the first tile in the tile selector.</p>
|
||
<p>You can use the sliders to zoom in and out on each of the view panes.</p>
|
||
</section>
|
||
<section id="map-layout-tab">
|
||
<span id="id2"></span><h2>Map Layout Tab<a class="headerlink" href="#map-layout-tab" title="Link to this heading"></a></h2>
|
||
<p>The layout tab is where map sections are placed on the region map. When the
|
||
player looks at the region map in-game, the layout determines the map under the
|
||
cursor.</p>
|
||
<figure class="align-center" id="id7">
|
||
<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>
|
||
<figcaption>
|
||
<p><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id7" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<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
|
||
with all of the map sections defined in <code class="docutils literal notranslate"><span class="pre">include/constants/region_map_sections.h</span></code>.
|
||
Select the map section you want to associate with the selected position on the
|
||
region map.</p>
|
||
<p>There are a couple of tools which make editing multiple layout squares simultaneously easier.</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Clear</span> <span class="pre">Map</span> <span class="pre">Layout</span></code> will set all squares in the layout to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Swap</span> <span class="pre">Layout</span> <span class="pre">Sections...</span></code> will exchange two layout sections with each other.</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">></span> <span class="pre">Replace</span> <span class="pre">Layout</span> <span class="pre">Section...</span></code> will replace all instances of one section with another.</p>
|
||
<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>
|
||
</section>
|
||
<section id="map-entries-tab">
|
||
<span id="id3"></span><h2>Map Entries Tab<a class="headerlink" href="#map-entries-tab" title="Link to this heading"></a></h2>
|
||
<p>A region map entry is the area on the region map that spans an entire map section.
|
||
This determines, for example, where the player’s head appears on the region map
|
||
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>
|
||
<figure class="align-center" id="id8">
|
||
<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>
|
||
<figcaption>
|
||
<p><span class="caption-text">RME Entries Tab</span><a class="headerlink" href="#id8" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<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 entry’s top-left square on the region map. The “Dimensions”
|
||
“width” and “height” spinboxes will change the size of the map entry.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<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" aria-hidden="true"></span> Previous</a>
|
||
<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" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, huderlem.</p>
|
||
</div>
|
||
|
||
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>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |