Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-08-14 04:46:49 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

finish region map editor docs

Browse Source
This commit is contained in:
garak
2019-04-29 20:01:32 -04:00
committed by huderlem
parent 41e17ec69e
commit f805f3af37
15 changed files with 115 additions and 999 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docsrc/manual/images/region-map-editor/rme-layout-swap.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.5 MiB

After

Width:  |  Height:  |  Size: 1.3 MiB

59
docsrc/manual/region-map-editor.rst
View File

@@ -34,9 +34,10 @@ the tile selector on the right. You can single-click or drag your mouse around
to paint the selected tile onto the region map image. If you make a mistake, or
are unhappy with what you have done, you can undo (``Ctrl+Z`` or *Edit -> Undo*)
and redo (``Ctrl+Y`` or *Edit -> Redo*) your changes. Right-clicking on the map
image will select the tile under your mouse from the tile selector. If you want
to clear the background image, *Edit -> Clear Background Image* will set all
tiles to the first tile in the tile selector.
image will select the tile under your mouse from the tile selector.
If you want to clear the background image, *Edit -> Clear Background Image*
will set all tiles to the first tile in the tile selector.
.. figure:: images/region-map-editor/rme-painting-image.gif
:scale: 75%
@@ -48,11 +49,11 @@ tiles to the first tile in the tile selector.
It is likely that you will want to use your own tiles for your region map. You
can import a tile image by navigating to *Tools -> Import Region Map Image Tiles*.
There are strict requirements for your region map tile image. It must (1) be
indexed with a 256 color palette\*, (2) composed of 8x8 pixel tiles, (3) have 256
indexed with a 256 color palette\*, (2) be composed of 8x8 pixel tiles, (3) have 256
or fewer tiles.
\* while the region map tile image requires a 256-color palette, the image only
uses the 32 colors beginning at index 112 in the palette
\* While the region map tile image requires a 256-color palette, the image only
uses the 32 colors beginning at index 112 in the palette.
.. _map-layout-tab:
@@ -60,7 +61,8 @@ Map Layout Tab
--------------
The layout tab is where map sections are placed on the region map. When the
player looks at the region map, the layout determines the map under the cursor.
player looks at the region map in-game, the layout determines the map under the
cursor.
.. figure:: images/region-map-editor/rme-layout-tab.png
:scale: 75%
@@ -71,16 +73,24 @@ player looks at the region map, the layout determines the map under the cursor.
To modify the region map layout, select a position by clicking on the map image
and higlighting a single square. The "Map Section" combobox will be populated
with all of the map sections defined in `include/constants/region_map_sections.h`.
with all of the map sections defined in ``include/constants/region_map_sections.h``.
Select the map section you want to associate with the selected position on the
region map. To change the popup name of the map section when you enter the map,
type it into the "Map Name" box. The popup name is tied to the map section, so
each layout square with the same map section will share a name.
*Edit -> Clear Map Layout*
If you want to start from a blank layout, *Edit -> Clear Map Layout* will set
all layout squares to the value of ``MAPSEC_NONE``.
When you add new region map sections.
*Edit -> Swap*
When adding new region map sections, the layout will be affected. This is
because the layout is stored as a binary file and uses the raw value of each
map section. In order to fix your layout to account for this, you can swap two
values for the entire layout with *Edit -> Swap*.
In this example, ``MAPSEC_NEW_MAPSEC`` is inserted before ``MAPSEC_NONE``, and
therefore the layout will link the original value of ``MAPSEC_NONE`` to the new
map section ``MAPSEC_NEW_MAPSEC``. Instances of ``MAPSEC_NEW_MAPSEC`` are swapped
with ``MAPSEC_NONE``.
.. figure:: images/region-map-editor/rme-layout-swap.gif
:scale: 75%
@@ -89,14 +99,16 @@ When you add new region map sections.
Swapping Map Sections
.
The "Delete Square" button simply resets a single layout square to ``MAPSEC_NONE``.
.. _map-entries-tab:
Map Entries Tab
---------------
The other thing
A region map entry is the area on the region map that spans an entire map section.
This determines, for example, where the player's head appears on the region map
in-game. Entries are stored at ``src/data/region_map/region_map_entries.h``.
.. figure:: images/region-map-editor/rme-entries-tab.png
:scale: 75%
@@ -105,12 +117,17 @@ The other thing
RME Entries Tab
.
To edit an entry, select a map section from the "Map Section" combobox. You can
use the "Location" "x" and "y" spinboxes to change the coordinates of the entry.
You can also drag the entry around the map. The "x" and "y" values correspond to
the position of the entry's top-left square on the region map. The "Dimensions"
"width" and "height" spinboxes will change the size of the map entry.
City Maps
---------
city maps
In the bottom half of the region map editor window, city maps can be edited.
You paint on this the same way you paint on the region map background image.
.. figure:: images/region-map-editor/rme-painting-city.gif
:scale: 60%
@@ -119,14 +136,16 @@ city maps
Drawing on the City Map
*Tools -> Import City Map Image Tiles*
To use custom tiles, there is a tile image importer under
*Tools -> Import City Map Image Tiles*. These images must (1) be indexed with a
16 color palette, (2) be made up of 8x8 pixel tiles, (3) have 256 or fewer tiles.
You can add a new city map by pressing the |new-city-map-button| button.
.. |new-city-map-button|
image:: images/region-map-editor/rme-new-city-map-button.png
Currently, it is not possible to associate a city map to a region map location,
but that functionality will be added in a future update.