Skip to content

Commit

Permalink
Release 5.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
huderlem committed Jan 22, 2023
1 parent 7d36994 commit cdd21cb
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 7 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,14 @@ and this project somewhat adheres to [Semantic Versioning](https://semver.org/sp
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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.

## [Unreleased]
Nothing, yet.

## [5.1.0] - 2023-01-22
### Added
- Add new config options for reorganizing metatile attributes.
- Add `setScale` to the scripting API.
- Add option to turn off the checkerboard fill for new tilesets.
- Add option (via right-click) to copy wild encounters from another tab.
- Add option to copy wild encounters from another encounters tab.

### Changed
- Double-clicking on a connecting map on the Map or Events tabs will now open that map.
Expand Down Expand Up @@ -370,7 +373,8 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
## [1.0.0] - 2018-10-26
This was the initial release.

[Unreleased]: https://github.com/huderlem/porymap/compare/5.0.0...HEAD
[Unreleased]: https://github.com/huderlem/porymap/compare/5.1.0...HEAD
[5.1.0]: https://github.com/huderlem/porymap/compare/5.0.0...5.1.0
[5.0.0]: https://github.com/huderlem/porymap/compare/4.5.0...5.0.0
[4.5.0]: https://github.com/huderlem/porymap/compare/4.4.0...4.5.0
[4.4.0]: https://github.com/huderlem/porymap/compare/4.3.1...4.4.0
Expand Down
29 changes: 24 additions & 5 deletions forms/aboutporymap.ui
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
</font>
</property>
<property name="text">
<string>Version 5.0.0 - October 30th, 2022</string>
<string>Version 5.1.0 - January 22nd, 2022</string>
</property>
<property name="alignment">
<set>Qt::AlignCenter</set>
Expand Down Expand Up @@ -112,12 +112,32 @@ p, li { white-space: pre-wrap; }
&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;All notable changes to this project will be documented in this file.&lt;/p&gt;
&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;The format is based on &lt;a href=&quot;https://keepachangelog.com/en/1.0.0/&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;Keep a Changelog&lt;/span&gt;&lt;/a&gt;,and this project somewhat adheres to &lt;a href=&quot;https://semver.org/spec/v2.0.0.html&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;Semantic Versioning&lt;/span&gt;&lt;/a&gt;. The MAJOR version number is bumped when there are breaking changes in the pret projects.&lt;/p&gt;
&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;The &lt;span style=&quot; font-weight:600;&quot;&gt;&amp;quot;Breaking Changes&amp;quot;&lt;/span&gt; listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.&lt;/p&gt;
&lt;h2 style=&quot; margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;-unreleased-&quot;&gt;&lt;/a&gt;&lt;a href=&quot;https://github.com/huderlem/porymap/compare/5.0.0...HEAD&quot;&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;U&lt;/span&gt;&lt;/a&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;nreleased&lt;/span&gt;&lt;/h2&gt;
&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Nothing, yet.&lt;/p&gt;
&lt;h2 style=&quot; margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;-5-1-0-2023-01-22&quot;&gt;&lt;/a&gt;&lt;a href=&quot;https://github.com/huderlem/porymap/compare/5.0.0...5.1.0&quot;&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;5&lt;/span&gt;&lt;/a&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;.1.0&lt;/span&gt;&lt;span style=&quot; font-size:x-large; font-weight:600;&quot;&gt; - 2023-01-22&lt;/span&gt;&lt;/h2&gt;
&lt;h3 style=&quot; margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;added&quot;&gt;&lt;/a&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;A&lt;/span&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;dded&lt;/span&gt;&lt;/h3&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add new config options for reorganizing metatile attributes.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add &lt;span style=&quot; font-family:'Courier New';&quot;&gt;setScale&lt;/span&gt; to the scripting API.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add option to turn off the checkerboard fill for new tilesets.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add option to copy wild encounters from another encounters tab.&lt;/li&gt;&lt;/ul&gt;
&lt;h3 style=&quot; margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;changed&quot;&gt;&lt;/a&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;C&lt;/span&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;hanged&lt;/span&gt;&lt;/h3&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Double-clicking on a connecting map on the Map or Events tabs will now open that map.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Hovering on border metatiles with the mouse will now display their information in the bottom bar.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;The last-used directory is now preserved in import/export file dialogs.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Encounter editing has been slightly modified in favor of a more performant ui.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Pokémon icons in the encounter editor have their transparency set.&lt;/li&gt;&lt;/ul&gt;
&lt;h3 style=&quot; margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;fixed&quot;&gt;&lt;/a&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;F&lt;/span&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;ixed&lt;/span&gt;&lt;/h3&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix the Region Map Editor being opened by the Shortcuts Editor.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix New Map settings being preserved when switching projects.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix scripting API callback &lt;span style=&quot; font-family:'Courier New';&quot;&gt;onMapResized&lt;/span&gt; not triggering.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix crash when importing AdvanceMap metatiles while &lt;span style=&quot; font-family:'Courier New';&quot;&gt;enable_triple_layer_metatiles&lt;/span&gt; is enabled.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix &lt;span style=&quot; font-family:'Courier New';&quot;&gt;File -&amp;gt; Open Project&lt;/span&gt; not resolving folder shortcuts.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix bug where &amp;quot;Requires Itemfinder&amp;quot; checkbox is being checked by wrong data.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix the map border not immediately reflecting Tileset Editor changes.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Fix pasting metatiles in the Tileset Editor not triggering the unsaved changes warning.&lt;/li&gt;&lt;/ul&gt;
&lt;h2 style=&quot; margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;-5-0-0-2022-10-30&quot;&gt;&lt;/a&gt;&lt;a href=&quot;https://github.com/huderlem/porymap/compare/4.5.0...5.0.0&quot;&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;5&lt;/span&gt;&lt;/a&gt;&lt;span style=&quot; font-size:x-large; font-weight:600; text-decoration: underline; color:#0000ff;&quot;&gt;.0.0&lt;/span&gt;&lt;span style=&quot; font-size:x-large; font-weight:600;&quot;&gt; - 2022-10-30&lt;/span&gt;&lt;/h2&gt;
&lt;h3 style=&quot; margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;breaking-changes&quot;&gt;&lt;/a&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;B&lt;/span&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;reaking Changes&lt;/span&gt;&lt;/h3&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Proper support for pokefirered's clone objects was added, which requires the changes made in &lt;a href=&quot;https://github.com/pret/pokefirered/pull/484&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;pokefirered/#484&lt;/span&gt;&lt;/a&gt;.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Warp IDs are now treated as strings, which requires the change to &lt;span style=&quot; font-family:'Courier New';&quot;&gt;mapjson&lt;/span&gt; made in &lt;a href=&quot;https://github.com/pret/pokeemerald/pull/1755&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;pokeemerald/#1755&lt;/span&gt;&lt;/a&gt;. Additionally &lt;span style=&quot; font-family:'Courier New';&quot;&gt;MAP_NONE&lt;/span&gt; was renamed to &lt;span style=&quot; font-family:'Courier New';&quot;&gt;MAP_DYNAMIC&lt;/span&gt;. Both changes also apply to pokefirered and pokeruby.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered. Requires the changes made in &lt;a href=&quot;https://github.com/pret/pokeemerald/pull/1651&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;pokeemerald/#1651&lt;/span&gt;&lt;/a&gt;, &lt;a href=&quot;https://github.com/pret/pokefirered/pull/500&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;pokefirered/#500&lt;/span&gt;&lt;/a&gt;, or &lt;a href=&quot;https://github.com/pret/pokeruby/pull/842&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;pokeruby/#842&lt;/span&gt;&lt;/a&gt;.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Many API functions which were previously accessible via the &lt;span style=&quot; font-family:'Courier New';&quot;&gt;map&lt;/span&gt; object are now accessible via one of the new objects &lt;span style=&quot; font-family:'Courier New';&quot;&gt;overlay&lt;/span&gt;, &lt;span style=&quot; font-family:'Courier New';&quot;&gt;utility&lt;/span&gt;, or &lt;span style=&quot; font-family:'Courier New';&quot;&gt;constants&lt;/span&gt;. Some functions were renamed accordingly. See &lt;a href=&quot;https://github.com/huderlem/porymap/pull/460&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;porymap/#460&lt;/span&gt;&lt;/a&gt; for a full list of API function name changes.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Arguments for the API function &lt;span style=&quot; font-family:'Courier New';&quot;&gt;createImage&lt;/span&gt; have changed: &lt;span style=&quot; font-family:'Courier New';&quot;&gt;xflip&lt;/span&gt; and &lt;span style=&quot; font-family:'Courier New';&quot;&gt;yflip&lt;/span&gt; have been replaced with &lt;span style=&quot; font-family:'Courier New';&quot;&gt;hScale&lt;/span&gt; and &lt;span style=&quot; font-family:'Courier New';&quot;&gt;vScale&lt;/span&gt;, and &lt;span style=&quot; font-family:'Courier New';&quot;&gt;offset&lt;/span&gt; has been replaced with &lt;span style=&quot; font-family:'Courier New';&quot;&gt;xOffset&lt;/span&gt; and &lt;span style=&quot; font-family:'Courier New';&quot;&gt;yOffset&lt;/span&gt;.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;The API function &lt;span style=&quot; font-family:'Courier New';&quot;&gt;addFilledRect&lt;/span&gt; has been removed; it's been replaced by new arguments in &lt;span style=&quot; font-family:'Courier New';&quot;&gt;addRect&lt;/span&gt;: &lt;span style=&quot; font-family:'Courier New';&quot;&gt;color&lt;/span&gt; has been replaced with &lt;span style=&quot; font-family:'Courier New';&quot;&gt;borderColor&lt;/span&gt; and &lt;span style=&quot; font-family:'Courier New';&quot;&gt;fillColor&lt;/span&gt;, and a new &lt;span style=&quot; font-family:'Courier New';&quot;&gt;rounding&lt;/span&gt; argument allows ellipses to be drawn.&lt;/li&gt;&lt;/ul&gt;
Expand All @@ -130,8 +150,7 @@ p, li { white-space: pre-wrap; }
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add color picker to palette editor for taking colors from the screen.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Add new features to the scripting API, including the ability to display messages and user input windows, set the overlay's opacity, rotation, scale, and clipping, interact with map header properties and the map border, read tile pixel data, and more.&lt;/li&gt;&lt;/ul&gt;
&lt;h3 style=&quot; margin-top:14px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a name=&quot;changed&quot;&gt;&lt;/a&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;C&lt;/span&gt;&lt;span style=&quot; font-size:large; font-weight:600;&quot;&gt;hanged&lt;/span&gt;&lt;/h3&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Overhauled the region map editor, adding support for tilemaps, and significant customization. Also now supports pokefirered.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Previous settings will be remembered in the New Map Options window.&lt;/li&gt;
&lt;ul style=&quot;margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px; -qt-list-indent: 1;&quot;&gt;&lt;li style=&quot;&quot; style=&quot; margin-top:12px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Previous settings will be remembered in the New Map Options window.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;The Custom Attributes table for map headers and events now supports types other than strings.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;If an object event is inanimate, it will always render using its first frame.&lt;/li&gt;
&lt;li style=&quot;&quot; style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Unused metatile attribute bits are preserved instead of being cleared.&lt;/li&gt;
Expand Down

0 comments on commit cdd21cb

Please sign in to comment.