KeyPrompter

README

KeyPrompter 📽️

Broadcast your shortcuts…

Motivations

I could not find a macOS application to broadcast keyboard shortcuts to a web page so it can be easily used with various live streaming softwares so I decided to build my own.

KeyPrompter is a Go application monitoring keyboard shortcuts and also serving locally a React application which can be used to visualize the pressed shortcuts (only shortcuts are visible meaning typing text won't display anything).

Installation

1. Download the latest version matching your system architecture.
2. Extract the downloaded archive.
3. Optionally, move the keyprompter application in your PATH (e.g. /usr/local/bin/)
4. Ensure the keyprompter application can be executed (e.g. chmod +x keyprompter).

Note: the application has been developed and tested only on macOS with a QWERTY layout and even tho it should technically work on other systems, it will probably require some adjustments and testing.

Usage

You can quickly starts the application using the following command:

$ keyprompter
You can now view the KeyPrompter UI in the browser: http://localhost:8484.

Various options are available:

Option	Default	Description
-p VALUE	8484	Port used to run the web UI.
-c VALUE	None	Path to the optional client configuration file
-v		Display the application version.
-h		Display the application options.

Configuration

Using the -c option, an optional path to a client configuration file can be passed down to the application.

The configuration is a TOML file where any value can be configured individually. Here is an example with the default values for each options:

# The maximum number of shortcuts to display at the same time.
Count = 5

# The duration in seconds during when a shortcut is visible on screen.
Duration = 5

# The font size in pixels used when displaying a shortcut.
FontSize = 18

# The font color used for a shortcut text (any supported CSS value).
FontColor = "white"

# The background color for a shortcut (any supported CSS value).
BgColor = "rgba(0, 0, 0, 0.6)"

Contribute

1. Fork & clone this repository.
2. Make sure your Go version is at least 1.16.
3. Build & run the development version using go run ..

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.