694 lines
No EOL
60 KiB
HTML
694 lines
No EOL
60 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Porymap Settings — porymap documentation</title>
|
||
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Changelog" href="../reference/changelog.html" />
|
||
<link rel="prev" title="Shortcuts" href="shortcuts.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home"> porymap
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#straight-paths">Straight Paths</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo & Redo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#clone-object-events">Clone Object Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||
<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>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#heal-location-healspots">Heal Location / Healspots</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#tool-buttons">Tool Buttons</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#ruler-tool">Ruler Tool</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive & Emerge Warps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#follow-connections">Follow Connections</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><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>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tileset-editor.html">The Tileset Editor</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#custom-scripts-editor">Custom Scripts Editor</a></li>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-header-editing-functions">Map Header Editing Functions</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#overlay-functions">Overlay Functions</a></li>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#constants">Constants</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||
<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>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Porymap Settings</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#global-settings">Global settings</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#project-settings">Project settings</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#general">General</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#maps">Maps</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#tilesets">Tilesets</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#events">Events</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#files-identifiers">Files & Identifiers</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">5.0.0 - 2022-10-30</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#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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id82">1.0.0 - 2018-10-26</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">porymap</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="../index.html">Docs</a> »</li>
|
||
|
||
<li>Porymap Settings</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/settings-and-options.rst" class="fa fa-github"> Edit on GitHub</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="porymap-settings">
|
||
<span id="settings-and-options"></span><h1>Porymap Settings<a class="headerlink" href="#porymap-settings" title="Permalink to this headline">¶</a></h1>
|
||
<p>Porymap uses config files to read and store user and project settings.</p>
|
||
<div class="section" id="global-settings">
|
||
<h2>Global settings<a class="headerlink" href="#global-settings" title="Permalink to this headline">¶</a></h2>
|
||
<p>A global settings file is stored in a platform-dependent location for app configuration files
|
||
(<code class="docutils literal notranslate"><span class="pre">%Appdata%\pret\porymap\porymap.cfg</span></code> on Windows, <code class="docutils literal notranslate"><span class="pre">~/Library/Application\</span> <span class="pre">Support/pret/porymap/porymap.cfg</span></code> on macOS).</p>
|
||
<p>A selection of the settings in this file can be edited under <code class="docutils literal notranslate"><span class="pre">Preferences...</span></code>, and the rest are updated automatically while using Porymap.</p>
|
||
</div>
|
||
<div class="section" id="project-settings">
|
||
<h2>Project settings<a class="headerlink" href="#project-settings" title="Permalink to this headline">¶</a></h2>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><a class="reference internal" href="#general"><span class="std std-ref">General</span></a></li>
|
||
<li><a class="reference internal" href="#maps"><span class="std std-ref">Maps</span></a></li>
|
||
<li><a class="reference internal" href="#tilesets"><span class="std std-ref">Tilesets</span></a></li>
|
||
<li><a class="reference internal" href="#events"><span class="std std-ref">Events</span></a></li>
|
||
<li><a class="reference internal" href="#files-identifiers"><span class="std std-ref">Files & Identifiers</span></a></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<p>A config file for project-specific settings is also created when opening a project in porymap for the first time. It is stored in your project root as <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code>. You may want to force commit this file so that other users will automatically have access to your project settings.</p>
|
||
<p>A second config file is created for user-specific settings. It is stored in your project root as <code class="docutils literal notranslate"><span class="pre">porymap.user.cfg</span></code>. You should add this file to your gitignore.</p>
|
||
<p>The settings in <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> and <code class="docutils literal notranslate"><span class="pre">porymap.user.cfg</span></code> can be edited under <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">-></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>. Any changes made in this window will not take effect unless confirmed by selecting <code class="docutils literal notranslate"><span class="pre">OK</span></code> and then reloading the project.</p>
|
||
<div class="section" id="general">
|
||
<span id="id1"></span><h3>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h3>
|
||
<div class="figure">
|
||
<img alt="General tab" src="../_images/tab-general.png" />
|
||
</div>
|
||
<dl class="docutils">
|
||
<dt>Use Poryscript</dt>
|
||
<dd><p class="first">If this is checked, a <code class="docutils literal notranslate"><span class="pre">scripts.pory</span></code> (and <code class="docutils literal notranslate"><span class="pre">text.pory</span></code>, if applicable) file will be created alongside new maps, instead of a <code class="docutils literal notranslate"><span class="pre">scripts.inc</span></code> file. Additionally, <code class="docutils literal notranslate"><span class="pre">.pory</span></code> files will be considered when searching for scripts labels and when opening scripts files (in addition to the regular <code class="docutils literal notranslate"><span class="pre">.inc</span></code> files).</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code>.</p>
|
||
</dd>
|
||
<dt>Show Wild Encounter Tables</dt>
|
||
<dd><p class="first">If this is checked, the <code class="docutils literal notranslate"><span class="pre">Wild</span> <span class="pre">Pokemon</span></code> tab will be enabled and wild encounter data will be read from the project’s encounters JSON file.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code>. If no encounters JSON file is found this will be automatically unchecked.</p>
|
||
</dd>
|
||
<dt>Prefabs</dt>
|
||
<dd><p class="first"><code class="docutils literal notranslate"><span class="pre">Prefabs</span> <span class="pre">Path</span></code> is the file path to a <code class="docutils literal notranslate"><span class="pre">.json</span></code> file that contains definitions of prefabs. This will be used to populate the <code class="docutils literal notranslate"><span class="pre">Prefabs</span></code> panel on the <code class="docutils literal notranslate"><span class="pre">Map</span></code> tab. If no path is specified prefabs will be saved to a new <code class="docutils literal notranslate"><span class="pre">prefabs.json</span></code> file in the root project folder. A new file can be selected with the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button or by editing the file path.</p>
|
||
<p class="last">The <a class="reference internal" href="../_images/import-defaults.png"><img alt="button-import-defaults" src="../_images/import-defaults.png" style="height: 24px;" /></a> button will populate the specified file with version-specific prefabs constructed using the vanilla tilesets. This will overwrite any existing prefabs.</p>
|
||
</dd>
|
||
<dt>Collision Graphics</dt>
|
||
<dd><p class="first"><code class="docutils literal notranslate"><span class="pre">Image</span> <span class="pre">Path</span></code> is a path to any image file you’d like to use to represent collision and elevation values on the <code class="docutils literal notranslate"><span class="pre">Collision</span></code> tab. A new file can be selected with the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button or by editing the file path. The image will be evenly divided into segments, with each row representing an elevation value (starting with <code class="docutils literal notranslate"><span class="pre">0</span></code> at the top) and each column representing a collision value (starting with <code class="docutils literal notranslate"><span class="pre">0</span></code> on the left).</p>
|
||
<p>Your image does not need to have a row/column for every valid elevation/collision value (for instance, the default collision values range from <code class="docutils literal notranslate"><span class="pre">0-3</span></code>, but because <code class="docutils literal notranslate"><span class="pre">2-3</span></code> are semantically the same as <code class="docutils literal notranslate"><span class="pre">1</span></code> they are not displayed). You can specify the highest elevation and collision value represented on your image with <code class="docutils literal notranslate"><span class="pre">Max</span> <span class="pre">Elevation</span></code> and <code class="docutils literal notranslate"><span class="pre">Max</span> <span class="pre">Collision</span></code>.</p>
|
||
<p>Note: Images with transparency may not function correctly when displayed on the map.</p>
|
||
<p class="last">The filepath defaults empty, which will use <a class="reference external" href="https://github.com/huderlem/porymap/blob/master/resources/images/collisions.png">Porymap’s original image</a>. <code class="docutils literal notranslate"><span class="pre">Max</span> <span class="pre">Elevation</span></code> and <code class="docutils literal notranslate"><span class="pre">Max</span> <span class="pre">Collision</span></code> default to <code class="docutils literal notranslate"><span class="pre">15</span></code> and <code class="docutils literal notranslate"><span class="pre">1</span></code> respectively.</p>
|
||
</dd>
|
||
<dt>Pokémon Icons</dt>
|
||
<dd><p class="first">Porymap can display Pokémon species icons that it reads from your project on the <code class="docutils literal notranslate"><span class="pre">Wild</span> <span class="pre">Pokemon</span></code> tab. If Porymap fails to load your icon image, or if you’d like to display your own icon in Porymap for any reason, you can select a new image with the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button or by editing the file path. You can select a species with the dropdown to edit the path for a different icon.</p>
|
||
<p>If your custom icon or the default icon fails to load a <a class="reference internal" href="../_images/pokemon-icon-placeholder.png"><img alt="pokemon-icon-placeholder" src="../_images/pokemon-icon-placeholder.png" style="width: 24px; height: 24px;" /></a> icon will be displayed.</p>
|
||
<p class="last">Defaults to empty (the path in your project where Porymap expects to find each icon).</p>
|
||
</dd>
|
||
<dt>Base Game Version</dt>
|
||
<dd><p class="first">This is the name of the base pret repository for this project. Changing this setting will prompt you to restore the default project settings for any of the three versions. You can also do this for the currently-selected base game version by selecting <a class="reference internal" href="../_images/restore-defaults.png"><img alt="button-restore-defaults" src="../_images/restore-defaults.png" style="height: 24px;" /></a> at the bottom of the window. Aside from determining the default settings in this window, the base game version also determines the default settings when initializing the region map and when importing default prefabs.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">pokeruby</span></code>, <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, or <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code> depending on the project folder name. If the folder name doesn’t match you will be prompted to select a version on first launch.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="section" id="maps">
|
||
<span id="id2"></span><h3>Maps<a class="headerlink" href="#maps" title="Permalink to this headline">¶</a></h3>
|
||
<div class="figure">
|
||
<img alt="Maps tab" src="../_images/tab-maps.png" />
|
||
</div>
|
||
<dl class="docutils">
|
||
<dt>Map Data Defaults</dt>
|
||
<dd><dl class="first last docutils">
|
||
<dt>Border Metatiles</dt>
|
||
<dd><p class="first">This is list of metatile ID values that will be used to fill the border on new maps. The spin boxes correspond to the top-left, top-right, bottom-left, and bottom-right border metatiles respectively.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">Enable</span> <span class="pre">Custom</span> <span class="pre">Border</span> <span class="pre">Size</span></code> is checked, this will instead be a comma-separated list of metatile ID values that will be used to fill the border on new maps. Values in the list will be read sequentially to fill the new border left-to-right top-to-bottom. If the number of metatiles in the border for a new map is not the same as the number of values in the list then the border will be filled with metatile ID <code class="docutils literal notranslate"><span class="pre">0x000</span></code> instead.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">0x014</span></code>, <code class="docutils literal notranslate"><span class="pre">0x015</span></code>, <code class="docutils literal notranslate"><span class="pre">0x01C</span></code>, <code class="docutils literal notranslate"><span class="pre">0x01D</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">0x1D4</span></code>, <code class="docutils literal notranslate"><span class="pre">0x1D5</span></code>, <code class="docutils literal notranslate"><span class="pre">0x1DC</span></code>, <code class="docutils literal notranslate"><span class="pre">0x1DD</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Metatile ID</dt>
|
||
<dd><p class="first">This is the metatile ID value that will be used to fill new maps.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">0x1</span></code>.</p>
|
||
</dd>
|
||
<dt>Collision</dt>
|
||
<dd><p class="first">This is the collision value that will be used to fill new maps. It will also be used to set the default selection on the Collision tab when the project is first opened.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
|
||
</dd>
|
||
<dt>Elevation</dt>
|
||
<dd><p class="first">This is the elevation value that will be used to fill new maps. It will also be used to set the default selection on the Collision tab when the project is first opened.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||
</dd>
|
||
<dt>Create separate text file</dt>
|
||
<dd><p class="first">If this is checked, a <code class="docutils literal notranslate"><span class="pre">text.inc</span></code> (or <code class="docutils literal notranslate"><span class="pre">text.pory</span></code>) file will be created alongside new maps.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code> and <code class="docutils literal notranslate"><span class="pre">checked</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt>Map Data Layout</dt>
|
||
<dd><p class="first">Each of these three settings are bit masks that will be used to read and write an attribute of the data that makes up each map space (metatile ID, collision, and elevation). A warning will be displayed if any of the masks overlap. Their values may be read from <code class="docutils literal notranslate"><span class="pre">#define</span></code> s in your project, in which case editing will be disabled and you can change their values by modifying them in your project.</p>
|
||
<p class="last">Default to being read from <code class="docutils literal notranslate"><span class="pre">MAPGRID_METATILE_ID_MASK</span></code>, <code class="docutils literal notranslate"><span class="pre">MAPGRID_COLLISION_MASK</span></code>, and <code class="docutils literal notranslate"><span class="pre">MAPGRID_ELEVATION_MASK</span></code>. If they can’t be read, they default to <code class="docutils literal notranslate"><span class="pre">0x3FF</span></code>, <code class="docutils literal notranslate"><span class="pre">0xC00</span></code>, and <code class="docutils literal notranslate"><span class="pre">0xF000</span></code> respectively.</p>
|
||
</dd>
|
||
<dt>Enable ‘Floor Number’</dt>
|
||
<dd><p class="first">If this is checked, a <code class="docutils literal notranslate"><span class="pre">Floor</span> <span class="pre">Number</span></code> option will become available on the <code class="docutils literal notranslate"><span class="pre">Header</span></code> tab and on the new map prompt. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-header.html">Editing Map Headers</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable ‘Allow Running/Biking/Escaping’</dt>
|
||
<dd><p class="first">If this is checked, <code class="docutils literal notranslate"><span class="pre">Allow</span> <span class="pre">Running</span></code>, <code class="docutils literal notranslate"><span class="pre">Allow</span> <span class="pre">Biking</span></code>, and <code class="docutils literal notranslate"><span class="pre">Allow</span> <span class="pre">Dig</span> <span class="pre">&</span> <span class="pre">Escape</span> <span class="pre">Rope</span></code> options will become available on the <code class="docutils literal notranslate"><span class="pre">Header</span></code> tab and on the new map prompt. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-header.html">Editing Map Headers</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokeruby</span></code> and <code class="docutils literal notranslate"><span class="pre">checked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable Custom Border Size</dt>
|
||
<dd><p class="first">If this is checked, <code class="docutils literal notranslate"><span class="pre">Border</span> <span class="pre">Width</span></code> and <code class="docutils literal notranslate"><span class="pre">Border</span> <span class="pre">Height</span></code> options will become available under the <code class="docutils literal notranslate"><span class="pre">Change</span> <span class="pre">Dimensions</span></code> button and on the new map prompt. If it is unchecked all maps will use the default 2x2 dimensions.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="section" id="tilesets">
|
||
<span id="id4"></span><h3>Tilesets<a class="headerlink" href="#tilesets" title="Permalink to this headline">¶</a></h3>
|
||
<div class="figure">
|
||
<img alt="Tilesets tab" src="../_images/tab-tilesets.png" />
|
||
</div>
|
||
<dl class="docutils">
|
||
<dt>Default Primary/Secondary Tilesest</dt>
|
||
<dd><p class="first">These will be the initially-selected tilesets when creating a new map, and will be used if a layout’s tileset fails to load. If a default tileset is not found then the first tileset in the respective list will be used instead.</p>
|
||
<p>The default primary tileset is <code class="docutils literal notranslate"><span class="pre">gTileset_General</span></code>.</p>
|
||
<p class="last">The default secondary tileset is <code class="docutils literal notranslate"><span class="pre">gTileset_PalletTown</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">gTileset_Petalburg</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable Triple Layer Metatiles</dt>
|
||
<dd><p class="first">Metatile data normally consists of 2 layers with 4 tiles each. If this is checked, they should instead consist of 3 layers with 4 tiles each. Additionally, the <code class="docutils literal notranslate"><span class="pre">Layer</span> <span class="pre">Type</span></code> option in the <code class="docutils literal notranslate"><span class="pre">Tileset</span> <span class="pre">Editor</span></code> will be removed. Note that layer type data will still be read and written according to your <code class="docutils literal notranslate"><span class="pre">Layer</span> <span class="pre">Type</span> <span class="pre">mask</span></code> setting.</p>
|
||
<p>For details on supporting this setting in your project, see <a class="reference external" href="https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles">https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code></p>
|
||
</dd>
|
||
<dt>Attributes size</dt>
|
||
<dd><p class="first">The number of bytes used per metatile for metatile attributes. The data in each of your project’s <code class="docutils literal notranslate"><span class="pre">metatile_attributes.bin</span></code> files will be expected to be <code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">*</span> <span class="pre">n</span></code>, where <code class="docutils literal notranslate"><span class="pre">s</span></code> is this size and <code class="docutils literal notranslate"><span class="pre">n</span></code> is the number of metatiles in the tileset. Additionally, new <code class="docutils literal notranslate"><span class="pre">metatile_attributes.bin</span></code> will be included in the project with a corresponding <code class="docutils literal notranslate"><span class="pre">INCBIN_U8</span></code>, <code class="docutils literal notranslate"><span class="pre">INCBIN_U16</span></code>, or <code class="docutils literal notranslate"><span class="pre">INCBIN_U32</span></code> directive.</p>
|
||
<p>Changing this setting will automatically enforce the new limit on the metatile attribute mask settings.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">4</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">2</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Attribute masks</dt>
|
||
<dd><p class="first">Each of these four settings are bit masks that will be used to read and write a specific metatile attribute from the metatile attributes data. If you are instead importing metatile attribute data from AdvanceMap, a default mask value will be used to read the data, and the mask value specified here will be used to write the new file.</p>
|
||
<p>If any of the mask values are set to <code class="docutils literal notranslate"><span class="pre">0x0</span></code>, the corresponding option in the Tileset Editor will be removed. The maximum for all the attribute masks is determined by the Attributes size setting. A warning will be displayed if any of the masks overlap.</p>
|
||
<ul class="last">
|
||
<li><dl class="first docutils">
|
||
<dt>Metatile Behavior mask</dt>
|
||
<dd><p class="first">This is the mask value for the <code class="docutils literal notranslate"><span class="pre">Metatile</span> <span class="pre">Behavior</span></code> metatile attribute.</p>
|
||
<p class="last">Defaults to being read from <code class="docutils literal notranslate"><span class="pre">sMetatileAttrMasks</span></code> or <code class="docutils literal notranslate"><span class="pre">METATILE_ATTR_BEHAVIOR_MASK</span></code>. If these can’t be read, defaults to <code class="docutils literal notranslate"><span class="pre">0x1FF</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">0xFF</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="first docutils">
|
||
<dt>Layer Type mask</dt>
|
||
<dd><p class="first">This is the mask value for the <code class="docutils literal notranslate"><span class="pre">Layer</span> <span class="pre">Type</span></code> metatile attribute. If the value is set to <code class="docutils literal notranslate"><span class="pre">0x0</span></code> the <code class="docutils literal notranslate"><span class="pre">Layer</span> <span class="pre">Type</span></code> option will be disabled in the Tileset Editor, and all metatiles will be treated in the editor as if they had the <code class="docutils literal notranslate"><span class="pre">Normal</span></code> layer type.</p>
|
||
<p class="last">Defaults to being read from <code class="docutils literal notranslate"><span class="pre">sMetatileAttrMasks</span></code> or <code class="docutils literal notranslate"><span class="pre">METATILE_ATTR_LAYER_MASK</span></code>. If these can’t be read, defaults to <code class="docutils literal notranslate"><span class="pre">0x60000000</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">0xF000</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="first docutils">
|
||
<dt>Encounter Type mask</dt>
|
||
<dd><p class="first">This is the mask value for the <code class="docutils literal notranslate"><span class="pre">Encounter</span> <span class="pre">Type</span></code> metatile attribute.</p>
|
||
<p class="last">Defaults to being read from <code class="docutils literal notranslate"><span class="pre">sMetatileAttrMasks</span></code>. If this can’t be read, defaults to <code class="docutils literal notranslate"><span class="pre">0x7000000</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">0x0</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="first docutils">
|
||
<dt>Terrain Type mask</dt>
|
||
<dd><p class="first">This is the mask value for the <code class="docutils literal notranslate"><span class="pre">Terrain</span> <span class="pre">Type</span></code> metatile attribute.</p>
|
||
<p class="last">Defaults to being read from <code class="docutils literal notranslate"><span class="pre">sMetatileAttrMasks</span></code>. If this can’t be read, defaults to <code class="docutils literal notranslate"><span class="pre">0x3E00</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code>, and <code class="docutils literal notranslate"><span class="pre">0x0</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
<dt>Output ‘callback’ and ‘isCompressed’ fields</dt>
|
||
<dd><p class="first">If these are checked, then <code class="docutils literal notranslate"><span class="pre">callback</span></code> and <code class="docutils literal notranslate"><span class="pre">isCompressed</span></code> fields will be output in the C data for new tilesets. Their default values will be <code class="docutils literal notranslate"><span class="pre">NULL</span></code> and <code class="docutils literal notranslate"><span class="pre">TRUE</span></code>, respectively.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for both.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="section" id="events">
|
||
<span id="id5"></span><h3>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h3>
|
||
<div class="figure">
|
||
<img alt="Events tab" src="../_images/tab-events.png" />
|
||
</div>
|
||
<dl class="docutils">
|
||
<dt>Default Icons</dt>
|
||
<dd><p class="first">Each event group is represented by a unique icon on the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of the main editor. Here you can provide filepaths to your own image files to replace these icons, either by selecting the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button or by editing the file path directly.</p>
|
||
<p>Events in the <code class="docutils literal notranslate"><span class="pre">Objects</span></code> group will only use this icon if there are no graphics associated with their <code class="docutils literal notranslate"><span class="pre">Sprite</span></code> field.</p>
|
||
<p class="last">The filepaths default to empty, which will use <a class="reference external" href="https://github.com/huderlem/porymap/blob/master/resources/images/Entities_16x16.png">Porymap’s original icons</a>.</p>
|
||
</dd>
|
||
<dt>Warp Behaviors</dt>
|
||
<dd><p class="first">By default, Warp Events only function as exits if they’re positioned on a metatile whose Metatile Behavior is treated specially in your project’s code. If any Warp Events are positioned on a metatile that doesn’t have one of these behaviors they will display a warning. Here you can disable that warning, or edit the list of behavior names that will silence the warning.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code>, i.e. the warning is enabled. The list of behaviors is initially populated with all the vanilla warp behavior names across pokeemerald, pokefirered, and pokeruby.</p>
|
||
</dd>
|
||
<dt>Enable Clone Objects</dt>
|
||
<dd><p class="first">If this is checked Clone Object Events will be available on the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#clone-object-events">Clone Object Events</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable Secret Bases</dt>
|
||
<dd><p class="first">If this is checked Secret Base Events will be available on the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#secret-base-event">Secret Base Events</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">checked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable Weather Triggers</dt>
|
||
<dd><p class="first">If this is checked Weather Trigger Events will be available on the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">checked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable ‘Quantity’ for Hidden Items</dt>
|
||
<dd><p class="first">If this is checked the <code class="docutils literal notranslate"><span class="pre">Quantity</span></code> property will be available for Hidden Item Events. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#hidden-item-event">Hidden Item Events</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable ‘Requires Itemfinder’ for Hidden Items</dt>
|
||
<dd><p class="first">If this is checked the <code class="docutils literal notranslate"><span class="pre">Requires</span> <span class="pre">Itemfinder</span></code> property will be available for Hidden Item Events. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#hidden-item-event">Hidden Item Events</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
<dt>Enable ‘Repsawn Map/NPC’ for Heal Locations</dt>
|
||
<dd><p class="first">If this is checked the <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map</span></code> and <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">NPC</span></code> properties will be available for Heal Location events. For more information see <a class="reference external" href="https://huderlem.github.io/porymap/manual/editing-map-events.html#heal-location-healspots">Heal Locations</a>.</p>
|
||
<p class="last">Defaults to <code class="docutils literal notranslate"><span class="pre">checked</span></code> for <code class="docutils literal notranslate"><span class="pre">pokefirered</span></code> and <code class="docutils literal notranslate"><span class="pre">unchecked</span></code> for other versions.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="section" id="files-identifiers">
|
||
<span id="id7"></span><h3>Files & Identifiers<a class="headerlink" href="#files-identifiers" title="Permalink to this headline">¶</a></h3>
|
||
<div class="figure">
|
||
<img alt="Files tab" src="../_images/tab-files.png" />
|
||
</div>
|
||
<div class="figure">
|
||
<img alt="Identifiers tab" src="../_images/tab-identifiers.png" />
|
||
</div>
|
||
<p>These two tabs provide a way to override the filepaths and symbol/macro names Porymap expects to find in your project.</p>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">Files</span></code>, each can be overridden by typing a new path or selecting a file/folder with the <a class="reference internal" href="../_images/folder.png"><img alt="button-folder" src="../_images/folder.png" style="width: 24px; height: 24px;" /></a> button. Paths are expected to be relative to the root project folder. If no path is specified, or if the file/folder specified does not exist, then the default path will be used instead.</p>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">Identifiers</span></code>, each can be overridden by typing a new name in the line edit. Overrides with <code class="docutils literal notranslate"><span class="pre">regex</span></code> in the name support the <a class="reference external" href="https://perldoc.perl.org/perlre">regular expression syntax</a> used by Qt.</p>
|
||
<p>For more information on what each of these overrides does, see <a class="reference external" href="https://huderlem.github.io/porymap/manual/project-files.html">Project Files</a>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="shortcuts.html" class="btn btn-neutral float-left" title="Shortcuts" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2023, 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> |