atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
porymap/docs/manual/introduction.html

388 lines
21 KiB
HTML
Raw Normal View History

Update GitHub Pages
2019-04-21 17:20:49 +01:00
<!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>Introduction &mdash; 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" />
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
Update GitHub Pages
2019-04-21 17:20:49 +01:00
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Navigation" href="navigation.html" />
<link rel="prev" title="Porymap Documentation" href="../index.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">
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
Update GitHub Pages
2019-04-21 17:20:49 +01:00
<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 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a></li>
</ul>
</li>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
<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>
Add map collision editing documentation
2019-04-25 00:49:08 +01:00
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; 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>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
Add map events editing documentation
2019-04-26 00:32:32 +01:00
<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 &amp; 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>
Add map header editing docs, and fix changelog
2019-04-26 23:46:04 +01:00
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
Add map connections editing docs
2019-04-27 19:43:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
add wild encounter documentation
2019-07-03 19:16:14 +01:00
<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
</ul>
</li>
begin region map editor documentation
2019-04-29 23:12:59 +01:00
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
</ul>
</li>
Update GitHub Pages
2019-04-21 17:20:49 +01:00
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
Add map header editing docs, and fix changelog
2019-04-26 23:46:04 +01:00
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
update changelog
2019-08-08 16:55:50 +01:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
add wild encounter documentation
2019-07-03 19:16:14 +01:00
<<<<<<< 92cf37cff99088605032dedf0be919d08d2e2fad
Add map header editing docs, and fix changelog
2019-04-26 23:46:04 +01:00
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
add wild encounter documentation
2019-07-03 19:16:14 +01:00
=======
>>>>>>> add wild encounter documentation
Add map header editing docs, and fix changelog
2019-04-26 23:46:04 +01:00
<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>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
update changelog
2019-08-08 16:55:50 +01:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
add wild encounter documentation
2019-07-03 19:16:14 +01:00
<<<<<<< 92cf37cff99088605032dedf0be919d08d2e2fad
update changelog
2019-08-08 16:55:50 +01:00
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
1.2.2 Release
2019-05-16 23:05:27 +01:00
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
update changelog
2019-08-08 16:55:50 +01:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
1.2.2 Release
2019-05-16 23:05:27 +01:00
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
update changelog
2019-08-08 16:55:50 +01:00
<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>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
update changelog
2019-08-08 16:55:50 +01:00
<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>
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
update changelog
2019-08-08 16:55:50 +01:00
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id17">1.0.0 - 2018-10-26</a></li>
add wild encounter documentation
2019-07-03 19:16:14 +01:00
=======
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id7">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#id8">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
<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">1.0.0 - 2018-10-26</a></li>
>>>>>>> add wild encounter documentation
add changelog and recommonmark req
2019-04-24 15:00:17 +01:00
</ul>
</li>
Update GitHub Pages
2019-04-21 17:20:49 +01:00
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">porymap</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>Introduction</li>
<li class="wy-breadcrumbs-aside">
Add map collision editing documentation
2019-04-25 00:49:08 +01:00
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/introduction.rst" class="fa fa-github"> Edit on GitHub</a>
Update GitHub Pages
2019-04-21 17:20:49 +01:00
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
<div class="section" id="about-porymap">
<h2>About Porymap<a class="headerlink" href="#about-porymap" title="Permalink to this headline"></a></h2>
<p><strong>Porymap is a cross-platform map editor for the Gen 3 pret decompilation projects. Its primary functions are to allow editing map tiles, collision, events, connections, and properties. Porymap provides additional functionality, such as tileset editing and region map editing. Downloadable releases are available for Windows and Mac, and Linux users can build it from source.</strong></p>
<p>Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, except for Wild Pokemon editing, so Advance Map users shouldn’t have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.</p>
<p>Porymap reads and writes files in the decompilation projects. It <strong>does not</strong> read or write ROM files. <strong>Therefore, it is highly recommended to use Git for version control when working with Porymap.</strong></p>
</div>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h2>
<p>Before using Porymap, you must have your decompilation project setup. Porymap currently supports <a class="reference external" href="https://github.com/pret/pokeemerald">pokeemerald</a> and <a class="reference external" href="https://github.com/pret/pokeruby">pokeruby</a>. See their respective <code class="docutils literal notranslate"><span class="pre">INSTALL.md</span></code> files to get setup, and make sure you can successfully compile the ROM.</p>
<p>When launching Porymap for the first time, you will be greeted with the following empty window:</p>
<div class="figure" id="id1">
<img alt="Porymap Empty Window" src="../_images/porymap-empty-window.png" />
<p class="caption"><span class="caption-text">Porymap Empty Window</span></p>
</div>
<p>The first thing we’ll do is open a Gen 3 decompilation project with <em>File -&gt; Open Project…</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+O</span></code>). A folder selection dialog will pop up. Choose the location of your existing decompilation project. After doing so, Porymap will take a few seconds to load the project, and the main window should now be displaying the first map. (In <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>, it’s Petalburg City.)</p>
<div class="figure" id="id2">
<img alt="Porymap Main Window" src="../_images/porymap-loaded-project.png" />
<p class="caption"><span class="caption-text">Porymap Main Window</span></p>
</div>
<p>Now, let’s make our first basic edit using Porymap. We’ll use the Pencil Tool to draw some more flowers on the grass in Petalburg City. First, make sure the Pencil Tool is selected. You can click the Pencil Tool button, press the <code class="docutils literal notranslate"><span class="pre">N</span></code> shortcut, or select <em>Tools -&gt; Pencil</em>. The various painting Tool buttons are found on the left side of the toolbar above the map area.</p>
<div class="figure" id="id3">
<img alt="Tool Buttons" src="../_images/tool-buttons.png" />
<p class="caption"><span class="caption-text">Tool Buttons</span></p>
</div>
<p>Next, select the flower metatile from the Metatile Selection panel by left-clicking on it. The flower is metatile 0x4 in the General tileset.</p>
<div class="figure" id="id4">
<img alt="Metatile Selection Panel" src="../_images/metatile-selection-panel.png" />
<p class="caption"><span class="caption-text">Metatile Selection Panel</span></p>
</div>
<p>Porymap shows the current metatile selection in the Selection panel.</p>
<div class="figure" id="id5">
<img alt="Current Metatile Selection" src="../_images/metatile-current-selection.png" />
<p class="caption"><span class="caption-text">Current Metatile Selection</span></p>
</div>
<p>Place some flowers in Petalburg City by left-clicking to paint on the map area.</p>
<div class="figure" id="id6">
<img alt="Flowery Petalburg City" src="../_images/flowers-painted.png" />
<p class="caption"><span class="caption-text">Flowery Petalburg City</span></p>
</div>
<p>That looks great! Save your changes with <em>File -&gt; Save</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+S</span></code>). Finally, compile the ROM and see the results in-game.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When re-compiling your ROM, it is not recommended to use <code class="docutils literal notranslate"><span class="pre">NODEP=1</span></code>, since that can result in data changes being ignored.</p>
</div>
<div class="figure" id="id7">
<img alt="Petalburg City In-Game Changes" src="../_images/flower-petalburg-ingame.png" />
<p class="caption"><span class="caption-text">Petalburg City In-Game Changes</span></p>
</div>
<p>Now that you have the basic workflow down, it’s time to learn how to navigate the various windows and screens of Porymap.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="navigation.html" class="btn btn-neutral float-right" title="Navigation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../index.html" class="btn btn-neutral float-left" title="Porymap Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>
Reference in a new issue Copy permalink