Add map header editing docs, and fix changelog

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

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

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

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.

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
--------------

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB