diff --git a/docs/CHANGELOG.html b/docs/CHANGELOG.html new file mode 100644 index 00000000..194c2ca5 --- /dev/null +++ b/docs/CHANGELOG.html @@ -0,0 +1,358 @@ + + + + + + + + + + + Changelog — porymap documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Changelog

+

All notable changes to this project will be documented in this file.

+

The format is based on Keep a Changelog, +and this project somewhat adheres to Semantic Versioning. The MINOR version number is bumped when there are breaking changes in the pret projects.

+

The “Breaking Changes” listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.

+
+

Unreleased

+
+

Added

+
    +
  • Add region map editor
    • +
  • Add ability to add new tilesets
    • +
+
+
+

Changed

+
    +
  • Event sprites now display as facing the direction of their movement type.
    • +
  • Default values for newly-created events now use valid values from the project, rather than hardcoded values.
    • +
  • Deleting events will stay in the same events tab for easier bulk deletions.
    • +
  • Double-clicking on a secret base event will open the corresponding secret base map.
    • +
+
+
+

Fixed

+
    +
  • Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.
    • +
  • Fix bug where edited map icons were not rendered properly.
    • +
  • Fix bug where right-click copying a tile from the tileset editor’s metatile layers wouldn’t copy the x/y flip status.
    • +
+
+
+
+

1.2.1 - 2019-02-16

+
+

Added

+
    +
  • Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.
    • +
+
+
+

Fixed

+
    +
  • Fix crash when creating a new map from a layout that has no pre-existing maps that use it.
    • +
  • Fix bug where var_value, trainer_type and trainer_sight_or_berry_tree_id JSON fields were being interpreted as integers.
    • +
+
+
+
+

1.2.0 - 2019-02-04

+
+

Breaking Changes

+ +
+
+

Added

+
    +
  • Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.
    • +
  • Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).
    • +
  • Add ability to export tileset tiles as indexed .png images. The currently-selected palette is used.
    • +
  • Restore window sizes the next time the application is opened.
    • +
  • Add ability to import metatiles from Advance Map 1.92 (.bvd files).
    • +
  • Add About window that contains porymap information and changelog. (Found in file menu Help > About Porymap)
    • +
  • Add option to show player’s in-game view when hovering the mouse on the map.
    • +
  • Add option to show an outline around the currently-hovered map tile. Its size depends on the size of the current metatile selection.
    • +
  • Add ability to define custom fields for map header and all events.
    • +
+
+
+

Changed

+
    +
  • Collapse the map list by default.
    • +
  • Collision view now has a transparency slider to help make it easier to view the underlying metatiles.
    • +
  • When importing tileset tiles from an image that is not indexed, the user can also provide a palette for the image. This is for the scenario where the user exports tiles and a palette from Advance Map.
    • +
  • When creating a new map, the user specifies all of the map properties in a new window prompt.
    • +
  • New maps can be created using existing layouts by right-clicking on an existing layout folder in the map list panel when sorted by “Layout”.
    • +
  • The map list panel now has “expand-all” and “collapse-all” buttons.
    • +
  • Events without sprites are now partially transparent so the underlying metatile can be seen. (Warps, signs, etc.)
    • +
  • Changed the Trainer checkbox to a combobox, since there are actually 3 valid values for the trainer type.
    • +
  • Multiline comments are now respected when parsing C defines.
    • +
  • The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.
    • +
+
+
+

Fixed

+
    +
  • Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.
    • +
  • Fix crash that could occur when changing the palette id in the tileset palette editor.
    • +
  • Fix crash that could occur when shrinking the number of metatiles in a tileset.
    • +
  • Fix bug where exported tile images from Advance Map were not handled correctly due to Advance Map using incorrect file extensions.
    • +
+
+
+
+

1.1.0 - 2018-12-27

+
+

Breaking Changes

+ +
+
+

Added

+
    +
  • Add porymap.project.cfg config file to project repos, in order to house project-specific settings, such as base_game_version=pokeemerald.
    • +
  • Write all logs to porymap.log file, so users can view any errors that porymap hits.
    • +
  • Changelog
    • +
+
+
+

Changed

+
    +
  • Add porymap.cfg base config file, rather than using built-in system settings (e.g. registry on Windows).
    • +
  • Properly read/write map headers for pokeemerald.
    • +
  • Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.
    • +
+
+
+

Fixed

+
    +
  • Creating new hidden-item events now uses a valid default flag value.
    • +
  • Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.
    • +
  • Fix bug where porymap crashes on startup due to missing map headers.
    • +
  • Fix tileset editor crash that only happened on macOS.
    • +
  • Fix minor bug when parsing C defines.
    • +
  • Write MAP_GROUPS_COUNT define to maps.h.
    • +
  • Fix bug where opening multiple projects and saving would cause junk to be written to layouts_table.inc.
    • +
  • Fix porymap icon on macOS.
    • +
+
+
+
+

1.0.0 - 2018-10-26

+

This was the initial release.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/README.html b/docs/README.html index 60b381ed..0b617c16 100644 --- a/docs/README.html +++ b/docs/README.html @@ -103,13 +103,47 @@
  • Smart Paths
  • Change Map Border
  • Change Map Tilesets
    • -
  • Undo & Redo
  • Editing Map Events
    • +
  • Editing Map Tiles +

    • Reference

    diff --git a/docs/_images/rme-entries-tab.png b/docs/_images/rme-entries-tab.png new file mode 100644 index 00000000..c4892954 Binary files /dev/null and b/docs/_images/rme-entries-tab.png differ diff --git a/docs/_images/rme-layout-swap.gif b/docs/_images/rme-layout-swap.gif new file mode 100644 index 00000000..ea349e04 Binary files /dev/null and b/docs/_images/rme-layout-swap.gif differ diff --git a/docs/_images/rme-layout-tab.png b/docs/_images/rme-layout-tab.png new file mode 100644 index 00000000..1ecd17f8 Binary files /dev/null and b/docs/_images/rme-layout-tab.png differ diff --git a/docs/_images/rme-new-city-map-button.png b/docs/_images/rme-new-city-map-button.png new file mode 100644 index 00000000..f2d124c9 Binary files /dev/null and b/docs/_images/rme-new-city-map-button.png differ diff --git a/docs/_images/rme-new-window.png b/docs/_images/rme-new-window.png new file mode 100644 index 00000000..da4deb7f Binary files /dev/null and b/docs/_images/rme-new-window.png differ diff --git a/docs/_images/rme-painting-city.gif b/docs/_images/rme-painting-city.gif new file mode 100644 index 00000000..51270024 Binary files /dev/null and b/docs/_images/rme-painting-city.gif differ diff --git a/docs/_images/rme-painting-image.gif b/docs/_images/rme-painting-image.gif new file mode 100644 index 00000000..2ae6b005 Binary files /dev/null and b/docs/_images/rme-painting-image.gif differ diff --git a/docs/_sources/CHANGELOG.md.txt b/docs/_sources/CHANGELOG.md.txt new file mode 100644 index 00000000..57d64119 --- /dev/null +++ b/docs/_sources/CHANGELOG.md.txt @@ -0,0 +1,98 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MINOR version number is bumped when there are breaking changes in the pret projects. + +The **"Breaking Changes"** listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. + +## [Unreleased] +### Added +- Add region map editor +- Add ability to add new tilesets + +### Changed +- Event sprites now display as facing the direction of their movement type. +- Default values for newly-created events now use valid values from the project, rather than hardcoded values. +- Deleting events will stay in the same events tab for easier bulk deletions. +- Double-clicking on a secret base event will open the corresponding secret base map. + +### Fixed +- Fix bug in zoomed metatile selector where a large selection rectangle was being rendered. +- Fix bug where edited map icons were not rendered properly. +- Fix bug where right-click copying a tile from the tileset editor's metatile layers wouldn't copy the x/y flip status. + + +## [1.2.1] - 2019-02-16 +### Added +- Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window. + +### Fixed +- Fix crash when creating a new map from a layout that has no pre-existing maps that use it. +- Fix bug where `var_value`, `trainer_type` and `trainer_sight_or_berry_tree_id` JSON fields were being interpreted as integers. + +## [1.2.0] - 2019-02-04 +### Breaking Changes +- New JSON map data format in pokeemerald and pokeruby from commits [82abc164dc9f6a74fdf0c535cc1621b7ed05318b](https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b) and [a0ba1b7c6353f7e4f3066025514c05b323a0123d](https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d). + +### Added +- Add "magic fill" mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region. +- Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act). +- Add ability to export tileset tiles as indexed .png images. The currently-selected palette is used. +- Restore window sizes the next time the application is opened. +- Add ability to import metatiles from Advance Map 1.92 (.bvd files). +- Add About window that contains porymap information and changelog. (Found in file menu `Help > About Porymap`) +- Add option to show player's in-game view when hovering the mouse on the map. +- Add option to show an outline around the currently-hovered map tile. Its size depends on the size of the current metatile selection. +- Add ability to define custom fields for map header and all events. + +### Changed +- Collapse the map list by default. +- Collision view now has a transparency slider to help make it easier to view the underlying metatiles. +- When importing tileset tiles from an image that is not indexed, the user can also provide a palette for the image. This is for the scenario where the user exports tiles and a palette from Advance Map. +- When creating a new map, the user specifies all of the map properties in a new window prompt. +- New maps can be created using existing layouts by right-clicking on an existing layout folder in the map list panel when sorted by "Layout". +- The map list panel now has "expand-all" and "collapse-all" buttons. +- Events without sprites are now partially transparent so the underlying metatile can be seen. (Warps, signs, etc.) +- Changed the Trainer checkbox to a combobox, since there are actually 3 valid values for the trainer type. +- Multiline comments are now respected when parsing C defines. +- The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though. + +### Fixed +- Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled. +- Fix crash that could occur when changing the palette id in the tileset palette editor. +- Fix crash that could occur when shrinking the number of metatiles in a tileset. +- Fix bug where exported tile images from Advance Map were not handled correctly due to Advance Map using incorrect file extensions. + +## [1.1.0] - 2018-12-27 +### Breaking Changes +- New map header format in pokeemerald from commit [a1ea3b5e394bc115ba9b86348c161094a00dcca7](https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7). + +### Added +- Add `porymap.project.cfg` config file to project repos, in order to house project-specific settings, such as `base_game_version=pokeemerald`. +- Write all logs to `porymap.log` file, so users can view any errors that porymap hits. +- Changelog + +### Changed +- Add `porymap.cfg` base config file, rather than using built-in system settings (e.g. registry on Windows). +- Properly read/write map headers for `pokeemerald`. +- Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window. + +### Fixed +- Creating new hidden-item events now uses a valid default flag value. +- Fix bug where tilesets were sometimes not displaying their bottom row of metatiles. +- Fix bug where porymap crashes on startup due to missing map headers. +- Fix tileset editor crash that only happened on macOS. +- Fix minor bug when parsing C defines. +- Write `MAP_GROUPS_COUNT` define to `maps.h`. +- Fix bug where opening multiple projects and saving would cause junk to be written to `layouts_table.inc`. +- Fix porymap icon on macOS. + +## [1.0.0] - 2018-10-26 +This was the initial release. + +[Unreleased]: https://github.com/huderlem/porymap/compare/1.2.1...HEAD +[1.2.1]: https://github.com/huderlem/porymap/compare/1.2.0...1.2.1 +[1.2.0]: https://github.com/huderlem/porymap/compare/1.1.0...1.2.0 +[1.1.0]: https://github.com/huderlem/porymap/compare/1.0.0...1.1.0 +[1.0.0]: https://github.com/huderlem/porymap/tree/1.0.0 diff --git a/docs/_sources/changelog.rst.txt b/docs/_sources/changelog.rst.txt new file mode 100644 index 00000000..60e50e26 --- /dev/null +++ b/docs/_sources/changelog.rst.txt @@ -0,0 +1,5 @@ +********* +CHANGELOG +********* + + CHANGELOG.md \ No newline at end of file diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 0f5b0f94..61894afd 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -15,6 +15,7 @@ Porymap Documentation manual/editing-map-events manual/editing-map-header manual/editing-map-connections + manual/region-map-editor .. toctree:: :maxdepth: 2 diff --git a/docs/_sources/manual/editing-map-tiles.rst.txt b/docs/_sources/manual/editing-map-tiles.rst.txt index 01a2eb85..3aeb2117 100644 --- a/docs/_sources/manual/editing-map-tiles.rst.txt +++ b/docs/_sources/manual/editing-map-tiles.rst.txt @@ -152,7 +152,7 @@ Every map uses exactly two Tilesets--primary and secondary. These can be change .. figure:: images/editing-map-tiles/tileset-pickers.png :alt: Tileset Pickers - Tileset Pickerss + Tileset Pickers Undo & Redo ----------- diff --git a/docs/_sources/manual/region-map-editor.rst.txt b/docs/_sources/manual/region-map-editor.rst.txt new file mode 100644 index 00000000..82627ef7 --- /dev/null +++ b/docs/_sources/manual/region-map-editor.rst.txt @@ -0,0 +1,132 @@ +********************* +The Region Map Editor +********************* + +This is where you edit the region map for your game. To open the region map +editor, navigate to *Tools -> Region Map Editor* from porymap's main window. + +When you first open the region map editor, your window will look like this: + +.. figure:: images/region-map-editor/rme-new-window.png + :scale: 75% + :align: center + :alt: RME Window + + Region Map Editor Window + +This window is split vertically--the region map editing is done at the top, +while the zoomed-in city maps are edited at the bottom. You can use the +sliders to zoom in and out on each of the view panes. You will notice +that there are three different tabs above the image of the region map +(:ref:`Background Image `, +:ref:`Map Layout `, +:ref:`Map Entries `). Let's take a look at each tab's +functionality in more detail... + + +.. _background-image-tab: + +Background Image Tab +-------------------- + +When this tab is selected, you can draw on the region map. Select tiles from +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. + +.. figure:: images/region-map-editor/rme-painting-image.gif + :scale: 75% + :align: center + :alt: RME Paint + + Drawing on the Region Map Image + +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 +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 + +.. _map-layout-tab: + +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. + +.. figure:: images/region-map-editor/rme-layout-tab.png + :scale: 75% + :align: center + :alt: RME Layout + + RME Layout Tab + +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`. +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* + +When you add new region map sections. +*Edit -> Swap* + +.. figure:: images/region-map-editor/rme-layout-swap.gif + :scale: 75% + :align: center + :alt: RME Swap + + Swapping Map Sections + +. + +.. _map-entries-tab: + +Map Entries Tab +--------------- + +The other thing + +.. figure:: images/region-map-editor/rme-entries-tab.png + :scale: 75% + :align: center + :alt: RME Entries + + RME Entries Tab + +. + +City Maps +--------- + +city maps + +.. figure:: images/region-map-editor/rme-painting-city.gif + :scale: 60% + :align: center + :alt: City Paint + + Drawing on the City Map + +*Tools -> Import City Map Image 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 + diff --git a/docs/_sources/reference/changelog.rst.txt b/docs/_sources/reference/changelog.rst.txt index 93ae2360..c16f8479 100644 --- a/docs/_sources/reference/changelog.rst.txt +++ b/docs/_sources/reference/changelog.rst.txt @@ -1,3 +1,5 @@ *********** Changelog -*********** \ No newline at end of file +*********** + + reference/CHANGELOG diff --git a/docs/_sources/requirements.txt b/docs/_sources/requirements.txt new file mode 100644 index 00000000..efa74079 --- /dev/null +++ b/docs/_sources/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx_rtd_theme +recommonmark diff --git a/docs/_static/porymap-icon-1.ico b/docs/_static/porymap-icon-1.ico new file mode 100644 index 00000000..9af82ad5 Binary files /dev/null and b/docs/_static/porymap-icon-1.ico differ diff --git a/docs/genindex.html b/docs/genindex.html index 2eb4f21a..d380f0f8 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -133,6 +133,13 @@
  • Follow Connections
    • +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/index.html b/docs/index.html index 5c5ed19c..a7066a05 100644 --- a/docs/index.html +++ b/docs/index.html @@ -133,6 +133,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

    +
  • The Region Map Editor +
    • diff --git a/docs/manual/editing-map-collisions.html b/docs/manual/editing-map-collisions.html index 04f8b10f..e324fe67 100644 --- a/docs/manual/editing-map-collisions.html +++ b/docs/manual/editing-map-collisions.html @@ -134,6 +134,13 @@
  • Follow Connections
    • +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/manual/editing-map-connections.html b/docs/manual/editing-map-connections.html index 197e35b9..d0c281fa 100644 --- a/docs/manual/editing-map-connections.html +++ b/docs/manual/editing-map-connections.html @@ -36,7 +36,7 @@ - + @@ -134,6 +134,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

      @@ -264,7 +271,7 @@
    +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/manual/editing-map-header.html b/docs/manual/editing-map-header.html index 9cfdc9f6..1a375490 100644 --- a/docs/manual/editing-map-header.html +++ b/docs/manual/editing-map-header.html @@ -134,6 +134,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/manual/editing-map-tiles.html b/docs/manual/editing-map-tiles.html index 1e593ea0..9feeed34 100644 --- a/docs/manual/editing-map-tiles.html +++ b/docs/manual/editing-map-tiles.html @@ -134,6 +134,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

      @@ -335,7 +342,7 @@

      Every map uses exactly two Tilesets–primary and secondary. These can be changed by choosing a different value from the two Tileset dropdowns.

      Tileset Pickers -

      Tileset Pickerss

      +

      Tileset Pickers

    diff --git a/docs/manual/introduction.html b/docs/manual/introduction.html index b727c27e..d18faefb 100644 --- a/docs/manual/introduction.html +++ b/docs/manual/introduction.html @@ -134,6 +134,13 @@
  • Follow Connections
    • +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/manual/navigation.html b/docs/manual/navigation.html index 436d9f14..4bfe8c92 100644 --- a/docs/manual/navigation.html +++ b/docs/manual/navigation.html @@ -134,6 +134,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/manual/region-map-editor.html b/docs/manual/region-map-editor.html new file mode 100644 index 00000000..ac957c00 --- /dev/null +++ b/docs/manual/region-map-editor.html @@ -0,0 +1,376 @@ + + + + + + + + + + + The Region Map Editor — porymap documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + + +
      + + + + + +
      + +
      + + + + + + + + + + + + + + + + + +
      + + + + +
      +
      +
      +
      + +
      +

      The Region Map Editor

      +

      This is where you edit the region map for your game. To open the region map +editor, navigate to Tools -> Region Map Editor from porymap’s main window.

      +

      When you first open the region map editor, your window will look like this:

      +
      +RME Window +

      Region Map Editor Window

      +
      +

      This window is split vertically–the region map editing is done at the top, +while the zoomed-in city maps are edited at the bottom. You can use the +sliders to zoom in and out on each of the view panes. You will notice +that there are three different tabs above the image of the region map +(Background Image, +Map Layout, +Map Entries). Let’s take a look at each tab’s +functionality in more detail…

      +
      +

      Background Image Tab

      +

      When this tab is selected, you can draw on the region map. Select tiles from +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.

      +
      +RME Paint +

      Drawing on the Region Map Image

      +
      +

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

      +
      +
      +

      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.

      +
      +RME Layout +

      RME Layout Tab

      +
      +

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

      +

      When you add new region map sections. +Edit -> Swap

      +
      +RME Swap +

      Swapping Map Sections

      +
      +

      .

      +
      +
      +

      Map Entries Tab

      +

      The other thing

      +
      +RME Entries +

      RME Entries Tab

      +
      +

      .

      +
      +
      +

      City Maps

      +

      city maps

      +
      +City Paint +

      Drawing on the City Map

      +
      +

      Tools -> Import City Map Image Tiles

      +

      You can add a new city map by pressing the new-city-map-button button.

      +
      +
      + + +
      + +
      + + +
      +
      + +
      + +
      + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/objects.inv b/docs/objects.inv index d081d38c..7bfc455a 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/reference/changelog.html b/docs/reference/changelog.html index f42cb25d..71b90b5a 100644 --- a/docs/reference/changelog.html +++ b/docs/reference/changelog.html @@ -37,7 +37,7 @@ - + @@ -134,6 +134,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

    diff --git a/docs/reference/related-projects.html b/docs/reference/related-projects.html index 672defee..69d60bf9 100644 --- a/docs/reference/related-projects.html +++ b/docs/reference/related-projects.html @@ -133,6 +133,13 @@
  • Follow Connections
    • +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/requirements.html b/docs/requirements.html new file mode 100644 index 00000000..d3b4cae6 --- /dev/null +++ b/docs/requirements.html @@ -0,0 +1,191 @@ + + + + + + + + + + + <no title> — porymap documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + + +
      + + + + + +
      + +
      + + + + + + + + + + + + + + + + + +
      + + + + +
      +
      +
      +
      + +

      sphinx +sphinx_rtd_theme +recommonmark

      + + +
      + +
      + + +
      +
      + +
      + +
      + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/search.html b/docs/search.html index 2adb5407..80b57313 100644 --- a/docs/search.html +++ b/docs/search.html @@ -133,6 +133,13 @@
    • Follow Connections
    +
  • The Region Map Editor +

    • Reference

      diff --git a/docs/searchindex.js b/docs/searchindex.js index 89721639..a1ae5993 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/introduction","manual/navigation","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["index.rst","manual\\editing-map-collisions.rst","manual\\editing-map-connections.rst","manual\\editing-map-events.rst","manual\\editing-map-header.rst","manual\\editing-map-tiles.rst","manual\\introduction.rst","manual\\navigation.rst","reference\\changelog.md","reference\\related-projects.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x4":6,"23asdf":[],"3x3":5,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":8,"case":[1,3],"default":[3,5,7,8],"export":8,"final":6,"function":[3,6],"import":[1,8],"long":1,"new":[1,2,3,8],"pok\u00e9mon":[3,5],"static":[],"switch":7,"true":1,"try":1,"var":3,"while":[1,5],AND:3,Adding:0,For:[1,2,4,5],Its:[6,8],That:6,The:[1,3,4,5,6,7,8],Then:1,There:[3,6],These:[1,2,5],Use:[3,5],a0ba1b7c6353f7e4f3066025514c05b323a0123d:8,a1ea3b5e394bc115ba9b86348c161094a00dcca7:8,abil:[1,3,8],abl:[1,3],about:[0,8],abov:[1,3,5,6,7],accomplish:5,accord:8,act:8,action:5,actual:8,add:[2,3,8],addit:[4,6],addition:5,adher:8,advanc:[6,8],after:[1,5,6],again:3,all:[1,2,3,5,7,8],allow:[1,4,5,6,7],along:1,also:[1,3,4,5,7,8],altern:3,alwai:[1,3],ani:[1,3,5,8],anoth:[3,5,7],anyth:[3,5],appear:[5,7],applic:[7,8],applymov:3,appropri:1,area:[1,3,5,6,7],around:[3,5,7,8],arrow:3,asdfasdf:[],assign:3,associ:[1,3],auto:8,automat:[2,3,4],avail:[5,6],awar:5,back:5,background:[4,7],base:[0,8],base_game_vers:8,basic:[1,5,6,7],battl:[3,4],becaus:[1,3,7],been:8,befor:[1,5,6],behav:8,being:[1,6,8],belong:4,below:[1,5,8],berri:3,between:[1,2,3,7],bigger:5,bike:4,binari:6,blah:[],block:1,blue:3,border:[0,3],both:2,bottom:[5,7,8],bound:3,branch:[],bread:5,breifli:[],bridg:1,briefli:7,bring:3,bucket:0,bug:8,build:[3,6],built:8,bulk:8,bump:8,butter:5,button:[2,3,5,6,7,8],bvd:8,call:5,can:[0,1,2,3,4,5,6,7,8],caus:8,center:[3,5,7],certain:3,cfg:8,chang:[0,2,6,7],changelog:0,charact:3,check:5,checkbox:[2,5,8],choos:[3,5,6,7],citi:[2,6,7],click:[1,2,3,5,6,7,8],cliff:1,close:3,collaps:[7,8],collect:4,collis:[0,3,6,7,8],column:1,com:0,combin:7,combobox:8,command:3,comment:8,commit:8,common:1,commonli:1,compil:6,concept:1,config:8,connect:[0,5,6,7],contain:[7,8],context:7,contigu:[5,8],continu:1,control:[1,3,4,6],conveni:5,coordin:3,copi:[5,8],corner:2,correctli:8,correspond:8,could:8,count:1,cover:[3,7],crash:8,creat:8,cross:6,ctrl:[2,3,5,6,8],current:[1,3,5,6,7,8],cursor:5,custom:[4,8],data:[6,8],date:8,daunt:7,decompil:[6,8],defin:8,delet:[0,2,8],demonstr:5,denot:1,depend:[5,8],desir:[2,5,7],despit:8,destin:[2,3],detail:[3,5],determin:[1,3],dialog:6,differ:[1,3,5,7,8],difficulti:6,dig:4,direct:[1,2,3,8],directori:[],disabl:[5,8],displai:[3,5,6,8],dissect:3,dive:0,doc:[],document:8,doe:[5,6],doesn:[1,5],doing:6,don:2,doubl:[2,3,7,8],down:[5,6,8],download:6,drag:[2,3,5],draw:6,dropdown:[2,5],due:8,dure:[1,3],dynam:3,each:[1,3,4,7,8],easi:[3,5],easier:[5,8],easiest:2,east:[1,2],edit:[0,6,7,8],editor:[0,3,6,8],either:[1,5,7],elev:[1,3],els:[1,3],emerg:0,empti:6,enabl:[2,5,8],engin:[3,4],ensur:3,enter:[1,3,4,7],entir:5,entranc:3,equal:3,equival:6,error:8,escap:4,etc:8,even:5,event:[0,2,6,7,8],everi:[5,7],exactli:5,exampl:[1,2,3,4,5],except:[1,3,6],execut:3,exist:[5,6,8],expand:[4,7,8],explain:3,explanatori:4,explor:1,extens:[3,8],extrem:2,eyedropp:5,face:[3,8],familiar:6,featur:[1,2,6,7],feel:0,few:[5,6,7],field:[4,8],file:[2,3,6,7,8],fill:[0,1,8],filter:7,find:0,finish:1,first:[1,3,6,7],fix:5,fixup:[],flag:[3,8],flash:4,flip:8,flow:[1,5],flower:6,floweri:6,folder:[6,7,8],follow:[0,6],format:[5,8],found:[6,8],from:[1,3,5,6,7,8],front:3,fullest:7,game:[1,3,4,5,6,7,8],gameplai:[1,3,7],gen:6,gener:[1,6],get:[0,5],gif:5,git:[3,6],github:0,give:7,global:3,going:3,gpl:8,graphic:4,grass:[1,6],great:6,green:3,greet:6,grid:5,group:7,hack:6,half:1,handl:8,happen:[3,8],hardcod:[3,8],has:[1,2,3,4,7,8],have:[1,2,3,5,6,7,8],header:[0,7,8],help:[5,8],here:1,hexadecim:1,hidden:[0,8],hide:4,hierarch:7,highli:6,histori:1,hit:8,hold:[3,5,8],hop:1,horizont:2,hous:8,hover:[5,8],how:[1,3,5,6,7],howev:3,http:0,huderlem:0,icon:[5,8],ident:[1,5],ignor:6,illustr:[1,5],imag:[3,5,7,8],impass:1,improperli:8,improv:6,inc:[3,8],includ:[1,3,5,7],incorrect:8,index:8,indic:5,individu:8,inform:8,initi:8,instal:6,integ:8,interact:[1,3,7],interpret:8,introduct:0,invis:3,involv:3,item:[0,4,8],iter:8,its:[3,5],jasc:8,json:8,junk:8,just:[1,5],keep:[2,4,8],kei:[5,8],known:3,laid:5,land:1,larg:[5,8],larger:7,launch:6,layer:8,layout:[7,8],layouts_t:8,learn:[5,6,7],leav:1,left:[1,5,6,7],let:[1,3,5,6,7],level:1,life:[3,5],like:[1,3,5,7,8],limit:4,line:3,linux:6,list:[0,8],load:[6,7],local:3,locat:[4,5,6],log:8,longer:[3,8],look:[0,3,6,7],mac:6,maco:8,made:8,magic:8,mai:3,main:[0,5,6],maintain:1,make:[1,3,5,6,8],mani:[3,6,7],manual:0,map:[0,6,8],map_groups_count:8,map_type_indoor:4,mark:3,master:[],match:[3,5,8],mean:[1,2,3],menu:[2,8],merg:[],metatil:[0,1,3,6,7,8],method:5,middl:5,minor:8,mirror:0,miscellan:4,miss:[0,8],mistak:5,mode:8,modif:1,modifi:[5,7],more:[3,5,6,7],most:[1,6,7],mostli:4,mountain:[1,5],mous:[5,8],move:[1,2,3,4],movement:[3,8],much:6,multi:1,multilin:8,multipl:[3,5,8],music:[4,7],must:[2,3,5,6],name:[3,4,7],navig:[0,2,3,6],nearli:1,need:[1,2,3,4,5],never:3,newli:8,next:[1,3,6,7,8],nodep:6,non:3,none:3,normal:3,north:1,notabl:[6,8],note:4,noth:3,now:[1,5,6,8],npc:3,number:[1,8],object:[0,1,7],occur:8,off:[1,5],offset:2,onc:[3,5],one:[1,2,5,7],onli:[1,2,3,4,5,7,8],onto:[1,5,7],open:[0,2,6,7,8],oper:7,option:[0,7,8],order:[3,8],organ:7,origin:3,other:[3,5,7],our:6,out:[0,5,8],outlin:[5,8],outsid:8,over:[1,3,4,5,7],overhaul:8,overworld:3,page:[],paint:[0,5,6,7],pal:8,palett:8,pane:[5,7,8],panel:[6,8],pars:8,part:7,partial:8,particular:1,path:[0,1,8],pathwai:5,patient:7,pattern:5,pencil:[0,6],perform:5,petalburg:[2,6],pick:3,picker:[],pickerss:5,pink:3,pip:[],place:[5,6],plai:4,platform:6,player:[1,2,3,5,7,8],pleas:0,plu:[2,3],png:8,pointer:0,pokeemerald:[6,8],pokemon:[6,7],pokerubi:[6,8],pond:5,pop:6,popup:4,portion:5,porymap:[2,3,5,7,8],posit:[0,5],possibl:8,power:5,pre:8,press:[2,3,6,7],pret:[6,8],preview:5,previou:1,primari:[5,6,7],process:1,project:[0,4,6,7,8],prompt:8,properli:8,properti:[1,3,4,6,7,8],provid:[5,6,8],purpos:[1,7],python:[],quick:5,quickli:7,radiu:[3,5],rang:3,rather:[5,8],reach:0,read:[6,8],receiv:3,recommend:6,rectangl:[5,8],red:1,redo:[0,1,3,6],refer:0,region:[0,4,5,6,8],registri:8,regular:5,relat:0,releas:[6,8],rememb:1,render:8,repo:8,repres:1,requir:[3,4,8],resiz:5,respect:[6,8],restor:8,result:6,right:[1,2,3,5,7,8],rival:3,rom:6,root:[],rop:4,rope:4,rout:[1,2],row:[1,8],rubi:4,run:4,same:[1,3,5,6,8],save:[2,5,6,8],scenario:8,scene:4,screen:6,script:[0,7],scroll:5,seamlessli:2,second:[1,6,7],secondari:[5,7],secret:[0,8],secret_bas:3,section:[3,4,7],see:[3,5,6],seem:7,seen:8,select:[0,2,3,6,7,8],selector:[1,8],self:4,semant:8,set:[3,5,7,8],setup:6,shift:[0,2],shoe:4,shortcut:[1,5,6],should:[1,3,5,6],shouldn:6,show:[4,5,6,7,8],shrink:8,side:[1,2,5,6,7],sight:3,sign:[0,8],signpost:[1,3],similar:[1,2],simpl:3,simpli:[2,5,7],simplifi:5,sinc:[2,6,8],singl:7,site:[],situat:7,size:8,slider:[1,5,8],small:3,smart:[0,1,8],snap:5,some:[1,3,5,6,7],someth:[0,1,3],sometim:8,somewhat:8,song:4,sort:[7,8],sourc:6,south:1,special:[1,3],specif:[3,8],specifi:[3,8],sphinx:[],spinner:[3,8],spot:3,sprite:[3,8],squar:3,src:3,ssecretbaseentrancemetatil:3,stai:8,stair:1,start:[0,1],startup:8,statu:8,still:8,successfulli:6,summar:7,support:[4,6],sure:[1,2,6],surf:1,surround:[5,7],sync:2,system:8,tab:[1,2,3,7,8],take:[5,6,7],technic:3,text:[1,3,7],than:[5,8],thei:[2,3,4,5,7],them:[1,2,3,4],therefor:6,thi:[1,2,3,4,5,7,8],thing:[3,4,5,6,7],think:[5,6],those:6,though:[5,8],three:3,through:[1,2,8],tile:[0,1,3,6,7,8],tileset:[0,6,8],time:[1,3,5,6,7,8],togeth:2,toggl:5,too:1,tool:[0,1,6,8],toolbar:[5,6],top:[1,2,3,8],total:1,tpl:8,tradit:6,trainer:[3,8],trainer_sight_or_berry_tree_id:8,trainer_typ:8,transit:[1,3],transpar:[1,8],tree:[3,5],trigger:[0,7],two:[2,5,7],txt:[],type:[0,3,4,7,8],typic:[1,3],unabl:1,under:1,underli:8,undertand:1,undo:[0,1,3,6],unfortun:3,uniqu:3,unlik:1,unreleas:0,updat:[1,2,5],usabl:6,use:[1,3,5,6,7,8],used:[1,2,3,4,5,7,8],useful:[2,4,5],user:[0,1,6,8],uses:[1,3,5,8],using:[3,5,6,7,8],valid:8,valu:[2,3,4,5,8],var_valu:8,variabl:3,variou:[4,5,6,7],veri:[1,2,3,5],version:[1,3,4,6,8],vertic:2,via:8,view:[1,2,3,4,5,7,8],visibl:[3,5],vision:4,visual:[0,1],wai:[2,5],walk:[1,2,3,7],warp:[0,7,8],weather:[0,4,7],websit:[],were:8,west:[1,2],what:[0,1,3,4,5,7],wheel:5,when:[1,2,3,4,5,6,7,8],whenev:[1,5,7],where:8,whether:[1,4],which:[1,2,4,5,7,8],white:[1,5],why:1,wild:6,window:[0,3,4,5,6,8],within:[3,7],without:[5,8],woman:3,won:1,work:[5,6,7,8],workflow:6,would:[1,8],wouldn:8,wrap:5,write:[6,8],written:8,you:[0,1,2,3,4,5,6,7],your:[2,3,4,5,6,7],zoom:[5,8]},titles:["Porymap Documentation","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Introduction","Navigation","Changelog","Related Projects"],titleterms:{"break":8,Added:8,Adding:3,about:6,base:3,border:5,bucket:5,build:[],chang:[5,8],changelog:8,collis:1,connect:2,delet:3,dive:2,document:0,edit:[1,2,3,4,5],editor:7,emerg:2,event:3,fill:5,fix:8,follow:2,get:6,header:4,hidden:3,introduct:6,item:3,list:7,main:7,map:[1,2,3,4,5,7],metatil:5,mirror:2,move:[],navig:7,object:3,open:3,option:5,paint:1,path:5,pencil:5,pointer:5,porymap:[0,6],posit:3,project:9,properti:[],redo:5,region:7,relat:9,script:3,secret:3,select:[1,5],setup:[],shift:5,sign:3,smart:5,start:6,tile:5,tileset:[5,7],tool:5,trigger:3,type:1,undo:5,unreleas:8,visual:5,warp:[2,3],weather:3,window:7}}) \ No newline at end of file +Search.setIndex({docnames:["index","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/introduction","manual/navigation","manual/region-map-editor","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["index.rst","manual/editing-map-collisions.rst","manual/editing-map-connections.rst","manual/editing-map-events.rst","manual/editing-map-header.rst","manual/editing-map-tiles.rst","manual/introduction.rst","manual/navigation.rst","manual/region-map-editor.rst","reference/changelog.md","reference/related-projects.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x4":6,"3x3":5,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":9,"8x8":8,"break":[],"case":[1,3],"default":[3,5,7,9],"export":9,"final":6,"function":[3,6,8],"import":[1,8,9],"long":1,"new":[1,2,3,8,9],"pok\u00e9mon":[3,5],"static":[],"switch":7,"true":1,"try":1,"var":3,"while":[1,5,8],AND:3,Added:[],Adding:0,For:[1,2,4,5],Its:[6,9],That:6,The:[0,1,3,4,5,6,7,9],Then:1,There:[3,6,8],These:[1,2,5],Use:[3,5],a0ba1b7c6353f7e4f3066025514c05b323a0123d:9,a1ea3b5e394bc115ba9b86348c161094a00dcca7:9,abil:[1,3,9],abl:[1,3],about:[0,9],abov:[1,3,5,6,7,8],accomplish:5,accord:9,act:9,action:5,actual:9,add:[2,3,8,9],addit:[4,6],addition:5,adher:9,advanc:[6,9],after:[1,5,6],again:3,all:[1,2,3,5,7,8,9],allow:[1,4,5,6,7],along:1,also:[1,3,4,5,7,9],altern:3,alwai:[1,3],ani:[1,3,5,9],anoth:[3,5,7],anyth:[3,5],appear:[5,7],applic:[7,9],applymov:3,appropri:1,area:[1,3,5,6,7],around:[3,5,7,8,9],arrow:3,assign:3,associ:[1,3,8],auto:9,automat:[2,3,4],avail:[5,6],awar:5,back:5,background:[0,4,7],base:[0,9],base_game_vers:9,basic:[1,5,6,7],battl:[3,4],becaus:[1,3,7],been:9,befor:[1,5,6],begin:8,behav:9,being:[1,6,9],belong:4,below:[1,5,9],berri:3,between:[1,2,3,7],bigger:5,bike:4,binari:6,block:1,blue:3,border:[0,3],both:2,bottom:[5,7,8,9],bound:3,box:8,branch:[],bread:5,bridg:1,briefli:7,bring:3,bucket:0,bug:9,build:[3,6],built:9,bulk:9,bump:9,butter:5,button:[2,3,5,6,7,8,9],bvd:9,call:5,can:[0,1,2,3,4,5,6,7,8,9],caus:9,center:[3,5,7],certain:3,cfg:9,chang:[0,2,6,7,8],changelog:0,charact:3,check:5,checkbox:[2,5,9],choos:[3,5,6,7],citi:[0,2,6,7],clear:8,click:[1,2,3,5,6,7,8,9],cliff:1,close:3,collaps:[7,9],collect:4,collis:[0,3,6,7,9],color:8,column:1,com:0,combin:7,combobox:[8,9],command:3,comment:9,commit:9,common:1,commonli:1,compar:[],compil:6,compos:8,concept:1,config:9,connect:[0,5,6,7],constant:8,contain:[7,9],content:[],context:7,contigu:[5,9],continu:1,control:[1,3,4,6],conveni:5,coordin:3,copi:[5,9],corner:2,correctli:9,correspond:9,could:9,count:1,cover:[3,7],crash:9,creat:9,cross:6,ctrl:[2,3,5,6,8,9],current:[1,3,5,6,7,9],cursor:[5,8],custom:[4,9],data:[6,9],date:9,daunt:7,decompil:[6,9],defin:[8,9],delet:[0,2,9],demonstr:5,denot:1,depend:[5,9],desir:[2,5,7],despit:9,destin:[2,3],detail:[3,5,8],determin:[1,3,8],dialog:6,differ:[1,3,5,7,8,9],difficulti:6,dig:4,direct:[1,2,3,9],directori:[],disabl:[5,9],discuss:[],displai:[3,5,6,9],dissect:3,dive:0,doc:[],document:9,doe:[5,6],doesn:[1,5],doing:6,don:2,done:8,doubl:[2,3,7,9],down:[5,6,9],download:6,drag:[2,3,5,8],draw:[6,8],dropdown:[2,5],due:9,dure:[1,3],dynam:3,each:[1,3,4,7,8,9],easi:[3,5],easier:[5,9],easiest:2,east:[1,2],edit:[0,6,7,8,9],editor:[0,3,6,9],either:[1,5,7],elev:[1,3],els:[1,3],emerg:0,empti:6,enabl:[2,5,9],engin:[3,4],ensur:3,enter:[1,3,4,7,8],entir:5,entranc:3,entri:0,equal:3,equival:6,error:9,escap:4,etc:9,even:5,event:[0,2,6,7,9],everi:[5,7],exactli:5,exampl:[1,2,3,4,5],except:[1,3,6],execut:3,exist:[5,6,9],expand:[4,7,9],explain:3,explanatori:4,explor:1,extens:[3,9],extrem:2,eyedropp:5,face:[3,9],familiar:6,featur:[1,2,6,7],feel:0,few:[5,6,7],fewer:8,field:[4,9],file:[2,3,6,7,9],fill:[0,1,9],filter:7,find:0,finish:1,first:[1,3,6,7,8],fix:5,flag:[3,9],flash:4,flip:9,flow:[1,5],flower:6,floweri:6,folder:[6,7,9],follow:[0,6],format:[5,9],found:[6,9],from:[1,3,5,6,7,8,9],front:3,fullest:7,game:[1,3,4,5,6,7,8,9],gameplai:[1,3,7],gen:6,gener:[1,6],get:[0,5],gif:5,git:[3,6],github:0,give:7,global:3,going:3,gpl:9,graphic:4,grass:[1,6],great:6,green:3,greet:6,grid:5,group:7,hack:6,half:1,handl:9,happen:[3,9],hardcod:[3,9],has:[1,2,3,4,7,9],have:[1,2,3,5,6,7,8,9],head:[],header:[0,7,9],help:[5,9],here:1,hexadecim:1,hidden:[0,9],hide:4,hierarch:7,highli:6,higlight:8,histori:1,hit:9,hold:[3,5,9],hop:1,horizont:2,hous:9,hover:[5,9],how:[1,3,5,6,7],howev:3,html:[],http:0,huderlem:0,icon:[5,9],ident:[1,5],ignor:6,illustr:[1,5],imag:[0,3,5,7,9],impass:1,improperli:9,improv:6,inc:[3,9],includ:[1,3,5,7,8],incorrect:9,index:[8,9],indic:5,individu:9,inform:9,initi:9,instal:6,integ:9,interact:[1,3,7],interpret:9,introduct:0,invis:3,involv:3,item:[0,4,9],iter:9,its:[3,5],jasc:9,json:9,junk:9,just:[1,5],keep:[2,4,9],keepachangelog:[],kei:[5,9],known:3,laid:5,land:1,larg:[5,9],larger:7,launch:6,layer:9,layout:[0,7,9],layouts_t:9,learn:[5,6,7],leav:1,left:[1,5,6,7],let:[1,3,5,6,7,8],level:1,life:[3,5],like:[1,3,5,7,8,9],limit:4,line:3,linux:6,list:[0,9],load:[6,7],local:3,locat:[4,5,6],log:9,longer:[3,9],look:[0,3,6,7,8],m2r:[],mac:6,maco:9,made:9,magic:9,mai:3,main:[0,5,6,8],maintain:1,make:[1,3,5,6,8,9],mani:[3,6,7],manual:0,map:[0,6,9],map_groups_count:9,map_type_indoor:4,mark:3,master:[],match:[3,5,9],mean:[1,2,3],menu:[2,9],merg:[],metatil:[0,1,3,6,7,9],method:5,middl:5,minor:9,mirror:0,miscellan:4,miss:[0,9],mistak:[5,8],mode:9,modif:1,modifi:[5,7,8],modul:[],more:[3,5,6,7,8],most:[1,6,7],mostli:4,mountain:[1,5],mous:[5,8,9],move:[1,2,3,4],movement:[3,9],much:6,multi:1,multilin:9,multipl:[3,5,9],music:[4,7],must:[2,3,5,6,8],name:[3,4,7,8],navig:[0,2,3,6,8],nearli:1,need:[1,2,3,4,5],never:3,newli:9,next:[1,3,6,7,9],nodep:6,non:3,none:3,normal:3,north:1,notabl:[6,9],note:4,noth:3,notic:8,now:[1,5,6,9],npc:3,number:[1,9],object:[0,1,7],occur:9,off:[1,5],offset:2,onc:[3,5],one:[1,2,5,7],onli:[1,2,3,4,5,7,8,9],onto:[1,5,7,8],open:[0,2,6,7,8,9],oper:7,option:[0,7,9],order:[3,9],org:[],organ:7,origin:3,other:[3,5,7,8],our:6,out:[0,5,8,9],outlin:[5,9],outsid:9,over:[1,3,4,5,7],overhaul:9,overworld:3,own:8,page:[],paint:[0,5,6,7,8],pal:9,palett:[8,9],pane:[5,7,8,9],panel:[6,9],pars:9,part:7,partial:9,particular:1,path:[0,1,9],pathwai:5,patient:7,pattern:5,pencil:[0,6],perform:5,petalburg:[2,6],pick:3,picker:5,pickerss:[],pink:3,pip:[],pixel:8,place:[5,6,8],plai:4,platform:6,player:[1,2,3,5,7,8,9],pleas:0,plu:[2,3],png:9,pointer:0,pokeemerald:[6,9],pokemon:[6,7],pokenav:[],pokerubi:[6,9],pond:5,pop:6,popul:8,popup:[4,8],portion:5,porymap:[2,3,5,7,8,9],posit:[0,5,8],possibl:9,power:5,pre:9,press:[2,3,6,7,8],pret:[6,9],preview:5,previou:1,primari:[5,6,7],process:1,project:[0,4,6,7,9],prompt:9,properli:9,properti:[1,3,4,6,7,9],provid:[5,6,9],purpos:[1,7],python:[],quick:5,quickli:7,radiu:[3,5],rang:3,rather:[5,9],reach:0,read:[6,9],receiv:3,recommend:6,recommonmark:[],rectangl:[5,9],red:1,redo:[0,1,3,6,8],refer:0,region:[0,4,5,6,9],region_map_sect:8,registri:9,regular:5,relat:0,releas:[6,9],rememb:1,render:9,repo:9,repres:1,requir:[3,4,8,9],resiz:5,respect:[6,9],restor:9,result:6,review:[],right:[1,2,3,5,7,8,9],rival:3,rme:8,rom:6,root:[],rop:4,rope:4,rout:[1,2],row:[1,9],rtd:[],rubi:4,run:4,same:[1,3,5,6,8,9],save:[2,5,6,9],scenario:9,scene:4,screen:6,script:[0,7],scroll:5,seamlessli:2,search:[],second:[1,6,7],secondari:[5,7],secret:[0,9],secret_bas:3,section:[3,4,7,8],see:[3,5,6],seem:7,seen:9,select:[0,2,3,6,7,8,9],selector:[1,8,9],self:4,semant:9,semver:[],set:[3,5,7,8,9],setup:6,share:8,shift:[0,2],shoe:4,shortcut:[1,5,6],should:[1,3,5,6],shouldn:6,show:[4,5,6,7,9],shrink:9,side:[1,2,5,6,7],sight:3,sign:[0,9],signpost:[1,3],similar:[1,2],simpl:3,simpli:[2,5,7],simplifi:5,sinc:[2,6,9],singl:[7,8],site:[],situat:7,size:9,slider:[1,5,8,9],small:3,smart:[0,1,9],snap:5,some:[1,3,5,6,7],someth:[0,1,3],sometim:9,somewhat:9,song:4,sort:[7,9],sourc:6,south:1,spec:[],special:[1,3],specif:[3,9],specifi:[3,9],sphinx:[],sphinx_rtd_them:[],spinner:[3,9],split:8,spot:3,sprite:[3,9],squar:[3,8],src:3,ssecretbaseentrancemetatil:3,stai:9,stair:1,start:[0,1],startup:9,statu:9,still:9,strict:8,successfulli:6,summar:7,summari:[],sumri:[],support:[4,6],sure:[1,2,6],surf:1,surround:[5,7],swap:8,sync:2,system:9,tab:[0,1,2,3,7,9],take:[5,6,7,8],technic:3,text:[1,3,7],than:[5,9],thei:[2,3,4,5,7],them:[1,2,3,4],theme:[],therefor:6,thi:[1,2,3,4,5,7,8,9],thing:[3,4,5,6,7,8],think:[5,6],those:6,though:[5,9],three:[3,8],through:[1,2,9],tied:8,tile:[0,1,3,6,7,8,9],tileset:[0,6,9],time:[1,3,5,6,7,9],togeth:2,toggl:5,too:1,tool:[0,1,6,8,9],toolbar:[5,6],top:[1,2,3,8,9],total:1,tpl:9,tradit:6,trainer:[3,9],trainer_sight_or_berry_tree_id:9,trainer_typ:9,transit:[1,3],transpar:[1,9],tree:[3,5],trigger:[0,7],two:[2,5,7],txt:[],type:[0,3,4,7,8,9],typic:[1,3],unabl:1,under:[1,8],underli:9,undertand:1,undo:[0,1,3,6,8],unfortun:3,unhappi:8,uniqu:3,unlik:1,unreleas:0,updat:[1,2,5],usabl:6,use:[1,3,5,6,7,8,9],used:[1,2,3,4,5,7,9],useful:[2,4,5],user:[0,1,6,9],uses:[1,3,5,8,9],using:[3,5,6,7,9],valid:9,valu:[2,3,4,5,9],var_valu:9,variabl:3,variou:[4,5,6,7],veri:[1,2,3,5],version:[1,3,4,6,9],vertic:[2,8],via:9,view:[1,2,3,4,5,7,8,9],visibl:[3,5],vision:4,visual:[0,1],wai:[2,5],walk:[1,2,3,7],want:8,warp:[0,7,9],weather:[0,4,7],websit:[],were:9,west:[1,2],what:[0,1,3,4,5,7,8],wheel:5,when:[1,2,3,4,5,6,7,8,9],whenev:[1,5,7],where:[8,9],whether:[1,4],which:[1,2,4,5,7,9],white:[1,5],why:1,wild:6,window:[0,3,4,5,6,8,9],within:[3,7],without:[5,9],woman:3,won:1,work:[5,6,7,9],workflow:6,would:[1,9],wouldn:9,wrap:5,write:[6,9],written:9,you:[0,1,2,3,4,5,6,7,8],your:[2,3,4,5,6,7,8],zoom:[5,8,9]},titles:["Porymap Documentation","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Introduction","Navigation","The Region Map Editor","Changelog","Related Projects"],titleterms:{"break":9,Added:9,Adding:3,The:8,about:6,background:8,base:3,border:5,bucket:5,build:[],chang:[5,9],changelog:9,citi:8,collis:1,connect:2,delet:3,dive:2,document:0,edit:[1,2,3,4,5],editor:[7,8],emerg:2,entri:8,event:3,fill:5,fix:9,follow:2,get:6,header:4,hidden:3,imag:8,indic:[],introduct:6,item:3,layout:8,list:7,main:7,map:[1,2,3,4,5,7,8],metatil:5,mirror:2,navig:7,object:3,open:3,option:5,paint:1,path:5,pencil:5,pointer:5,porymap:[0,6],posit:3,project:10,redo:5,region:[7,8],relat:10,script:3,secret:3,select:[1,5],setup:[],shift:5,sign:3,smart:5,start:6,tab:8,tabl:[],tile:5,tileset:[5,7],tool:5,trigger:3,type:1,undo:5,unreleas:9,visual:5,warp:[2,3],weather:3,welcom:[],window:7}}) \ No newline at end of file diff --git a/docsrc/index.rst b/docsrc/index.rst index 0f5b0f94..61894afd 100644 --- a/docsrc/index.rst +++ b/docsrc/index.rst @@ -15,6 +15,7 @@ Porymap Documentation manual/editing-map-events manual/editing-map-header manual/editing-map-connections + manual/region-map-editor .. toctree:: :maxdepth: 2 diff --git a/docsrc/manual/editing-map-tiles.rst b/docsrc/manual/editing-map-tiles.rst index 01a2eb85..3aeb2117 100644 --- a/docsrc/manual/editing-map-tiles.rst +++ b/docsrc/manual/editing-map-tiles.rst @@ -152,7 +152,7 @@ Every map uses exactly two Tilesets--primary and secondary. These can be change .. figure:: images/editing-map-tiles/tileset-pickers.png :alt: Tileset Pickers - Tileset Pickerss + Tileset Pickers Undo & Redo ----------- diff --git a/docsrc/manual/images/region-map-editor/rme-entries-tab.png b/docsrc/manual/images/region-map-editor/rme-entries-tab.png new file mode 100644 index 00000000..c4892954 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-entries-tab.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-layout-swap.gif b/docsrc/manual/images/region-map-editor/rme-layout-swap.gif new file mode 100644 index 00000000..ea349e04 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-layout-swap.gif differ diff --git a/docsrc/manual/images/region-map-editor/rme-layout-tab.png b/docsrc/manual/images/region-map-editor/rme-layout-tab.png new file mode 100644 index 00000000..1ecd17f8 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-layout-tab.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-new-city-map-button.png b/docsrc/manual/images/region-map-editor/rme-new-city-map-button.png new file mode 100644 index 00000000..f2d124c9 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-new-city-map-button.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-new-city-map-layout.png b/docsrc/manual/images/region-map-editor/rme-new-city-map-layout.png new file mode 100644 index 00000000..c24c3369 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-new-city-map-layout.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-new-city-map-window.png b/docsrc/manual/images/region-map-editor/rme-new-city-map-window.png new file mode 100644 index 00000000..56b3164d Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-new-city-map-window.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-new-window.png b/docsrc/manual/images/region-map-editor/rme-new-window.png new file mode 100644 index 00000000..da4deb7f Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-new-window.png differ diff --git a/docsrc/manual/images/region-map-editor/rme-painting-city.gif b/docsrc/manual/images/region-map-editor/rme-painting-city.gif new file mode 100644 index 00000000..51270024 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-painting-city.gif differ diff --git a/docsrc/manual/images/region-map-editor/rme-painting-image.gif b/docsrc/manual/images/region-map-editor/rme-painting-image.gif new file mode 100644 index 00000000..2ae6b005 Binary files /dev/null and b/docsrc/manual/images/region-map-editor/rme-painting-image.gif differ diff --git a/docsrc/manual/region-map-editor.rst b/docsrc/manual/region-map-editor.rst new file mode 100644 index 00000000..82627ef7 --- /dev/null +++ b/docsrc/manual/region-map-editor.rst @@ -0,0 +1,132 @@ +********************* +The Region Map Editor +********************* + +This is where you edit the region map for your game. To open the region map +editor, navigate to *Tools -> Region Map Editor* from porymap's main window. + +When you first open the region map editor, your window will look like this: + +.. figure:: images/region-map-editor/rme-new-window.png + :scale: 75% + :align: center + :alt: RME Window + + Region Map Editor Window + +This window is split vertically--the region map editing is done at the top, +while the zoomed-in city maps are edited at the bottom. You can use the +sliders to zoom in and out on each of the view panes. You will notice +that there are three different tabs above the image of the region map +(:ref:`Background Image `, +:ref:`Map Layout `, +:ref:`Map Entries `). Let's take a look at each tab's +functionality in more detail... + + +.. _background-image-tab: + +Background Image Tab +-------------------- + +When this tab is selected, you can draw on the region map. Select tiles from +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. + +.. figure:: images/region-map-editor/rme-painting-image.gif + :scale: 75% + :align: center + :alt: RME Paint + + Drawing on the Region Map Image + +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 +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 + +.. _map-layout-tab: + +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. + +.. figure:: images/region-map-editor/rme-layout-tab.png + :scale: 75% + :align: center + :alt: RME Layout + + RME Layout Tab + +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`. +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* + +When you add new region map sections. +*Edit -> Swap* + +.. figure:: images/region-map-editor/rme-layout-swap.gif + :scale: 75% + :align: center + :alt: RME Swap + + Swapping Map Sections + +. + +.. _map-entries-tab: + +Map Entries Tab +--------------- + +The other thing + +.. figure:: images/region-map-editor/rme-entries-tab.png + :scale: 75% + :align: center + :alt: RME Entries + + RME Entries Tab + +. + +City Maps +--------- + +city maps + +.. figure:: images/region-map-editor/rme-painting-city.gif + :scale: 60% + :align: center + :alt: City Paint + + Drawing on the City Map + +*Tools -> Import City Map Image 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 +