Merge pull request #110 from jbunke/0.5.0-dev-branch

0.5.0 dev branch

changelog.md

@@ -1,5 +1,76 @@
 # Changelog
 
+## **0.5.0** - 2024-06-12
+
+### Added:
+* Added tools
+  * Shape tool (hotkey *R*)
+  * Script brush (hotkey *Q*)
+* Polygon Select now has a "close polygon" shortcut (*Shift + Left Click*)
+* Images can now be pasted from the system clipboard
+* Added themes:
+  * Asylum
+  * Ramallah
+* Added "snap to target pixel" behaviour (*Shift + Enter*)
+* Stretch operation can now be snapped to the pixel grid by holding *Shift*
+* Added relative frame durations so some frames can be displayed for more or less time than others
+* Added history dialog (*Shift + Y*) where users can browse all cached project states and revert to any of them
+* Added playback controls to preview dialogs
+* Added keyboard controls to the preview window's playback controls
+
+### Changed:
+* Optimized selection overlays
+* Optimized selection logic
+* Optimized search algorithm (Wand and Fill tools)
+* Now discards intermediate (granular) project states after five new checkpoint project states
+* Updated themes:
+  * Zo
+  * Neon
+  * Bunkering
+* Move selection and pick up selection action previews are rendered in a different style
+* Changed frame limit from 100 to 300 and layer limit from 100 to 50
+* Increased maximum canvas bounds to 1920 x 1080 pixels
+* Improved selection transform node manipulation
+
+### Fixed:
+* Bug: PIXEL_GRID_ON_BY_DEFAULT setting flag is not persistent
+
+### API Changes:
+* Added:
+  * `project` frame duration functions:
+      * ```js
+        P.get_frame_duration(int i) -> float
+        ```
+      * ```js
+        P.get_frame_durations() -> float[]
+        ```
+      * ```js
+        P.set_frame_duration(int i, float frame_duration);
+        ```
+
+* Changed:
+  * Separated selection from scope in color actions
+      * Modified `scope` enumeration:
+        ```js
+        0: PROJECT
+        1: LAYER
+        2: FRAME
+        3: LAYER_FRAME
+        ```
+      * Changed `project` color action function signatures:
+          * ```js
+            P.palettize(palette pal, int scope, bool include_disabled, bool ignore_selection);
+            ```
+          * ```js
+            P.extract_to_pal(palette pal, int scope, bool include_disabled, bool ignore_selection);
+            ```
+          * ```js
+            P.hsv_shift(int scope, bool include_disabled, bool ignore_selection, int h_shift, N s_shift, N v_shift);
+            ```
+          * ```js
+            P.color_script(int scope, bool include_disabled, bool ignore_selection, string script_path);
+            ```
+
 ## **0.4.2** - 2024-05-26
 
 ### Added:
@@ -46,11 +117,11 @@
 * Added HSV level shifting
 * Added "Flatten project" layer action
 * Added themes
-  * Added "Zo" theme inspired by Haiti
+  * Added "Zo" theme inspired by Haitian culture and African diasporic religions
   * Added "Neon" theme
-  * Added "Bunkering" theme inspired by the environmental degradation the Niger Delta
+  * Added "Bunkering" theme inspired by the environmental degradation of the Niger Delta
 * Added transparency checkerboard to the color slider core
-* Dialog menus can now be closed by pressing {Enter} if the precondition is passing
+* Dialog menus can now be closed by pressing *Enter* if the precondition is passing
 * Added settings for windowed program size
 * Added flag to include or exclude disabled layers in color actions
 

res/blurbs/__changelog.txt

@@ -1,3 +1,61 @@
+{0.5.0} - The Performance Update - 2024-06-12
+
+Added:
+> Added tools
+  > Shape tool (hotkey {R})
+  > Script brush (hotkey {Q})
+> Polygon Select now has a "close polygon" shortcut ({Shift + Left Click})
+> Images can now be pasted from the system clipboard
+> Added themes:
+  > Asylum
+  > Ramallah
+> Added "snap to target pixel" behaviour ({Shift + Enter})
+> Stretch operation can now be snapped to the pixel grid by holding {Shift}
+> Added relative frame durations so some frames can be displayed for more or less time than others
+> Added history dialog ({Shift + Y}) where users can browse all cached project states and revert
+    to any of them
+> Added playback controls to preview dialogs
+> Added keyboard controls to the preview window's playback controls
+
+Changed:
+> Optimized selection overlays
+> Optimized selection logic
+> Optimized search algorithm (Wand and Fill tools)
+> Now discards intermediate (granular) project states after five new checkpoint project states
+> Updated themes:
+  > Zo
+  > Neon
+  > Bunkering
+> Move selection and pick up selection action previews are rendered in a different style
+> Changed frame limit from 100 to 300 and layer limit from 100 to 50
+> Increased maximum canvas bounds to 1920 x 1080 pixels
+> Improved selection transform node manipulation
+
+Fixed:
+> Bug: PIXEL_GRID_ON_BY_DEFAULT setting flag is not persistent
+
+API Changes:
+  Added:
+  > {project} frame duration functions:
+    > P.{get_frame_duration}(int i) -> float
+    > P.{get_frame_durations}() -> float[]
+    > P.{set_frame_duration}(int i, float frame_duration);
+
+  Changed:
+  > Separated selection from scope in color actions
+    > Modified {scope} enumeration:
+        {0: PROJECT}
+        {1: LAYER}
+        {2: FRAME}
+        {3: LAYER_FRAME}
+
+    > Changed {project} color action function signatures:
+      > P.{palettize}(palette pal, int scope, bool include_disabled, bool ignore_selection);
+      > P.{extract_to_pal}(palette pal, int scope, bool include_disabled, bool ignore_selection);
+      > P.{hsv_shift}(int scope, bool include_disabled, bool ignore_selection,
+          int h_shift, N s_shift, N v_shift);
+      > P.{color_script}(int scope, bool include_disabled, bool ignore_selection, string script_path);
+
 {0.4.2} - 2024-05-26
 
 Added:
@@ -41,9 +99,9 @@ Added:
 > Added HSV level shifting
 > Added "Flatten project" layer action
 > Added themes
-    > Added "Zo" theme inspired by Haiti
+    > Added "Zo" theme inspired by Haitian culture and African diasporic religions
     > Added "Neon" theme
-    > Added "Bunkering" theme inspired by the environmental degradation the Niger Delta
+    > Added "Bunkering" theme inspired by the environmental degradation of the Niger Delta
 > Added transparency checkerboard to the color slider core
 > Dialog menus can now be closed by pressing {Enter} if the precondition is passing
 > Added settings for windowed program size

res/blurbs/__general.txt

@@ -1,6 +1,7 @@
 Window / layout:
 Toggle fullscreen / windowed mode: {Escape}
 Recenter canvas in workspace: {Enter}
+Center the canvas around the target pixel: {Shift + Enter}
 Toggle show all UI / minimal UI mode: {Ctrl + Shift + A}
 Set checkerboard and pixel grid cell dimensions to project/selection bounds: {Ctrl + B}
 

res/blurbs/__roadmap.txt

@@ -1,17 +1,7 @@
 This is a rough outline of planned features and when to expect them. Everything you see here is
 subject to change.
 
-{0.5.0} - The Performance Update - Late May 2024
-
-Add:
-> Paste images from the system clipboard
-
-Change:
-> Implement massive performance optimizations to make the program faster and less demanding
-    on the machine
-> Overhaul the move selection and pick up selection tools
-
-Fix:
-> Memory issues and related crashes
-
-{1.0.0} - Official Release - Early June 2024
+{Q3 2024}
+> Timeline: frames and layers combined in a single UI panel
+> Lossless video export
+> Presets for common scriptable behaviours

res/blurbs/frame_properties.txt

@@ -0,0 +1,3 @@
+Shortcut: {Shift + F}
+
+Displays a dialog where the frame's properties can be modified

res/blurbs/history.txt

@@ -0,0 +1,3 @@
+Shortcut: {Shift + Y}
+
+Opens a dialog that lists all the retained major project states, any of which can be reverted to.

res/blurbs/layer_settings.txt

@@ -1,5 +1,5 @@
 Shortcut: {Shift + L}
 
-Opens all the layer's settings and properties in one place
+Displays a dialog where the layer's settings and properties can be modified
 
 The layer's opacity can be adjusted from here.

res/blurbs/move_selection.txt

@@ -8,6 +8,7 @@ Move: {Click & Drag} or {Arrow Keys}
 * Only works with {Click & Drag}, not with {Arrow Keys}
 
 Stretch: {Click & Drag} on one of the transform nodes
+If the pixel grid is on, hold {Shift} to snap the stretch operation to the pixel grid.
 
 Rotate: {Click & Drag} around one of the transform nodes
 Modify the rotation operation to snap to the nearest 45-degree angle by holding {Shift}.

res/blurbs/pick_up_selection.txt

@@ -8,6 +8,7 @@ Move: {Click & Drag} or {Arrow Keys}
 * Only works with {Click & Drag}, not with {Arrow Keys}
 
 Stretch: {Click & Drag} on one of the transform nodes
+If the pixel grid is on, hold {Shift} to snap the stretch operation to the pixel grid.
 
 Rotate: {Click & Drag} around one of the transform nodes
 Modify the rotation operation to snap to the nearest 45-degree angle by holding {Shift}.

res/blurbs/pixel_grid_on.txt

@@ -1,7 +1 @@
 Toggle pixel grid on/off: {Ctrl + G}
-
-The pixel grid can only be displayed at a minimum zoom level of {400%}. The amount of pixels between
-each grid along the X and Y axes can be set in the program settings.
-
-Due to performance considerations, the pixel grid can currently only be turned on for projects with
-a maximum canvas size of {128x128 pixels}.

res/blurbs/polygon_select.txt

@@ -5,6 +5,7 @@ the bounds of the selection. To close the polygon, place a vertex down on the sa
 the shape began.
 
 Place vertex: {Left Click}
+Close polygon: {Shift + Left Click}
 Remove previous vertex: {Right Click}
 Reset: {Middle Click}
 

res/blurbs/script_brush.txt

@@ -0,0 +1,12 @@
+Shortcut: {Q}
+
+The script brush paints applies a color script transformation to the pixel that it paints over.
+
+Use existing color as input: {Click & Drag}
+
+Use primary color as input: {Shift + Left Click + Drag}
+Use secondary color as input: {Shift + Right Click + Drag}
+
+Hold {Ctrl} to ignore transparent pixels of the layer-frame.
+
+Increment/decrement brush width: {Arrow Keys} or {Shift + Scroll Wheel}

res/blurbs/shade_brush.txt

@@ -1,6 +1,6 @@
 Shortcut: {D}
 
-Works like the regular {brush} tool, but shifts the color of a pixel that is {drawn over} to one of
+Works like the regular {Brush} tool, but shifts the color of a pixel that is {painted over} to one of
 the colors next to it in the current palette {if the pixel's initial color is in the palette}.
 
 Replace with left-adjacent color in palette: {Left Click & Drag}

res/blurbs/shape_tool.txt

@@ -0,0 +1,10 @@
+Shortcut: {R}
+
+The shape tool plots a shape of a determined pixel width.
+
+Primary color: {Left Click & Drag}
+Secondary color: {Right Click & Drag}
+
+Snap a rectangle to a square or an ellipse to a circle by holding {Shift}.
+
+Increment/decrement brush width: {Arrow Keys} or {Shift + Scroll Wheel}

res/blurbs/text_tool.txt

@@ -10,7 +10,7 @@ Start typing: {Click}
 Increment/decrement font scale factor: {Down/Up Arrow Keys} or {Shift + Scroll Wheel}
 Navigate to previous/next font: {Left/Right Arrow Keys}
 Toggle text alignment: {Ctrl + K}
-Upload new font: {Shift + F}
+Upload new font: {Shift + T}
 
 (While typing)
     Modify text: < type as normal >

res/program

@@ -1,5 +1,5 @@
 name:{Stipple Effect}
-version:{0.4.2}
+version:{0.5.0}
 devbuild:{false}
-native_standard:{1.1}
+native_standard:{1.2}
 palette_standard:{1.0}

res/tooltips/frame_properties.txt

@@ -0,0 +1 @@
+Frame properties... | {Shift + F}

res/tooltips/history.txt

@@ -0,0 +1 @@
+History... | {Shift + Y}

res/tooltips/new_font.txt

@@ -1 +1 @@
-New font... | {Shift + F}
+New font... | {Shift + T}

res/tooltips/script_brush.txt

@@ -0,0 +1 @@
+Script Brush | {Q}

res/tooltips/shape_tool.txt

@@ -0,0 +1 @@
+Shape Tool | {R}

roadmap.md

@@ -3,17 +3,7 @@
 This is a rough outline of planned features and when to expect them. Everything you see here is
 subject to change.
 
-## **0.5.0** - The Performance Update - Late May 2024
-
-### Add:
-* Paste images from the system clipboard
-
-### Change:
-* Implement massive performance optimizations to make the program faster and less demanding
-on the machine
-* Overhaul the move selection and pick up selection tools
-
-### Fix:
-* Memory issues and related crashes
-
-## **1.0.0** - Official Release - Early June 2024
+## Q3 2024
+* Timeline: frames and layers combined in a single UI panel
+* Lossless video export
+* Presets for common scriptable behaviours