diff --git a/docsrc/manual/editing-map-events.rst b/docsrc/manual/editing-map-events.rst index 89bc57f4..25f45263 100644 --- a/docsrc/manual/editing-map-events.rst +++ b/docsrc/manual/editing-map-events.rst @@ -9,7 +9,7 @@ Events are what bring your maps to life. They include NPCs, signposts, warps, s Map Events View -All of the events are visible on the map. The Event Details window on the right displays the properties of the currently-selected event. If you look closely, you'll see that the woman NPC near the Pokémon Center has a pink border around it because it's selected. To select a different event, simple click on an event in the map area. Alternatively, you can use the spinner at the top of the event properties window. Multiple events can be selected at the same time by holding ``Ctrl`` and clicking another event. +All of the events are visible on the map. The Event Details window on the right displays the properties of the currently-selected event. If you look closely, you'll see that the woman NPC near the Pokémon Center has a pink border around it because it's selected. To select a different event, simply click on an event in the map area. Alternatively, you can use the spinner at the top of the event properties window. Multiple events can be selected at the same time by holding ``Ctrl`` and clicking another event. .. figure:: images/editing-map-events/event-id-spinner.png :alt: Event Id Spinner @@ -65,11 +65,14 @@ Event Flag The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to `0`, then the object will always be visible because `0` means "no flag". Trainer Type - `NONE`, `NORMAL`, or `SEE ALL DIRECTIONS`. If the object is a trainer, `NORMAL` means that the trainer will spot the player in the object's line-of-sight. + The trainer type used by the object. If the object is a trainer, `TRAINER_TYPE_NORMAL` means that the trainer will spot the player in the object's line-of-sight. Sight Radius or Berry Tree ID If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id. +In Connection + Exclusive to pokefirered. Used to replace objects that are visible in a map's connection with their corresponding object on the connecting map. When checked, these objects will make odd use of other fields; its trainer type value will be the connecting map number, its Sight Radius / Berry Tree Id will be the connecting map group, and its z coordinate will be the object's local id on the connecting map. + .. _event-warps: Warp Events @@ -116,7 +119,7 @@ Var Value Weather Trigger Events ---------------------- -Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type. +Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type. This event type is unavailable for pokefirered projects; the functions to trigger weather changes were dummied out. .. figure:: images/editing-map-events/event-weather-trigger.png :alt: Weather Trigger Event Properties @@ -167,10 +170,17 @@ Item Flag This flag is set when the player receives the hidden item. +Quantity + Exclusive to pokefirered. The number of items received when the item is picked up. + +Requires Itemfinder + Exclusive to pokefirered. When checked, the hidden item can only be received by standing on it and using the Itemfinder. + Secret Base Event ----------------- This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game's engine (see ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``). +This event type is unavailable for pokefirered projects; secret bases do not exist there. .. figure:: images/editing-map-events/event-secret-base.png :alt: Secret Base Event Properties @@ -183,6 +193,22 @@ Id Secret Base Id The id of the destination secret base. +Heal Location / Healspots +------------------------- + +This event is used to control where a player will arrive when they white out or fly to the map. The white out functions a little differently between game versions. For pokeemerald and pokeruby players will arrive at the event's coordinates after a white out, while in pokefirered they will arrive on the map set in ``Respawn Map`` and at hardcoded coordinates (see ``SetWhiteoutRespawnWarpAndHealerNpc`` in ``src/heal_location.c``). + +.. figure:: images/editing-map-events/event-heal-location.png + :alt: Heal Location Properties + + Heal Location Properties + +Respawn Map + Exclusive to pokefirered. The map where the player will arrive when they white out (e.g. inside the PokéCenter that the heal location is in front of). + +Respawn NPC + Exclusive to pokefirered. The local id of the NPC the player will interact with when they white out. + Adding & Deleting Events ------------------------ diff --git a/docsrc/manual/editing-map-header.rst b/docsrc/manual/editing-map-header.rst index 1300450c..a5cd1569 100644 --- a/docsrc/manual/editing-map-header.rst +++ b/docsrc/manual/editing-map-header.rst @@ -22,7 +22,7 @@ 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``. + The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes cannot be used when the map type is ``MAP_TYPE_INDOOR``. Battle Scene Controls what graphics are used in battles. @@ -36,8 +36,11 @@ Allow Running Allow Biking Controls whether or not a bike can be used. -Allow Dig & Escape Rop +Allow Dig & Escape Rope Controls whether the Dig field move or the Escape Rope item can be used. +Floor Number + Exclusive to pokefirered. Used to append a number to the map name popup. Negative values are prefixed with "B" for basement, and floor 127 is "Rooftop". + 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. diff --git a/docsrc/manual/editing-map-tiles.rst b/docsrc/manual/editing-map-tiles.rst index 3aeb2117..63672f8f 100644 --- a/docsrc/manual/editing-map-tiles.rst +++ b/docsrc/manual/editing-map-tiles.rst @@ -144,6 +144,8 @@ The map's border can be modified by painting on the Border image, which is locat Change Map Border +The dimensions of the map's border can also be adjusted for pokefirered projects via the ``Change Dimensions`` button. If you have modified your pokeemerald or pokeruby project to support custom border sizes you can enable this option with the ``use_custom_border_size`` field in your project's ``porymap.project.cfg`` file. + Change Map Tilesets ------------------- diff --git a/docsrc/manual/images/editing-map-events/event-heal-location.png b/docsrc/manual/images/editing-map-events/event-heal-location.png new file mode 100644 index 00000000..16ec90f1 Binary files /dev/null and b/docsrc/manual/images/editing-map-events/event-heal-location.png differ diff --git a/docsrc/manual/images/editing-map-events/event-hidden-item.png b/docsrc/manual/images/editing-map-events/event-hidden-item.png index 20475430..2377edfc 100644 Binary files a/docsrc/manual/images/editing-map-events/event-hidden-item.png and b/docsrc/manual/images/editing-map-events/event-hidden-item.png differ diff --git a/docsrc/manual/images/editing-map-events/event-object.png b/docsrc/manual/images/editing-map-events/event-object.png index 6699033c..e019caba 100644 Binary files a/docsrc/manual/images/editing-map-events/event-object.png and b/docsrc/manual/images/editing-map-events/event-object.png differ diff --git a/docsrc/manual/images/editing-map-events/event-sign.png b/docsrc/manual/images/editing-map-events/event-sign.png index 5e279eb3..5d4c6596 100644 Binary files a/docsrc/manual/images/editing-map-events/event-sign.png and b/docsrc/manual/images/editing-map-events/event-sign.png differ diff --git a/docsrc/manual/images/editing-map-events/event-trigger.png b/docsrc/manual/images/editing-map-events/event-trigger.png index c2805341..c922b06d 100644 Binary files a/docsrc/manual/images/editing-map-events/event-trigger.png and b/docsrc/manual/images/editing-map-events/event-trigger.png differ diff --git a/docsrc/manual/images/editing-map-events/map-events.png b/docsrc/manual/images/editing-map-events/map-events.png index 135e383f..9a4d3f5d 100644 Binary files a/docsrc/manual/images/editing-map-events/map-events.png and b/docsrc/manual/images/editing-map-events/map-events.png differ diff --git a/docsrc/manual/images/editing-map-header/map-header.png b/docsrc/manual/images/editing-map-header/map-header.png index 9b446985..fe31076b 100644 Binary files a/docsrc/manual/images/editing-map-header/map-header.png and b/docsrc/manual/images/editing-map-header/map-header.png differ diff --git a/docsrc/manual/introduction.rst b/docsrc/manual/introduction.rst index 1638f51c..7ad845da 100644 --- a/docsrc/manual/introduction.rst +++ b/docsrc/manual/introduction.rst @@ -14,7 +14,7 @@ Porymap reads and writes files in the decompilation projects. It **does not** r Getting Started --------------- -Before using Porymap, you must have your decompilation project setup. Porymap currently supports `pokeemerald `_ and `pokeruby `_. See their respective ``INSTALL.md`` files to get setup, and make sure you can successfully compile the ROM. +Before using Porymap, you must have your decompilation project setup. Porymap supports the `pokeemerald `_, `pokeruby `_, and `pokefirered `_ decompilation projects. See their respective ``INSTALL.md`` files to get setup, and make sure you can successfully compile the ROM. When launching Porymap for the first time, you will be greeted with the following empty window: diff --git a/docsrc/manual/navigation.rst b/docsrc/manual/navigation.rst index de31a368..bc25e9a9 100644 --- a/docsrc/manual/navigation.rst +++ b/docsrc/manual/navigation.rst @@ -81,7 +81,7 @@ The Tileset Editor can be opened with *File -> Tileset Editor*. When the Tilese Region Map Editor ----------------- -The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map. You can also modify the city map images using the bottom two panes. +The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map. You can also modify the city map images using the bottom two panes. Currently the Region Map Editor is only available for pokeemerald and pokeruby projects. .. figure:: images/navigation/region-map-editor.png :alt: Region Map Editor diff --git a/docsrc/manual/project-files.rst b/docsrc/manual/project-files.rst index 5c4fb0fa..92201854 100644 --- a/docsrc/manual/project-files.rst +++ b/docsrc/manual/project-files.rst @@ -19,10 +19,10 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note data/tilesets/graphics.inc, yes, yes, also edits palette and tile image files listed in this file data/tilesets/metatiles.inc, yes, yes, also edits metatile files listed in this file src/data/wild_encounters.json, yes, yes, - src/data/field_event_obj/event_object_graphics_info_pointers.h, yes, no, - src/data/field_event_obj/event_object_graphics_info.h, yes, no, - src/data/field_event_obj/event_object_pic_tables.h, yes, no, - src/data/field_event_obj/event_object_graphics.h, yes, no, + src/data/object_events/object_event_graphics_info_pointers.h, yes, no, + src/data/object_events/object_event_graphics_info.h, yes, no, + src/data/object_events/object_event_pic_tables.h, yes, no, + src/data/object_events/object_event_graphics.h, yes, no, src/data/graphics/pokemon.h, yes, no, for pokemon sprite icons src/data/heal_locations.h, yes, yes, src/data/region_map/region_map_entries.h, yes, yes, @@ -34,13 +34,13 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note include/constants/heal_locations.h, no, yes, include/constants/pokemon.h, yes, no, reads min and max level constants include/constants/map_types.h, yes, no, - include/constants/secret_bases.h, yes, no, - include/constants/event_object_movement_constants.h, yes, no, - include/constants/bg_event_constants.h, yes, no, + include/constants/trainer_types.h, yes, no, + include/constants/secret_bases.h, yes, no, pokeemerald and pokeruby only + include/constants/event_object_movement.h, yes, no, + include/constants/event_bg.h, yes, no, include/constants/region_map_sections.h, yes, no, include/constants/metatile_labels.h, yes, yes, include/constants/metatile_behaviors.h, yes, no, - include/constants/bg_event_constants.h, yes, no, include/fieldmap.h, yes, no, reads tileset related constants diff --git a/docsrc/manual/region-map-editor.rst b/docsrc/manual/region-map-editor.rst index 24642d19..418812e3 100644 --- a/docsrc/manual/region-map-editor.rst +++ b/docsrc/manual/region-map-editor.rst @@ -5,6 +5,9 @@ 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. +.. note:: + The region map editor is currently only available for pokeemerald and pokeruby. + When you first open the region map editor, your window will look like this: .. figure:: images/region-map-editor/rme-new-window.png