Skip to content

Releases: thinakaranmanokaran/Key_Overlayer

Key Overlayer 1.0

22 Nov 07:36

Choose a tag to compare

Key Overlayer — Desktop App v1.0

Summary

  • Version: v1.0 (Initial public release)
  • App: Key Overlayer
  • Platform: Cross-platform Java desktop app (Windows, macOS, Linux)
  • Purpose: Real‑time visual keyboard overlay for presentations, screen recordings, and livestreams — shows pressed keys on screen so viewers can follow input.

Highlights — What's new in v1.0

  • Real‑time key visualization with low latency overlay.
  • Customizable appearance: themes, font size, colors, opacity, and position.
  • Multiple layouts (e.g., full QWERTY and compact modes).
  • Configurable hotkeys to toggle overlay and lock/unlock position.
  • Multi‑monitor support: move and pin overlay to any connected display.
  • Lightweight and performant — minimal CPU/RAM footprint.
  • Settings persistence between sessions.

System requirements

  • Java Runtime: Java 11+ (OpenJDK or Oracle JDK recommended).
  • OS: Windows 10+, macOS 10.14+ (Mojave or newer), or modern Linux (X11/Wayland — Wayland behavior may vary).
  • Typical desktop/laptop hardware — minimal resource needs.

Installation

Option A — Runnable JAR (recommended)

  1. Download the release asset Key_Overlayer-v1.0.jar.
  2. Run:
    java -jar Key_Overlayer-v1.0.jar
    

Option B — Platform installers (if provided)

  • Windows: run Key_Overlayer-Setup-v1.0.exe and follow the installer.
  • macOS: open Key_Overlayer-v1.0.dmg, drag to Applications.
  • Linux: use provided .deb, .rpm, or AppImage assets if available.

Note: Replace asset names above with the actual filenames included in this release.


macOS permissions

  • On first run you may be prompted to grant Accessibility / Input Monitoring permission so the app can detect global key events.
  • To enable manually: System Settings → Privacy & Security → Input Monitoring (or Accessibility) → add Key Overlayer, then restart the app.

Quick start

  1. Launch Key Overlayer.
  2. Open Settings to choose theme, layout, opacity and hotkeys.
  3. Drag the overlay to desired screen position; use the pin control to lock it.
  4. Start your recording/stream — keys pressed will appear on screen.

Usage tips

  • Use a compact layout and higher opacity for streams with small capture windows.
  • Configure a toggle hotkey to hide/show overlay quickly during presentations.
  • Lower animation or refresh rate to reduce CPU usage on low-end systems.

Known issues & limitations

  • macOS: Accessibility/Input Monitoring permission required for key capture.
  • Wayland: Some compositors restrict global key capture — behavior may vary.
  • Virtual machines and some remote desktop environments may not forward key events reliably.
  • v1.0 does not include per-application overlays, per-key advanced highlighting modes, or layout editor (planned for future releases).

Security & privacy

  • Key Overlayer reads local key events only for visualization and does not transmit key data to remote servers by default.
  • No persistent logging of typed content is performed beyond in-memory overlay state.
  • For additional assurance, review the repository source before running or run the app offline.

Troubleshooting

  • Overlay not visible: ensure opacity > 0, overlay unlocked, and hotkey not toggled off.
  • Keys not detected (macOS): enable Accessibility/Input Monitoring permission and restart the app.
  • High CPU usage: disable animations or lower refresh rate in settings.
  • Still stuck: open an issue at https://github.com/thinakaranmanokaran/Key_Overlayer with OS, Java version, and reproduction steps.

Changelog — v1.0

  • Initial public release with:
    • Real‑time key overlay
    • Appearance customization (themes, fonts, colors, opacity)
    • Layout options
    • Hotkeys for quick control
    • Multi‑monitor support
    • Persistent user settings

Release assets (suggested)

  • Key_Overlayer-v1.0.jar
  • Key_Overlayer-Setup-v1.0.exe (Windows installer) — optional
  • Key_Overlayer-v1.0.dmg (macOS image) — optional
  • Key_Overlayer-v1.0.AppImage or .deb/.rpm (Linux) — optional
  • Checksums (SHA256) — include actual values here, for example:
    • Key_Overlayer-v1.0.jar — SHA256: <replace-with-checksum>

Please replace the placeholder asset names and checksums with the actual files and values included in the release.


Credits & support