Glassnote

On-screen quick notes/annotation tool to untangle complex ideas.

glassnote.mp4

Jump to Usage

Jump to Installation

Roadmap

• Configurable color palette
• Configurable keybinds (extend gnctl functionality)
• Instanced line rendering
• Antialiased line rendering
• Rounded line joins + line caps
• Online line simplification algorithm
• Toggleable canvas
• Touch support
• Tablet support (lol)
• Undo support
• Eraser tool

Building/Installation

Important

• glassnote uses the zwlr_layer_shell_v1 and wp_cursor_shape_manager_v1 protocols, which are not supported by all Wayland compositors.
• gnctl uses systemd and dbus to communicate with glassnote.

Install the following dependencies:

• libsystemd
• wayland-client
• wayland-protocols (≥ 1.32)
• egl
• glesv2
• wayland-egl
• xkbcommon

Then run:

git clone https://github.com/raybbian/glassnote
cd glassnote
meson setup build
cd build
meson compile

To optionally install both glassnote and gnctl, run:

meson install

Example Usage

gnctl is a CLI tool that assists in the functionality of glassnotes, allowing you to dim the glassnote overlay to access the underlying wayland surface.

When glassnote is running, use

• gnctl show to show the overlay
• gnctl hide to hide the overlay
• gnctl show || gnctl hide to toggle the overlay

These CLI commands should then be dispatched using your Wayland compositor.

Example Hyprland Config:

# Start glassnote if it is not running, otherwise toggle the overlay
bind = SUPER, R, exec, gnctl show || gnctl hide || glassnote

Keybindings

glassnote allows you to change the cursor stroke and size while the overlay is active.

• 1-5 will change the color of the stroke
• Q/- will decrease the stroke size
• W/= will increase the stroke size
• ESC will close/kill glassnote