401 lines
No EOL
21 KiB
HTML
401 lines
No EOL
21 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>The Region Map Editor — porymap documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Changelog" href="../reference/changelog.html" />
|
||
<link rel="prev" title="Editing Map Connections" href="editing-map-connections.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home"> porymap
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><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>
|
||
<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>
|
||
</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#events-positions">Events Positions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||
<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#open-map-scripts">Open Map Scripts</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>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 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>
|
||
<li class="toctree-l2"><a class="reference internal" href="#city-maps">City Maps</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</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">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</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#id9">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id12">1.1.0 - 2018-12-27</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">1.0.0 - 2018-10-26</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">porymap</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="../index.html">Docs</a> »</li>
|
||
|
||
<li>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">
|
||
|
||
<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>
|
||
<p>When you first open the region map editor, your window will look like this:</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></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
|
||
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>
|
||
<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>
|
||
<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 -> 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 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></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>
|
||
</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></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></p>
|
||
</div>
|
||
<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>
|
||
<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>
|
||
<p class="caption"><span class="caption-text">RME Entries Tab</span></p>
|
||
</div>
|
||
<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>
|
||
</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></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>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="editing-map-connections.html" class="btn btn-neutral float-left" title="Editing Map Connections" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, huderlem
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |