回答
非常抱歉哇,是我没有写清楚使用方法QAQ,我先简单描述一下吧,等完整的写好应该会直接更新在开发文档里。
📋 准备工作
-
在插件市场中下载开发助手: hamibot-assistant
-
设置好开发者令牌:
- 从 Hamibot 的
令牌
页面获取你的开发者令牌(如果没有请创建一个新的)。 - 在 VS Code 中按
F1
打开命令菜单
,找到并执行Hamibot Config: 设置 Hamibot API 令牌
命令(可以通过搜索Hamibot
快速找到)。 - 将刚才获取到的令牌复制到新打开的对话框中,回车完成设置。
- 从 Hamibot 的
🎉 创建项目
- 打开
命令菜单
,找到并执行Hamibot Operation: 新建 Hamibot 项目
命令。 - 填写项目相关信息来完成创(包括项目名称、选择调试所用机器人、创建所用模板等)。
注意事项:
- 选择项目位置时选中目录是即将存放项目文件夹的目录,插件会自动在文件夹中新建一个与项目同名的新文件夹用来存放项目文件。
- 远程项目模板依赖于
npm
和Git
详细信息参见 "多文件打包" 章节。
🛠️ 运行和调试
-
(可选)如果你新建的项目不是使用模板生成的,那就需要手动标记要上传的文件:
- 在左侧的文件浏览器中找到需要上传的脚本或配置文件。
- 右键点击,然后在菜单中找到并
标记脚本文件
或标记脚本配置文件
,具体出现的选项和你选中的文件类型相关,一次指挥出现一种。
-
(可选)如果在新建项目时没有选择运行所用的机器人,此时建议补充上,而不是等到依赖检测模块提示再设置:
- 打开
命令菜单
,找到并执行Hamibot Project: 设置用于调试的机器人
命令。 - 选择调试所用机器人。
- 打开
-
打开
命令菜单
,找到并执行Hamibot Operation: 上传并运行标记的脚本文件
命令。当然你也可以选择只上传不运行,对应的指令为Hamibot Operation: 上传标记的脚本文件
。 -
(可选)打开
命令菜单
,找到并执行Hamibot Operation: 强制停止脚本运行
命令。如果脚本无法停止让你没法检查数据,可以使用这个指令,但是并不用每次运行前都使用,因为每次启动都会先结束前一次的脚本然后再运行。
注意事项:
- 本节中使用的指令都只能在项目文件夹中使用,不在项目文件夹时并不能找到相关的指令。
- 目前可视化管理脚本配置文件和远程调试并不支持,后者可以使用 Hamibot 官网提供的远程调试临时替代,入口在
控制台
-概览
页面中。
📦 (可选)多文件打包
如果你有打包多文件的需求,本节内容可能会对你有所帮助。因为 Hamibot 目前只支持单一文件的脚本(用 module
模块不算),所以我们可以使用 Webpack 将多个文件打包为一个使用,前端的开发者应该比较熟悉。事实上我提供的多文件模板就相当于一个 cli 帮你提前配置好了相关工具,以达到开箱即用的效果。
- 在新建项目时选择使用多文件模板。
- (可选)新建后修改相关信息(
package.json
),具体操作可以百度。
注意事项:
- 需要在电脑上安装 npm(Node.js 自带的包管理器),用于获取 Webpack 和 babel 。
- 需要在电脑上安装并配置好 Git ,远程模板需要使用 Git clone 到本地。
还有一些细小的功能这里没有提到,剩下的大多数和设置项以及默认值有关。具体可以去翻看插件的 Readme 文档 关于设置和指令的说明。
如果遇到其他使用上的问题或者好得提议都可以在这里回复我,我每天都会看。
ORZ
可以试试这个简单版的
VS Marketplace 链接: https://marketplace.visualstudio.com/items?itemName=hamibot.vscode-hamibot