porymap/docs/index.html

608 lines
39 KiB
HTML
Raw Normal View History

2024-01-02 19:55:25 +00:00
<!DOCTYPE html>
2024-01-02 19:55:25 +00:00
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
2024-01-02 19:55:25 +00:00
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2022-11-03 15:33:06 +00:00
<title>Porymap Documentation &mdash; porymap documentation</title>
2024-01-02 19:55:25 +00:00
2023-02-11 15:49:16 +00:00
<link rel="shortcut icon" href="_static/porymap-icon-2.ico"/>
2022-11-03 22:49:03 +00:00
2024-01-02 19:55:25 +00:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
2019-04-21 17:20:49 +01:00
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="manual/introduction.html" />
</head>
2024-01-02 19:55:25 +00:00
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
2024-01-02 19:55:25 +00:00
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
2019-04-24 15:00:17 +01:00
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
2024-01-02 19:55:25 +00:00
2022-11-03 22:49:03 +00:00
2024-01-02 19:55:25 +00:00
<a href="#" class="icon icon-home"> porymap
2022-11-03 22:49:03 +00:00
</a>
2024-01-02 19:55:25 +00:00
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
2024-01-02 19:55:25 +00:00
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
2019-04-19 01:39:57 +01:00
</div>
2024-01-02 19:55:25 +00:00
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">User Manual</span></p>
2019-04-21 17:20:49 +01:00
<ul>
2019-04-24 15:00:17 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#straight-paths">Straight Paths</a></li>
2019-04-24 15:00:17 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
2019-04-24 15:00:17 +01:00
</ul>
</li>
2019-04-26 00:32:32 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
2020-07-17 22:55:31 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
2020-03-04 17:48:19 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
2020-03-04 17:48:19 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
2020-05-16 02:43:24 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
2019-04-26 00:32:32 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
2020-05-16 20:35:42 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#ruler-tool">Ruler Tool</a></li>
2019-04-26 00:32:32 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
2019-04-27 19:43:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
2019-07-03 19:16:14 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-wild-encounters.html">Editing Wild Encounters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
</ul>
</li>
2020-05-16 02:43:24 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
</ul>
</li>
2019-04-29 23:12:59 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
2022-09-10 19:08:48 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#layer-type">Layer Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#encounter-type">Encounter Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#terrain-type">Terrain Type</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#metatile-label">Metatile Label</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/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="manual/tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/tileset-editor.html#other-tools">Other Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
2019-04-29 23:12:59 +01:00
</ul>
</li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
2024-01-02 19:55:25 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#custom-scripts-editor">Custom Scripts Editor</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
2024-01-02 19:55:25 +00:00
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
2022-09-10 19:08:48 +01:00
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
2022-10-30 15:05:55 +00:00
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#overlay-functions">Overlay Functions</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
</ul>
</li>
2024-01-02 19:55:25 +00:00
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#constants">Constants</a></li>
2020-05-15 01:42:41 +01:00
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l1"><a class="reference internal" href="manual/shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
2024-01-02 19:55:25 +00:00
<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/settings-and-options.html#global-settings">Global settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/settings-and-options.html#project-settings">Project settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manual/settings-and-options.html#general">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/settings-and-options.html#maps">Maps</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/settings-and-options.html#tilesets">Tilesets</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/settings-and-options.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="manual/settings-and-options.html#files-identifiers">Files &amp; Identifiers</a></li>
</ul>
</li>
</ul>
</li>
</ul>
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Reference</span></p>
2019-04-21 17:20:49 +01:00
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
2024-01-15 22:26:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">5.4.1 - 2024-03-21</a><ul>
<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">5.4.0 - 2024-02-13</a><ul>
2024-01-02 19:55:25 +00:00
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
2020-05-19 00:04:05 +01:00
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
2024-03-21 19:38:02 +00:00
<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">5.3.0 - 2024-01-15</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">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Fixed</a></li>
2019-04-24 15:00:17 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">5.2.0 - 2024-01-02</a><ul>
<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>
2019-04-24 15:00:17 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id12">5.1.1 - 2023-02-20</a><ul>
<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>
2019-08-08 16:55:50 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">5.1.0 - 2023-01-22</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>
2019-07-03 19:16:14 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">5.0.0 - 2022-10-30</a><ul>
2024-01-15 22:26:47 +00:00
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
2024-03-21 19:38:02 +00:00
<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>
2020-03-04 17:48:19 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id24">4.5.0 - 2021-12-26</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>
2020-05-15 01:42:41 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">4.4.0 - 2020-12-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>
2020-03-04 17:48:19 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">4.3.1 - 2020-07-17</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>
2020-06-06 17:57:53 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id36">4.3.0 - 2020-06-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id37">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id38">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id39">Fixed</a></li>
2020-06-27 23:28:36 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id40">4.2.0 - 2020-06-06</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id41">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id42">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id43">Fixed</a></li>
2019-07-03 19:16:14 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id44">4.1.0 - 2020-05-18</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id45">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id46">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id47">Fixed</a></li>
2020-05-15 01:42:41 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id48">4.0.0 - 2020-04-28</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id49">Breaking Changes</a></li>
<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>
2021-12-26 18:40:26 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id53">3.0.1 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id54">Fixed</a></li>
2020-07-17 22:55:31 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">3.0.0 - 2020-03-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id56">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id57">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id58">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id59">Fixed</a></li>
2023-01-22 18:02:00 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id60">2.0.0 - 2019-10-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id61">Breaking Changes</a></li>
<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>
2020-12-21 01:16:47 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id65">1.2.2 - 2019-05-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id66">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id67">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id68">Fixed</a></li>
2023-03-06 01:13:11 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id69">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id70">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id71">Fixed</a></li>
2022-09-10 19:08:48 +01:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id72">1.2.0 - 2019-02-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>
2023-02-11 15:49:16 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id77">1.1.0 - 2018-12-27</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>
2024-01-15 22:26:47 +00:00
</ul>
</li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id82">1.0.0 - 2018-10-26</a></li>
2019-04-24 15:00:17 +01:00
</ul>
</li>
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>
2024-01-02 19:55:25 +00:00
2019-04-19 01:39:57 +01:00
</div>
</div>
</nav>
2019-04-19 01:39:57 +01:00
2024-01-02 19:55:25 +00:00
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">porymap</a>
2024-01-02 19:55:25 +00:00
</nav>
2024-01-02 19:55:25 +00:00
<div class="wy-nav-content">
2024-01-02 19:55:25 +00:00
<div class="rst-content">
2024-01-02 19:55:25 +00:00
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
2024-01-02 19:55:25 +00:00
<li><a href="#">Docs</a> &raquo;</li>
<li>Porymap Documentation</li>
<li class="wy-breadcrumbs-aside">
2024-01-02 19:55:25 +00:00
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/index.rst" class="fa fa-github"> Edit on GitHub</a>
2024-01-02 19:55:25 +00:00
</li>
2024-01-02 19:55:25 +00:00
</ul>
2024-01-02 19:55:25 +00:00
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
2024-01-02 19:55:25 +00:00
<div class="section" id="porymap-documentation">
<h1>Porymap Documentation<a class="headerlink" href="#porymap-documentation" title="Permalink to this headline"></a></h1>
2019-04-21 17:20:49 +01:00
<div class="admonition note">
2024-01-02 19:55:25 +00:00
<p class="first admonition-title">Note</p>
<p class="last">If you cant find what youre looking for, or you feel something is missing, please reach out on GitHub: <a class="reference external" href="https://github.com/huderlem/porymap">https://github.com/huderlem/porymap</a></p>
2019-04-19 01:39:57 +01:00
</div>
2019-04-21 17:20:49 +01:00
<div class="toctree-wrapper compound">
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">User Manual</span></p>
2019-04-21 17:20:49 +01:00
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
2019-04-22 02:07:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
2019-04-24 00:41:17 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#straight-paths">Straight Paths</a></li>
2019-04-24 00:41:17 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#prefabs">Prefabs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-collisions.html">Editing Map Collisions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
2019-04-24 00:41:17 +01:00
</ul>
</li>
2019-04-26 00:32:32 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
2020-07-17 22:55:31 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
2020-03-04 17:48:19 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
2022-09-10 19:08:48 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#clone-object-events">Clone Object Events</a></li>
2020-03-04 17:48:19 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
2020-05-16 02:43:24 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
2019-04-26 00:32:32 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
2020-05-16 20:35:42 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#tool-buttons">Tool Buttons</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#ruler-tool">Ruler Tool</a></li>
2019-04-26 00:32:32 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
2019-04-27 19:43:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-connections.html">Editing Map Connections</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#dive-emerge-warps">Dive &amp; Emerge Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-connections.html#follow-connections">Follow Connections</a></li>
</ul>
</li>
2019-07-03 19:16:14 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/editing-wild-encounters.html">Editing Wild Encounters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
</ul>
</li>
2020-05-16 02:43:24 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/creating-new-maps.html">Creating New Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/creating-new-maps.html#new-map-options">New Map Options</a></li>
</ul>
</li>
2019-04-29 23:12:59 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/region-map-editor.html">The Region Map Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#background-image-tab">Background Image Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
2022-09-10 19:08:48 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/tileset-editor.html">The Tileset Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#metatile-properties">Metatile Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#tools-menu">Tools Menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/tileset-editor.html#palette-editor">Palette Editor</a></li>
2019-04-29 23:12:59 +01:00
</ul>
</li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
2024-01-02 19:55:25 +00:00
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#custom-scripts-editor">Custom Scripts Editor</a></li>
2020-05-15 01:42:41 +01:00
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
2020-12-21 01:16:47 +00:00
<li class="toctree-l1"><a class="reference internal" href="manual/shortcuts.html">Shortcuts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/shortcuts.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
2024-01-02 19:55:25 +00:00
<li class="toctree-l1"><a class="reference internal" href="manual/settings-and-options.html">Porymap Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/settings-and-options.html#global-settings">Global settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/settings-and-options.html#project-settings">Project settings</a></li>
</ul>
</li>
2019-04-21 17:20:49 +01:00
</ul>
2019-04-19 01:39:57 +01:00
</div>
2019-04-21 17:20:49 +01:00
<div class="toctree-wrapper compound">
2024-01-02 19:55:25 +00:00
<p class="caption"><span class="caption-text">Reference</span></p>
2019-04-21 17:20:49 +01:00
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
2019-08-08 16:55:50 +01:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
2024-03-21 19:38:02 +00:00
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">5.4.1 - 2024-03-21</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">5.4.0 - 2024-02-13</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">5.3.0 - 2024-01-15</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">5.2.0 - 2024-01-02</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id12">5.1.1 - 2023-02-20</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">5.1.0 - 2023-01-22</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">5.0.0 - 2022-10-30</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id24">4.5.0 - 2021-12-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">4.4.0 - 2020-12-20</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id32">4.3.1 - 2020-07-17</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id36">4.3.0 - 2020-06-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id40">4.2.0 - 2020-06-06</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id44">4.1.0 - 2020-05-18</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id48">4.0.0 - 2020-04-28</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id53">3.0.1 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id55">3.0.0 - 2020-03-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id60">2.0.0 - 2019-10-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id65">1.2.2 - 2019-05-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id69">1.2.1 - 2019-02-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id72">1.2.0 - 2019-02-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id77">1.1.0 - 2018-12-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id82">1.0.0 - 2018-10-26</a></li>
2019-04-24 15:00:17 +01:00
</ul>
</li>
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>
2019-04-21 17:20:49 +01:00
</div>
2024-01-02 19:55:25 +00:00
</div>
2019-04-19 01:39:57 +01:00
</div>
2024-01-02 19:55:25 +00:00
</div>
2024-01-02 19:55:25 +00:00
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="manual/introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
2019-04-21 17:20:49 +01:00
</div>
2024-01-02 19:55:25 +00:00
2019-04-19 01:39:57 +01:00
<hr/>
2019-04-19 01:39:57 +01:00
<div role="contentinfo">
2024-01-02 19:55:25 +00:00
<p>
&copy; Copyright 2023, huderlem
2023-02-11 15:49:16 +00:00
2024-01-02 19:55:25 +00:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
2019-04-19 01:39:57 +01:00
2022-11-03 15:33:06 +00:00
</footer>
2024-01-02 19:55:25 +00:00
2019-04-19 01:39:57 +01:00
</div>
</div>
2024-01-02 19:55:25 +00:00
</section>
2024-01-02 19:55:25 +00:00
</div>
2024-01-02 19:55:25 +00:00
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2024-01-02 19:55:25 +00:00
</script>
</body>
2019-04-19 01:39:57 +01:00
</html>