- Key statistics with customizable keyboard, view statistics
- Key display, real-time display of key status, supports multiple display styles for keys, such as rounded corners, fade out, custom movement directions, etc . , support for multiple screens, similar to Carnac
- Support Chinese and English switching and light & dark theme switching
- Support parameters import and export
- Support remote statistics and settings
- For privacy and security, showKeyBoard only records statistical information, do not record specific content, and save the content locally
- Support the statstics of mouse and keyboard of different application programs
- Supports the analysis of the usage time of each application. The basic principle is as follows: count the list of applications used every minute, and then allocate and summarize the usage time to each application,Note: The application requires mouse or keyboard operation.
- Display the status of control keys/status keys in real-time, including the status of the Caps Lock, Scroll Lock, Num Lock keys, as well as the Ctrl, Shift, and Alt keys.
- Show the last N keystrokes (not saved)
- Support gamepad joystick and button detection.
- Support the synchronization of multiple device records through third-party tools (FreeFileSync is recommended)
- Supports historical app usage duration statistics, as well as trend analysis of daily usage duration and app count
- Supports real-time viewing of key information via the web interface. Method: Settings → Popup UI → Web Key Display, it can support the independent display of keys in OBS (Open Broadcaster Software), and can also turn off the desktop key display to show them only in the web.
- Supports analyzing the usage rate of each finger based on key mapping (customizable).
- Windows 64-bit system, Windows10 , Windows11 or MacOS 12 Monterey(x86_64 /aarch64)及以上 is recommended
- Have a modern browser (Edge/Chrome/FireFox/Safari, etc.)
Install for the first time, install
ShowKeyBoard_Setup_(version)_(date).exe
Unzip version as below, please note that manual backup and restore of data is required when update
`ShowKeyBoard_portable_(version)_(date).7z
Follow the prompts to select during installation, such as whether to keep the configuration, whether to create a shortcut, etc. The default configuration can be used in general
Note:
- Due to the use of system hooks, some computers may report viruses by mistake and need to be trusted.
- On some systems, you may need to run in administrator mode, otherwise showKeyBoard will not be able to listen to the keys
- If the system time is incorrect, for example, the time of a certain day changes to N years later, it may lead to the loss of application usage duration data. Please run the
fixStat修复统计数据.batfile in the installation directory.
This version starts with 1.xx, and after 1.61, it is dominated by Rust
-
If you have node10 or above environment, or have installed it once, install
ShowKeyBoard_Setup_(version)_(date)(node).exeorShowKeyBoard_Setup_(version)_(date).node.exe -
Some companies may have installed encryption software, which will encrypt the configuration files, causing all parameters to become invalid. In this case, you can rename
./httpdist/dist/node.exein the installation directory to./httpdist/dist/chrome.exe, and modify theshowKeyBoard.inifile in the installation directory by adding the parameterserverExecName=./httpdist/dist/chrome.exe.
This version starts with 2.xx All user data has been migrated to the following locations: For Windows, the user directory is %USERPROFILE%\Documents\ [Documents]; for MacOS, it is ~/Documents [Documents] User directory\ShowKeyBoard
├─ records.db ← Main statistical database ├─ showKeyBoard.ini ← Main configuration file ├─ KeyList.txt ← Key display and matching list ├─ kbserver.pid ← Process ID, used for data retention in case of abnormal power loss ├─ lastRecord.json ← Last temporary data, used for data retention in case of abnormal power loss ├─ updateTime.txt ← Last updated time, used for data retention in case of abnormal power loss ├─ dbs\ ← Shared/Other Device Libraries ├─ backup\ ← Local data backup repository; automatic backup upon restart, scheduled cleanup ├─ share\ ← Backup repository of other terminals, which will be automatically converted to dbs for access └── uploads\ ← directory for user uploads
Launch showkeyboard.exe
- Direct drag installation
- Release in system settings
- The prompt "Finish" pops up
- Open: System Settings → Privacy and Security, scroll down
- In the "Security" block, a line will appear: * * ShowKeyBoard has been blocked because it is from an unidentified developer**
- Click "Still Open" on the right and enter the power on password to confirm
- Since the program needs to read mouse and keyboard events, it needs to check ShowKeyBoard.app in
System Settings ->Privacy and Security ->Auxiliary Functions or Device Control and Data Access - If you want to upgrade, you need to first delete ShowKeyBoard.app in
System Settings ->Privacy and Security ->Auxiliary Functions or Device Control and Data Access->` Restart the program and then allow
Here is an example of FreeFileSync synchronization FTP
- First set the directory where shared files are saved. The default directory is share in the user directory
- Configure synchronization between local share and FTP server in FreeFileSync, and generate the synchronization file as ffs_batch file, such as Keyboard.ffs_batch
- Set the Interval hours for generating shared files to indicate how often local records are packaged
- Set the command to be automatically executed after packaging. If FreeFileSync is installed, you can directly execute the ffs_batch file. For example, the command can be configured as Keyboard.ffs_batch above
- The share name defaults to the computer name, which can be changed by itself and will be displayed in the history and statistics module
- The system will check the files in the shared file directory every minute and decompress them to the dbs directory. If there are updates, they will be decompressed again
- In the history and statistics module, you can select and view the records of other devices after local decompression
分享
The key monitoring client uses AutoHotkey v2.1alpha.18 + Windows API
The interface display uses HTML, and node does WebSocket and HTTP communication
The client program only reads the configuration file and sends data, and does not write the configuration file
The client includes a low-level hook process, which is used to decouple the process and the display of the data processing interface.
The HTTP side writes the configuration file and receives the HTML front-end data
Nodejs Version
graph LR
Client -->|Post/Launch|NodeServer ---|WebSocket/Post/Get|Web
NodeServer -->|WebSocket|Client
NodeServer ---|R/W|ConfigFile
ConfigFile -->|Reload|Client
HookKey -->|SendMessage|Client
Client -->|Launch|HookKey
Rust Version
graph LR
Client -->|Post/Launch|Server ---|WebSocket/Post/Get|Web
Server ---|WebSocket|Client
Server ---|R/W|ConfigFile
ConfigFile ---|R/W|Client
httpis the server-side code, usenpm run buildto package and generate thehttpdistdirectoryui-helperis the client configuration pagenpm run buildto generate thedistdirectory, which needs to be placed in thehttpdist/dist/uidirectory when publishing- The root directory is the AutoHotkey v2.1alpha.18 script, which needs to be packaged into exe with the AutoHotkey tool for
showKeyBoard.ahk, and the corresponding exe file needs to be placed in the same level directory ashttpdist - Starting from version 2.0, Autohotkey and nodejs have been replaced with rust+slint implementation
KeyList.txtin the root directory saves key characters directory.showKeyBoard.inisaves the client configuration , move to user directoryhttpdist/dist/records.dbsaves the statistical information of the keys and the related configuration information of the statistics, move to user directoryshowkeyboard.exeprovides both front-end key display and back-endhttp/websocketservices
Each directory contains a readme.md or readme.txt with relevant instructions. For development interfaces, see Interface Description.
When input is entered rapidly, there may be a slight delay in the interface display as the input is processed through a queue.
The client function refers to part of the design of KMCounter and Carnac
The UI interface uses the Naive UI framework











