View source for LDT/User Area/Compatible Lua VMs

= Compatible VMs =
This page aims to list the Lua VMs which work with Lua Development Tools (LDT).

By "work", we mean :
* VM which is compatible with our debugger.
* VM for which an execution environment is available. (enable API's autocompletion and documentation)

(Feel free to complete this list with your tests)

{| border="1" border="1" cellpadding="3" cellspacing="0"
!align="center" colspan="2" | VM
!align="center" colspan="3" | Debugger Compatibility
!align="center" | Execution Environment
|-
!align="center" | Name-Version
!align="center" | Based on
!align="center" | Officially supported 
!align="center" | Transport Layer
!align="center" | Comments
! Execution environment is only used to enable some user assistance (autocompletion, documentation) for a given VM
|-
|[http://www.lua.org/ Lua-5.1]
|Lua-5.1
|[[Image:Ok_green.gif]] Since LDT 0.1.
|[http://w3.impa.br/~diego/software/luasocket/ LuaSocket] 2.0 needed.
|
|[[Image:Ok_green.gif]]Officially available since 0.8, shipped with LDT since 0.9.
|-
|[http://code.google.com/p/jnlua/ Jnlua-0.9]
|Lua-5.1
|[[Image:Ok_green.gif]] Since LDT 0.9.
| Based on Java Socket. 
|Interpreter based on Jnlua 0.9 shipped with LDT since 0.9.
|[[Image:Ok_green.gif]]Officially available since 0.8 (use Lua 5.1 one), shipped with LDT since 0.9.
|-
|[http://eclipse.org/mihini/ Mihini-0.8]
|Lua-5.1
|[[Image:Progress.gif]] Coming soon.
| LuaSocket 2.0 available in Mihini.
|
||Available at [[LDT/User_Area/Available_Execution_Environments#Mihini_0.8 | Execution Environment page]]
|-
|[http://www.lua.org/ Lua-5.2]
|Lua-5.2
|[[Image:Ok_green.gif]] Since LDT 1.0
| [https://github.com/diegonehab/luasocket/tree/v3.0-rc1 LuaSocket 3.0 RC1] needed (not released yet).
| 
| [[Image:Ok_green.gif]] Shipped with LDT since 1.0.
|-
|[http://code.google.com/p/jnlua/ Jnlua-1.0]
|Lua-5.2
| [[Image:Ok_green.gif]] Shipped since LDT 1.0
| Based on Java Socket. 
| 
| [[Image:Ok_green.gif]] Shipped since LDT 1.0
|-
|[http://luajit.org/ LuaJIT-2.0]
|Lua-5.1
|[[Image:Ok_green.gif]] Since 1.0
| Work with [https://github.com/diegonehab/luasocket/tree/v3.0-rc1 LuaSocket 3.0 RC1] (not released yet).
| 
| Lua 5.1 Execution environment could be used.
|-
|[http://wxlua.sourceforge.net/ wxLua]
|Lua-5.1
| Not officially supported, but should work.
| [http://w3.impa.br/~diego/software/luasocket/ LuaSocket] 2.0 needed.
| Tested v2.8.10 on windows with LuaSocket 2.0 and LDT 0.9: works out of the box.
| We don't know about any. Perhaps it could be partially generated from [http://wxlua.sourceforge.net/documentation.php doxygen documentation] (we are looking for community help). 
Lua 5.1 execution environment could be used waiting for better.
|-
|MOAI
|Lua-5.1
|Not officially supported.
|LuaSocket shipped by MOAI.
|Tested MOAI sdk v1.3-149 on windows : Works only with the [[LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session|Lua Attach To Application] and seems there are problems with coroutines created with MOAI's API.
Could be nice to offer a better support.
Could work out of the box if MOAI's interpreter was able to handle "-e" option. :/
|Available at  [[LDT/User_Area/Available_Execution_Environments#MOAI_SDK_1.2_Execution_Environment_.28alpha.29 | Execution Environment page]]
|-
|Gideros
|Lua-5.1
|Not officially supported.
|LuaSocket ?
|Not tested.
|Available at [[LDT/User_Area/Available_Execution_Environments#Gideros_Studio_2012.2.2.1_.28alpha.29 | Execution Environment page]]
|-
|Corona
|Lua-5.1
|Not officially supported.
|Included in Corona
|Successfully tested, see [[http://forums.coronalabs.com/topic/35188-windows-eclipse-koneki-corona-first-steps-setup/?p=183754 Corona forum]]
|We don't know about any (we are looking for community help).
Lua 5.1 execution environment could be used waiting for better.
|-
|LÖVE
|Lua-5.1
|Not officially supported.
|LuaSocket shipped by LOVE.
|Successfully tested on windows but need to define interpeter which does not support -e and file as arguments. Need to bootstrap debugger manually with <code>if os.getenv('DEBUG_MODE') then require "debugger"() end</code>. And add project path as interpreter arguments.
|Available at [[LDT/User_Area/Available_Execution_Environments#L.C3.96VE_11.1 | Execution Environment page]]
|}


= Make my VM LDT Compatible =
'''If you want to provide an execution environment for your VM, you could read [[LDT/User_Area/Execution_Environment_file_format |this]].'''

'''To be compatible with our debugger, you need to :'''
* be based on a Lua VM 5.1 or 5.2.
* integrate (or be compatible) with "standard" luasocket (2.0 or 2.1) to create a TCP connection between the VM and the IDE.
(if you ''cannot/do not want to'' use luasocket, you can also implement your own transport layer : see the transport parameter of debuger in the [[LDT/Developer_Area/User_Guides/User_Guide_0.9#Attach_session|user guide]])

'''To have full debug integration with the IDE, you need to :'''
* have an interpreter which handles the [http://www.lua.org/manual/5.1/manual.html#6 '-e' option] to bootstrap the debugger code.
* have an interpreter which takes in parameter the lua script file to run ([http://www.lua.org/manual/5.1/manual.html#6 see lua interpreter documentation]).
* respect the <code>LUA_PATH</code> and <code>LUA_CPATH</code> environment variable.
* (optional) ship luasocket.