Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mulaRahul/keyviz

Keyviz is a free and open-source tool to visualize your keystrokes ⌨️ and 🖱️ mouse actions in real-time.
https://github.com/mulaRahul/keyviz

flutter flutter-desktop keypress keystroke

Last synced: about 2 months ago
JSON representation

Keyviz is a free and open-source tool to visualize your keystrokes ⌨️ and 🖱️ mouse actions in real-time.

Host: GitHub
URL: https://github.com/mulaRahul/keyviz
Owner: mulaRahul
License: gpl-3.0
Created: 2022-07-22T13:03:59.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-04-27T07:43:17.000Z (5 months ago)
Last Synced: 2024-05-02T04:08:01.102Z (5 months ago)
Topics: flutter, flutter-desktop, keypress, keystroke
Language: Dart
Homepage: https://mularahul.github.io/keyviz
Size: 3.79 MB
Stars: 4,191
Watchers: 18
Forks: 140
Open Issues: 31
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome - mulaRahul/keyviz - Keyviz is a free and open-source tool to visualize your keystrokes ⌨️ and 🖱️ mouse actions in real-time. (Dart)
awesome - mulaRahul/keyviz - Keyviz is a free and open-source tool to visualize your keystrokes ⌨️ and 🖱️ mouse actions in real-time. (Dart)

README

![keyviz-2.0](previews/banner.svg)

Keyviz is a free and open-source software to visualise your keystrokes and mouse actions in real time! Let your audience know what handy shortcuts/keys you're pressing during screencasts, presentations, collaborations, or whenever you need it.

**English** | [简体中文](./README_zh_CN.md)

# ⌨️ Keystrokes & 🖱️ Mouse Actions

Now you can visualize mouse actions! Not only mouse clicks, you can also visualize mouse actions along with keystrokes like Cmd + Click, Alt + Drag, etc.

![key-visualizer](previews/visualizer-bar.svg)

# 🎨 Stylize

Don't restrain yourself to just black & white! You can customize every aspect of the visualization. The visualisation's style, size, colour (modifier and regular keys), border, icon, etc.

![settings-window](previews/settings.svg)

Powerful and easy-to-use configuration options.

- Filter normal keys and only display shortcuts like Cmd + K **(Default)**
- Adjust the visualisation position on the screen
- Decide how much the visualisation lingers on the screen before animating out
- Switch between animation presets to animate your visualisation in & out

# 📥 Installation

You can download the latest version of keyviz from the [Github Releases](https://github.com/mulaRahul/keyviz/releases) page. For the installer, unzip the downloaded file, run the installer and follow the familiar steps to install keyviz.

Below are the platform specifics options and requirements -

🪟 Windows

### 👜 Microsoft Store
You can download keyviz directly from the [microsoft store](https://apps.microsoft.com/detail/Keyviz/9phzpj643p7l?mode=direct).

### 🥄 Scoop
```bash
scoop bucket add extras # first, add the bucket
scoop install keyviz
```

### 📦 Winget
```bash
winget install mulaRahul.Keyviz
```

*.dll missing error?

If you're getting a `.dll` missing error after installing the application, you're missing the required Visual C++ redistributables. You can get the same from here [VSC++ Redist](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).

🍎 MacOS

### 🔒 Permission

Keyviz requires **Input Monitoring** and **Accessibility** permissions. Enable the same in settings -

```
Settings > Privacy & Security > Input Monitoring/Accessibility
```

🐧 Linux

### ❗ v2.x.x Requirements
```bash
sudo apt-get install libayatana-appindicator3-dev
```
or
```bash
sudo apt-get install appindicator3-0.1 libappindicator3-dev
```

# 🛠️ Build Instructions

You can always further develop/build the project by yourself. First of all ensure that you've setup Flutter on your system. If not follow this [guide](https://docs.flutter.dev/get-started/install).

After setting up flutter, clone the repository if you have `git` installed or download the zip and unpack the same.

```bash
mkdir keyviz
cd keyviz
git clone https://github.com/mulaRahul/keyviz.git .
```

Move inside the flutter project and run the build command to create an executable -

```bash
flutter build windows
```

# 💖 Support

As keyviz is freeware, the only way I can earn is through your generous donations. It helps free my time and work more on keyviz.