https://github.com/sneezry/signpost

A simple tool to show keys pressed on the screen for Windows 10. It could be helpful when you record the screen.
https://github.com/sneezry/signpost

Last synced: 2 months ago
JSON representation

A simple tool to show keys pressed on the screen for Windows 10. It could be helpful when you record the screen.

• Host: GitHub
• URL: https://github.com/sneezry/signpost
• Owner: Sneezry
• License: mit
• Created: 2020-01-04T12:13:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-01-04T19:10:56.000Z (about 5 years ago)
• Last Synced: 2024-10-26T04:25:00.391Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 99.6 KB
• Stars: 108
• Watchers: 3
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Signpost

A simple tool to show keys pressed on the screen for Windows 10. It could be helpful when you record the screen.

## Configuration

The configuration file locates at `%UserProfile%\.signpost\config.json`.

```json

{

  "display": 0,

  "fadeDelay": 3,

  "position": "bottomright",

  "offsetX": -20,

  "offsetY": -50,

  "showPrintableKey": false

}

```

* `display`: default to 0, which is your primary display.

* `fadeDealy`: time in second before fade popup.

* `position`: popup position on the screen, valid values are `top`, `bottom`, `left`, `right`, `topleft`, `topright`, `bottomleft` and `bottomright`.

* `offsetX`: offset x in pixel relative to the position.

* `offsetY`: offset y in pixel relative to the position.

* `showPrintableKey`: whether or not to show printable keys, if set to true, any key you pressed will be shown on the screen.

## Custom CSS

The custom CSS locates at `%UserProfile%\.signpost\custom.json`.

```css

#signpost {

  background: #ccc;

  color: black;

  opacity: 0.75;

}

.kbd {

  border: 1px solid black;

}

.plus {

  margin: 0 1em;

}

```

* `#signpost`: popup style

* `.kbd`: key style

* `.plus`: plus symbol style