2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01: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] -->
2019-04-21 17:20:49 +01:00
< 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 > Introduction — 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" / >
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 >
2024-01-02 19:55:25 +00:00
< body class = "wy-body-for-nav" >
2019-04-21 17:20:49 +01:00
< div class = "wy-grid-for-nav" >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01: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 = "../index.html" class = "icon icon-home" > porymap
2022-11-03 22:49:03 +00:00
2019-04-21 17:20:49 +01:00
< / a >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01: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" / >
2019-04-21 17:20:49 +01:00
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / 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 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 >
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 >
2020-12-21 01:16:47 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "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 = "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 >
2019-04-25 00:49:08 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-tiles.html#undo-redo" > Undo & Redo< / a > < / li >
2023-01-22 18:02:00 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-tiles.html#prefabs" > Prefabs< / a > < / li >
2019-04-25 00:49:08 +01:00
< / 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 >
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 = "editing-map-events.html" > Editing Map Events< / a > < ul >
2020-12-21 01:16:47 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#adding-deleting-events" > Adding & Deleting Events< / a > < / li >
2020-03-04 17:48:19 +00:00
< 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 >
2023-01-22 18:02:00 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "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 = "editing-map-events.html#warp-events" > Warp Events< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#trigger-events" > Trigger Events< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#weather-trigger-events" > Weather Trigger Events< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#sign-event" > Sign Event< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#hidden-item-event" > Hidden Item Event< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "editing-map-events.html#secret-base-event" > Secret Base Event< / a > < / li >
2020-05-16 02:43:24 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "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 = "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 = "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 = "editing-map-events.html#ruler-tool" > Ruler Tool< / a > < / li >
2019-04-26 00:32:32 +01:00
< / ul >
< / li >
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 >
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 & 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 >
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 >
2020-05-16 02:43:24 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "creating-new-maps.html" > Creating New Maps< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "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 = "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 >
2023-01-22 18:02:00 +00:00
< / 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 >
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 = "scripting-capabilities.html" > Scripting Capabilities< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "scripting-capabilities.html#writing-a-custom-script" > Writing a Custom Script< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "scripting-capabilities.html#registering-script-actions" > Registering Script Actions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "scripting-capabilities.html#scripting-api" > Scripting API< / a > < ul >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "scripting-capabilities.html#callbacks" > Callbacks< / a > < / li >
2020-05-15 01:42:41 +01:00
< 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 >
2023-01-22 18:02:00 +00:00
< li class = "toctree-l4" > < a class = "reference internal" href = "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 = "scripting-capabilities.html#tileset-functions" > Tileset Functions< / a > < / li >
2023-01-22 18:02:00 +00:00
< li class = "toctree-l4" > < a class = "reference internal" href = "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 = "scripting-capabilities.html#settings-functions" > Settings Functions< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "scripting-capabilities.html#utility-functions" > Utility Functions< / a > < / li >
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "scripting-capabilities.html#constants" > Constants< / a > < / li >
2020-05-15 01:42:41 +01:00
< / ul >
< / li >
< / ul >
< / li >
2019-10-01 05:07:49 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "project-files.html" > Project Files< / a > < / li >
2020-12-21 01:16:47 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "shortcuts.html" > Shortcuts< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "shortcuts.html#main-window" > Main Window< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "shortcuts.html#tileset-editor" > Tileset Editor< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "shortcuts.html#region-map-editor" > Region Map Editor< / a > < / li >
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "settings-and-options.html" > Porymap Settings< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#preferences" > Preferences< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#use-poryscript" > Use Poryscript< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#show-wild-encounters" > Show Wild Encounters< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#default-tilesets" > Default Tilesets< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#new-map-defaults" > New Map Defaults< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#border-metatiles" > Border Metatiles< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#fill-metatile" > Fill Metatile< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#elevation" > Elevation< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#create-separate-text-file" > Create separate text file< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#prefabs" > Prefabs< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#prefabs-path" > Prefabs Path< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#base-game-version" > Base game version< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#tilesets-metatiles" > Tilesets / Metatiles< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-triple-layer-metatiles" > Enable Triple Layer Metatiles< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#attribute-size" > Attribute size< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#behavior-mask" > Behavior mask< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#layer-type-mask" > Layer Type mask< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#encounter-type-mask" > Encounter Type mask< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#terrain-type-mask" > Terrain Type mask< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#output-callback-and-iscompressed-fields" > Output < code class = "docutils literal notranslate" > < span class = "pre" > callback< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > isCompressed< / span > < / code > fields< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#project-files" > Project Files< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#events" > Events< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-clone-objects" > Enable Clone Objects< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-secret-bases" > Enable Secret Bases< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-weather-triggers" > Enable Weather Triggers< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-quantity-for-hidden-items" > Enable < code class = "docutils literal notranslate" > < span class = "pre" > Quantity< / span > < / code > for Hidden Items< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-requires-itemfinder-for-hidden-items" > Enable < code class = "docutils literal notranslate" > < span class = "pre" > Requires< / span > < span class = "pre" > Itemfinder< / span > < / code > for Hidden Items< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-repsawn-map-npc-for-heal-locations" > Enable < code class = "docutils literal notranslate" > < span class = "pre" > Repsawn< / span > < span class = "pre" > Map/NPC< / span > < / code > for Heal Locations< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "settings-and-options.html#maps" > Maps< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-floor-number" > Enable < code class = "docutils literal notranslate" > < span class = "pre" > Floor< / span > < span class = "pre" > Number< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-allow-running-biking-escaping" > Enable < code class = "docutils literal notranslate" > < span class = "pre" > Allow< / span > < span class = "pre" > Running/Biking/Escaping< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "settings-and-options.html#enable-custom-border-size" > Enable Custom Border Size< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
2019-04-21 17:20:49 +01:00
< / 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 >
2022-11-03 22:49:03 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../reference/changelog.html" > Changelog< / a > < ul >
2023-02-11 15:49:16 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#unreleased" > Unreleased< / 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 >
2023-03-07 01:01:14 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#changed" > Changed< / a > < / li >
2023-02-11 15:49:16 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#fixed" > Fixed< / a > < / li >
< / ul >
< / li >
2023-03-07 01:01:14 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id1" > 5.1.1 - 2023-02-20< / a > < ul >
2024-01-02 19:55:25 +00: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 >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id4" > Fixed< / a > < / li >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id5" > 5.1.0 - 2023-01-22< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id9" > 5.0.0 - 2022-10-30< / a > < ul >
2023-03-07 01:01:14 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#breaking-changes" > Breaking Changes< / a > < / li >
2024-01-02 19:55:25 +00:00
< 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id13" > 4.5.0 - 2021-12-26< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id17" > 4.4.0 - 2020-12-20< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id21" > 4.3.1 - 2020-07-17< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id25" > 4.3.0 - 2020-06-27< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id26" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id27" > Changed< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id28" > Fixed< / a > < / li >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id29" > 4.2.0 - 2020-06-06< / a > < ul >
< 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id33" > 4.1.0 - 2020-05-18< / a > < ul >
< 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id37" > 4.0.0 - 2020-04-28< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id42" > 3.0.1 - 2020-03-04< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id43" > Fixed< / a > < / li >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id44" > 3.0.0 - 2020-03-04< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id45" > Breaking Changes< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id46" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id47" > Changed< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id48" > Fixed< / a > < / li >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id49" > 2.0.0 - 2019-10-16< / 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 >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id54" > 1.2.2 - 2019-05-16< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id55" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id56" > Changed< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id57" > Fixed< / a > < / li >
2023-01-22 18:02:00 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id58" > 1.2.1 - 2019-02-16< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id59" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id60" > Fixed< / a > < / li >
2022-11-03 22:49:03 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id61" > 1.2.0 - 2019-02-04< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id62" > Breaking Changes< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id63" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id64" > Changed< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id65" > Fixed< / a > < / li >
2023-01-22 18:02:00 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id66" > 1.1.0 - 2018-12-27< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id67" > Breaking Changes< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id68" > Added< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id69" > Changed< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "../reference/changelog.html#id70" > Fixed< / a > < / li >
2023-03-07 01:01:14 +00:00
< / ul >
< / li >
2024-01-02 19:55:25 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../reference/changelog.html#id71" > 1.0.0 - 2018-10-26< / a > < / li >
2022-11-03 22:49:03 +00: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-21 17:20:49 +01:00
< / div >
< / div >
< / nav >
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" >
2019-04-21 17:20:49 +01:00
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../index.html" > porymap< / a >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / nav >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< div class = "wy-nav-content" >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< div class = "rst-content" >
2024-01-02 19:55:25 +00:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
2019-04-21 17:20:49 +01:00
< ul class = "wy-breadcrumbs" >
2024-01-02 19:55:25 +00:00
< li > < a href = "../index.html" > Docs< / a > » < / li >
< li > Introduction< / li >
2019-04-21 17:20:49 +01:00
< li class = "wy-breadcrumbs-aside" >
2024-01-02 19:55:25 +00:00
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 >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / li >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / ul >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01: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 = "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 >
2019-04-21 17:20:49 +01:00
< 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 >
2020-03-04 17:48:19 +00:00
< 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, so Advance Map users shouldn’ < / p >
2019-04-21 17:20:49 +01:00
< 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 >
2024-01-02 19:55:25 +00:00
< / div >
< div class = "section" id = "getting-started" >
< h2 > Getting Started< a class = "headerlink" href = "#getting-started" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-05-16 02:43:24 +01:00
< p > Before using Porymap, you must have your decompilation project setup. Porymap supports the < a class = "reference external" href = "https://github.com/pret/pokeemerald" > pokeemerald< / a > , < a class = "reference external" href = "https://github.com/pret/pokeruby" > pokeruby< / a > , and < a class = "reference external" href = "https://github.com/pret/pokefirered" > pokefirered< / a > decompilation projects. 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 >
2019-04-21 17:20:49 +01:00
< p > When launching Porymap for the first time, you will be greeted with the following empty window:< / p >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id1" >
2019-04-21 17:20:49 +01:00
< img alt = "Porymap Empty Window" src = "../_images/porymap-empty-window.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Porymap Empty Window< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > The first thing we’ < em > File -> 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’ < / p >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id2" >
2019-04-21 17:20:49 +01:00
< img alt = "Porymap Main Window" src = "../_images/porymap-loaded-project.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Porymap Main Window< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > Now, let’ ’ < code class = "docutils literal notranslate" > < span class = "pre" > N< / span > < / code > shortcut, or select < em > Tools -> Pencil< / em > . The various painting Tool buttons are found on the left side of the toolbar above the map area.< / p >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id3" >
2019-04-21 17:20:49 +01:00
< img alt = "Tool Buttons" src = "../_images/tool-buttons.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Tool Buttons< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< 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 >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id4" >
2019-04-21 17:20:49 +01:00
< img alt = "Metatile Selection Panel" src = "../_images/metatile-selection-panel.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Metatile Selection Panel< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > Porymap shows the current metatile selection in the Selection panel.< / p >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id5" >
2019-04-21 17:20:49 +01:00
< img alt = "Current Metatile Selection" src = "../_images/metatile-current-selection.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Current Metatile Selection< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > Place some flowers in Petalburg City by left-clicking to paint on the map area.< / p >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id6" >
2019-04-21 17:20:49 +01:00
< img alt = "Flowery Petalburg City" src = "../_images/flowers-painted.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Flowery Petalburg City< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > That looks great! Save your changes with < em > File -> 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" >
2024-01-02 19:55:25 +00:00
< 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 >
2019-04-21 17:20:49 +01:00
< / div >
2024-01-02 19:55:25 +00:00
< div class = "figure" id = "id7" >
2019-04-21 17:20:49 +01:00
< img alt = "Petalburg City In-Game Changes" src = "../_images/flower-petalburg-ingame.png" / >
2024-01-02 19:55:25 +00:00
< p class = "caption" > < span class = "caption-text" > Petalburg City In-Game Changes< / span > < / p >
< / div >
2019-04-21 17:20:49 +01:00
< p > Now that you have the basic workflow down, it’ < / p >
2024-01-02 19:55:25 +00:00
< / div >
< / div >
2019-04-21 17:20:49 +01:00
< / div >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / div >
2024-01-02 19:55:25 +00:00
< 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 >
2019-04-21 17:20:49 +01:00
< / div >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< hr / >
< div role = "contentinfo" >
2024-01-02 19:55:25 +00:00
< p >
© 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-21 17:20:49 +01:00
2022-11-03 15:33:06 +00:00
< / footer >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / div >
< / div >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / section >
2024-01-02 19:55:25 +00:00
2019-04-21 17:20:49 +01:00
< / div >
2024-01-02 19:55:25 +00:00
< script type = "text/javascript" >
2019-04-21 17:20:49 +01:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2024-01-02 19:55:25 +00:00
< / script >
2019-04-21 17:20:49 +01:00
< / body >
< / html >
