Update changelog and manual
This commit is contained in:
parent
f70e77ab66
commit
9927d66389
5 changed files with 23 additions and 8 deletions
10
CHANGELOG.md
10
CHANGELOG.md
|
@ -8,10 +8,14 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
### Added
|
### Added
|
||||||
|
- Redesigned the Connections tab, adding a number of new features including the option to open or display diving maps and a list UI for easier edit access.
|
||||||
- Add a `Close Project` option
|
- Add a `Close Project` option
|
||||||
- An alert will be displayed when attempting to open a seemingly invalid project.
|
- An alert will be displayed when attempting to open a seemingly invalid project.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
- Edits to map connections now have Undo/Redo and can be viewed in exported timelapses.
|
||||||
|
- Changes to the "Mirror to Connecting Maps" setting will now be saved between sessions.
|
||||||
|
- A notice will be displayed when attempting to open the "Dyamic" map, rather than nothing happening.
|
||||||
- The base game version is now auto-detected if the project name contains only one of "emerald", "firered/leafgreen", or "ruby/sapphire".
|
- The base game version is now auto-detected if the project name contains only one of "emerald", "firered/leafgreen", or "ruby/sapphire".
|
||||||
- It's now possible to cancel quitting if there are unsaved changes in sub-windows.
|
- It's now possible to cancel quitting if there are unsaved changes in sub-windows.
|
||||||
|
|
||||||
|
@ -25,6 +29,12 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
|
||||||
- Fix `About porymap` opening a new window each time it's activated.
|
- Fix `About porymap` opening a new window each time it's activated.
|
||||||
- Fix the `Edit History` window not raising to the front when reactivated.
|
- Fix the `Edit History` window not raising to the front when reactivated.
|
||||||
- New maps are now always inserted in map dropdowns at the correct position, rather than at the bottom of the list until the project is reloaded.
|
- New maps are now always inserted in map dropdowns at the correct position, rather than at the bottom of the list until the project is reloaded.
|
||||||
|
- Fix changes to map connections not marking connected maps as unsaved.
|
||||||
|
- Fix numerous issues related to connecting a map to itself.
|
||||||
|
- Fix incorrect map connections getting selected when opening a map by double-clicking a map connection.
|
||||||
|
- Fix a visual issue when quickly dragging map connections around.
|
||||||
|
- Fix map connections rendering incorrectly if their direction name was unknown.
|
||||||
|
- Fix map connections rendering incorrectly if their dimensions were smaller than the border draw distance.
|
||||||
|
|
||||||
## [5.4.1] - 2024-03-21
|
## [5.4.1] - 2024-03-21
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
|
@ -2,35 +2,40 @@
|
||||||
Editing Map Connections
|
Editing Map Connections
|
||||||
***********************
|
***********************
|
||||||
|
|
||||||
Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.
|
Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.
|
||||||
|
|
||||||
.. figure:: images/editing-map-connections/map-connections.png
|
.. figure:: images/editing-map-connections/map-connections.png
|
||||||
:alt: Map Connections View
|
:alt: Map Connections View
|
||||||
|
|
||||||
Map Connections View
|
Map Connections View
|
||||||
|
|
||||||
A connection has a direction, offset, and destination map. To add new connection, press the plus button |add-connection-button|. To delete a connection, select it and press the delete button |remove-connection-button|.
|
A connection has a direction, offset, and destination map. To add a new connection, press the |add-connection-button| button. To delete a connection you can either press the |remove-connection-button| button on its entry in the list, or select the connection and press the delete key.
|
||||||
|
|
||||||
|
The |open-connection-button| button will open the destination map. You may also open the destination map by double-clicking the connection itself (this can be done from the ``Map`` and ``Events`` tabs as well).
|
||||||
|
|
||||||
.. |add-connection-button|
|
.. |add-connection-button|
|
||||||
image:: images/editing-map-connections/add-connection-button.png
|
image:: images/editing-map-connections/add-connection-button.png
|
||||||
|
:height: 24
|
||||||
|
|
||||||
.. |remove-connection-button|
|
.. |remove-connection-button|
|
||||||
image:: images/editing-map-connections/remove-connection-button.png
|
image:: images/editing-map-connections/remove-connection-button.png
|
||||||
|
:height: 24
|
||||||
|
|
||||||
|
.. |open-connection-button|
|
||||||
|
image:: images/editing-map-connections/open-connection-button.png
|
||||||
|
:height: 24
|
||||||
|
|
||||||
To change the connection's vertical or horizontal offset, it's easiest to click and drag the connection to the desired offset.
|
To change the connection's vertical or horizontal offset, it's easiest to click and drag the connection to the desired offset.
|
||||||
|
|
||||||
Dive & Emerge Warps
|
Dive & Emerge Warps
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
Dive & emerge warps are used for the HM move Dive. They don't have offsets or directions--only a destination map. To add a dive or emerge warp, simply add a value in the Dive Map and/or Emerge Map dropdown menus.
|
Dive & emerge warps are used for the HM move Dive. They don't have offsets or directions--only a destination map. To add a dive or emerge warp, simply add a value in the Dive Map and/or Emerge Map dropdown menus.
|
||||||
|
|
||||||
|
You can select the ``Show Emerge/Dive Maps`` checkbox to view your connected dive/emerge maps overlaid on the current map. The slider will change the opacity of this overlay. If you have both an emerge and a dive map connected you will see two sliders; the top slider is for the emerge map's opacity, and the bottom slider is for the dive map's opacity.
|
||||||
|
|
||||||
|
|
||||||
Mirror Connections
|
Mirror Connections
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the top-right corner. Connections are one-way, which means that you must keep the two connections in sync between the two maps. For example, Petalburg City has a west connection to Route 104, and Route 104 has an east connection to Petalburg City. If *Mirror to Connecting Maps* is enabled, then Porymap will automatically update both sides of the connection. Be sure to *File -> Save All* (``Ctrl+Shift+S``) when saving, since you will need to save both maps' connections.
|
An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the top-right corner. Connections are one-way, which means that you must keep the two connections in sync between the two maps. For example, Petalburg City has a west connection to Route 104, and Route 104 has an east connection to Petalburg City. If *Mirror to Connecting Maps* is enabled, then Porymap will automatically update both sides of the connection. Be sure to *File -> Save All* (``Ctrl+Shift+S``) when saving, since you will need to save both maps' connections.
|
||||||
|
|
||||||
Follow Connections
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Warp Events <event-warps>`.
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 890 B After Width: | Height: | Size: 10 KiB |
Binary file not shown.
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 431 KiB |
Binary file not shown.
After Width: | Height: | Size: 5.5 KiB |
Loading…
Reference in a new issue