Merge branch 'dev' of https://github.com/huderlem/porymap

Author: GriffinRichards

CHANGELOG.md

@@ -5,7 +5,58 @@ 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 MAJOR version number is bumped when there are **"Breaking Changes"** in the pret projects. For more on this, see [the manual page on breaking changes](https://huderlem.github.io/porymap/manual/breaking-changes.html).
 
 ## [Unreleased]
-Nothing, yet.
+### Added
+- Add `View > Show Unused Colors` to the Palette Editor.
+- Add `Tools > Find Color Usage` to the Palette Editor. This opens a dialog showing which metatiles use a particular color.
+- Add `Edit > Swap Metatiles` to the Tileset Editor. While in this mode, selecting two metatiles in the selector will swap their positions. When changes to the tilesets are saved these relocations will be applied to all layouts that use the relevant tileset(s).
+- Add `View > Layer Arrangement` to the Tileset Editor, which changes whether the metatile layer view is oriented vertically (default) or horizontally.
+- Add an `Export Metatiles Image` option to the Tileset Editor that provides many more options for customizing metatile images.
+- Add an `Export Porytiles Layer Images` option to the Tileset Editor, which is a shortcut for individually exporting layer images that Porytiles can use.
+- Add an option under `Preferences` to include common scripts in the autocomplete for Script labels.
+- Add a setting under `Project Settings` to change the width of the metatile selectors.
+- Add versions of the API functions `[get|set]MetatileLayerOrder` and `[get|set]MetatileLayerOpacity` that work globally, rather than on individual layouts.
+- A link to Porymap's manual is now available under `Help`.
+
+### Changed
+- The Player View Rectangle is now visible on the Events tab, as is the Cursor Tile Outline for certain tools.
+- When hovering over tiles in the Tileset Editor their palette and x/yflip are now listed alongside the tile ID.
+- The scroll position of the map view now remains the same between the Connections tab and the Map/Events tabs.
+- The Move tool now behaves more like a traditional pan tool (with no momentum).
+- The map image exporter now uses a checkered background to indicate transparency.
+- Invalid tile IDs are now rendered as magenta (like invalid metatiles), instead of rendering the same as a transparent tile.
+- While holding down `Ctrl` (`Cmd` on macOS) painting on the metatile layer view will now only change the tile's palette.
+- Full menu paths are now listed for shortcuts in the Shortcuts Editor.
+- Adding new event data to a map that has a `shared_events_map` will now remove the `shared_events_map`, rather than discard the event data.
+
+### Fixed
+- Fix crash when rendering tiles with invalid palette numbers.
+- Fix crash when opening the Tileset Editor for tilesets with no metatiles.
+- Fix crash when changing the map/border size in certain API callbacks.
+- Fix metatile images exporting at 2x scale.
+- Fix display errors when a project's metatile limits are not divisible by 8.
+- Fix incorrect dividing line position for primary tiles images that are smaller than the maximum size.
+- Fix the checkered background of the `Change Dimensions` popup shifting while scrolling around.
+- Fix pasting Wild Pokémon data then changing maps resetting the pasted data.
+- Fix click-drag map selections behaving unexpectedly when the cursor is outside the map grid.
+- Fix events being dragged in negative coordinates lagging behind the cursor.
+- Fix the shortcut for duplicating events working while on the Connections tab.
+- Fix the Shortcuts Editor displaying the duplicate shortcut prompt repeatedly.
+- Fix the clear text button on the left in each row of the Shortcuts Editor also clearing the shortcut on the right.
+- Fix Undo/Redo ignoring the automatic resizing that occurs if a layout/border was an unexpected size.
+- Fix Undo/Redo in the Tileset and Palette Editors and Paste in the Tileset Editor appearing enabled even when they don't do anything.
+- Fix `Ctrl+Shift+Z` not being set as a default shortcut for Redo in the Palette Editor like it is for other windows.
+- Fix the Tileset Editor's status bar not updating while selecting tiles in the metatile layer view, or when pasting metatiles.
+- Fix the main window's status bar not immediately reflecting changes made while painting metatiles / movement permissions.
+- Fix cleared metatile labels not updating until the project is reloaded.
+- Fix some changes in the Tileset Editor being discarded if the window is closed too quickly.
+- Fix the Region Map Editor incorrectly displaying whether a `MAPSEC` has region map data.
+- Fix the Primary/Secondary Tileset selectors allowing invalid text, and considering a map unsaved if changed to invalid text then back again.
+- Fix broken error message for the primary tileset on the new map/layout dialogs.
+- Fix the dialog for duplicating/importing a map layout not allowing the tilesets to be changed.
+- Fix warning not appearing when the log file exceeds maximum size.
+- Fix possible lag while using the Tileset Editor's tile selector.
+- Fix unnecessary resources being used to watch files.
+- Fix possible crash on Linux if too many inotify instances are requested.
 
 ## [6.1.0] - 2025-06-09
 ### Added

docsrc/manual/scripting-capabilities.rst

@@ -11,6 +11,9 @@ Porymap is extensible via scripting capabilities. This allows the user to write
 - Procedurally Generated Maps
 - Randomize Grass Patterns
 
+.. note::
+    If you are compiling Porymap yourself, these features will only be available if Qt's ``qml`` module is installed.
+
 
 Custom Scripts Editor
 ---------------------
@@ -1222,6 +1225,58 @@ All tileset functions are callable via the global ``map`` object.
    :returns: the pixel data
    :rtype: array
 
+.. |describe-metatile-layer-order|
+   replace:: where ``0`` is the bottom layer, ``1`` is the middle layer, and ``2`` is the top layer. The default order is ``[0, 1, 2]``
+
+.. |describe-metatile-layer-order-handling|
+   replace:: If no elements are provided the layer order will be reset to the default. Any layer not listed in the provided ``order`` will not be rendered. Any additional elements after the first 3 are ignored
+
+.. js:function:: map.getMetatileLayerOrder()
+
+   Gets the order that metatile layers are rendered for the current layout, |describe-metatile-layer-order|.
+
+   If you'd like to get the default metatile layer order for all layouts, see :js:func:`utility.getMetatileLayerOrder` instead.
+
+   :returns: array of layers
+   :rtype: array
+
+.. js:function:: map.setMetatileLayerOrder(order)
+
+   Sets the order that metatile layers are rendered for the current layout, |describe-metatile-layer-order|.
+
+   |describe-metatile-layer-order-handling|.
+
+   If you'd like to set the default metatile layer order for all layouts, see :js:func:`utility.setMetatileLayerOrder` instead.
+
+   :param order: array of layers
+   :type order: array
+
+.. |describe-metatile-layer-opacity|
+   replace:: where the first element is the bottom layer, the second element is the middle layer, and the third element is the top layer. The default opacities are ``[1.0, 1.0, 1.0]``
+
+.. |describe-metatile-layer-opacity-handling|
+   replace:: Any additional elements after the first 3 are ignored. Any elements not provided will be rendered with opacity ``1.0``
+
+.. js:function:: map.getMetatileLayerOpacity()
+
+   Gets the opacities that metatile layers are rendered with for the current layout, |describe-metatile-layer-opacity|.
+
+   If you'd like to get the default metatile layer opacities for all layouts, see :js:func:`utility.getMetatileLayerOpacity` instead.
+
+   :returns: array of opacities for each layer
+   :rtype: array
+
+.. js:function:: map.setMetatileLayerOpacity(opacities)
+
+   Sets the opacities that metatile layers are rendered with for the current layout, |describe-metatile-layer-opacity|.
+
+   |describe-metatile-layer-opacity-handling|.
+
+   If you'd like to set the default metatile layer opacities for all layouts, see :js:func:`utility.setMetatileLayerOpacity` instead.
+
+   :param opacities: array of opacities for each layer
+   :type opacities: array
+
 Overlay Functions
 ^^^^^^^^^^^^^^^^^
 
@@ -1811,30 +1866,42 @@ All settings functions are callable via the global ``utility`` object.
 
 .. js:function:: utility.getMetatileLayerOrder()
 
-   Gets the order that metatile layers are rendered.
+   Gets the order that metatile layers are rendered by default, |describe-metatile-layer-order|.
 
-   :returns: array of layers. The bottom layer is represented as 0.
+   If you'd like to get the metatile layer order for only the current layout, see :js:func:`map.getMetatileLayerOrder` instead.
+
+   :returns: array of layers
    :rtype: array
 
 .. js:function:: utility.setMetatileLayerOrder(order)
 
-   Sets the order that metatile layers are rendered.
+   Sets the order that metatile layers are rendered by default, |describe-metatile-layer-order|.
+
+   |describe-metatile-layer-order-handling|.
 
-   :param order: array of layers. The bottom layer is represented as 0.
+   If you'd like to set the metatile layer order for only the current layout, see :js:func:`map.setMetatileLayerOrder` instead.
+
+   :param order: array of layers
    :type order: array
 
 .. js:function:: utility.getMetatileLayerOpacity()
 
-   Gets the opacities that metatile layers are rendered with.
+   Gets the opacities that metatile layers are rendered with by default, |describe-metatile-layer-opacity|.
+
+   If you'd like to get the metatile layer opacities for only the current layout, see :js:func:`map.getMetatileLayerOpacity` instead.
 
-   :returns: array of opacities for each layer. The bottom layer is the first element.
+   :returns: array of opacities for each layer
    :rtype: array
 
 .. js:function:: utility.setMetatileLayerOpacity(opacities)
 
-   Sets the opacities that metatile layers are rendered with.
+   Sets the opacities that metatile layers are rendered with by default, |describe-metatile-layer-opacity|.
+
+   |describe-metatile-layer-opacity-handling|.
+
+   If you'd like to set the metatile layer opacities for only the current layout, see :js:func:`map.setMetatileLayerOpacity` instead.
 
-   :param opacities: array of opacities for each layer. The bottom layer is the first element.
+   :param opacities: array of opacities for each layer
    :type opacities: array
 
 

forms/mainwindow.ui

@@ -1638,9 +1638,6 @@
                     </item>
                     <item row="1" column="0">
                      <widget class="QLabel" name="label_NoEvents">
-                      <property name="text">
-                       <string>There are no events on the current map.</string>
-                      </property>
                       <property name="alignment">
                        <set>Qt::AlignmentFlag::AlignCenter</set>
                       </property>
@@ -2926,6 +2923,7 @@
      <string>Help</string>
     </property>
     <addaction name="actionAbout_Porymap"/>
+    <addaction name="actionOpen_Manual"/>
     <addaction name="actionOpen_Log_File"/>
     <addaction name="actionOpen_Config_Folder"/>
     <addaction name="actionCheck_for_Updates"/>
@@ -3267,6 +3265,11 @@
     <string>Alt+Right</string>
    </property>
   </action>
+  <action name="actionOpen_Manual">
+   <property name="text">
+    <string>Open Manual</string>
+   </property>
+  </action>
  </widget>
  <layoutdefault spacing="6" margin="11"/>
  <customwidgets>