EmmyLua for VSCode

EmmyLua is a powerful Lua language support extension for Visual Studio Code, providing intelligent code completion, debugging, and analysis capabilities.

📋 Quick Links

• 📖 Documentation
• 📝 Changelog (English)
• 📝 更新日志 (中文)
• 🔧 Language Server (Rust)
• 💬 QQ Group: 29850775

🚀 Features

• Smart Code Completion: Intelligent auto-completion with type inference
• Real-time Diagnostics: Error detection and warnings as you type
• Advanced Debugging: Support for attach, launch, and remote debugging
• Cross-platform: Works on Windows, macOS, and Linux
• LSP-based: Built on Language Server Protocol for reliability

📦 Related Extensions

Enhance your Lua development experience with these complementary extensions:

• EmmyLuaCodeStyle - Code formatting and style enforcement
• EmmyLuaUnity - Unity3D integration

🔧 Configuration

Project Configuration

Create a .emmyrc.json file in your project root to customize behavior:

{
  "diagnostics": {
    "undefined-global": false
  }
}

For detailed configuration options, see:

• English Documentation
• 中文文档

🐛 Debugging

Remote Debug Setup

1. Insert Debugger Code

   • Use command: EmmyLua: Insert Emmy Debugger Code
   • Or manually add:

   package.cpath = package.cpath .. ";path/to/emmy/debugger/?.dll"
   local dbg = require('emmy_core')
   dbg.tcpListen('localhost', 9966)
   dbg.waitIDE()
   

2. Set Breakpoints

   • Add dbg.breakHere() where you want to pause execution
   • Or use VSCode's built-in breakpoint system

3. Start Debugging

   • Run your Lua application
   • Launch "EmmyLua New Debug" configuration in VSCode
   • The debugger will connect automatically

Debug Types

• EmmyLua New Debug: Modern debugging with better performance
• EmmyLua Attach: Attach to running processes (requires exported Lua symbols)
• EmmyLua Launch: Direct launch debugging

❓ Frequently Asked Questions

{
  "diagnostics": {
    "disable" : [
      "undefined-global"
    ]
  }
}

🤝 Contributing

We welcome contributions! Please feel free to:

• Report bugs and issues
• Suggest new features
• Submit pull requests
• Join our QQ group for discussions

📄 License

This project is licensed under the MIT License.