# vscode-lua-debug

**Repository Path**: aihacker/vscode-lua-debug

## Basic Information

- **Project Name**: vscode-lua-debug
- **Description**: Lua Debug Adapter for Visual Studio Code
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-04-10
- **Last Updated**: 2023-04-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vscode-lua-debug

## 安装
在vscode中按Ctrl+P，输入
> ext install lua-debug

## 模块功能
* vscode-debug-client.exe 代理客户端。在launch模式中，vscode-debug-client.exe会用vscode-debug.dll创建一个调试器进行调试。在attach模式中，vscode-debug-client.exe会连接一个远程的调试器(也是由vscode-debug.dll创建的)。无论如何，调试开始后vscode-debug-client.exe只负责在vscode-debug.dll和vscode之间转发消息。
* vscode-debug.dll 调试器的核心模块。你可以在你的程序中加载vscode-debug.dll并创建调试器，这样vscode就可以通过attach模式进行调试。
* luacore.dll lua核心模块。如果你的程序定制了lua，你可以替换掉它。

## 配置launch.json

1. launch模式，等同于使用lua.exe来执行你的代码。

    * program，lua.exe执行的入口文件 
    * cwd，lua.exe的当前目录
    * stopOnEntry，开始调试时是否先暂停
    * luadll，指定lua dll的路径，如果不填则会加载luacore.dll
    * path，用于初始化package.path
    * cpath，用于初始化package.cpath
    * arg0，lua.exe的命令行参数，用于初始化arg的arg[-n] .. arg[0]
    * arg，lua.exe的命令行参数，用于初始化arg的arg[1] .. arg[n]
    * console，lua的标准输出的编码，可选择utf8、ansi、none， 等于none时不会重定向标准输出到vscode
    * sourceMaps，一般不需要，作用同attach模式

2. attach模式，调试任意加载了vscode-debug.dll的进程。

    * stopOnEntry，开始调试时是否先暂停
    * ip，远程调试器的ip
    * port，远程调试器的端口
    * sourceMaps，远程代码和本地代码的路径映射

3. 如果你只是使用在本机的远程调试器，你还可以不使用vscode-debug-client.exe，直接使用vscode连接调试器。只需要加上"debugServer"的参数。例如

```json
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "attach",
            "type": "lua",
            "request": "attach",
            "program": "",
            "stopOnEntry": false,
            "cwd": "${workspaceRoot}",
            "debugServer" : 4278
        }
    ]
}
```