Skip to content

brunosimon/drawverlay

Repository files navigation

Drawverlay

An always-on-top drawing overlay for macOS and Windows. Draw, annotate, and highlight anything on screen during presentations, recordings, or walkthroughs — without interrupting your workflow.

Platform Electron

Website

The marketing website lives in web/. It's an Astro static site. The full Drawverlay drawing app is embedded as an interactive background in the hero — visitors can draw on the page, right-click to open the menu, and use all keyboard shortcuts.

cd web
npm install
npm run dev    # http://localhost:4321
npm run build  # output → web/dist/

Web version

web/app/index.html runs Drawverlay entirely in a browser — no Electron, no install. It uses the same components/renderer.js and components/menu.js unchanged. web/app/bridge.js replaces the Electron preload.js, implementing the same window.drawverlay API surface using CustomEvent for messaging and localStorage for settings and canvas persistence.

Open web/app/index.html directly in a browser (no server needed). The hamburger button in the top-right corner opens the menu panel.

Limitations vs. the native app: no always-on-top overlay, no global keyboard shortcuts outside the browser tab, no multi-display support, no login item.

Install

npm install
npm run setup   # recreate the components/ symlink (required after cloning on Windows)
npm start

Requires Node.js and a recent version of macOS or Windows.

After cloning on Windows

Git on Windows stores symlinks as plain text files when core.symlinks is disabled (the default). The components/ entry at the repo root is one such symlink — without it the Electron app cannot find its HTML/CSS/JS files and won't launch.

Run the setup script once after cloning to recreate it as a directory junction:

npm run setup

On macOS the same script creates a proper symlink. Either way you only need to run it once per clone.

Build

npm run dist:mac   # macOS DMG + ZIP (arm64 + x64 universal)
npm run dist       # current platform

Output goes to the dist/ folder. Requires electron-builder (installed via npm install).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors