ppInk

Introduction

ppInk is an on-screen annotation software under Windows, forked from gInk.

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.

As another option you can use ppInk to support demonstrations:

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.

image

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):

Magnetic

The magnet activates some magnetic effect :

*Move one -> Copy one-> Move All(pan) *image

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: image 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

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.

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

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 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.

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

through the options or long click on a pen button, or using the edit pen hotkey you can edit advance pen:

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

Note2 : Hotkeys allows to set/unset the fading, linestyle, increase/decrease penwidth and open the pen modify dialog of the current pen

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)

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:

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. 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:

ppInk has now some capability to do some video recording. tuning is available in options/video tab :

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. When checked in the options, a secondary toolbar will open when selected some tools to access all functions/filling immediately: image

The example above shows also an example with the pens on two lines (setup through options dialog box)

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

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. 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. image

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

https://user-images.githubusercontent.com/61389799/111090958-1d3bfc80-853a-11eb-91fc-04e85ed18454.mp4

(demo from @eamayreh)

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

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 :

image

example with touchportal: image (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)

Note that this API returns results in JSON format that can be used for further extension.

Download

https://github.com/PubPub-zz/ppInk/releases/

Change log

https://github.com/pubpub-zz/ppInk/blob/master/changelog.txt

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.
Inking is started :

(*) activation and position saving are available in options.

Click the exit button or press ESC to exit drawing.

Features

Tips

How to contribute translation

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 for the next version of release for others to use.

arabic available

gInk
https://github.com/geovens/gInk
https://github.com/geovens/gInk
© Weizhi Nai © 2019

ppInk https://github.com/pubpub-zz/ppInk © Pubpub-ZZ 2020-2021