mirror of
https://github.com/huderlem/porymap.git
synced 2026-08-23 00:56:47 -05:00
Add documentation for prefabs
This commit is contained in:
Marcus Huderle
@@ -38,7 +38,7 @@
|
||||
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Scripting Capabilities" href="scripting-capabilities.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>
|
||||
|
||||
@@ -109,6 +109,7 @@
|
||||
<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 & 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>
|
||||
@@ -121,6 +122,7 @@
|
||||
<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>
|
||||
@@ -153,7 +155,25 @@
|
||||
<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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#city-maps">City Maps</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>
|
||||
@@ -163,6 +183,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
@@ -185,94 +206,100 @@
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<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">4.4.0 - 2020-12-20</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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.5.0 - 2021-12-26</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">4.3.1 - 2020-07-17</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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">4.4.0 - 2020-12-20</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">4.3.0 - 2020-06-27</a><ul>
|
||||
<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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">4.3.1 - 2020-07-17</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">4.2.0 - 2020-06-06</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">4.3.0 - 2020-06-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">4.1.0 - 2020-05-18</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">4.2.0 - 2020-06-06</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id22">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">4.1.0 - 2020-05-18</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id25">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id28">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id30">3.0.1 - 2020-03-04</a><ul>
|
||||
<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#id33">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id36">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id38">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id37">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id41">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id42">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id45">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id46">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id49">Fixed</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#id50">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id53">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id55">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id54">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id57">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id59">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>
|
||||
@@ -343,21 +370,113 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="the-region-map-editor">
|
||||
<h1>The Region Map Editor<a class="headerlink" href="#the-region-map-editor" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This is where you edit the region map for your game. To open the region map
|
||||
editor, navigate to <em>Tools -> Region Map Editor</em> from porymap’s main window.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The region map editor is currently only available for pokeemerald and pokeruby.</p>
|
||||
</div>
|
||||
<p>When you first open the region map editor, your window will look like this:</p>
|
||||
<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>
|
||||
<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 -> Region Map Editor</em> 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>
|
||||
<div class="figure align-center" id="id4">
|
||||
<a class="reference internal image-reference" href="../_images/rme-new-window.png"><img alt="RME Window" src="../_images/rme-new-window.png" style="width: 621.75px; height: 499.5px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
<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>
|
||||
<p class="caption"><span class="caption-text">Region Maps Configurator</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>This window is split vertically–the region map editing is done at the top,
|
||||
while the zoomed-in city maps are edited at the bottom. You can use the
|
||||
sliders to zoom in and out on each of the view panes. You will notice
|
||||
<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>
|
||||
<div class="figure 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>
|
||||
<p class="caption"><span class="caption-text">Region Map Properties Window</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>This window has many options for users to define:</p>
|
||||
<table class="colwidths-given docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 17%" />
|
||||
<col style="width: 50%" />
|
||||
<col style="width: 33%" />
|
||||
</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>
|
||||
<div class="figure 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>
|
||||
<p class="caption"><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<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>,
|
||||
@@ -371,59 +490,39 @@ 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 -> Undo</em>)
|
||||
and redo (<code class="docutils literal notranslate"><span class="pre">Ctrl+Y</span></code> or <em>Edit -> Redo</em>) 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, <em>Edit -> Clear Background Image</em>
|
||||
will set all tiles to the first tile in the tile selector.</p>
|
||||
<div class="figure align-center" id="id5">
|
||||
<a class="reference internal image-reference" href="../_images/rme-painting-image.gif"><img alt="RME Paint" src="../_images/rme-painting-image.gif" style="width: 730.5px; height: 424.5px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Drawing on the Region Map Image</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>It is likely that you will want to use your own tiles for your region map. You
|
||||
can import a tile image by navigating to <em>Tools -> Import Region Map Image Tiles</em>.
|
||||
There are strict requirements for your region map tile image. It must (1) be
|
||||
indexed with a 256 color palette*, (2) be composed of 8x8 pixel tiles, (3) have 256
|
||||
or fewer tiles.</p>
|
||||
<p>* While the region map tile image requires a 256-color palette, the image only
|
||||
uses the 32 colors beginning at index 112 in the palette.</p>
|
||||
<p>You can use the sliders to zoom in and out on each of the view panes.</p>
|
||||
</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>
|
||||
<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>
|
||||
<div class="figure align-center" id="id6">
|
||||
<a class="reference internal image-reference" href="../_images/rme-layout-tab.png"><img alt="RME Layout" src="../_images/rme-layout-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
|
||||
<p class="caption"><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
<div class="figure 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>
|
||||
<p class="caption"><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<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. To change the popup name of the map section when you enter the map,
|
||||
type it into the “Map Name” box. The popup name is tied to the map section, so
|
||||
each layout square with the same map section will share a name.</p>
|
||||
<p>If you want to start from a blank layout, <em>Edit -> Clear Map Layout</em> will set
|
||||
all layout squares to the value of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
|
||||
<p>When adding new region map sections, the layout will be affected. This is
|
||||
because the layout is stored as a binary file and uses the raw value of each
|
||||
map section. In order to fix your layout to account for this, you can swap two
|
||||
values for the entire layout with <em>Edit -> Swap</em>.</p>
|
||||
<p>In this example, <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code> is inserted before <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>, and
|
||||
therefore the layout will link the original value of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code> to the new
|
||||
map section <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code>. Instances of <code class="docutils literal notranslate"><span class="pre">MAPSEC_NEW_MAPSEC</span></code> are swapped
|
||||
with <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
|
||||
<div class="figure align-center" id="id7">
|
||||
<a class="reference internal image-reference" href="../_images/rme-layout-swap.gif"><img alt="RME Swap" src="../_images/rme-layout-swap.gif" style="width: 559.5px; height: 495.0px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Swapping Map Sections</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
region map.</p>
|
||||
<p>There are a couple of tools which make editing multiple layout squares simultaneously easier.</p>
|
||||
<p><em>Edit -> 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 -> Swap Layout Sections…</em> will exchange two layout sections with each other.</p>
|
||||
<p><em>Edit -> Replace Layout Section…</em> 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>
|
||||
</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>
|
||||
<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 at <code class="docutils literal notranslate"><span class="pre">src/data/region_map/region_map_entries.h</span></code>.</p>
|
||||
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>
|
||||
<div class="figure align-center" id="id8">
|
||||
<a class="reference internal image-reference" href="../_images/rme-entries-tab.png"><img alt="RME Entries" src="../_images/rme-entries-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
|
||||
<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>
|
||||
<p class="caption"><span class="caption-text">RME Entries Tab</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>To edit an entry, select a map section from the “Map Section” combobox. You can
|
||||
@@ -431,21 +530,8 @@ use the “Location” “x” and “y” spinboxes to change the coordinates o
|
||||
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>
|
||||
</div>
|
||||
<div class="section" id="city-maps">
|
||||
<h2>City Maps<a class="headerlink" href="#city-maps" title="Permalink to this headline">¶</a></h2>
|
||||
<p>In the bottom half of the region map editor window, city maps can be edited.
|
||||
You paint on this the same way you paint on the region map background image.</p>
|
||||
<div class="figure align-center" id="id9">
|
||||
<a class="reference internal image-reference" href="../_images/rme-painting-city.gif"><img alt="City Paint" src="../_images/rme-painting-city.gif" style="width: 482.4px; height: 408.0px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Drawing on the City Map</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>To use custom tiles, there is a tile image importer under
|
||||
<em>Tools -> Import City Map Image Tiles</em>. These images must (1) be indexed with a
|
||||
16 color palette, (2) be made up of 8x8 pixel tiles, (3) have 256 or fewer tiles.</p>
|
||||
<p>You can add a new city map by pressing the <img alt="new-city-map-button" src="../_images/rme-new-city-map-button.png" /> button.</p>
|
||||
<p>Currently, it is not possible to associate a city map to a region map location,
|
||||
but that functionality will be added in a future update.</p>
|
||||
<p>To change the popup name of the map section when you enter the map, type it
|
||||
into the “Map Name” box.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -457,7 +543,7 @@ but that functionality will be added in a future update.</p>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="scripting-capabilities.html" class="btn btn-neutral float-right" title="Scripting Capabilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></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"></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>
|
||||
|
||||
Reference in New Issue
Block a user