/KmCaster

Capture keyboard and mouse events for screencasting

Primary LanguageJavaMIT LicenseMIT

Total Downloads Release Downloads Released Version

Introduction

Java-based on-screen display (OSD) for keyboard and mouse events.

This program displays keyboard and mouse events for the purpose of screencasting. While such software already exists, none meet all the following criteria:

  • custom display size;
  • easily positioned;
  • show single events;
  • show all mouse clicks;
  • show scrolling;
  • configurable translucent background colour;
  • configurable gaps between keys;
  • accurate modifier key states; and
  • works with emulation software (e.g., Sikuli).

Alternatives

Comparison

The following video compares KmCaster to key-mon:

KmCaster Demo

The UI has been modernized:

KmCaster UI

Requirements

OpenJDK version 19.0.1 or newer.

Linux Java Version

Depending on the Linux distribution, Java 19+ can be installed by issuing one of the following commands in a terminal:

sudo apt install openjdk-19-jdk
sudo pacman -S jdk-openjdk

Switching from earlier versions of Java can be accomplished by issuing one of the following commands in a terminal:

sudo update-alternatives --config java
sudo archlinux-java set java-19-openjdk

Note: on some Linux operating systems you may need to add a repository. On Ubuntu 18.04 run the following commands before trying to install Java 19, for example (source):

sudo add-apt-repository ppa:linuxuprising/java
sudo apt install openjdk-19-jdk

Download

Download the latest Java Archive file:

Download

Running

After installing Java, run the program as follows:

java -jar kmcaster.jar

To see the configuration options, run the program as follows:

java -jar kmcaster.jar -h

To quit the application:

  1. Click the application to give it focus.
  2. Press Alt+F4 to exit.

Error Messages

Earlier versions of Java will display the following message:

Error: A JNI error has occurred, please check your installation and try again.