新的介绍内容

功能概述

BeautykitScriptingTools是一款专为beautykit特效Lua脚本开发者设计的强大工具，基于VS Code平台，支持Windows和MacOS操作系统。该工具主要提供以下功能：

• beautykit引擎中的Lua脚本调试器（debugger），帮助您快速定位和解决代码问题。
• Lua代码补全（code completion），提升您的开发效率。

安装指南

• 在线安装：在VS Code插件市场中搜索“BeautykitScriptingTools”，即可轻松安装。
• 离线安装：通过VS Code插件界面中的“从VSIX安装”选项，选择下载的vsix文件进行安装。

使用指南

在VS Code中使用

• 创建项目：在VS Code中打开一个文件夹，右键点击资源管理器中的文件夹，选择“初始化BK特效项目”，插件将自动生成项目初始文件。
• 编辑脚本：在VS Code中编辑项目中的Lua文件，插件会自动提供代码补全、定义跳转和格式化等功能，提升您的编辑体验。
• 调试Lua：使用VS Code左侧的调试面板启动预览模块，加载特效模块，并在断点处暂停，利用变量视图、监视视图、调用堆栈视图和断点视图进行调试。
• PC端调试：在调试面板中选择“local”选项，点击三角形按钮或使用F5快捷键启动调试。
• 移动端调试：在移动端程序中启用LuaPanda.lua文件，并通过特效同步功能生成文件。启动调试功能后，在VS Code中选择“bklua：remote”调试配置，并按F5启动调试。
• 特效同步：用于移动端调试，确保在加载特效模块前同步VS Code端的特效项目文件。

使用beautykit预览程序

• 启动预览程序：使用-h参数查看详细参数说明。常用参数包括窗口标题、宽高设置、启动摄像头、帧率设置、视网膜屏幕支持、调试模式、调试器路径、远程调试IP和端口等。

构建与发布

环境搭建

• 安装VS Code和Node.js。
• 通过npm安装vsce打包工具：npm i vsce -g。
• 登录VS Code发布者账号：vsce login your-publisher-name，使用微软账号令牌登录。

编译与打包

• 下载依赖包：npm install。
• 发布到市场：vsce publish。
• 打包离线安装包：vsce package -o ./vsix。

发布自动构建系统编译的插件

• 安装Node.js和vsce插件：npm install -g vsce。
• 登录微软开发发布者账号：vsce login alexleo，输入令牌。
• 修改package.json中的版本号和CHANGELOG.md中的更新说明，并提交到git。
• 使用构建系统中的Beautykit-Lua-VSC-Pipeline构建项目。
• 下载并解压构建完成的包，获取实际的插件vsix文件。
• 使用vsce发布插件：vsce publish --packagePath ./vsix/beautykitscriptingtools-1.3.11.vsix，确保使用实际的vsix文件路径。

通过以上步骤，您可以轻松使用BeautykitScriptingTools进行Lua脚本开发和调试，提升您的开发效率和效果。