From b3b2873ae31639af8af8d03f0dc0ba52db875d1b Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 22 May 2023 09:44:35 +0200
Subject: [PATCH 01/13] Update readme.md
---
readme.md | 126 ++++++++++++++++++++++++++++++------------------------
1 file changed, 70 insertions(+), 56 deletions(-)
diff --git a/readme.md b/readme.md
index b604ae9..8b064e1 100644
--- a/readme.md
+++ b/readme.md
@@ -1,93 +1,107 @@
#### Introduction
-ppInk is an on-screen annotation software under Windows, forked from gInk.
+ppInk is a user-friendly on-screen annotation software for Windows, derived from gInk.
+It offers numerous new features inspired by Epic Pen, another screen annotation software, making it even easier to use.
+
-ppInk introduces many new features compared to gInk, greatly inspired by another
-screen annotation software Epic Pen, but even more easy to use. ppInk / gInk are
-made with the idea kept in mind that the interface should be simple and should
-not distract attention of both the presenter and the audience when used for
-presentations. Unlike in many other softwares in the same category, you select
-from pens to draw things instead of changing individual settings of color,
-transparency and tip width everytime. Each pen is a combination of these
-attributes and is configurable to your need.
+It offers numerous new features freely inspired from other application such as Epic Pen, making it even easier to use.
+ppInk/gInk is designed with simplicity in mind, ensuring it doesn't distract presenters or audiences during presentations. Instead of adjusting individual settings like color, transparency, and tip width, ppInk allows you to select different pens for drawing, each with configurable attributes.
-As another option you can use ppInk to support demonstrations:
+because of that ppInk can be used to annotate and then capture the screens, but it can also be used to support demonstration:
https://user-images.githubusercontent.com/4083478/119278023-16f58b00-bc23-11eb-95de-9dc16505bf43.mp4
(extract from @NOVAinc on Twitch)
other demo : https://www.twitch.tv/novaaoe/clip/PlacidConcernedBulgogiOptimizePrime-mONUtlMLGvu2uUu1
-This tool is intended to be usable through mouse,tablet pen(taking into pressure) but also throug touchscreen or graphic tablet.
-
-A set of drawing tools are introduced: Hand Writing, Line (2 points and polyline), Rectangular,
-Ellipsis, Arrow, Numbering Tag, Text Left/Right aligned, cliparts, strokes of patterns and move/copy/resize/rotate.
+This tool is intended to be usable through mouse,tablet pen(taking into pressure) but also throug touchscreen or graphic tablet, and keyboard can be used to activate functions.
+It provides a variety of drawing tools, including hand writing, lines (2 points and polyline), rectangles, ellipses, arrows, numbering tags, left/right aligned text, cliparts, stroke patterns, and move/copy/resize/rotate functions.
-In order to reduce the number of buttons, some buttons have multiple functions,
-selected my multiple click on those or some through long click (**or right click as an alternative**):
+To streamline the interface, some buttons have multiple functions that can be accessed through multiple clicks or long clicks (or right clicks).
-- Pen:
- Short click : select Pen
- Long Click : Open the pen parameters dialog
+* **Pen**:
-- Hand 
-/ Rectangular 
-/ Ellipsis 
-:
- unfilled drawing -\> filled with pen color -\> outside filled with pen color -\> filled with white -\> filled
- with black
+ Short click : select Pen
+ Long Click / Right click : Open the pen parameters dialog
-- Line
-:
- 2 points -\> polyline -\> pen color filled polygon -\> white filled polygon -\> black filled polygon
-
-- Numbering :
- transparent background -\> edit tag Number -\> white background -\> black background
+|**Hand**||
+|**Rectangular**||
+|**Ellipsis**||
+
+ any click: select next tool in the following order:
+ line stroke -\> pen color filled area -\> pen color the background but the drawn area -\> white filled area -\> black filled
+ area
+ in line stroke, all line style are applied.
+
+* **Line** :
+ segment line -\> polyline -\> pen color filled polygon -\> pen color background but polygon -\> white filled polygon -\> black filled polygon
-- Arrow :
- arrows heads and tails are now customizable. multiple click will scroll through the different arrows. you can select the ends either in options/general, or with a long press on the arrow button.
- the definition image shall be 300x201 and a line size of 18px(the image will be shrinked/enlarged to match the curren pen size). the center correspond to the visual end. the line will be ended a little before center by default, but you can define a different position with a blue pixel on line 101 (centered line). normally the ends will be rotated to be aligned with the line, except if the filename of the image is starting with !(eg to have always horizontal square)
- 
+* **Numbering** :
+ transparent background -\> **modify** tag Number -\> white background -\> black background
-- Text:
+* **Arrow** :
+ clicking multiple times will scroll through different arrow styles. To select the ends, you have two options: either go to 'Options/General' or perform a long press on the arrow button.
+
+ Arrow heads and tails can be customized. Multiple clicks will cycle through different arrow options. You can adjust the list of arrow heads either in the options/general settings or by long-pressing the arrow button.
+The arrow heads are defined by 300x201px images. These images are designed for an 18px wide line. The drawn image will be resized to match the current pen size. The arrow head image is centered on the reference points, which correspond to where the cursor starts or stops the line. On the center line (line 101) of the image, a blue pixel (R=0, G=0, B=255) is expected to indicate where the line should end. If this reference point cannot be found, the center of the image is considered.
+By default, the arrow heads are rotated to align with the line. However, if the name of the head definition image starts with an exclamation mark (!), the rotation will be ignored. This is useful for lines where the end is a square that should remain horizontal.
+
+
+ When drawing an arrow using the left button, the arrow tail is positioned where you initially pressed the button, and the arrow head is placed where you release the button.
+ If you are using the right button, the arrow is drawn in the head and the tail are exchanged.
+ (note : _remember that a long press on touch screen wil engage a right click_)
+
+
+* Text:
Text left aligned -\> Text Right aligned
- You can now use ctrl+enter to validate the entry
+ You can use ctrl+enter to validate the entry
-- Move:
+* Move: :
Move 1 drawing -\> Copy 1 drawing -\> Move all drawings.
-- Edit:
- Short click : modify text/number tool (text and font) *or* the color/pen width of a stroke
- Long click : edit default font (for the time of the session)
- if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
-
-- Lasso:
- Allow selection of multiple stroke either with the lasso, or clicking on strokes (surrounded). left click for lasso/selection will add to selection, and right click will substract (for touchscreen, remember that longclick is engaging rightclick).\
- Each time you click on lasso tool or use shortcut the selection is reset.
+* Lasso:
+ Allows selection of multiple strokes/drawings.
+ you can extend(left button) or reduce(right button) the selection by:
+ * outlining strokes with the lasso ; right click shows a pink outline to indicate substraction,
+ * clicking on strokes (marked by a red dash box where hovering them).
+
+ * right clicking will remove the hovered for lasso/selection will add to selection, and right click will substract (for touchscreen, remember that longclick is engaging rightclick).\
+ Each time you click on lasso tool(or use the shortcut),the selection is reset.
Once you have just added a stroke with the lasso, you can use undo to cancel this selection modification
In lasso mode, the global length is reported in a tooltip.
- After lasso selection, you can:
- * engage Erase to delete selection
- * engage move/copy to move/copy selection
- * engage edit to modify color/line style/width of the selected strokes
+ 
+ if the drawing is a 2 segment polyline, the angle will also be displayed
+ 
+
+ When you have selected some drawing,
+ * engage Erase tool : will delete selected objects
+ * engage move or copy tool : will move/copy the selected objects
+ * engage edit tool : will modify color/line style/width of the selected strokes
+
+* Edit:
+ Short click : modify text/number tool (text and font) *or* the color/pen width of a stroke
+ Long/right click : edit default font (for the duration of the session only)
+ if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
-- Resize / Rotate:
+* Resize / Rotate:
Allow to resize or rotate the selection (also applies to stroke under the cursor if no selection has been done first).
- First the cursor becomes a target in order,waiting for the center for the transformation with left click, or you can right click: in this case the center will be the center of the selected stroke(s)
- Then the cursor becomes an arrow, and you adjust the size or the angle.
+ To set the transformation:
+ * the cursor becomes a target shape : indicate the center of the transformation : either a point or a drawing/selection in with case the center of the containing box is used:
+ then
+ * the cursor becomes a red big arrow : click and drag to scale/rotate the selected (if applicable) else the hovered drawing. this can be done many times
https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a976-d66a621f36ac.mp4
-- Pointer Mode (arrow cursor):
+* Pointer Mode :
Short click : engage Pointer Mode
Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
-- Pen Width:
+* Pen Width:
Short click : select Pen Width
- Long click : engage **color picker**: this functions allow to modify the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
+ Long/Right click : engage **color picker**: this functions allow to modify the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
- Cliparts:
Open the dialog to select image and the background/frame. This list displayed of cliparts is initialized from the list defined
From fa7a4f6e699f59e3f73d6d306d75a6e3d678a486 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 22 Apr 2024 23:05:35 +0200
Subject: [PATCH 02/13] Update readme.md
---
readme.md | 151 +++++++++++++++++++++++++++++++++++-------------------
1 file changed, 97 insertions(+), 54 deletions(-)
diff --git a/readme.md b/readme.md
index 8b064e1..c21645d 100644
--- a/readme.md
+++ b/readme.md
@@ -26,66 +26,109 @@ To streamline the interface, some buttons have multiple functions that can be ac
* **Pen**:
Short click : select Pen
- Long Click / Right click : Open the pen parameters dialog
-
-|**Hand**||
-|**Rectangular**||
-|**Ellipsis**||
-
- any click: select next tool in the following order:
- line stroke -\> pen color filled area -\> pen color the background but the drawn area -\> white filled area -\> black filled
- area
- in line stroke, all line style are applied.
+ Long Click / Right click : Open the pen parameters dialog
+
+ The pen setup (fading / width / line strokes) applies to the follwing drawings:
-* **Line** :
- segment line -\> polyline -\> pen color filled polygon -\> pen color background but polygon -\> white filled polygon -\> black filled polygon
+* **Hand**
+
+
+* **Rectangular**
+
+
+* **Ellipsis**
+
+
+for those three tools,
+ any click: select next tool in the following order:
+ colored border -\> colored (filled) area -\> outside filled(inner part remains empty) -\> colored border - white area -\> colored border - black area
+
+
+* **Line**
+
+ segment line -\> polyline -\> pen color filled polygon -\> outer filled polygon -\> colored border - white polygon -\> colored border - black polygon
+
+* **Numbering**
+ 
+
+ - Left click select the tool:
+ transparent background -\> **modify** tag Number -\> white background -\> black background
+ - Right/Long click opens the Dialogbox to modify the font/style used for the number tags.
+
+* **Arrow**
+ 
+ Arrow heads and tails can be customized, and you can cycle through different arrow options clicking .
+ To adjust the list of arrow heads, you have two options: Go to the options/general settings, or long-press the arrow button.
+
+ Arrow heads are defined by 300x201px images and designed for an 18px wide line. The drawn image will be resized to match the current pen size.
+ The arrow head image is centered on the reference points, which correspond to where the cursor starts or stops the line. This position should be marked on the image, on the center line (line 101) of the image,
+ by a blue pixel (R=0, G=0, B=255). If this reference point cannot be found, the center of the image is considered.
+
+ In standard, arrow heads are rotated to align with the line, but, if the arrow filename begins with an exclamation mark (!), the drawing remains horizontal.
+
+ When drawing an arrow on screen, if you press left button:
+ - The arrow tail is positioned where you initially pressed the button.
+ - The arrow head is placed where you release the button.
+ as an alternative, you can select the direction on the sub-toolbar (the arrow head is only selected on the button)
+
+ If you are using the right button, the arrow is drawn with the head and tail exchanged.(Note: _Remember that a long press on a touch screen will engage a right-click action._)
-* **Numbering** :
- transparent background -\> **modify** tag Number -\> white background -\> black background
+ a Right/Long click on the button will open the dialogbox to modify the arrow heads :
+ 
-* **Arrow** :
- clicking multiple times will scroll through different arrow styles. To select the ends, you have two options: either go to 'Options/General' or perform a long press on the arrow button.
-
- Arrow heads and tails can be customized. Multiple clicks will cycle through different arrow options. You can adjust the list of arrow heads either in the options/general settings or by long-pressing the arrow button.
-The arrow heads are defined by 300x201px images. These images are designed for an 18px wide line. The drawn image will be resized to match the current pen size. The arrow head image is centered on the reference points, which correspond to where the cursor starts or stops the line. On the center line (line 101) of the image, a blue pixel (R=0, G=0, B=255) is expected to indicate where the line should end. If this reference point cannot be found, the center of the image is considered.
-By default, the arrow heads are rotated to align with the line. However, if the name of the head definition image starts with an exclamation mark (!), the rotation will be ignored. This is useful for lines where the end is a square that should remain horizontal.
-
-
- When drawing an arrow using the left button, the arrow tail is positioned where you initially pressed the button, and the arrow head is placed where you release the button.
- If you are using the right button, the arrow is drawn in the head and the tail are exchanged.
- (note : _remember that a long press on touch screen wil engage a right click_)
+* **Text**
+ 
+
+ Any click select the text alignment.
+ left-aligned -\> Text Right-aligned
+
+ Once you will have selected the insert point a dialog box will allow you to type in the text and select properties:
+ 
+
+ While typing in the text, enter will jump to a new line, and ctrl+enter closes the dialog box
+
+* **Lasso**
+ 
+
+ Any click activates selection of multiple strokes/drawings.
+ Once the tool select, left click extend the selection, while right-click removes the drawings from the current selection.
+ You can either :
+ - surround strokes with the lasso (red/pink means add/remove) or
+ - click on strokes marked by a dash box where hovering.
+
+ Reselecting the tool will clear the selection.
+ Once you have modified the selection, you can use undo to cancel it.
+ If the measurement is activated (enabled in the Options):
+ In lasso mode, the global length is reported in a tooltip.
+
+ 
+
+ if the drawing is a 2 segment polyline, the angle will also be displayed
+
+ 
+
+ When you have selected some drawing,
+ * Erase tool : will delete selected objects
+ * move or copy tool : will move/copy the selected objects
+ * edit tool : will modify color/line style/width of the selected strokes
+
+* **Move**
+ 
+
+ Any clic select between the different tool
+ Move one or preselected drawing -\> Copy one or preselected drawing -\> Pan all drawings.
-* Text:
- Text left aligned -\> Text Right aligned
- You can use ctrl+enter to validate the entry
-* Move: :
- Move 1 drawing -\> Copy 1 drawing -\> Move all drawings.
-
-* Lasso:
- Allows selection of multiple strokes/drawings.
- you can extend(left button) or reduce(right button) the selection by:
- * outlining strokes with the lasso ; right click shows a pink outline to indicate substraction,
- * clicking on strokes (marked by a red dash box where hovering them).
-
- * right clicking will remove the hovered for lasso/selection will add to selection, and right click will substract (for touchscreen, remember that longclick is engaging rightclick).\
- Each time you click on lasso tool(or use the shortcut),the selection is reset.
- Once you have just added a stroke with the lasso, you can use undo to cancel this selection modification
- In lasso mode, the global length is reported in a tooltip.
- 
- if the drawing is a 2 segment polyline, the angle will also be displayed
- 
-
- When you have selected some drawing,
- * engage Erase tool : will delete selected objects
- * engage move or copy tool : will move/copy the selected objects
- * engage edit tool : will modify color/line style/width of the selected strokes
-
-* Edit:
- Short click : modify text/number tool (text and font) *or* the color/pen width of a stroke
- Long/right click : edit default font (for the duration of the session only)
- if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
+* **Edit**
+ 
+
+ -Left click : modify text/number tool (text and font) *or* the color/pen width of a stroke:
+ 
+
+ -Right/Long click : edit the default text font(for the duration of the session only, go the Options for a sustainable modification)
+
+ if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
* Resize / Rotate:
Allow to resize or rotate the selection (also applies to stroke under the cursor if no selection has been done first).
From 952007a3daf27448b3de6dac74173bbc2f285856 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Tue, 23 Apr 2024 07:17:44 +0200
Subject: [PATCH 03/13] Update readme.md
---
readme.md | 96 ++++++++++++++++++++++++++++++++++---------------------
1 file changed, 60 insertions(+), 36 deletions(-)
diff --git a/readme.md b/readme.md
index c21645d..26578bc 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,4 @@
-#### Introduction
+# Introduction
ppInk is a user-friendly on-screen annotation software for Windows, derived from gInk.
It offers numerous new features inspired by Epic Pen, another screen annotation software, making it even easier to use.
@@ -23,20 +23,21 @@ It provides a variety of drawing tools, including hand writing, lines (2 points
To streamline the interface, some buttons have multiple functions that can be accessed through multiple clicks or long clicks (or right clicks).
-* **Pen**:
+### **Pens**:
+
- Short click : select Pen
- Long Click / Right click : Open the pen parameters dialog
+Short click : select Pen
+Long Click / Right click : Open the pen parameters dialog
- The pen setup (fading / width / line strokes) applies to the follwing drawings:
+The pen setup (fading / width / line strokes) applies to the follwing drawings:
-* **Hand**
+### **Hand**
-* **Rectangular**
+### **Rectangular**
-* **Ellipsis**
+### **Ellipsis**
for those three tools,
@@ -44,19 +45,20 @@ for those three tools,
colored border -\> colored (filled) area -\> outside filled(inner part remains empty) -\> colored border - white area -\> colored border - black area
-* **Line**
+### **Line**
- segment line -\> polyline -\> pen color filled polygon -\> outer filled polygon -\> colored border - white polygon -\> colored border - black polygon
+
+ segment line -\> polyline -\> pen color filled polygon -\> outer filled polygon -\> colored border - white polygon -\> colored border - black polygon
-* **Numbering**
+### **Numbering**
- Left click select the tool:
transparent background -\> **modify** tag Number -\> white background -\> black background
- Right/Long click opens the Dialogbox to modify the font/style used for the number tags.
-* **Arrow**
-
+### **Arrow**
+
Arrow heads and tails can be customized, and you can cycle through different arrow options clicking .
To adjust the list of arrow heads, you have two options: Go to the options/general settings, or long-press the arrow button.
@@ -77,10 +79,10 @@ for those three tools,
-* **Text**
+### **Text**
- Any click select the text alignment.
+ Any click select the text alignment.
left-aligned -\> Text Right-aligned
Once you will have selected the insert point a dialog box will allow you to type in the text and select properties:
@@ -88,7 +90,7 @@ for those three tools,
While typing in the text, enter will jump to a new line, and ctrl+enter closes the dialog box
-* **Lasso**
+### **Lasso**
Any click activates selection of multiple strokes/drawings.
@@ -102,45 +104,67 @@ for those three tools,
If the measurement is activated (enabled in the Options):
In lasso mode, the global length is reported in a tooltip.
- 
+ 
if the drawing is a 2 segment polyline, the angle will also be displayed
- 
+ 
When you have selected some drawing,
* Erase tool : will delete selected objects
* move or copy tool : will move/copy the selected objects
* edit tool : will modify color/line style/width of the selected strokes
-* **Move**
- 
+### **Move**
+ 
Any clic select between the different tool
Move one or preselected drawing -\> Copy one or preselected drawing -\> Pan all drawings.
-* **Edit**
- 
+### **Edit**
+ 
-Left click : modify text/number tool (text and font) *or* the color/pen width of a stroke:
+
-Right/Long click : edit the default text font(for the duration of the session only, go the Options for a sustainable modification)
if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
-* Resize / Rotate:
- Allow to resize or rotate the selection (also applies to stroke under the cursor if no selection has been done first).
- To set the transformation:
- * the cursor becomes a target shape : indicate the center of the transformation : either a point or a drawing/selection in with case the center of the containing box is used:
- then
- * the cursor becomes a red big arrow : click and drag to scale/rotate the selected (if applicable) else the hovered drawing. this can be done many times
- https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a976-d66a621f36ac.mp4
+### **Resize / Rotate**
+ 
+
+ Allow to resize or rotate the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
+
+ Once select, to activate the transformation:
+ - (_the cursor displays a target shape_)
+ select the center of the transformation. It can be :
+ * a point which will be the center of the rotation of the resize
+ * a drawing (highlighted with a red box) to use the 'center' of the stroke/shape
+ - (_the cursor becomes a red big arrow_)
+ click and drag to perform the scaling /rotation of the preselected (else the hovered) strokes.the selected (if applicable)
+ this can be done many times
+
+#### Demonstration of different tools:
+
+https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a976-d66a621f36ac.mp4
-* Pointer Mode :
- Short click : engage Pointer Mode
- Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
+* **Pointer**
+
+
+ Left click : engage Pointer Mode
+
+ Right/Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
+
+ **Pointer mode** keeps the drawings displayed but the cursor events will be processed by the windows below.
+
+ This mode can be engaged clicking on the pointer button on switching between applications with alt+tab
+
+ **Window mode** allows you to define a window where ppInk will be active
+
+ To come back to full desktop, engage window mode then just short click within the window
* Pen Width:
Short click : select Pen Width
@@ -295,7 +319,7 @@ You can now select how the toolbar will be deployed : to left/ to right or verti
*Alt+Tab engaging Pointer*
-When the option is set in the options, switching application (with alt+tab) will engage pointer mode. Also, when pointer mode is activated (by any means, ie button click, alt+tab, global short cut), the toolbar is folded automatically, and when pressing undock button, alt+tab, or global shortcut,the inking mode is restored and the toolbar is unfolded.
+When the option is set in the options, switching application (with alt+tab) will engage pointer mode. Also,
Note that you can still fold toolbar when drawing without engaging pointer mode with the dock button.
*Measurement tool*
@@ -306,7 +330,7 @@ When enabled, in Move one/Copy one or erase tool, the length of the selected obj
The example shows also a very specific case where the object is a 3 point polyline, the angle is also computed.
-*Window mode*
+#### *Window mode*
You can now run ppink in window mode (engaged through Long/Right Click on pointer icon)
In this mode ppInk is run in a window and you can access clicks or mousewheel applications out of the window:
@@ -413,7 +437,7 @@ Click the exit button or press ESC to exit drawing.
_note about ini files_: when upgrading to a newer version, you can copy your config.ini / pens.ini / hotkeys.ini. All the new entries will be copied from the defaults part of the delivery,
you can then change the new parameters and when you will use the `save to files` in the options dialog box, they will be appended to your files
-#### How to contribute translation
+#### How to contribute to translations
gInk/ppInk supports multiple languages now (ppInk introduces a few new sentences where internationalization has not be implemented.). Here is how you can contribute translation. Simply create a duplication of the file "en-us.txt" in "bin/lang" folder, rename it and then translate the strings in the file. Check in ppInk to make sure your translation shows correctly, and then you can make a pull request or use https://github.com/pubpub-zz/ppInk/issues/17 to propose your translation.
@@ -427,7 +451,7 @@ https://github.com/geovens/gInk
ppInk
https://github.com/pubpub-zz/ppInk
-© Pubpub-ZZ 2020-2021
+© Pubpub-ZZ 2020-2024
From 16c3b7d84538cf4b2a2282cb950c541495aabd0f Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Tue, 23 Apr 2024 22:54:06 +0200
Subject: [PATCH 04/13] Update readme.md
---
readme.md | 313 +++++++++++++++++++++++++++---------------------------
1 file changed, 156 insertions(+), 157 deletions(-)
diff --git a/readme.md b/readme.md
index 26578bc..edf9774 100644
--- a/readme.md
+++ b/readme.md
@@ -13,7 +13,7 @@ because of that ppInk can be used to annotate and then capture the screens, but
https://user-images.githubusercontent.com/4083478/119278023-16f58b00-bc23-11eb-95de-9dc16505bf43.mp4
-(extract from @NOVAinc on Twitch)
+(extract from @NOVAinc on Twitch)
other demo : https://www.twitch.tv/novaaoe/clip/PlacidConcernedBulgogiOptimizePrime-mONUtlMLGvu2uUu1
This tool is intended to be usable through mouse,tablet pen(taking into pressure) but also throug touchscreen or graphic tablet, and keyboard can be used to activate functions.
@@ -23,140 +23,150 @@ It provides a variety of drawing tools, including hand writing, lines (2 points
To streamline the interface, some buttons have multiple functions that can be accessed through multiple clicks or long clicks (or right clicks).
-### **Pens**:
+### Pens
Short click : select Pen
Long Click / Right click : Open the pen parameters dialog
-The pen setup (fading / width / line strokes) applies to the follwing drawings:
+The pen setup (fading / width / line strokes) applies to the following tools:
-### **Hand**
+### Hand
-### **Rectangular**
+### Rectangular
-### **Ellipsis**
+### Ellipsis
-
-for those three tools,
- any click: select next tool in the following order:
- colored border -\> colored (filled) area -\> outside filled(inner part remains empty) -\> colored border - white area -\> colored border - black area
-
+
+---
+for these three drawing tools, clicks scroll through the following filling options:
+no filling → colored (filled) area → outside filling (interior remains empty) → white filling → black filling
+
+---
-### **Line**
+### Line
+
-
- segment line -\> polyline -\> pen color filled polygon -\> outer filled polygon -\> colored border - white polygon -\> colored border - black polygon
+
+- any click scroll through the following options:
+
+ segment line → polyline → pen color filled polygon → outer filled polygon → colored border - white polygon → colored border - black polygon
+
+### Numbering
-### **Numbering**
-
- - Left click select the tool:
- transparent background -\> **modify** tag Number -\> white background -\> black background
- - Right/Long click opens the Dialogbox to modify the font/style used for the number tags.
-### **Arrow**
+ - successive Left click select the number tag stamp within the following options:
+
+transparent background → **modify** tag Number → white background → black background
+ - Right/Long click opens the dialog box to set the font/style used.
+
+### Arrow
+
- Arrow heads and tails can be customized, and you can cycle through different arrow options clicking .
- To adjust the list of arrow heads, you have two options: Go to the options/general settings, or long-press the arrow button.
+ * Left click on the button scrolls through the different arrow Tail/Heads:
+ * Right/Long click on the tool button opens the dialog box to select or modify the arrow heads
+
+As an alternative to Right/long click, the list of arrow heads can be modified through to the options/general settings both opens the following dialog box:
+
+Arrow heads are 300x201 px images and designed for an 18px wide line. During drawing The images are resized to match the current pen size.
- Arrow heads are defined by 300x201px images and designed for an 18px wide line. The drawn image will be resized to match the current pen size.
- The arrow head image is centered on the reference points, which correspond to where the cursor starts or stops the line. This position should be marked on the image, on the center line (line 101) of the image,
- by a blue pixel (R=0, G=0, B=255). If this reference point cannot be found, the center of the image is considered.
+The arrow head images reference point are aligned to the drawn segment ends.
+This reference shall be defined on the center line of image(line 101) and shall be marked by a blue pixel (R=0, G=0, B=255). If this blue point does not exist, the center of the image is used.
- In standard, arrow heads are rotated to align with the line, but, if the arrow filename begins with an exclamation mark (!), the drawing remains horizontal.
+By default, arrow heads are rotated to align with the line, but, if the arrow filenames starts with an exclamation mark (!), the drawing remains horizontal. eg.:
- When drawing an arrow on screen, if you press left button:
- - The arrow tail is positioned where you initially pressed the button.
- - The arrow head is placed where you release the button.
- as an alternative, you can select the direction on the sub-toolbar (the arrow head is only selected on the button)
-
- If you are using the right button, the arrow is drawn with the head and tail exchanged.(Note: _Remember that a long press on a touch screen will engage a right-click action._)
+
- a Right/Long click on the button will open the dialogbox to modify the arrow heads :
- 
+When drawing an arrow on screen, in standard:
+- left click/drag draws the arrow from the tail to the head
+- right click/drag draws the arrow from the head to the tail.
-
-### **Text**
+this default behavior can be revert:
+* using the right button in the sub-toolbar (if activated)
+* through the setting in the global setting:
+
+
+ as an alternative, you can select the arrow direction in the sub-toolbar
+ note: the arrow head can only selected by clicking on the button of the main toolbar
+
+### Text
-
- Any click select the text alignment.
- left-aligned -\> Text Right-aligned
+Successive clicks select the alignment:
+left-aligned → right-aligned
Once you will have selected the insert point a dialog box will allow you to type in the text and select properties:
- While typing in the text, enter will jump to a new line, and ctrl+enter closes the dialog box
+ While typing in the text, 'enter' will jump to a new line, ctrl+enter terminates the input
-### **Lasso**
- 
-
- Any click activates selection of multiple strokes/drawings.
- Once the tool select, left click extend the selection, while right-click removes the drawings from the current selection.
- You can either :
- - surround strokes with the lasso (red/pink means add/remove) or
- - click on strokes marked by a dash box where hovering.
+### Lasso
+
+Any click activates the selection of multiple strokes/drawings.
+Once the tool select, left click adds elements to the selection, while right click removes them.
+You can either :
+ - circle strokes with the lasso (red/pink means add/remove) or
+ - click on strokes (highlighted by a dash box where hovered).
- Reselecting the tool will clear the selection.
- Once you have modified the selection, you can use undo to cancel it.
- If the measurement is activated (enabled in the Options):
- In lasso mode, the global length is reported in a tooltip.
-
-
-
- if the drawing is a 2 segment polyline, the angle will also be displayed
-
+Reselecting the tool will clear the selection.
+Whe you modify the selection, you can use the undo button to cancel the latest modification.
+When the measure option is activated (eabled in the Options):
+the individual length of the hovered drawing and the total length(if applicalbe) is reported in a tooltip.
+
+
+if the drawing is a 2 segment polyline, the angle is also displayed
+
-
- When you have selected some drawing,
+
+ Once you have selected some drawing, you can use
* Erase tool : will delete selected objects
* move or copy tool : will move/copy the selected objects
* edit tool : will modify color/line style/width of the selected strokes
-### **Move**
-
-
- Any clic select between the different tool
- Move one or preselected drawing -\> Copy one or preselected drawing -\> Pan all drawings.
+### Move
+
+
+Any click Scroll through the different tools:
+Move one or preselected drawing → Copy one or preselected drawing → Pan all drawings.
-### **Edit**
-
-
- -Left click : modify text/number tool (text and font) *or* the color/pen width of a stroke:
-
- 
+### Edit
+
- -Right/Long click : edit the default text font(for the duration of the session only, go the Options for a sustainable modification)
+ - Left click : modify text/number tool (text and font) *or* the color/pen width of a stroke:
+
+
+ - Right/Long click : edit the text default font(for the duration of the session only, go the Options for a sustainable modification)
if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
-### **Resize / Rotate**
-
-
- Allow to resize or rotate the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
+### Resize / Rotate
+
+
+Any click Scroll through the different tranformations:
+ resize → rotate
+the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
Once select, to activate the transformation:
- - (_the cursor displays a target shape_)
+ - (_the cursor displays a target shape_)
select the center of the transformation. It can be :
* a point which will be the center of the rotation of the resize
* a drawing (highlighted with a red box) to use the 'center' of the stroke/shape
- - (_the cursor becomes a red big arrow_)
+ - (_the cursor becomes a red big arrow_)
click and drag to perform the scaling /rotation of the preselected (else the hovered) strokes.the selected (if applicable)
- this can be done many times
+ the tranformation can be done many times
#### Demonstration of different tools:
https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a976-d66a621f36ac.mp4
-* **Pointer**
-
-
- Left click : engage Pointer Mode
-
- Right/Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
+* Pointer
+
+
+* Left click : engage Pointer Mode
+* Right/Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
**Pointer mode** keeps the drawings displayed but the cursor events will be processed by the windows below.
@@ -166,42 +176,44 @@ https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a
To come back to full desktop, engage window mode then just short click within the window
-* Pen Width:
- Short click : select Pen Width
- Long/Right click : engage **color picker**: this functions allow to modify the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
+### Pen Width/Color Picker
+
+* Short click : select Pen Width
+* Long/Right click : engage **color picker**: this functions allow to modify the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
+
-- Cliparts:
- Open the dialog to select image and the background/frame. This list displayed of cliparts is initialized from the list defined
- in the options. you can overload adding images for the inking sessions from files or from the clipboard.
- you can then stamp the images. you just click, the image will be stamped with the images original size. if you use the right click the image will be centered on the cursor click
+### Cliparts
+Open the dialog to select image and the background/frame. This list displayed of cliparts is initialized from the list defined in the options. you can overload adding images for the inking sessions from files or from the clipboard.
+You can then stamp the images. you just click, the image will be stamped with the images original size. if you use the right click the image will be centered on the cursor click
- if you just draw a vertical or horizontal line, the image will be drawn with the drawn width/height respecting
- proportional size. else you can draw a box which will define the image size (non proportional).
- If you draw from bottom/right to up/left, the image will be stamped reversed.
+if you just draw a vertical or horizontal line, the image will be drawn with the drawn width/height respecting
+proportional size. else you can draw a box which will define the image size (non proportional).
+If you draw from bottom/right to up/left, the image will be stamped reversed.
- 3 preset cliparts are also available: they can be configured in the option dialogbox, or for the time of the session through a right or long
- click on the selected button.
+3 preset cliparts are also available: they can be configured in the option dialogbox, or for the time of the session through a right or long click on the selected button.
- **Animated Cliparts are now supported**: APNG and animaged-GIF are supported. By default animations are supported forever. you can specify duration or loops using square brackets: negative means the object will be destroyed at the end. x after the number means, the number indicated information in loop percent. eg:
+**Animated Cliparts are supported**:
+APNG and animaged-GIF are supported. By default animations are supported forever. you can specify duration or loops using square brackets: negative means the object will be destroyed at the end. x after the number means, the number indicated information in loop percent. eg:
ppInkClipart.png -> animated for ever
ppInkClipart[5.2].png -> animated for 5.2 sec and then animation stops
ppInkClipart[-3.1].png -> animated for 3.1 sec and then disappear
ppInkClipart[3.5x].png -> animated for 3 cycles and a half and then animation stops
ppInkClipart[-2x].png -> animated for 2 cycles and then disappear
-- Stroke of Patterns:
- This tools provides capability to draw images along a hand stroke.
- The function is selected in the clipart dialog box throught the type of filling selection. Then you will be asked for the size of the image
+**Stroke of Patterns**:
+This tools provides capability to draw images along a hand stroke.
+The function is selected in the clipart dialog box throught the type of filling selection. Then you will be asked for the size of the image
+dfdsfsf
https://user-images.githubusercontent.com/4083478/130367766-ee6cbd89-34d1-43ac-9f3e-13184b6a0bca.mp4
-Note 1 : the checkbox "save Pattern setup" allows when you modify one of the predefined clipart to bypass the image size and interval in order to go directly to stroke drawing
-- Snapshot:
- Short click : Take a snapshot and exit after
- Long click : Take a snapshot and return to inking mode (keeping data); use alt+Hokey to do that with keyboard
- note that an option is available to invert behaviors between Long and short click
+Note 1 : the checkbox "save Pattern setup" allows when you modify one of the predefined clipart to bypass the image size and interval in order to go directly to stroke drawing
-*Magnetic*
+### Snapshot
+* Short click : Take a snapshot and exit after
+* Long click : Take a snapshot and return to inking mode (keeping data); use alt+Hokey to do that with keyboard
+note that an option is available to invert behaviors between Long and short click
+### Magnetic
The magnet activates some magnetic effect :
- Find a point on the drawing next to the cursor. For rectangles, magnetic
effect is available to vertices, and also to the middle of sides.(also activated pressing Ctrl)
@@ -211,14 +223,10 @@ The Magnetic distance can be adjusted in the options.
If only Ctrl or Shift is depressed, the global magnetic effect is switched off to only take into account the magnetic of the pressed key.
Hotkeys are availables for all tools,pens (configurable throught right click on icon next to clock)
-*Move one -> Copy one-> Move All(pan) *
-
-
You can move one stroke when clicking first time on the button. The stroke to be moved/copied will be surrounded by a rectangle to identify it and gets its measurement
When in Move one/Copy one or Erase, when the cursor flies over a shape, a tool tip indicates the length of the stroke. if the stroke is a 3 point polyline, it will also indicates the drawn angle.
-*Zoom*
-
+### Zoom
Two zoom can be activated (multiple clicks on the zoom buttom). the first one offers a standard dynamic window following the cursor. with the second one, you select the area that you want to enlarge. this area will be frozen and then full displayed on the screen. You can then carry on drawing on this new enlarged background image. a new click will end working on this image and will show back the screen and will restore the previously drawn strokes.
behind the zoom, a spot mode is also available where the screen is masked and a transparent area follows the cursor:
@@ -226,8 +234,17 @@ note 1: if the option is activated, you can activate the spot depressing alt.
note 2: the spot remains active during pointer mode
note 3: color, transparency, spot size, and activation with alt can be adjusted in the options / general tab
+### Clear Board:
+
+
+short click : Delete all drawings and apply last selected background
+Long click : Delete all drawings and select background surface color (white/black/customed color(modifiable through Options))
+In options you will be able to select a default mode at opening , and customed color
+advice : the created rectangle can be deleted using the erasor next to the border of the screen.
-*Save / Load*
+
+### Save / Load
+
through those two buttons, you will be able to store(in a text format) the current strokes. Load redraw the saved strokes onto the existing drawing.
- Save button : a long click(or first short click) is a sort of "save as" : it open the dialog box and will allow you to select the filename. the following short clicks will overwrite the strokes into the previously named file.
@@ -235,9 +252,11 @@ note that a backup is done when inking is ended/quit.
Load button : a long click(or first short click) is a sort of "load as" : it open the dialog box and will allow you to select the filename. the following short clicks will load the strokes from the previously named file. at first click the file loaded is the autosave(from latest session).
-**Keep in mind that an automatic save is performed when closing inking mode in autosave.strokes.txt . If you have ended your drawing session by error, you can recall your work depressing load button immediately after opening session**
+An automatic save is performed when closing inking mode in autosave.strokes.txt . If you have ended your drawing session by error, you can recall your work depressing load button immediately after opening session.
+
+## Other features / tricks
-*Alt+ shortcut for temporary commands:*
+### Alt+ shortcut for temporary commands
When this option is activated (yes by default), when Alt is pressed and hold, the tool/pen/mode is temporary selected, left when alt is released
eg : with Hand drawing selected, press Alt and keep it down. Press and release R : rectangle is active, as long as Alt is depressed, and Hand will be reengaged when Alt is released
@@ -246,27 +265,14 @@ Alt also works with dash line selection or fading shortcut.
This can be also used with Erasor
when pressing down Alt, the cursor is also temporary change to the big arrow to ease finding it on screen.
-*Option Capture at toolbar opening*
+### Option Capture at toolbar opening
Capture can be engaged as toolbar is opened. This option is set to false by default.
-*Long left click/Right click on Pens*
-
-Open the Modify pen dialog box for that pen
-
-*Clear Board (Bin icon):*
-
-short click : Delete all drawings and apply last selected background
-Long click : Delete all drawings and select background surface color (white/black/customed color(modifiable through Options))
-In options you will be able to select a default mode at opening , and customed color
-advice : the created rectangle can be deleted using the erasor next to the border of the screen.
-
-*Pens specials*
+### Pens Options
through the options or long click on a pen button, or using the edit pen hotkey you can edit advance pen:
-
-
-
+
- Fading : the stroke drawn will disappear after the defined time(adjustable in options dialogbox/pen tab)
- Line Style (Stroke/Solid/Dash/Dot/DashDot/DashDotDot) : This will apply the define line style on all type of drawings. Stroke keeps the original drawing which uses the pen pressure to adjust the width. Solid,Dash,... ignore pen pressure.
@@ -279,22 +285,17 @@ _Note3 : an option is now available in options/pen to allow to modify the linest
A global option exists also to set/unset smoothing. When off, strokes drawing will not be smoothed. General recommendation is to leave this option on.
-*color picker*
-
-When activated (hotkey or long press on pen width button) : a pickup tool will be available to pickup from screen a color and set it (on mouse click release) to current pen. When in this mode, the mouse wheel will allow to adjust transparency.
-
-*cursor files:*
-
+### cursor files
You can configure you own cursor file, saving it as cursor.ico in your exe folder (click position and size are loaded from the file). In the same you can save an image as FloatingCall.png to define the calling form image(in this case the width and transparency are in the Window_POS parameter in config.ini
-*mouse wheel:*
+### mouse wheel
Mouse wheel allows you mainly to modify the pen width. this can be easily observed with the tipped cursor. in this configuration, finding the mouse may be difficult to find in this configuration : you can then depress the alt key to get the arrow(or customized) cursor. When Number tool is selected, instead of change pen with, it changes the number size.
shift+mouse wheel allows to select pen
note1 : mouse wheel / shift+ mouse wheel can now be swapped (shift+mouse wheel to access pen width) : available in options / pen tab
note2 : as said above, two hotkeys are available to control width through the keyboard.
-*video recording:*
+### video recording
ppInk has now some capability to do some video recording. tuning is available in options/video tab :
- basic recording with FFmpeg:
@@ -303,8 +304,7 @@ ppInk has now some capability to do some video recording. tuning is available in
You need to first install and configure OBS-studio(https://obsproject.com/fr/download) with OBS-websocket(https://github.com/Palakis/obs-websocket). select the required option (recording or broadcasting). with this program you will be able to start/stop broadcasting or start/pause/resume/stop video recording. file names and folders are defined in OBS-studio.
Note : ppink is now compatible with release 4.8 of OBS-websocket. this should be fixed in very next release. for the moment,prefer to stop recording when stopping Ink mode
-*UI customisation*
-
+### UI customisation
You add arrow.ani/cur/ico and eraser.ani/cur/ico to put your own cursors. if you use ico file the cursor is down with the file sized ( you can then put a bigger or smaller image)
toolbar Background Color can be changed in the options. currently a draw hickup make the background color incorrect during opening. transparency is currenly ignored
Button Images can be customized putting Png files in the ppink exe folder. the name to be used are the same as the one from the src folder.
@@ -313,33 +313,32 @@ When checked in the options, a secondary toolbar will open when selected some to
The example above shows also an example with the pens on two lines (setup through options dialog box)
-*Toolbar orientation*
+### Toolbar orientation
You can now select how the toolbar will be deployed : to left/ to right or vertically to top/ to bottom
-*Alt+Tab engaging Pointer*
+### Engaging Pointer with Alt+Tab
When the option is set in the options, switching application (with alt+tab) will engage pointer mode. Also,
Note that you can still fold toolbar when drawing without engaging pointer mode with the dock button.
-*Measurement tool*
+### Measurement tool
When enabled, in Move one/Copy one or erase tool, the length of the selected object is provided in a tooltip.
-
The example shows also a very specific case where the object is a 3 point polyline, the angle is also computed.
-#### *Window mode*
+### Window mode
You can now run ppink in window mode (engaged through Long/Right Click on pointer icon)
In this mode ppInk is run in a window and you can access clicks or mousewheel applications out of the window:
https://user-images.githubusercontent.com/4083478/112311221-c656c580-8ca5-11eb-895b-2279366c0fc4.mp4
- note : the border color can be changed directly in config.ini
+note : the border color can be changed directly in config.ini
-*snapshots in pointer mode*
+### snapshots in pointer mode
when trying to annote menu opened with mouse click / contextual menus
@@ -350,7 +349,7 @@ https://user-images.githubusercontent.com/61389799/111090958-1d3bfc80-853a-11eb-
you can configure shortcuts with shift/ctrl/alt with a press and hold and tap twice keys to prevent menu to close
multiple snapshots can be captured, they are pasted one over the other, in the reverse order to make a full sequence
-#### Rest API
+### Rest API
In order to allow customisation, ppInk provides now a REST API allowing control from an external program/device such as a streamdesk from Elgato or touchPortal:
Example with StreamDesk :
@@ -362,21 +361,20 @@ example with touchportal:
(thanks to @NOVAinc)
Ensure you are working with http protocol
-All the API is described in the https://github.com/pubpub-zz/ppInk/raw/master/ppInk/httpRequests.rtf (provided next to ppink.exe in each release)
+All the API is described in the https://github.com/pubpub-zz/ppInk/raw/master/ppInk/httpRequests.md (provided next to ppink.exe in each release)
Note that this API returns results in JSON format that can be used for further extension.
-
-#### Download
+### Download
-#### Change log
+### Change log
-#### How to use
+### How to use
Start ppInk.exe and an icon will appear in the system tray and possible a floating window(\*)
(which can be moved using RightClick) to start drawing on screen.
@@ -391,7 +389,7 @@ Inking is started :
Click the exit button or press ESC to exit drawing.
-#### Features
+### Features
- Compact and intuitive interface with customizable hotkeys.
@@ -422,13 +420,13 @@ Click the exit button or press ESC to exit drawing.
- Zoom (2 versions)
-#### Tips
+### Tips
- **There is a known issue for multiple displays of unmatched DPI settings (100%, 125%, 150%, etc.). If you use ppInk on a computer with multiple displays of unmatched DPI settings, or you encounter problems such as incorrect snapshot position, unable to drag toolbar to locations etc., please do the following as a workaround (in Windows 10 version 1903 as an example): right-click ppInk.exe, Properties, Compatibility, Change high DPI settings, Enable override high DPI scaling behavior scaling performed by: Application.**
- There is a very few hidden options you can tweak in config.ini that are not shown in the options window.
-#### Configurations
+### Configurations
- ppInk can be largely configured. Some examples/proposals of simplified configuation are offered here:
* [Simplified configuration from @earthjasonlin](extra_doc/simplified_from_earthjasonlin.md)
@@ -437,7 +435,7 @@ Click the exit button or press ESC to exit drawing.
_note about ini files_: when upgrading to a newer version, you can copy your config.ini / pens.ini / hotkeys.ini. All the new entries will be copied from the defaults part of the delivery,
you can then change the new parameters and when you will use the `save to files` in the options dialog box, they will be appended to your files
-#### How to contribute to translations
+### How to contribute to translations
gInk/ppInk supports multiple languages now (ppInk introduces a few new sentences where internationalization has not be implemented.). Here is how you can contribute translation. Simply create a duplication of the file "en-us.txt" in "bin/lang" folder, rename it and then translate the strings in the file. Check in ppInk to make sure your translation shows correctly, and then you can make a pull request or use https://github.com/pubpub-zz/ppInk/issues/17 to propose your translation.
@@ -455,3 +453,4 @@ https://github.com/pubpub-zz/ppInk
+
From 136caaa818b5ff62f4182b53ebdbbcf5365c6fae Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Wed, 24 Apr 2024 19:53:56 +0200
Subject: [PATCH 05/13] Update readme.md
---
readme.md | 32 +++++++++++++++++++++-----------
1 file changed, 21 insertions(+), 11 deletions(-)
diff --git a/readme.md b/readme.md
index edf9774..8e42f96 100644
--- a/readme.md
+++ b/readme.md
@@ -23,26 +23,30 @@ It provides a variety of drawing tools, including hand writing, lines (2 points
To streamline the interface, some buttons have multiple functions that can be accessed through multiple clicks or long clicks (or right clicks).
-### Pens
+### Pens
-Short click : select Pen
-Long Click / Right click : Open the pen parameters dialog
+* Short click : select Pen
+* Long Click / Right click : Open the pen parameters dialog
The pen setup (fading / width / line strokes) applies to the following tools:
### Hand
-### Rectangular
+### Rectangle
### Ellipsis
---
-for these three drawing tools, clicks scroll through the following filling options:
-no filling → colored (filled) area → outside filling (interior remains empty) → white filling → black filling
+for these three drawing tools, clicks scroll through the following filling options:
+no filling → colored (filled) area → outer filling (interior remains empty) → white filling → black filling
+
+
+
+
---
@@ -52,7 +56,7 @@ for these three drawing tools, clicks scroll through the following filling optio
- any click scroll through the following options:
- segment line → polyline → pen color filled polygon → outer filled polygon → colored border - white polygon → colored border - black polygon
+ segment line → polyline → color filled polygon → outer filed polygon → white filled polygon → black filled polygon
### Numbering
@@ -70,11 +74,13 @@ for these three drawing tools, clicks scroll through the following filling optio
* Right/Long click on the tool button opens the dialog box to select or modify the arrow heads
As an alternative to Right/long click, the list of arrow heads can be modified through to the options/general settings both opens the following dialog box:
+
+
Arrow heads are 300x201 px images and designed for an 18px wide line. During drawing The images are resized to match the current pen size.
The arrow head images reference point are aligned to the drawn segment ends.
-This reference shall be defined on the center line of image(line 101) and shall be marked by a blue pixel (R=0, G=0, B=255). If this blue point does not exist, the center of the image is used.
+This reference shall be defined on the center line of image(_line 101_) and shall be marked by a blue pixel (R=0, G=0, B=255). If this blue point does not exist, the center of the image is used.
By default, arrow heads are rotated to align with the line, but, if the arrow filenames starts with an exclamation mark (!), the drawing remains horizontal. eg.:
@@ -89,21 +95,25 @@ this default behavior can be revert:
* through the setting in the global setting:
- as an alternative, you can select the arrow direction in the sub-toolbar
+as an alternative, you can select the arrow direction in the sub-toolbar
+
note: the arrow head can only selected by clicking on the button of the main toolbar
### Text
+
Successive clicks select the alignment:
+
left-aligned → right-aligned
- Once you will have selected the insert point a dialog box will allow you to type in the text and select properties:
- 
+Once you will have selected the insert point a dialog box will allow you to type in the text and select properties:
+> 
While typing in the text, 'enter' will jump to a new line, ctrl+enter terminates the input
### Lasso
+
Any click activates the selection of multiple strokes/drawings.
Once the tool select, left click adds elements to the selection, while right click removes them.
You can either :
From fc3cc772e96cc00f896aae4dae74e5922b3b6aa7 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Thu, 25 Apr 2024 23:38:29 +0200
Subject: [PATCH 06/13] Update readme.md
---
readme.md | 53 ++++++++++++++++++++++++++++++++---------------------
1 file changed, 32 insertions(+), 21 deletions(-)
diff --git a/readme.md b/readme.md
index 8e42f96..f99cbf6 100644
--- a/readme.md
+++ b/readme.md
@@ -145,26 +145,27 @@ Any click Scroll through the different tools:
### Edit
- - Left click : modify text/number tool (text and font) *or* the color/pen width of a stroke:
-
-
+ - Left click : modify text/number tool (text and font / frame)
+ 
+ edit drawings' properties (color, pen width and types, or filling type)
+ 
- Right/Long click : edit the text default font(for the duration of the session only, go the Options for a sustainable modification)
- if some strokes are selected before short click, the pen/color dialog will open to modify all selected strokes at once.
+You can apply the same parameters to a group of drawings, selecting them before clicking on the button.
### Resize / Rotate
-Any click Scroll through the different tranformations:
+Any click Scroll let you choose between the different tranformations:
resize → rotate
the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
- Once select, to activate the transformation:
- - (_the cursor displays a target shape_)
+ Once select, to activate the transformation:
+ - _the cursor displays a target shape_ (
)
select the center of the transformation. It can be :
- * a point which will be the center of the rotation of the resize
+ * a point which will be the center of the rotation or of the resize
* a drawing (highlighted with a red box) to use the 'center' of the stroke/shape
- - (_the cursor becomes a red big arrow_)
+ - _the cursor becomes a red big arrow_(
)
click and drag to perform the scaling /rotation of the preselected (else the hovered) strokes.the selected (if applicable)
the tranformation can be done many times
@@ -176,20 +177,34 @@ https://user-images.githubusercontent.com/4083478/130367372-233d6d64-06fc-4f0f-a
* Left click : engage Pointer Mode
-* Right/Long click : engage Window mode (Open a window) or click( to come back to fullscreen)
+* Right/Long click : start Window mode (Dragging the window box) or Fullscreen (with a short click)
- **Pointer mode** keeps the drawings displayed but the cursor events will be processed by the windows below.
-
- This mode can be engaged clicking on the pointer button on switching between applications with alt+tab
- **Window mode** allows you to define a window where ppInk will be active
-
- To come back to full desktop, engage window mode then just short click within the window
+#### Pointer mode
+This mode can be engaged:
+ - clicking on the pointer button,
+ - using the global hotkey
+ - or switching between applications with alt+tab.
+
+When activated,
+* the drawings remains displayed
+* the toolbar is folded
+* mouse clicks and scrolls are processed by the windows below.
+
+to return to drawing mode:
+ - unfold the toolbar,
+ - press the global hotkey
+ - switch back with alt+tab
+
+#### Window mode
+Window mode allows to run ppink in a window. when mouse is not hovering the window, scrollings are processed by application behind. If you click in the other application, Pointer mode is then activated. Resuming is performed in the same way as described in pointer mode above.
+
+If you disable "Engage Pointer Mode and Auto-Fold with Alt+Tab", entering pointer mode/drawing mode will be done at first click.
### Pen Width/Color Picker
* Short click : select Pen Width
-* Long/Right click : engage **color picker**: this functions allow to modify the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
+* Long/Right click : engage **color picker**: this functions allow to set the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
### Cliparts
@@ -460,7 +475,3 @@ https://github.com/geovens/gInk
ppInk
https://github.com/pubpub-zz/ppInk
© Pubpub-ZZ 2020-2024
-
-
-
-
From 4c31a62d1ab72428b4999ad1ae77f3405015e2ba Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Thu, 25 Apr 2024 23:43:06 +0200
Subject: [PATCH 07/13] Update readme.md
---
readme.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/readme.md b/readme.md
index f99cbf6..5de4288 100644
--- a/readme.md
+++ b/readme.md
@@ -44,8 +44,9 @@ The pen setup (fading / width / line strokes) applies to the following tools:
for these three drawing tools, clicks scroll through the following filling options:
no filling → colored (filled) area → outer filling (interior remains empty) → white filling → black filling
-
-
+
+
+
---
From fee9adde762e2d88e0146ce61c308ed1aafc8b71 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 29 Apr 2024 12:39:12 +0200
Subject: [PATCH 08/13] Update readme.md
---
readme.md | 78 ++++++++++++++++++++++++++++++++++++++-----------------
1 file changed, 54 insertions(+), 24 deletions(-)
diff --git a/readme.md b/readme.md
index 5de4288..9cbe32d 100644
--- a/readme.md
+++ b/readme.md
@@ -46,8 +46,7 @@ for these three drawing tools, clicks scroll through the following filling optio
-
-
+
---
@@ -158,7 +157,7 @@ You can apply the same parameters to a group of drawings, selecting them before
Any click Scroll let you choose between the different tranformations:
- resize → rotate
+ resize → rotate
the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
Once select, to activate the transformation:
@@ -202,11 +201,61 @@ Window mode allows to run ppink in a window. when mouse is not hovering the wind
If you disable "Engage Pointer Mode and Auto-Fold with Alt+Tab", entering pointer mode/drawing mode will be done at first click.
+### Magnetic
+
+
+Any clicks toggle the magnetic effect. The magnetic effect allows you:
+- to find the nearest point on a drawing (forced holding down Ctrl key):
+ - on any curve/stroke or ellipse
+ - vertexes of line/polyline/polygones/arrows.
+ - vertexes of middle of sides for rectangles or text bounding boxes
+- follow line directions (forced holding down Shift key):
+ - the direction every __x__ ° from the horizontal.
+ __x__ and the distance of the magnetic effect can be adjusted in the global settings in the option dialog box:
+ 
+
+Hotkeys are availables for all tools,pens (configurable throught right click on icon next to clock)
+
+### Zoom
+
+
+
+
+Any click on this button will scroll through the different zooms and spotlight:
+ Dynamic Zoom → Frozen Enlargement → Spotlight
+
+#### Dynamic zoom
+
+this zoom that follows the cursor which Two zoom can be activated (multiple clicks on the zoom buttom). the first one offers a live zoom window following the cursor. The window size can be adjusted using Ctrl + mouse wheel.
+
+The default size and zoom factors can be modified in the global setting:
+
+
+#### Frozen enlargement
+this zoom will :
+* freeze all drawing in progress
+* you can snapshot an area (the area size ratio are bounded to the screen size)
+* the area will be displayed full screen
+* you can draw on this new image
+* once finished, a new click on the zoom button will delete all drawings and background and then restore previous work.
+
+#### Spot Mode
+Spot mode is not actually a zoom. when activated, the screen is grayed but around the cursor to focus attention on the cursor:
+ 
+ you can activate this spot pressing alt (the cursor will then be also replaced with a big arrow).
+is activated, the spot mode remains active in pointer mode (allowing to highlight the active cursor)
+
+color, transparency, spot size, and activation with alt can be adjusted in the options / general tab:
+
+
### Pen Width/Color Picker
* Short click : select Pen Width
-* Long/Right click : engage **color picker**: this functions allow to set the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
+* Long/Right click : engage **color picker**:
+
+
+this functions allow to set the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
### Cliparts
Open the dialog to select image and the background/frame. This list displayed of cliparts is initialized from the list defined in the options. you can overload adding images for the inking sessions from files or from the clipboard.
@@ -239,27 +288,7 @@ Note 1 : the checkbox "save Pattern setup" allows when you modify one of the pre
* Long click : Take a snapshot and return to inking mode (keeping data); use alt+Hokey to do that with keyboard
note that an option is available to invert behaviors between Long and short click
-### Magnetic
-The magnet activates some magnetic effect :
-- Find a point on the drawing next to the cursor. For rectangles, magnetic
- effect is available to vertices, and also to the middle of sides.(also activated pressing Ctrl)
-- The 8 points of the bounding rectangle of a text.(also activated pressing Ctrl)
-- On the line from the origin. The lines are horizontal,vertical and every 15°.(also activated pressing Shift)
-The Magnetic distance can be adjusted in the options.
-If only Ctrl or Shift is depressed, the global magnetic effect is switched off to only take into account the magnetic of the pressed key.
-Hotkeys are availables for all tools,pens (configurable throught right click on icon next to clock)
-
- You can move one stroke when clicking first time on the button. The stroke to be moved/copied will be surrounded by a rectangle to identify it and gets its measurement
- When in Move one/Copy one or Erase, when the cursor flies over a shape, a tool tip indicates the length of the stroke. if the stroke is a 3 point polyline, it will also indicates the drawn angle.
-### Zoom
-Two zoom can be activated (multiple clicks on the zoom buttom). the first one offers a standard dynamic window following the cursor. with the second one, you select the area that you want to enlarge. this area will be frozen and then full displayed on the screen. You can then carry on drawing on this new enlarged background image. a new click will end working on this image and will show back the screen and will restore the previously drawn strokes.
- behind the zoom, a spot mode is also available where the screen is masked and a transparent area follows the cursor:
- 
-note 1: if the option is activated, you can activate the spot depressing alt.
-note 2: the spot remains active during pointer mode
-note 3: color, transparency, spot size, and activation with alt can be adjusted in the options / general tab
-
### Clear Board:
@@ -476,3 +505,4 @@ https://github.com/geovens/gInk
ppInk
https://github.com/pubpub-zz/ppInk
© Pubpub-ZZ 2020-2024
+
From edb5c079b5dfe92277ef55797987fd90f80de8f5 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 29 Apr 2024 12:44:01 +0200
Subject: [PATCH 09/13] Update readme.md
---
readme.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/readme.md b/readme.md
index 9cbe32d..2666a49 100644
--- a/readme.md
+++ b/readme.md
@@ -217,9 +217,8 @@ Any clicks toggle the magnetic effect. The magnetic effect allows you:
Hotkeys are availables for all tools,pens (configurable throught right click on icon next to clock)
### Zoom
-
-
-
+
+.
Any click on this button will scroll through the different zooms and spotlight:
Dynamic Zoom → Frozen Enlargement → Spotlight
@@ -227,8 +226,11 @@ Any click on this button will scroll through the different zooms and spotlight:
#### Dynamic zoom
this zoom that follows the cursor which Two zoom can be activated (multiple clicks on the zoom buttom). the first one offers a live zoom window following the cursor. The window size can be adjusted using Ctrl + mouse wheel.
+___
+___
The default size and zoom factors can be modified in the global setting:
+
#### Frozen enlargement
From 7a606aad3e039714681ded089b1a062962847520 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 29 Apr 2024 19:23:20 +0200
Subject: [PATCH 10/13] Update readme.md
---
readme.md | 95 ++++++++++++++++++++++++++++++++++++-------------------
1 file changed, 63 insertions(+), 32 deletions(-)
diff --git a/readme.md b/readme.md
index 2666a49..3d7699e 100644
--- a/readme.md
+++ b/readme.md
@@ -145,10 +145,14 @@ Any click Scroll through the different tools:
### Edit
- - Left click : modify text/number tool (text and font / frame)
+ - Left click : modify text/number tool (text and font / frame)
+
- edit drawings' properties (color, pen width and types, or filling type)
+
+edit drawings' properties (color, pen width and types, or filling type)
+
+
- Right/Long click : edit the text default font(for the duration of the session only, go the Options for a sustainable modification)
You can apply the same parameters to a group of drawings, selecting them before clicking on the button.
@@ -200,6 +204,12 @@ to return to drawing mode:
Window mode allows to run ppink in a window. when mouse is not hovering the window, scrollings are processed by application behind. If you click in the other application, Pointer mode is then activated. Resuming is performed in the same way as described in pointer mode above.
If you disable "Engage Pointer Mode and Auto-Fold with Alt+Tab", entering pointer mode/drawing mode will be done at first click.
+Example of window mode:
+
+
+https://user-images.githubusercontent.com/4083478/112311221-c656c580-8ca5-11eb-895b-2279366c0fc4.mp4
+
+_note : the border color can be changed directly in config.ini_
### Magnetic
@@ -260,37 +270,66 @@ color, transparency, spot size, and activation with alt can be adjusted in the o
this functions allow to set the current pen color picking up a color on screen; in this mode mousewheel modifies transparency
### Cliparts
-Open the dialog to select image and the background/frame. This list displayed of cliparts is initialized from the list defined in the options. you can overload adding images for the inking sessions from files or from the clipboard.
-You can then stamp the images. you just click, the image will be stamped with the images original size. if you use the right click the image will be centered on the cursor click
+
+Any click on the clipart button(
) opens the dialog box to select image and the background/frame:
+
+In this dialog box, you can :
+* Add or Remove images in the list (using 'From Clipboard', 'Load Image', 'Delete)
+* Select an image to stamp, with its background (the droplist in the bottom)
+
+
+When stamping the images:
+* with short left click, the image will be stamped with the images original size, and positioned at the top-left position.
+* with short right click the image will be centered on the cursor
+* with a drag right/left click, the image will be scaled (ignoring aspect ratio) to fit the drawn bounding box.
if you just draw a vertical or horizontal line, the image will be drawn with the drawn width/height respecting
proportional size. else you can draw a box which will define the image size (non proportional).
If you draw from bottom/right to up/left, the image will be stamped reversed.
-
-3 preset cliparts are also available: they can be configured in the option dialogbox, or for the time of the session through a right or long click on the selected button.
-
-**Animated Cliparts are supported**:
-APNG and animaged-GIF are supported. By default animations are supported forever. you can specify duration or loops using square brackets: negative means the object will be destroyed at the end. x after the number means, the number indicated information in loop percent. eg:
- ppInkClipart.png -> animated for ever
- ppInkClipart[5.2].png -> animated for 5.2 sec and then animation stops
- ppInkClipart[-3.1].png -> animated for 3.1 sec and then disappear
- ppInkClipart[3.5x].png -> animated for 3 cycles and a half and then animation stops
- ppInkClipart[-2x].png -> animated for 2 cycles and then disappear
-
-**Stroke of Patterns**:
-This tools provides capability to draw images along a hand stroke.
-The function is selected in the clipart dialog box throught the type of filling selection. Then you will be asked for the size of the image
-dfdsfsf
+
+The image list permanently through the global settings:
+
+
+#### stamping on curve
+The option in the filling combo box will allow you to draw images along a curve. Once selected:
+* the cursor will become a target .
+* you will define the size of the image stamp (the bounding box will be displayed)
+* you will define the distance between the images (2 images will be displayed for rendering evaluation)
+* the cursor will become an arrow
+* you will draw the curve along which the images will be drawn.
+
+
+
+example of drawing:
+
https://user-images.githubusercontent.com/4083478/130367766-ee6cbd89-34d1-43ac-9f3e-13184b6a0bca.mp4
-Note 1 : the checkbox "save Pattern setup" allows when you modify one of the predefined clipart to bypass the image size and interval in order to go directly to stroke drawing
+_note : when defining a preset clipart, the checkbox "save Pattern setup" allows when you modify one of the predefined clipart to bypass the image size and interval in order to go directly to stroke drawing_
+#### preset cliparts
+3 buttons are available to get quick access to preset buttons.
+* left click selects the image and filling to be used
+* right/long click opens the dialogbox to modify the options.
+
+It is also possible to modify these buttons in the global settings
+
+#### Animated Cliparts:
+APNG and animaged-GIF are supported. By default these drawings are animated without stopping. Duration or loops renaming the images:
+* at the end of the filename add in square brackets the time or how many times the animation will be played for:
+ * ppInkClipart.png -> animated for ever
+ * ppInkClipart[5.2].png -> animated for 5.2 sec and then animation stops
+ * ppInkClipart[3.5x].png -> animated for 3 cycles and a half and then animation stops
+* if a negative number is used, indicates that the image will then be erased.
+ * ppInkClipart[-3.1].png -> animated for 3.1 sec and then disappear
+ * ppInkClipart[-2x].png -> animated for 2 cycles and then disappear
### Snapshot
-* Short click : Take a snapshot and exit after
-* Long click : Take a snapshot and return to inking mode (keeping data); use alt+Hokey to do that with keyboard
-note that an option is available to invert behaviors between Long and short click
+
+* left click : Take a snapshot and exit after
+* right/long click : Take a snapshot and then return to drawing mode (keeping data); use alt+Hokey to do that with keyboard
+_note: the two behaviors can be inverted in the global options:
+
### Clear Board:
@@ -386,15 +425,6 @@ When enabled, in Move one/Copy one or erase tool, the length of the selected obj
The example shows also a very specific case where the object is a 3 point polyline, the angle is also computed.
-### Window mode
-
-You can now run ppink in window mode (engaged through Long/Right Click on pointer icon)
-In this mode ppInk is run in a window and you can access clicks or mousewheel applications out of the window:
-
-https://user-images.githubusercontent.com/4083478/112311221-c656c580-8ca5-11eb-895b-2279366c0fc4.mp4
-
-note : the border color can be changed directly in config.ini
-
### snapshots in pointer mode
when trying to annote menu opened with mouse click / contextual menus
@@ -508,3 +538,4 @@ ppInk
https://github.com/pubpub-zz/ppInk
© Pubpub-ZZ 2020-2024
+
From 4c65bf9ccbf6bd6a549843b5bb54a1999a22930a Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Mon, 29 Apr 2024 22:48:23 +0200
Subject: [PATCH 11/13] Update readme.md
---
readme.md | 74 +++++++++++++++++++++++++++++++++++++------------------
1 file changed, 50 insertions(+), 24 deletions(-)
diff --git a/readme.md b/readme.md
index 3d7699e..eeb64d4 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,4 @@
+
# Introduction
ppInk is a user-friendly on-screen annotation software for Windows, derived from gInk.
@@ -33,13 +34,16 @@ The pen setup (fading / width / line strokes) applies to the following tools:
### Hand
+ if you press ctrl or shift, you will engage momentarily line tool.
### Rectangle
+ when drawing, if you use right-click, the drawing will be centered on the click down.
### Ellipsis
-
+ when drawing, if you use right-click, the drawing will be centered on the click down.
+
---
for these three drawing tools, clicks scroll through the following filling options:
no filling → colored (filled) area → outer filling (interior remains empty) → white filling → black filling
@@ -49,6 +53,7 @@ for these three drawing tools, clicks scroll through the following filling optio
---
+
### Line
@@ -322,6 +327,11 @@ APNG and animaged-GIF are supported. By default these drawings are animated wit
* ppInkClipart[-3.1].png -> animated for 3.1 sec and then disappear
* ppInkClipart[-2x].png -> animated for 2 cycles and then disappear
+### Visibility
+
+
+this button make the drawing visibles / invisibles.
+
### Snapshot
@@ -333,11 +343,27 @@ _note: the two behaviors can be inverted in the global options:
### Clear Board:
-short click : Delete all drawings and apply last selected background
-Long click : Delete all drawings and select background surface color (white/black/customed color(modifiable through Options))
-In options you will be able to select a default mode at opening , and customed color
-advice : the created rectangle can be deleted using the erasor next to the border of the screen.
+* left click :
+ Delete all drawings and apply last selected background
+* Right / long click :
+ Delete all drawings and select background surface color (white/black/customed color, configured in the global settings)
+
+_note: the board is a drawn rectangle can be deleted using the erasor next to the border of the screen_
+
+### Undo
+
+
+Any click undo the actions.
+
+this button make the drawing visibles / invisibles.
+
+### page managment
+
+Any click moves to previous or next page
+
+These pages allow to switch between pages of drawings.
+This feature can be activated in the global settings.
### Save / Load
@@ -352,19 +378,30 @@ An automatic save is performed when closing inking mode in autosave.strokes.txt
## Other features / tricks
+### Calling Window
+by default ppink displays a floating window
+
+* left clicking on it starts drawing.
+* right click and drag allows to move the window to another position:
+This position will be kept you quit ppInk.
+To save it open the options and click on the button.
+
+
+If due to screen reconfiguration, the window dissapears, unset/set the "Show Floating Window" : the window will come back to coordinates 100,100.
+
### Alt+ shortcut for temporary commands
-When this option is activated (yes by default), when Alt is pressed and hold, the tool/pen/mode is temporary selected, left when alt is released
-eg : with Hand drawing selected, press Alt and keep it down. Press and release R : rectangle is active, as long as Alt is depressed, and Hand will be reengaged when Alt is released
-This can be reset any combinaisons of Pens and Tools : eg : press Alt, you can engage Filled Blue rectangle, depressing R twice, and 3 (in any order), and return to previous tools/color releasing Alt
+When this option is activated (default), and alt pressed is pressed and hold, the next tool/pen/mode is selected momentarily : the previous tool/pen is restored when alt is released. This also affects the shortcuts
+_eg : Hand drawing is selected. Press and hold alt Alt and shortly press and release R : rectangle is active, as long as Alt is depressed. Release Alt then Hand is restored._
+This can be used witgh combinaisons of Pens and Tools, and dashes, fading.
+_eg : press and hold Alt, you can engage Filled Blue rectangle, depressing R twice, and 3 (in any order). Release alt restores previous tool and color_
Alt also works with dash line selection or fading shortcut.
This can be also used with Erasor
when pressing down Alt, the cursor is also temporary change to the big arrow to ease finding it on screen.
-### Option Capture at toolbar opening
-
-Capture can be engaged as toolbar is opened. This option is set to false by default.
-
+### Option Capture at opening
+In the options you can set the option to engage capture when starting drawing.
+
### Pens Options
through the options or long click on a pen button, or using the edit pen hotkey you can edit advance pen:
@@ -381,9 +418,6 @@ _Note3 : an option is now available in options/pen to allow to modify the linest
A global option exists also to set/unset smoothing. When off, strokes drawing will not be smoothed. General recommendation is to leave this option on.
-### cursor files
-You can configure you own cursor file, saving it as cursor.ico in your exe folder (click position and size are loaded from the file). In the same you can save an image as FloatingCall.png to define the calling form image(in this case the width and transparency are in the Window_POS parameter in config.ini
-
### mouse wheel
Mouse wheel allows you mainly to modify the pen width. this can be easily observed with the tipped cursor. in this configuration, finding the mouse may be difficult to find in this configuration : you can then depress the alt key to get the arrow(or customized) cursor. When Number tool is selected, instead of change pen with, it changes the number size.
@@ -418,13 +452,6 @@ You can now select how the toolbar will be deployed : to left/ to right or verti
When the option is set in the options, switching application (with alt+tab) will engage pointer mode. Also,
Note that you can still fold toolbar when drawing without engaging pointer mode with the dock button.
-### Measurement tool
-
-When enabled, in Move one/Copy one or erase tool, the length of the selected object is provided in a tooltip.
-
-The example shows also a very specific case where the object is a 3 point polyline, the angle is also computed.
-
-
### snapshots in pointer mode
when trying to annote menu opened with mouse click / contextual menus
@@ -508,8 +535,7 @@ Click the exit button or press ESC to exit drawing.
- Zoom (2 versions)
### Tips
-
-- **There is a known issue for multiple displays of unmatched DPI settings (100%, 125%, 150%, etc.). If you use ppInk on a computer with multiple displays of unmatched DPI settings, or you encounter problems such as incorrect snapshot position, unable to drag toolbar to locations etc., please do the following as a workaround (in Windows 10 version 1903 as an example): right-click ppInk.exe, Properties, Compatibility, Change high DPI settings, Enable override high DPI scaling behavior scaling performed by: Application.**
+**There is a known issue for multiple displays of unmatched DPI settings (100%, 125%, 150%, etc.). If you use ppInk on a computer with multiple displays of unmatched DPI settings, or you encounter problems such as incorrect snapshot position, unable to drag toolbar to locations etc., please do the following as a workaround (in Windows 10 version 1903 as an example): right-click ppInk.exe, Properties, Compatibility, Change high DPI settings, Enable override high DPI scaling behavior scaling performed by: Application.**
- There is a very few hidden options you can tweak in config.ini that are not shown in the options window.
From 7cfccaa25368af2de65fee50bd54f9d93be07b51 Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Tue, 30 Apr 2024 15:08:58 +0200
Subject: [PATCH 12/13] Update readme.md
---
readme.md | 132 +++++++++++++++++++++++++++++++-----------------------
1 file changed, 77 insertions(+), 55 deletions(-)
diff --git a/readme.md b/readme.md
index eeb64d4..8db538a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,14 +1,12 @@
# Introduction
-ppInk is a user-friendly on-screen annotation software for Windows, derived from gInk.
-It offers numerous new features inspired by Epic Pen, another screen annotation software, making it even easier to use.
-
+ppInk is a user-friendly on-screen annotation software for Windows, compatible with Mouse use, touchscreen or drawing tablet(also with pressure).
-It offers numerous new features freely inspired from other application such as Epic Pen, making it even easier to use.
-ppInk/gInk is designed with simplicity in mind, ensuring it doesn't distract presenters or audiences during presentations. Instead of adjusting individual settings like color, transparency, and tip width, ppInk allows you to select different pens for drawing, each with configurable attributes.
+Derived form gInk It offers numerous new features freely inspired frm other application such as Epic Pen, making it even easier to use and even more functionalities.
+ppInk/gInk is designed with simplicity in mind, ensuring it doesn't distract presenters or audiences during presentations. Instead of adjusting individual settings like color, transparency, and tip width, stroke, ppInk allows you to select different pens for drawing, each with configurable attributes.
because of that ppInk can be used to annotate and then capture the screens, but it can also be used to support demonstration:
@@ -170,12 +168,12 @@ Any click Scroll let you choose between the different tranformations:
the selected stroke(s) (also applies to stroke under the cursor if no selection has been done first).
Once select, to activate the transformation:
- - _the cursor displays a target shape_ ()
+ - _the cursor displays a target shape_ ()
select the center of the transformation. It can be :
* a point which will be the center of the rotation or of the resize
* a drawing (highlighted with a red box) to use the 'center' of the stroke/shape
- - _the cursor becomes a red big arrow_()
- click and drag to perform the scaling /rotation of the preselected (else the hovered) strokes.the selected (if applicable)
+ - _the cursor becomes a red big arrow_()
+ click and drag to perform the scaling /rotation of the preselected (else the hovered) strokes or text.the selected (if applicable)
the tranformation can be done many times
#### Demonstration of different tools:
@@ -238,7 +236,7 @@ Hotkeys are availables for all tools,pens (configurable throught right click on
Any click on this button will scroll through the different zooms and spotlight:
Dynamic Zoom → Frozen Enlargement → Spotlight
-#### Dynamic zoom
+#### Dynamic magnifier
this zoom that follows the cursor which Two zoom can be activated (multiple clicks on the zoom buttom). the first one offers a live zoom window following the cursor. The window size can be adjusted using Ctrl + mouse wheel.
___
@@ -286,7 +284,7 @@ In this dialog box, you can :
When stamping the images:
* with short left click, the image will be stamped with the images original size, and positioned at the top-left position.
* with short right click the image will be centered on the cursor
-* with a drag right/left click, the image will be scaled (ignoring aspect ratio) to fit the drawn bounding box.
+* with a drag right/left click, the image will be scaled (ignoring aspect ratio) to fit the drawn boun ding box.
if you just draw a vertical or horizontal line, the image will be drawn with the drawn width/height respecting
proportional size. else you can draw a box which will define the image size (non proportional).
@@ -317,6 +315,11 @@ _note : when defining a preset clipart, the checkbox "save Pattern setup" allows
It is also possible to modify these buttons in the global settings
+
+#### Offset images:
+The default position with the left click the position is positioned on the top/left corner. In order to move this position, rename the file in order to add @x.y at the end of the base name to define the position of the cursor (see #269)
+eg: `mick@1.295.png` set the finger at the click position (part of ppink delivery)
+
#### Animated Cliparts:
APNG and animaged-GIF are supported. By default these drawings are animated without stopping. Duration or loops renaming the images:
* at the end of the filename add in square brackets the time or how many times the animation will be played for:
@@ -379,12 +382,13 @@ An automatic save is performed when closing inking mode in autosave.strokes.txt
## Other features / tricks
### Calling Window
-by default ppink displays a floating window
+by default ppink displays a floating window
+
* left clicking on it starts drawing.
* right click and drag allows to move the window to another position:
This position will be kept you quit ppInk.
-To save it open the options and click on the button.
+To save it open the options and click on the button.
If due to screen reconfiguration, the window dissapears, unset/set the "Show Floating Window" : the window will come back to coordinates 100,100.
@@ -401,13 +405,18 @@ when pressing down Alt, the cursor is also temporary change to the big arrow to
### Option Capture at opening
In the options you can set the option to engage capture when starting drawing.
+
+
### Pens Options
-through the options or long click on a pen button, or using the edit pen hotkey you can edit advance pen:
+through the options or long click on a pen button, or using the edit pen hotkey you can edit pen:
+
-- Fading : the stroke drawn will disappear after the defined time(adjustable in options dialogbox/pen tab)
-- Line Style (Stroke/Solid/Dash/Dot/DashDot/DashDotDot) : This will apply the define line style on all type of drawings. Stroke keeps the original drawing which uses the pen pressure to adjust the width. Solid,Dash,... ignore pen pressure.
+
+- **Fading** : the stroke drawn will disappear after the defined time(adjustable in options dialogbox/pen tab)
+- **Line Style (Stroke/Solid/Dash/Dot/DashDot/DashDotDot)** : This will apply the define line style on all type of drawings. Stroke keeps the original drawing which uses the pen pressure to adjust the width. Solid,Dash,... ignore pen pressure.
+
_Note1 : When drawing with dashed lines,try to not draw too slowly : the number of vertex will increase and make the drawing not very nice_
@@ -416,6 +425,11 @@ _Note2 : Hotkeys allows to set/unset the fading, linestyle, increase/decrease pe
_Note3 : an option is now available in options/pen to allow to modify the linestyle when clicking on already selected pen button(or using hotkeys). also an option in hotkeys allow to select which linestyle will be accessible through click/hotkeys (not applicable to Pen Modify dialog box)_
+_Note4: up to 10 pens can be accessible in the toolbar. a second page can be activated in the options:_
+
+
+_To access this second page, press ctrl and/or shift or click on the vertical separation bar on right of the group._
+
A global option exists also to set/unset smoothing. When off, strokes drawing will not be smoothed. General recommendation is to leave this option on.
### mouse wheel
@@ -432,10 +446,15 @@ ppInk has now some capability to do some video recording. tuning is available in
You need to first install ffmpeg. and select the option in the video tab. In this case the button will be proposed. you can start/stop recording. Names and destination folders are defined throught the command line.
- advanced recording with OBS-studio:
You need to first install and configure OBS-studio(https://obsproject.com/fr/download) with OBS-websocket(https://github.com/Palakis/obs-websocket). select the required option (recording or broadcasting). with this program you will be able to start/stop broadcasting or start/pause/resume/stop video recording. file names and folders are defined in OBS-studio.
- Note : ppink is now compatible with release 4.8 of OBS-websocket. this should be fixed in very next release. for the moment,prefer to stop recording when stopping Ink mode
+ Note : ppink is compatible with release 4.8 of OBS-websocket, but not yet with version 5.0 part of OBS studio 28+. this should be fixed in a next release. for the moment,prefer to stop recording when stopping Ink mode
+
+when ffmpeg recording is selected, you can use ppInk to record your screen and stores events within an M3U file. This could be used during some application testing.
+During the record you can set some marks manually and automatically when opening the toolbar (for example to highlight the odd observation).
+
+During your analysis, you can replay the M3U file and jump to the different markers.
### UI customisation
-You add arrow.ani/cur/ico and eraser.ani/cur/ico to put your own cursors. if you use ico file the cursor is down with the file sized ( you can then put a bigger or smaller image)
+You add use your own cursors replacing the files. if you use ico file the cursor is down with the file sized ( you can then put a bigger or smaller image)
toolbar Background Color can be changed in the options. currently a draw hickup make the background color incorrect during opening. transparency is currenly ignored
Button Images can be customized putting Png files in the ppink exe folder. the name to be used are the same as the one from the src folder.
When checked in the options, a secondary toolbar will open when selected some tools to access all functions/filling immediately:
@@ -463,6 +482,24 @@ https://user-images.githubusercontent.com/61389799/111090958-1d3bfc80-853a-11eb-
you can configure shortcuts with shift/ctrl/alt with a press and hold and tap twice keys to prevent menu to close
multiple snapshots can be captured, they are pasted one over the other, in the reverse order to make a full sequence
+### Global options
+Many adjustment are possible through the different pages in the options:
+
+
+
+
+
+
+All the parameters are saved in config.ini / pens.ini / hotkeys.ini. There is no dedicated files and settings can be stored in any of them.
+
+Over these files, in order to ease upgrades between versions, defaults.ini / pensdef.ini stores some default parameters that are first loaded as default values and should not be changed.
+
+When upgrading from an previous ppInk version :
+* copy your previous config.ini/pens.ini/hotkeys.ini into the new folder
+* start ppInk
+* Open global settings
+* save the files : The new entries will be added.
+
### Rest API
In order to allow customisation, ppInk provides now a REST API allowing control from an external program/device such as a streamdesk from Elgato or touchPortal:
@@ -475,7 +512,7 @@ example with touchportal:
(thanks to @NOVAinc)
Ensure you are working with http protocol
-All the API is described in the https://github.com/pubpub-zz/ppInk/raw/master/ppInk/httpRequests.md (provided next to ppink.exe in each release)
+All the API is described in the https://github.com/pubpub-zz/ppInk/blob/master/ppInk/httpRequests.md (in ppInk folder)
Note that this API returns results in JSON format that can be used for further extension.
@@ -483,6 +520,9 @@ Note that this API returns results in JSON format that can be used for further e
+You will find ppInk.zip and ppInkS.zip. this second package provides a ppInk version where network connections have been removed (may ease some security analysis)
+
+
### Change log
@@ -503,44 +543,12 @@ Inking is started :
Click the exit button or press ESC to exit drawing.
-### Features
-
-- Compact and intuitive interface with customizable hotkeys.
-
-- Inks rendered on dynamic desktops.
-
-- Drawing tools: Hand Writing, Line, Rectangular, Ellipsis, Arrow, Numbering
- Tag, Text Left/Right aligned
-
-- Stylus with eraser, touch screen and mouse compatible.
-
-- Click-through mode. (note : once inking is engaged, global shortcut enters and exits this mode)
-
-- Multiple displays support.
-
-- Pen pressure support.
-
-- Snapshot support.
-
-- Hotkey support. (includes hotkeys with Del, BackSpace; in options **use ctrl+shift+del or ctrl+shift+backspace to delete the current hotkey**)
-
-- Magnetic effect when drawing shapes
-
-- Filled shapes
-
-- Video recording
-
-- Load/Save stroke
-
-- Zoom (2 versions)
-
### Tips
**There is a known issue for multiple displays of unmatched DPI settings (100%, 125%, 150%, etc.). If you use ppInk on a computer with multiple displays of unmatched DPI settings, or you encounter problems such as incorrect snapshot position, unable to drag toolbar to locations etc., please do the following as a workaround (in Windows 10 version 1903 as an example): right-click ppInk.exe, Properties, Compatibility, Change high DPI settings, Enable override high DPI scaling behavior scaling performed by: Application.**
- There is a very few hidden options you can tweak in config.ini that are not shown in the options window.
### Configurations
-
- ppInk can be largely configured. Some examples/proposals of simplified configuation are offered here:
* [Simplified configuration from @earthjasonlin](extra_doc/simplified_from_earthjasonlin.md)
@@ -548,12 +556,26 @@ Click the exit button or press ESC to exit drawing.
_note about ini files_: when upgrading to a newer version, you can copy your config.ini / pens.ini / hotkeys.ini. All the new entries will be copied from the defaults part of the delivery,
you can then change the new parameters and when you will use the `save to files` in the options dialog box, they will be appended to your files
-### How to contribute to translations
-
-gInk/ppInk supports multiple languages now (ppInk introduces a few new sentences where internationalization has not be implemented.). Here is how you can contribute translation. Simply create a duplication of the file "en-us.txt" in "bin/lang" folder, rename it and then translate the strings in the file. Check in ppInk to make sure your translation shows correctly, and then you can make a pull request or use https://github.com/pubpub-zz/ppInk/issues/17 to propose your translation.
+### translations
+
+ppInk supports multiple languages, you can contribute to translations.
+A few points will help you to contribute:
+* all translations are in lang folder in your configuration directory.
+* en-us.txt is loaded before any other translation : if a translation is missing in your file the english version will be used.
+* translation files are loaded at start-up and when you change the langage in the options
+* you can build your own translation:
+ - if it not exist duplicate of the file "en-us.txt" in "ppink/lang" folder with your language entry and then translate the strings in the file.
+* to update an existing file:
+ - open the global options.
+ - Select first english translation
+ - Select your file langage. a pop-up will appear
+
+ - confirm to update it. the new entries will be appened at the end of your file
+ - edit the new entries (you can also reorder the entries as you wish)
+ - change back and forth the language in the ppInk's options to reload and test your modifications.
+
+do not hesitate to share your work in https://github.com/pubpub-zz/ppInk/issues/17 to propose your translation. It will be apreciated 😋.
-When upgrading to a new version, to ease translation, all the missing entries in your translation can be copied from the english version into your translation : For this, go the option, (re-)select your current langage (or another one) in the langage list, you will be prompted for completing the langage definition file. if you say yes, all missing inputs (will be added with the english translation). You then just have to translation the new inputs.
-after translation you can(not required) also reorder the sentences as you wish.
gInk
https://github.com/geovens/gInk
From 667fac7bf683271c0b14bba6692e9dd907ee4ddc Mon Sep 17 00:00:00 2001
From: pubpub-zz <4083478+pubpub-zz@users.noreply.github.com>
Date: Tue, 30 Apr 2024 16:04:42 +0200
Subject: [PATCH 13/13] Update readme.md
---
readme.md | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/readme.md b/readme.md
index 8db538a..9175391 100644
--- a/readme.md
+++ b/readme.md
@@ -61,6 +61,14 @@ for these three drawing tools, clicks scroll through the following filling optio
segment line → polyline → color filled polygon → outer filed polygon → white filled polygon → black filled polygon
+#### scaled measurement
+when measurement is activated, the length of your in progress drawing is displayed. taking into account the current scale.
+You can set the scale in the options, but you can also define it drawing.
+to do so:
+* draw a curve, a line, or an arrow with the right button.
+* when the drawing will be completed, enter the actual length of your drawing to defin the scale
+* draw all your next drawing normally with the left scale. The next drawings length will take into account the new scale
+
### Numbering
@@ -500,6 +508,14 @@ When upgrading from an previous ppInk version :
* Open global settings
* save the files : The new entries will be added.
+### running ppInk
+
+ppInk can be executed from any folder. If the folder has limited rights and can not write in the folder, images and config and translation files will be copied to
+%APPDATA%\ppInk. This allow ppInk to be run by many users with different setups.
+
+you can also indicate an other folder with your setup in the command line using ppink -c _config folder_
+
+
### Rest API
In order to allow customisation, ppInk provides now a REST API allowing control from an external program/device such as a streamdesk from Elgato or touchPortal:
@@ -585,5 +601,3 @@ https://github.com/geovens/gInk
ppInk
https://github.com/pubpub-zz/ppInk
© Pubpub-ZZ 2020-2024
-
-