diff --git a/README.md b/README.md index 745f177..38b4ad7 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ 基于 electron 的工具箱。Rubick(拉比克) 是 dota 里面的英雄之一,其核心技能是插件化使用其他英雄的技能,用完即走。非常符合本工具的设计理念,所以取名 Rubick。 ## 安装包 -* [Rubick Mac OS V0.0.2-beta.2](https://github.com/clouDr-f2e/rubick/releases/tag/v0.0.2-beta.2) -* [Rubick Windows V0.0.2-beta.2](https://github.com/clouDr-f2e/rubick/releases/download/v0.0.2-beta.2/rubick2.Setup.0.0.2-beta.2.exe) +* [Rubick Mac OS V0.0.3-beta.1](https://github.com/clouDr-f2e/rubick/releases/tag/v0.0.3-beta.1) +* [Rubick Windows V0.0.3-beta.3](https://github.com/clouDr-f2e/rubick/releases/download/v0.0.3-beta.1/rubick2.Setup.0.0.3-beta.1.exe) -## 支持能力。 +## 支持能力 - [x] 支持远程下载安装插件,支持插件开发者模式 - [x] 支持插件分离 - [x] 支持系统命令取色、截屏、帮助 @@ -32,8 +32,12 @@ - [ ] 支持 Linux -![QQ20210705-210753](https://user-images.githubusercontent.com/21073039/124477360-8770f980-ddd6-11eb-8dc3-ba318223697f.gif) +![example.gif](https://user-images.githubusercontent.com/21073039/128359309-2377d3cf-7b70-4e8f-9973-ae8f337a8006.gif) + +## 使用文档 + +[Rubick Docs](https://cloudr-f2e.github.io/rubick/) ## 使用问题 @@ -48,7 +52,7 @@ ![image.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1706cc730f1f46078cb700a445211317~tplv-k3u1fbpfcp-watermark.image) ### 模板 -为了更贴合 `uTools` 的插件能力,需要实现模板功能,模板即是一个内置 UI 样式的功能插件。 +模板即是一个内置 UI 样式的功能插件。 diff --git a/docs/docs/.vuepress/config.js b/docs/docs/.vuepress/config.js index 708109c..4d43331 100644 --- a/docs/docs/.vuepress/config.js +++ b/docs/docs/.vuepress/config.js @@ -24,6 +24,10 @@ module.exports = { title: '开发者', path: '/dev/', }, + { + title: '常见问题', + path: '/qs/', + }, { title: 'TODO: 原理解析', children: [ diff --git a/docs/docs/.vuepress/public/images/6.png b/docs/docs/.vuepress/public/images/6.png new file mode 100644 index 0000000..580899c Binary files /dev/null and b/docs/docs/.vuepress/public/images/6.png differ diff --git a/docs/docs/dev/README.md b/docs/docs/dev/README.md index 1f335d4..c13acac 100644 --- a/docs/docs/dev/README.md +++ b/docs/docs/dev/README.md @@ -75,7 +75,7 @@ rubick 更多支持 API 能力参考:[rubick 全局API](https://github.com/clo 复制 `plugin.json` 文件,在 `rubick` 主窗口执行 `ctrl/command + v` 即可唤起安装插件的功能,选择`新建rubick插件`,进入插件主界面, 开启插件后,在插件主窗口即可通过命令打开插件: -![](/images/5.gif) +![](/rubick/images/5.gif) 本小节所有代码:[rubcik-plugin-demo](https://github.com/clouDr-f2e/rubick-plugin-demo) diff --git a/docs/docs/guide/README.md b/docs/docs/guide/README.md index fc4bd77..563a973 100644 --- a/docs/docs/guide/README.md +++ b/docs/docs/guide/README.md @@ -3,7 +3,7 @@ 安装完成后打开 rubick 即可看到主搜索界面: -![](/images/1.png) +![](/rubick/images/1.png) 目前支持 windows 和 macos。linux 小伙伴正在开发中 @@ -21,7 +21,7 @@ ``` 也就是说只要当前系统软件安装到这些目录才会被检索到。支持中文搜索和拼音、拼音首字母搜索: -![](/images/2.gif) +![](/rubick/images/2.gif) `Windows` 内由于安装目录太多不确定,有的在 C盘,有的在D盘,还有的在自定义其他位置,所以该功能还在设计中,如果您有好的方案也欢迎提供:[issues](https://github.com/clouDr-f2e/rubick/issues) @@ -42,13 +42,13 @@ 点击搜索框右侧 rubick 图标,进入插件市场,选择所需插件,点击下载按钮即可下载,下载完成后在已安装 tab 下可以找到安装插件。 安装完成后,输入插件呼起命令即可使用对应插件: -![](/images/3.gif) +![](/rubick/images/3.gif) ### 4. 右击增强 通常我们需要使用鼠标右击来对桌面属性进行拓展,`Rubick` 支持对右击属性进行增强功能,长按鼠标右键即可呼起。如果安装的插件支持 特殊类型的文件操作,还可以在右键中唤起插件: -![](/images/4.gif) +![](/rubick/images/4.gif) ### 更多功能 如果您还需要更多功能,欢迎来这里给我们提建议:[issues](https://github.com/clouDr-f2e/rubick/issues/20) diff --git a/docs/docs/qs/README.md b/docs/docs/qs/README.md new file mode 100644 index 0000000..bdf8a3b --- /dev/null +++ b/docs/docs/qs/README.md @@ -0,0 +1,99 @@ +## windows 本地启动项目 +**windows 项目地址目前在 `feat-win` 分支,需要切换到 `feat-win`。** +如果您是在 `windows` 系统下使用本项目进行启动的话,如果出现了一些跑不起的情况,下面的一些经验或许可以帮助您。 + +### 安装依赖 +项目是基于 `electron-vue` 的,所以需要本地已经安装好 `nodejs`。当 `clone` 好项目到本地的时候,需要对项目依赖 +进行手动安装: +```bash +$ cd rubick +$ npm install +``` +由于本项目依赖 [iohook](https://wilix-team.github.io/iohook/) 和 [robotjs](http://robotjs.io/) +而这2个项目在安装时,依赖 node gyp 的编译,所以你可能会遇到一些环境问题或者网络问题。 +### iohook 安装 +首先,我们先来安装 `iohook`,按照 `iohook` 的文档所示,安装前需要先确定当前 `electron` 的版本以及 `abi` 的版本, +现在我们使用的 `electron` 版本是 `v11.0.2` 所以只需要在 `package,json` 中加上以下配置,指定安装特点的`.node` 文件 + +```json +{ + "iohook": { + "targets": [ + "node-83", + "electron-85" + ], + "platforms": [ + "win32" + ], + "arches": [ + "x64", + "ia32" + ] + } +} +``` +接下来执行安装操作: +```shell +$ npm i iohook +``` + +如果此时一直停留在 `node install` 进度上,说明可能需要翻墙,这里就不介绍如何翻墙了。此时虽然 `.node` 文件没有下载成功,但是 `iohook` 源文件 +已经安装成功,如果因为翻墙问题导致的安装失败,我们解决好翻墙问题后,可以接着运行一下: + +```shell +$ npm run rebuild_win +``` +到这里 `iohook` 应该就安装好了 + +### 安装 robotjs +和 iohook 不同, `robotjs` 需要 `node gyp` 重新编译 `C++`。所以第一步是先安装源文件: +```shell +npm i robotjs@git+https://github.com/Toinane/robotjs.git +``` +此时如果报错,大多还是因为墙的问题。不管包不报错,我们接下来都需要执行一下下面的编译操作: + +```shell +npm run rebuild_win +``` +此时,可能会出现下这个错: + +```text +gyp ERR! find VS msvs_version not set from command line or npm config +// ... +``` +google 了一圈,大多数是说缺少 `visual studio`。需要安装,所以可以执行这个命令: + +```shell +$ npm install --global --production windows-build-tools +``` +到这里会进入正常的安装流程,理论上会一部到底,如果你卡在了 `Successfully installed Python 2.7` 不动了 +可以去一下 `C:\Users\you username\.windows-build-tools` 找一下看看应该会有一个 `vs_BuildTools` 文件 +双击后,会出现以下弹窗: + +![](/rubick/images/6.png) + +点击启动,如果一切正常那么可以方向关掉你的命令行了,此时 vs 已经安装成功,接下来要配置一下编译工具: +```shell +$ npm config set python python3.9 +$ npm config set msvs_version 2017 +``` +到这里终于完事了,再执行一下 `npm run rebuild_win` 此时已经安装成功! + +## macos +macos 下安装就简单不少了,首先先解决翻墙的问题,然后: +```shell +$ npm i +``` + +最后执行 + +```shell +$npm run rebuild +``` + +## 最后 +如果您在启动过程中还有其他的问题,欢迎随时给我们反馈,我们会在第一时间回复:[issues](https://github.com/clouDr-f2e/rubick/issues/20) + + + +