Signpost 项目使用教程

云云乐Lynn

于 2024-09-25 08:07:29 发布

阅读量750

点赞数 19

本文链接：https://blog.csdn.net/gitblog_00461/article/details/142508752

版权

Signpost 项目使用教程

Signpost A simple tool to show keys pressed on the screen for Windows 10. It could be helpful when you record the screen. 项目地址: https://gitcode.com/gh_mirrors/sig/Signpost

1. 项目目录结构及介绍

Signpost 项目的目录结构如下：

Signpost/
├── .gitignore
├── LICENSE
├── README.md
├── config.json
├── custom.css
├── electron-builder.json
├── icon.png
├── index.html
├── main.js
├── package-lock.json
├── package.json
├── preload.js
├── style.css
└── (其他文件和目录)

目录结构介绍

.gitignore: 指定 Git 版本控制系统忽略的文件和目录。
LICENSE: 项目的开源许可证文件，本项目使用 MIT 许可证。
README.md: 项目的介绍文件，包含项目的基本信息和使用说明。
config.json: 项目的配置文件，用于自定义显示设置。
custom.css: 自定义 CSS 文件，用于修改按键显示的样式。
electron-builder.json: Electron 构建配置文件，用于打包应用程序。
icon.png: 应用程序的图标文件。
index.html: 项目的主 HTML 文件，定义了应用程序的用户界面。
main.js: 项目的启动文件，负责初始化和运行应用程序。
package-lock.json: 锁定项目依赖包的版本。
package.json: 项目的元数据文件，包含项目的依赖和脚本。
preload.js: 预加载脚本，用于在渲染进程启动前加载必要的资源。
style.css: 项目的样式文件，定义了应用程序的外观。

2. 项目启动文件介绍

项目的启动文件是 main.js，它负责初始化和运行 Signpost 应用程序。以下是 main.js 的主要功能：

初始化 Electron 应用程序: 通过 app 模块初始化 Electron 应用程序。
创建窗口: 使用 BrowserWindow 模块创建应用程序的主窗口。
加载 HTML 文件: 通过 loadFile 方法加载 index.html 文件，显示用户界面。
处理事件: 处理应用程序的生命周期事件，如 ready、window-all-closed 和 activate。

3. 项目配置文件介绍

项目的配置文件是 config.json，它位于用户配置目录下的 signpost 文件夹中（例如 %UserProfile%\signpost\config.json）。以下是 config.json 的配置项及其说明：

{
  "display": 0,
  "fadeDelay": 3,
  "position": "bottomright",
  "offsetX": -20,
  "offsetY": -50,
  "showPrintableKey": false
}

配置项说明

display: 默认值为 0，表示主显示器。指定按键显示的显示器。
fadeDelay: 默认值为 3，表示按键显示的淡出延迟时间（秒）。
position: 默认值为 "bottomright"，表示按键显示的位置。可选值包括 top、bottom、left、right、topleft、topright、bottomleft 和 bottomright。
offsetX: 默认值为 -20，表示按键显示位置的 X 轴偏移量（像素）。
offsetY: 默认值为 -50，表示按键显示位置的 Y 轴偏移量（像素）。
showPrintableKey: 默认值为 false，表示是否显示可打印的按键。如果设置为 true，则所有按键都会显示在屏幕上。