English Version

README-EN.md

Y3开发助手

初始化项目（给新建的地图使用，老地图勿用！）

1. 点击左侧栏“Y3开发助手”图标，点击“初始化”
2. 选择地图路径
3. 完成！

功能面板

包含“启动游戏”、“在编辑器中打开”、“查看日志”等常用功能。

当使用此助手启动游戏后，游戏会连接到开发助手，并额外提供以下功能：

1. 一键热重载
2. 在“自定义视图”区显示仪表盘，可以监控游戏状态并快速重启
3. 在VSCode的“终端”区使用远程终端，显示游戏日志以及执行命令

物编支持

打开地图后，可以在 资源管理器/Y3开发助手：物编数据 中浏览、编辑物编数据（.json文件）。

打开物编json文件后，在 资源管理器/大纲/Y3开发助手：物编字段 视图中以中文查看和跳转字段。

搜索

按下 Ctrl+T 即可搜索物编，例如使用 #关羽 来搜索名称中带有 “关羽” 的所有物编。使用 #关羽.移动速度 来搜索到指定的物编字段。

也可以使用数字key与英文字段名来搜索。分割符支持 . 和 /。

高级应用

自定义视图

你可以自己在自定义视图上画按钮，见演示代码

远程终端

可以在地图发布到平台后，利用远程终端功能调试线上地图

应当只在测试服中启用此功能

1. 在代码中埋入初始化代码，如：

   y3.game:event('玩家-发送指定消息', 'Link Start', function (trg, data)
       y3.develop.helper.init(11037)
   end)
   -- 允许在平台中执行本地代码
   y3.config.code.enable_local = true
   

2. 在VSCode的设置中将 Y3-Helper.ServerPort 改为上述相同的端口号 11037
3. 重启VSCode，确保插件应用了新的端口号
4. 点击一下侧边栏的“Y3开发助手”图标，确保此助手已启动
5. 通过第1步中埋入的初始化代码，执行到 y3.develop.helper.init(11037) 即可连接到远程终端

插件

插件是存放在你地图中的JavaScript脚本，可以手动或自动运行里面的代码，实现批量修改物编、生成Lua文件等功能。

在侧边栏的“Y3开发助手”中点击 插件/初始化 后会在 script/y3-helper/plugin 目录中生成演示文件，目前包含：

• 1-使用代码修改物编.js
• 2-自动执行的脚本.js
• 3-读取excel.js
• 4-excel生成物编.js
• 5-excel生成物编·极.js
• 6-更多的演示 （会根据作者需求逐步更新）

如何对本插件进行二次开发？

1. 安装vscode和Node.js
2. git clone 或其他方式下载本插件项目源码
3. 使用VSCode打开项目文件夹
4. 在终端中使用 npm install 命令，安装相关依赖
5. 按下 ctrl+shift+B 启动实时编译
6. 按F5启动新的VSCode窗口测试代码