cnsoft / unilua

A pure c# implementation of Lua 5.2 focus on compatibility with Unity

UniLua

A pure C# implementation of Lua 5.2 focus on compatibility with Unity3D.
Being used in commercial MMORPG game development.

UniLua是一个纯C#的Lua 5.2实现，专注于与Unity3D的兼容性。
目前正使用在我们大型多人在线角色扮演商业游戏的开发中。

示例工程 ( Sample Project )

To demonstrate the basic use of UniLua, a sample project is included.
Open Assets\Stages\GameMain.unity with Unity3D, and just click the "Play" button.
An icon will appear in the screen, and you can move it around with WSAD keys.

项目中包含了一个微型的示例工程，用来演示 UniLua 的基本使用。
用 Unity3D 打开 Assets\Stages\GameMain.unity 然后直接点击播放按钮运行。
屏幕上会显示一个小图标，你可以用 WSAD 键控制它四处移动。

开发状况 ( Development Status )

• 基本特性 ( Basic features )

  • 所有 Lua 的基本语言特性都已实现，包括协程和元表，并且与 Lua5.2 标准实现一致。部分 GC 相关的元方法如 __gc 和 __mode 未实现
    ( All language features are implemented exactly the same as the standard Lua 5.2, including coroutine and metatable, except some GC-related metamethods like __gc and __mode. )

• 内置库 ( Libraries )

  • Base lib: done
  • Package lib: done
  • Coroutine lib: done
  • Table lib: done
  • IO lib: not implemented
    • 因为暂时没有需求 ( not needed in our games right now )
  • OS lib: not implemented
    • 因为暂时没有需求 ( not needed in our games right now )
  • String lib: partially implemented
    • 因为暂时没有需求 ( not needed in our games right now )
  • Debug lib: partially implemented
    • 勉强够用了 ( barely enough )

• 额外实现的库 ( Additional Libraries )

  • FFI lib: basicly done
    • 实验性质,不建议在要求性能的环境下使用 ( experimental. not suggested to use in performance-critical situation )
  • Encoding lib: basicly done
    • 支持在 UTF-8 编码和 UTF-16 编码间进行转换 ( support convert between UTF-8 and UTF-16 )

• TODO

  • Complete string lib.
  • Complete debug lib.

• 已知的问题 ( Known Issues )

  • Metamethod '__gc' will not working.
    • 因为没有自己实现GC机制,而是依赖于C#的GC ( for directly depending on C#'s GC mechanism )
  • Weak tables is not supported: '__mode' will not working.
    • 原因同上 ( the same reason mentioned above )

常用链接 ( Links )##

• Wiki首页 (Wiki Homepage)
  • 一些简单的说明 ( Quick Start )
  • 从 C# 调用 Lua ( Calling Lua function from C# )
  • 从 Lua 调用 C# 函数 ( Calling C# funcitons from Lua )
  • 从AssetBundle加载代码 ( Loading code from asset bundles )
  • UTF-8 support
  • Reference: Lua functions
  • Reference: C# API