LuaPanda 是一个基于 VS Code 的 lua 代码工具,设计目标是简单易用。它支持多种开发框架,主要提供以下功能:
- 自动补全(auto completion)
- 代码片段(snippet completion)
- 定义跳转(definition)
- 生成注释(comment generation)
- 类型推断(limited type inference)
- 代码格式化(formatting): 依赖 lua-fmt
- 代码诊断(linting):依赖 luacheck
- 调试器(debugger)
功能详情可以参考项目介绍。LuaPanda 支持 lua5.1- 5.3,调试器运行环境需要包含 LuaSocket。
LuaPanda 的立项源于潘多拉项目中大量的lua调试需求。潘多拉
为游戏提供嵌入式跨引擎的运营开发能力,使游戏研发及运营各自独立闭环,在游戏内实现各种营销活动和周边系统,让游戏分工更加专业,团队更加专注,高效产出价值。
潘多拉为游戏提供的服务包括用户生命周期的精细化运营方案、游戏内直播解决方案、游戏内内容社区解决方案、游戏内商城商业化解决方案等,已经在大量腾讯精品游戏中上线、稳定运营。
接入和使用文档
项目介绍 | 快速试用指引 | 调试器接入指引 | 真机调试 | 单文件调试和运行 | 升级说明 | FAQ
调试器开发文档
-
版本说明和升级建议
3.0.0 版本中加入了 LuaPanda.lua 文件的自动更新提示,帮助把版本保持到最新。升级原理是检测VScode打开工程中是否包含 LuaPanda 文件,并匹配文件中的版本号,如果落后于当前插件版本,则用插件中附带的最新版覆盖。升级过程无需网络,也不会对外发送和接收数据。
另外加入了配置页面,点击状态栏的LuaPanda图标即可打开。其中提供了一些常用配置方便用户修改。配置页面打开时读取launch.json中的对应数据,并在配置完成后把数据写回launch.json, 如果不想使用配置页面,直接修改launch.json中的项目可以达到同样的效果。
-
关于找不到
libpdebug
模块报错libpdebug.so(dll)
是放置在VSCode插件中的调试器C扩展,会在调试器运行时自动加载,作用是加速调试。xlua允许用户重写文件加载函数
CustomLoader
,sluaunreal也提供类似方法setLoadFileDelegate
。发生此问题的原因之一是用户重写的加载函数中没有加入对so/dll的处理,加载so/dll时会报找不到文件错误,但随后执行lua原生loader能够正确加载libpdebug。
查看libpdebug.so是否加载的方式是在控制台输入
LuaPanda.getInfo()
, 返回信息中有 hookLib Ver 说明libpdebug已经加载。此时可以忽略报错或在文件加载函数函数中正确处理.so/dll。
-
V3.0.1
- 修复可视化配置的bug
- 在可视化界面增加lua辅助工具开关
-
V3.0.0
-
加入代码辅助功能
加入常用的代码补全,代码片段,定义跳转,生成注释,符号列表等功能。这些功能无需设置,VSCode包含打开lua的文件夹即可使用。
-
LuaPanda.lua 升级提示
用户很少主动更新LuaPanda.lua文件,有时会因版本不匹配造成无法调试的问题。所以我们加入了自动更新提示。可以自动把工程中的LuaPanda.lua替换到最新。
-
可视化配置界面
采用了配置界面,方便用户可视化配置常用选项。原理是把用户的配置结果写回到 launch.json,和直接修改 launch.json 中的配置效果一致。
-
合并了
LuaPanda.lua
和DebugTools.lua
。 为了方便文件拷贝和升级对这两个文件做了合并,内容全部放入LuaPanda.lua
。DebugTools.lua 不再使用。
-
-
v2.3.0
-
增加了自动路径识别功能
2.3.0版本插件在launch.json文件中新增了
autoPathMode
设置项。当设置为true
时,调试器会根据文件名查询完整路径。用户在接入时不必再进行繁琐的路径配置。当此配置项为false或者未配置时,使用传统的路径拼接方式。另外,用户需要确保VSCode打开的工程目录中不存在同名lua文件,才可以使用本功能。否则调试器可能会把断点指向错误的文件,造成执行异常。
-
测试了在cocos2dx下的运行情况
之前的版本在cocos2dx中运行时会报查找 c 库错误。2.3.0 修复了此问题,测试 cocos2dx 在 win/mac 下都可以使用c库。
另外调试器目前支持标准lua虚拟机,cocos2dx集成的是luajit,可能会在单步时出现跳步的情况,后续完整支持luajit会解决此问题。
-
-
支持常用的代码补全,代码片段,定义跳转,生成注释,符号列表等功能
-
支持单步调试,条件断点,协程调试,支持调试时变量赋值。
-
支持lua5.1- 5.3, 支持 slua/xlua/slua-unreal 等框架
-
在断点处可以监视和运行表达式,返回结果
-
可以根据断点密集程度调整 hook 频率, 有较高的效率
-
支持 attach 模式,lua 运行过程中可随时建立连接
-
使用 lua / C 双调试引擎。lua 部分可动态下发,避免打包后无法调试。C 部分效率高,适合开发期调试
-
可以提供代码补全,代码片段,定义跳转,生成注释,符号列表等功能
调试器功能依赖 LuaSocket , 可运行于 slua,slua-unreal ,xlua 等已集成 LuaSocket 的 lua 环境,也可以在 console 中调试。lua 版本支持 5.1- 5.3。
其他依赖项目(插件中已包含,无需用户手动安装):
我们非常期待您的贡献,无论是完善文档,提出、修复 Bug 或是增加新特性。 如果您在使用过程中发现文档不够完善,欢迎记录下来并提交。 如果发现 bug,请通过 issues 来提交并描述相关的问题,您也可以在这里查看其它的 issue,通过解决这些 issue 来贡献代码。
请将pull request提交在 dev
分支上,经过测试后会在下一版本合并到 master
分支。更多规范请看CONTRIBUTING
腾讯开源激励计划 鼓励开发者的参与和贡献,期待你的加入。
如有问题先参阅 FAQ ,如有问题建议使用 issues ,我们会关注和回复。
QQ群:974257225