| GitHub | 您所在的位置：网站首页 › 平台功能模块路开发应用 › GitHub |
GitHub
|
项目迁移至 https://github.com/rubickCenter/native
简体中文 | English
基于 Rust / WASM 提供截图、取色、键鼠事件监听模拟、图像处理、获取已安装应用等跨平台功能的现代异步 Nodejs 模块，占用空间小, 安装便捷, 使用简单, 高性能, 资源占用极小, 可取代 iohook 和 robotjs 功能设备监听与模拟 获取鼠标位置 键鼠事件监听 键盘事件模拟 鼠标事件模拟 订阅快捷键事件图像与屏幕 截图 获取鼠标像素颜色(主屏幕) 图片缩放 图片取色 图片裁剪 多屏幕截图系统信息 获取已安装的应用列表(linux✅/macos✅/windows✅) 获取已安装应用的详细信息(linux✅) 获取系统语言其他工具 asar 打包压缩解压 (zstd 算法) 安装与 iohook 与 robotjs 不同, 你不需要针对不同版本进行繁琐的重新编译, 一切开箱即用 无论你是在 node 中还是在 electron 中，都可以用你喜欢的包管理器直接安装: # npm npm install --save rubickbase # yarn yarn add rubickbase # pnpm pnpm add rubickbase 注意事项rubickbase 基于 N-API v6 , 因此 Nodejs 环境推荐以下版本 v10.x ,v12.x ,14.x, 15.x, 16.x Electron 环境推荐以下版本 v13.x,v14.x ,v15.x ,16.x 快速开始 引入依赖rubickbase 支持 cjs 和 esm 两种规范，当然你可以并且推荐在 TypeScript 中使用它 // cjs const { newRubickBase } = require('rubickbase') // esm / typescript import { newRubickBase } from 'rubickbase' 基本使用在这个例子中，你通过 newRubickbase 获得了 rubickbase 服务实例，你可以通过 getAPI 获取到 rubickbase 所有功能 这里每隔一秒获取当前的鼠标位置 const { newRubickBase } = require('rubickbase') // init rubickbase const rubickBase = newRubickBase() setInterval(async () => { // start rubickbase and get APIs const api = await rubickBase.getAPI() // print Cursor Position console.log(api.getCursorPosition()) }, 1000) 可选初始化参数 参数名称 参数意义 类型 port GRPC 服务器的端口 number logger 日志器 Logger tmpdir 临时文件目录 string workerBoot 是否将 worker 一起启动 boolean ioEventCallback 侦听所有设备事件的回调函数 EventCallback 高级启动rubickbase 由 GRPC 服务器 master 与多个提供不同功能的 worker 组合运行 一般来说，当你调用 getAPI 时，rubickbase 会自动开启所有服务，但如果你需要在不同的地方或时间运行他们, 就可以手动控制他们的生命周期，达到更精细的控制 首先你需要在 master 启动时选择不启动 workers，这时候 master 会侦听来自 worker 的消息 // init rubickbase const rubickBase = newRubickBase({ workerBoot: false }) rubickBase.start()然后在需要的地方手动启动 workers const rubickWorker = newRubickWorker() // 启动所有 worker rubickWorker.start() // 单独启动 ioio worker rubickWorker.start('ioio')注意, worker 的生命周期(存在时间)必须比 master 要短, 否则 worker 中的 GRPC client 会抛出找不到服务端的异常 并且如果你在启动 master 时更改了端口, 那么也要把端口传递给 worker // init rubickbase const rubickBase = newRubickBase({ port: 8001, workerBoot: false }) rubickBase.start() // then const rubickWorker = newRubickWorker({ port: 8001 }) rubickWorker.start() 直接使用底层无状态 API允许你在不启动 master 和 worker 的情况下直接调用一些基础 API const { language, sendEvent, getInstalledApps, screenCapture, screenCaptureAll, screenCaptureAroundPosition, } = await newRubickBase().getBasicAPI() 设备输入事件模拟模拟设备输入事件非常简单，只要调用 sendEvent 即可 由于 rubickbase 是用 TypeScript 书写，书写 Event 时编辑器会自动提示 // 这里将会模拟按下 F1 键 api.sendEvent({ device: 'KeyBoard', action: 'Press', info: 'F1', }) // 这里将会模拟按下鼠标中键 api.sendEvent({ device: 'Mouse', action: 'Press', info: 'Middle', }) 设备输入事件侦听通过 setEventChannel API 创建目标事件频道, 获取对应事件的订阅器 // 这里创建了监听鼠标左键的频道 const register = api.setEventChannel({ device: 'Mouse', action: 'Press', info: 'Left', }) // 查看目前所有已创建的事件订阅 console.log(api.allEventChannels()) // 通过 `registerHook` 注册打印函数 register('myeventchannel', async (e) => { console.log(e) }) // 删除事件频道 api.delEventChannel('myeventchannel') console.log(api.hasEventChannel('myeventchannel'), api.allEventChannels()) 检索和关闭频道allEventChannels 可以获得目前所有已存在的事件频道 hasEventChannel 可以判断是否有某个名字的频道 delEventChannel 可以删除创建的事件频道 事件模糊匹配一个设备事件有 device action info 三个约束条件, 你可以去掉其中的任何条件来完成事件模糊匹配 // 匹配鼠标左键的按下事件 api.setEventChannel({ device: 'Mouse', action: 'Press', info: 'Left', }) // 匹配鼠标移动事件 api.setEventChannel({ device: 'Mouse', action: 'Move', }) // 匹配鼠标所有键的按下事件 api.setEventChannel({ device: 'Mouse', action: 'Press', }) // 匹配所有设备所有键的按下事件 api.setEventChannel({ action: 'Press', }) 图像处理rubickbase 基于 Photon 的高性能 WASM 模块进行图像处理 取色 Image.colorAt const color = img.colorAt({ x: 1, y: 1 }) 缩放 Image.resize输入宽和高，输出缩放后的图像 const newImg = img.resize(100, 100) 可选缩放算法默认最邻近差值算法，其他的算法的图像结果边缘更光滑，可以根据自己的需要进行选择 最邻近差值算法 = 1, 二值寻找算法 = 2, CatmullRom 插值算法 = 3, 高斯算法 = 4, 插值算法 = 5 const newImg = img.resize(100, 100, 1) 裁剪 Image.crop输入左上角的点、宽、高，输出裁剪后的图像 const newImg = img.crop({ x: 5, y: 5 }, 10, 10) 功能一览rubickbase 还有以下功能: 获取鼠标当前座标 getCursorPosition: () => Position 获取鼠标当前座标的像素值 此 API 仅适用于主屏幕 getCursorPositionPixelColor: () => Promise< Color > 主屏幕截屏 screenCapture: () => Promise< Image > 所有屏幕截屏 screenCaptureAll: () => Promise< Image[] > 获取鼠标周围图像 此 API 仅适用于主屏幕 screenCaptureAroundPosition: (position: Position, width: number, height: number) => Promise< Image > 获取系统内已安装的应用列表 getInstalledApps: (getDetailInfo: boolean = false, extraDirs?: Array< string >) => Promise< string > getDetailInfo 是否获取应用详细信息 默认否 (目前只有 Linux 有效) extraDirs 额外要扫描的目录 return JSON 格式的快捷方式路径列表 如果 getDetailInfo 为 true, 那么返回应用详细信息列表 应用详细信息字段解释name: 名称 icon_path: 各个尺寸的图标列表 description: 应用描述 command: 应用启动命令 desktop_entry_path: 快捷方式路径 扫描原理扫描系统存放快捷方式的目录来获取所有系统内安装的应用, 包含的扫描格式: 平台 后辍名 linux desktop macos app,prefPane windows lnk获取系统语言 language: () => Promise< string > asar + zstd 压缩 是 electron 官方 asar 格式的超集，兼容打包解包官方 asar 文件，增加了 zstd 压缩算法，可减少文件60-85%的大小 asarList(path: string): Promise< Array < string > | undefined> asarExtractFile(path: string, dest: string): Promise< undefined > asarExtract(path: string, dest: string): Promise< undefined > asarPack(path: string, dest: string, level?: number): Promise< undefined > 贡献与联系欢迎任何形式的贡献与开源协作！ 项目依赖 pnpm 包管理器, 你需要先安装它 npm install -g pnpm 项目采用全自动化的代码检查与构建, 使用以下命令进行开发即可 Action Command Install · pnpm i Build · pnpm build Commit · pnpm commit Release · pnpm release关注公众号后发送联系关键字加我微信: 本项目遵守 MPLv2 协议 |
【本文地址】