atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add map header editing docs, and fix changelog

Browse source
This commit is contained in:
Marcus Huderle 2019-04-26 17:46:04 -05:00
parent 276f0a3827
commit e1e44dab81
22 changed files with 605 additions and 189 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_images/map-header.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

3
docs/_sources/index.rst.txt
View file

@ -13,10 +13,11 @@ Porymap Documentation
manual/editing-map-tiles
manual/editing-map-collisions
manual/editing-map-events
manual/editing-map-header
.. toctree::
:maxdepth: 2
:caption: Reference
reference/CHANGELOG
reference/changelog
reference/related-projects

43
docs/_sources/manual/editing-map-header.rst.txt Normal file
View file

@ -0,0 +1,43 @@
*******************
Editing Map Headers
*******************
The map header is a collection of miscellaneous properties that belong to a map. They are mostly self-explanatory, but we'll go over each of them.
.. figure:: images/editing-map-header/map-header.png
:alt: Map Header View
Map Header View
Song
The background music that is automatically played when entering the map.
Location
The region map section to which the map belongs.
Requires Flash
Whether or not the map has limited vision which the HM move Flash can expand.
Weather
The weather that is running when entering the map.
Type
The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is ``MAP_TYPE_INDOOR``.
Battle Scene
Controls what graphics are used in battles.
Show Location Name
Shows or hides the map name popup window when entering the map.
Allow Running
Controls whether or not running shoes can be used.
Allow Biking
Controls whether or not a bike can be used.
Allow Dig & Escape Rop
Controls whether the Dig field move or the Escape Rope item can be used.
Custom Fields
You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.

2
docs/_sources/manual/editing-map-tiles.rst.txt
View file

@ -99,6 +99,8 @@ The Bucket Fill Tool |bucket-fill-tool| (*Tools -> Bucket Fill*, or ``B``) works
.. |bucket-fill-tool|
image:: images/editing-map-tiles/bucket-fill-tool.png
Holding down the ``Ctrl`` key while using the Bucket Fill Tool will fill *all* matching metatiles on the map, rather that just the contiguous region.
Map Shift Tool
--------------

39
docs/genindex.html
View file

@ -126,36 +126,37 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">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>

52
docs/index.html
View file

@ -126,36 +126,37 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">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>
@ -278,17 +279,18 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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">1.2.1 - 2019-02-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id8">1.1.0 - 2018-12-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<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">1.2.1 - 2019-02-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">1.2.0 - 2019-02-04</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.1.0 - 2018-12-27</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">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>

39
docs/manual/editing-map-collisions.html
View file

@ -127,36 +127,37 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>

43
docs/manual/editing-map-events.html
View file

@ -36,7 +36,7 @@
<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="next" title="Editing Map Headers" href="editing-map-header.html" />
<link rel="prev" title="Editing Map Collisions" href="editing-map-collisions.html" />
</head>
@ -127,36 +127,37 @@
<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>
@ -391,7 +392,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../reference/CHANGELOG.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-header.html" class="btn btn-neutral float-right" title="Editing Map Headers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-collisions.html" class="btn btn-neutral float-left" title="Editing Map Collisions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

312
docs/manual/editing-map-header.html Normal file
View file

@ -0,0 +1,312 @@
<!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>Editing Map Headers &mdash; porymap documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Changelog" href="../reference/changelog.html" />
<link rel="prev" title="Editing Map Events" href="editing-map-events.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
<a href="../index.html" class="icon icon-home"> porymap
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">User Manual</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo &amp; Redo</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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> &raquo;</li>
<li>Editing Map Headers</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/editing-map-header.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="editing-map-headers">
<h1>Editing Map Headers<a class="headerlink" href="#editing-map-headers" title="Permalink to this headline"></a></h1>
<p>The map header is a collection of miscellaneous properties that belong to a map. They are mostly self-explanatory, but we’ll go over each of them.</p>
<div class="figure" id="id1">
<img alt="Map Header View" src="../_images/map-header.png" />
<p class="caption"><span class="caption-text">Map Header View</span></p>
</div>
<dl class="docutils">
<dt>Song</dt>
<dd>The background music that is automatically played when entering the map.</dd>
<dt>Location</dt>
<dd>The region map section to which the map belongs.</dd>
<dt>Requires Flash</dt>
<dd>Whether or not the map has limited vision which the HM move Flash can expand.</dd>
<dt>Weather</dt>
<dd>The weather that is running when entering the map.</dd>
<dt>Type</dt>
<dd>The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is <code class="docutils literal notranslate"><span class="pre">MAP_TYPE_INDOOR</span></code>.</dd>
<dt>Battle Scene</dt>
<dd>Controls what graphics are used in battles.</dd>
<dt>Show Location Name</dt>
<dd>Shows or hides the map name popup window when entering the map.</dd>
<dt>Allow Running</dt>
<dd>Controls whether or not running shoes can be used.</dd>
<dt>Allow Biking</dt>
<dd>Controls whether or not a bike can be used.</dd>
<dt>Allow Dig &amp; Escape Rop</dt>
<dd>Controls whether the Dig field move or the Escape Rope item can be used.</dd>
<dt>Custom Fields</dt>
<dd>You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.</dd>
</dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="editing-map-events.html" class="btn btn-neutral float-left" title="Editing Map Events" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, huderlem
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

40
docs/manual/editing-map-tiles.html
View file

@ -127,36 +127,37 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>
@ -289,6 +290,7 @@
<img alt="Painting with Bucket Fill Tool" src="../_images/bucket-fill-painting.gif" />
<p class="caption"><span class="caption-text">Painting with Bucket Fill Tool</span></p>
</div>
<p>Holding down the <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> key while using the Bucket Fill Tool will fill <em>all</em> matching metatiles on the map, rather that just the contiguous region.</p>
</div>
<div class="section" id="map-shift-tool">
<h2>Map Shift Tool<a class="headerlink" href="#map-shift-tool" title="Permalink to this headline"></a></h2>

39
docs/manual/introduction.html
View file

@ -127,36 +127,37 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>

39
docs/manual/navigation.html
View file

@ -127,36 +127,37 @@
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">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>

BIN
docs/objects.inv
View file

Binary file not shown.

7
docs/reference/changelog.html
View file

@ -37,7 +37,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Related Projects" href="related-projects.html" />
<link rel="prev" title="Editing Map Events" href="../manual/editing-map-events.html" />
<link rel="prev" title="Editing Map Headers" href="../manual/editing-map-header.html" />
</head>
<body class="wy-body-for-nav">
@ -127,6 +127,7 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul class="current">
@ -212,7 +213,7 @@
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/reference/CHANGELOG.md" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/reference/changelog.md" class="fa fa-github"> Edit on GitHub</a>
@ -377,7 +378,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
<a href="related-projects.html" class="btn btn-neutral float-right" title="Related Projects" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../manual/editing-map-events.html" class="btn btn-neutral float-left" title="Editing Map Events" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../manual/editing-map-header.html" class="btn btn-neutral float-left" title="Editing Map Headers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>

43
docs/reference/related-projects.html
View file

@ -36,7 +36,7 @@
<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="prev" title="Changelog" href="CHANGELOG.html" />
<link rel="prev" title="Changelog" href="changelog.html" />
</head>
<body class="wy-body-for-nav">
@ -126,36 +126,37 @@
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id5">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id6">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id7">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id9">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="CHANGELOG.html#id12">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.0.0 - 2018-10-26</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Related Projects</a></li>
@ -238,7 +239,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="CHANGELOG.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="changelog.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>

39
docs/search.html
View file

@ -126,36 +126,37 @@
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-header.html">Editing Map Headers</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#fixed">Fixed</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id3">Fixed</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#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">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">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>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

4
docsrc/Makefile
View file

@ -12,12 +12,12 @@ help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
github:
@cp ../CHANGELOG.md reference/
@cp ../CHANGELOG.md reference/changelog.md
@make html
rm -rf ../docs
@cp -a $(BUILDDIR)/html/. ../docs
touch ../docs/.nojekyll
@rm reference/CHANGELOG.md
@rm reference/changelog.md
.PHONY: help Makefile

3
docsrc/index.rst
View file

@ -13,10 +13,11 @@ Porymap Documentation
manual/editing-map-tiles
manual/editing-map-collisions
manual/editing-map-events
manual/editing-map-header
.. toctree::
:maxdepth: 2
:caption: Reference
reference/CHANGELOG
reference/changelog
reference/related-projects

43
docsrc/manual/editing-map-header.rst Normal file
View file

@ -0,0 +1,43 @@
*******************
Editing Map Headers
*******************
The map header is a collection of miscellaneous properties that belong to a map. They are mostly self-explanatory, but we'll go over each of them.
.. figure:: images/editing-map-header/map-header.png
:alt: Map Header View
Map Header View
Song
The background music that is automatically played when entering the map.
Location
The region map section to which the map belongs.
Requires Flash
Whether or not the map has limited vision which the HM move Flash can expand.
Weather
The weather that is running when entering the map.
Type
The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is ``MAP_TYPE_INDOOR``.
Battle Scene
Controls what graphics are used in battles.
Show Location Name
Shows or hides the map name popup window when entering the map.
Allow Running
Controls whether or not running shoes can be used.
Allow Biking
Controls whether or not a bike can be used.
Allow Dig & Escape Rop
Controls whether the Dig field move or the Escape Rope item can be used.
Custom Fields
You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.

2
docsrc/manual/editing-map-tiles.rst
View file

@ -99,6 +99,8 @@ The Bucket Fill Tool |bucket-fill-tool| (*Tools -> Bucket Fill*, or ``B``) works
.. |bucket-fill-tool|
image:: images/editing-map-tiles/bucket-fill-tool.png
Holding down the ``Ctrl`` key while using the Bucket Fill Tool will fill *all* matching metatiles on the map, rather that just the contiguous region.
Map Shift Tool
--------------

BIN
docsrc/manual/images/editing-map-header/map-header.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB