|
1 | | -# Keyviz |
| 1 | + |
2 | 2 |
|
3 | | -<a href="https://www.producthunt.com/posts/keyviz?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-keyviz" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=354216&theme=neutral" alt="Keyviz - Visualize your keystrokes in real-time | Product Hunt" style="width: 96px; height: 20px;" width="96" height="20" /></a> |
4 | | - |
| 3 | +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. |
5 | 4 |
|
6 | | -Keyviz is a free and open-source software to visualise your ⌨️ keystrokes in real time! Let your audience know what handy shortcuts/keys you're pressing during screencasts, presentations, collaborations, or whenever you need it. |
7 | 5 |
|
8 | | - |
| 6 | +# ⌨️ Keystrokes & 🖱️ Mouse Actions |
9 | 7 |
|
10 | | -## 🦄 Style |
11 | | - |
| 8 | +Now you can visualize mouse actions! Not only mouse clicks, you can also visualize mouse actions along with keystrokes like <kbd>Cmd</kbd> + <kbd>Click</kbd>, <kbd>Alt</kbd> + <kbd>Drag</kbd>, etc. |
12 | 9 |
|
13 | | -Don't restrain yourself to just black & white! Change the visualisation's style, size, colour (modifier and regular keys), border, icon, and symbols. |
| 10 | + |
14 | 11 |
|
15 | | -## ⚙️ Fully Customizable |
16 | | - |
17 | 12 |
|
18 | | -Powerful and easy-to-use configuration options. |
19 | | -- Filter normal keys and only display shortcuts like <kbd>Ctrl</kbd> + <kbd>S</kbd> |
| 13 | +# 🎨 Stylize |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +Powerful and easy-to-use configuration options. |
| 20 | + |
| 21 | +- Filter normal keys and only display shortcuts like <kbd>Cmd</kbd> + <kbd>K</kbd> |
20 | 22 | - Adjust the visualisation position on the screen |
21 | 23 | - Decide how much the visualisation lingers on the screen before animating out |
22 | 24 | - Switch between animation presets to animate your visualisation in & out |
23 | 25 |
|
24 | | -# Installation |
25 | | -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. |
| 26 | +</br> |
26 | 27 |
|
27 | | -Or, install keyviz using [Winget](https://learn.microsoft.com/en-us/windows/package-manager/): |
28 | | -```powershell |
29 | | -winget install mulaRahul.Keyviz |
30 | | -``` |
| 28 | +# 📥 Installation |
31 | 29 |
|
32 | | -Or from [Scoop](https://scoop.sh/): |
33 | | -```powershell |
34 | | -scoop bucket add extras # first, add the bucket |
35 | | -scoop install keyviz |
36 | | -``` |
| 30 | +You can download the latest version of keyviz from the [Github Releases]() page. For the installer, unzip the downloaded file, run the installer and follow the familiar steps to install keyviz. |
| 31 | + |
| 32 | +<details> |
| 33 | + <summary>🥄 Scoop</summary> |
| 34 | + |
| 35 | + ```bash |
| 36 | + scoop bucket add extras # first, add the bucket |
| 37 | + scoop install keyviz |
| 38 | + ``` |
| 39 | + |
| 40 | +</details> |
| 41 | + |
| 42 | +<details> |
| 43 | + <summary>🪟 Winget</summary> |
| 44 | + |
| 45 | + ```bash |
| 46 | + winget install mulaRahul.Keyviz |
| 47 | + ``` |
| 48 | + |
| 49 | +</details> |
| 50 | + |
| 51 | +</br> |
37 | 52 |
|
38 | | -Alternatively, you can get the portable version which doesn't require installation but may or may not work on every system. |
| 53 | +<details> |
| 54 | + <summary><code>*.dll</code> missing error?</summary> |
| 55 | + |
| 56 | + 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). |
39 | 57 |
|
40 | | -# Build Instructions |
41 | | -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/windows). |
| 58 | +</details> |
| 59 | +</br> |
| 60 | + |
| 61 | + |
| 62 | +# 🛠️ Build Instructions |
| 63 | + |
| 64 | +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). |
42 | 65 |
|
43 | 66 | After setting up flutter, clone the repository or download the zip and unpack the same. |
44 | 67 |
|
45 | | -```powershell |
| 68 | +```bash |
46 | 69 | mkdir keyviz |
47 | 70 | git clone https://github.com/mulaRahul/keyviz.git . |
48 | 71 | ``` |
| 72 | +Move inside the flutter project and run the build command to create an executable - |
49 | 73 |
|
50 | | -Move inside the flutter project and run the `build` command to create an executable - |
51 | | - |
52 | | -```powershell |
| 74 | +```bash |
53 | 75 | cd keyviz |
54 | 76 | # get required dependencies |
55 | 77 | flutter pub get |
56 | 78 | # build executable |
57 | 79 | flutter build windows |
58 | 80 | ``` |
59 | 81 |
|
60 | | -You can find the executable here `keyviz\build\windows\runner\<build mode>\`. Learn more [here](https://docs.flutter.dev/platform-integration/windows/building). |
61 | | - |
62 | | -# Quickstart |
63 | | -You can also check out this [video tutorial](https://youtu.be/FwuTqWzlRSc). |
64 | | - |
65 | | -Follow the above [installation](#installation) process to start. Then, you can start visualising your keystrokes by just running the application. |
66 | | - |
67 | | -To open the settings window, find the keyviz icon on the right side of the **Taskbar** or **Taskbar > Hidden Icons <kbd>^</kbd>**. Then right-click on the icon and select **Settings**. |
68 | | - |
69 | | -The settings window will appear, from which you customise the style, appearance, and other general visualisation settings. You can also pause the visualisations temporarily by left-clicking on the tray icon. |
70 | | - |
71 | | -## `*.dll` Missing Error? |
72 | | - |
73 | | - |
74 | | - |
75 | | -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). |
| 82 | +</br> |
76 | 83 |
|
77 | | -# Feature Requests |
78 | | -You can **vote** for planned features in this [📃 poll](https://github.com/mulaRahul/keyviz/discussions/36). |
| 84 | +# 💖 Support |
79 | 85 |
|
80 | | -If you want to request features, start a discussion or join our [discord](https://discord.gg/qyrKWCvtEq) community and let us know about your suggestions. You can go ahead and vote for the requested features by others and see the future development plans. |
| 86 | +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. |
0 commit comments