MORPH
SIGN IN SIGN UP
Tencent / xLua UNCLAIMED

xLua is a lua programming solution for C# ( Unity, .Net, Mono) , it supports android, ios, windows, linux, osx, etc.

10065 0 1 C
Normal View History Raw
first commit
2016-12-20 18:08:47 +08:00
![](Assets/XLua/Doc/xLua.png)
update license release push-request link
2017-01-13 09:49:11 +08:00
[![license](https://img.shields.io/badge/license-MIT-blue.png)](https://github.com/Tencent/xLua/blob/master/LICENSE.TXT)
更新release的图标
2017-03-01 11:13:02 +08:00
[![release](https://img.shields.io/badge/release-v2.1.6-blue.png)](https://github.com/Tencent/xLua/releases)
update license release push-request link
2017-01-13 09:49:11 +08:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.png)](https://github.com/Tencent/xLua/pulls)
first commit
2016-12-20 18:08:47 +08:00
通用版本的介绍文档
2017-03-01 10:13:53 +08:00
## C#下Lua编程支持
一些描述的调整
2017-03-10 10:23:13 +08:00
xLua为Unity、 .Net、 Mono等C#环境增加Lua脚本编程的能力，借助xLua，这些Lua代码可以方便的和C#相互调用。
通用版本的介绍文档
2017-03-01 10:13:53 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
## xLua的突破
first commit
2016-12-20 18:08:47 +08:00
HOTFIX_DEBUG_SYMBOLS的支持
2017-01-03 10:49:33 +08:00
xLua在功能、性能、易用性都有不少突破，这几方面分别最具代表性的是：
first commit
2016-12-20 18:08:47 +08:00
一些描述的调整
2017-03-10 10:23:13 +08:00
* 可以运行时把C#实现（方法，操作符，属性，事件等等）替换成lua实现；
* 出色的GC优化，自定义struct，枚举在Lua和C#间传递无C# gc alloc；
hotfix document
2016-12-27 19:17:40 +08:00
* 编辑器下无需生成代码，开发更轻量；
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
更详细的特性、平台支持介绍请看[这里](Assets/XLua/Doc/features.md)。
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
## 安装
first commit
2016-12-20 18:08:47 +08:00
安装说明修改
2017-03-01 11:02:07 +08:00
直接解压工程下可用。第一次使用建议把例子包也安装，运行看看效果。
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
如果希望安装到其它目录，请看[FAQ](Assets/XLua/Doc/faq.md)相关介绍。
first commit
2016-12-20 18:08:47 +08:00
readme加入Lua53和luajit版本说明
2017-01-04 09:04:36 +08:00
## lua5.3 vs luajit
xLua有两个版本，分别集成了lua5.3和luajit，一个项目只能选择其一。这两个版本C#代码是一样的，不同的是Plugins部分。
lua5.3的特性更丰富些，比如支持原生64位整数，支持苹果bitcode，支持utf8等。出现问题因为是纯c代码，也好定位。比起luajit，lua对安装包的影响也更小。
修正些用词
2017-01-08 16:55:21 +08:00
而luajit胜在性能，如果其jit不出问题的话，可以比lua高一个数量级。目前luajit作者不打算维护luajit，在找人接替其维护，后续发展不太明朗。
readme加入Lua53和luajit版本说明
2017-01-04 09:04:36 +08:00
项目可以根据自己情况判断哪个更适合。因为目前lua53版本使用较多，所以xLua工程Plugins目录下默认配套是lua53版本。
hotfix document
2016-12-27 19:17:40 +08:00
## 快速入门
一个完整的例子仅需3行代码：
下载xLua后解压到Unity工程Assets目录下，建一个MonoBehaviour拖到场景，在Start加入如下代码：
first commit
2016-12-20 18:08:47 +08:00
```csharp
笔误
2017-02-10 15:08:18 +08:00
XLua.LuaEnv luaenv = new XLua.LuaEnv();
first commit
2016-12-20 18:08:47 +08:00
luaenv.DoString("CS.UnityEngine.Debug.Log('hello world')");
luaenv.Dispose();
```
hotfix document
2016-12-27 19:17:40 +08:00
1、DoString参数为string，可输入任意合法的Lua代码，本示例在lua里调用C#的UnityEngine.Debug.Log打印了个日志。
first commit
2016-12-20 18:08:47 +08:00
HOTFIX_DEBUG_SYMBOLS的支持
2017-01-03 10:49:33 +08:00
2、一个LuaEnv实例对应Lua虚拟机，出于开销的考虑，建议全局唯一。
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
C#主动调用lua也很简单，比如要调用lua的系统函数，推荐方式是：
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
* 声明
first commit
2016-12-20 18:08:47 +08:00
```csharp
[XLua.CSharpCallLua]
public delegate double LuaMax(double a, double b);
```
hotfix document
2016-12-27 19:17:40 +08:00
* 绑定
first commit
2016-12-20 18:08:47 +08:00
```csharp
var max = luaenv.Global.GetInPath<LuaMax>("math.max");
```
hotfix document
2016-12-27 19:17:40 +08:00
* 调用
first commit
2016-12-20 18:08:47 +08:00
```csharp
Debug.Log("max:" + max(32, 12));
```
hotfix document
2016-12-27 19:17:40 +08:00
建议绑定一次，重复使用。生成了代码的话，调用max是不产生gc alloc的。
## 热补丁
一些描述的调整
2017-03-10 10:23:13 +08:00
xLua可以运行时把C#实现替换成lua实现，这意味着你可以：
hotfix document
2016-12-27 19:17:40 +08:00
* 1、开发只用C#；
* 2、运行也是C#，性能可以秒杀lua；
一些描述的调整
2017-03-10 10:23:13 +08:00
* 3、出问题了可以用Lua来改掉C#出问题的部分；
注意！
请遵从苹果的条款规定，该特性禁止在IOS系统下使用！
hotfix document
2016-12-27 19:17:40 +08:00
一些描述的调整
2017-03-10 10:23:13 +08:00
[这里](Assets/XLua/Doc/hotfix.md)是使用指南。
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
## 更多示例
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
* [01_Helloworld](Assets/XLua/Examples/01_Helloworld/): 快速入门的例子。
* [02_U3DScripting](Assets/XLua/Examples/02_U3DScripting/): 展示怎么用lua来写MonoBehaviour。
* [03_UIEvent](Assets/XLua/Examples/03_UIEvent/): 展示怎么用lua来写UI逻辑。
* [04_LuaObjectOrented](Assets/XLua/Examples/04_LuaObjectOrented/): 展示lua面向对象和C#的配合。
* [05_NoGc](Assets/XLua/Examples/05_NoGc/): 展示怎么去避免值类型的GC。
* [06_Coroutine](Assets/XLua/Examples/06_Coroutine/): 展示lua协程怎么和Unity协程相配合。
* [07_AsyncTest](Assets/XLua/Examples/07_AsyncTest/): 展示怎么用lua协程来把异步逻辑同步化。
update doc
2016-12-28 16:04:33 +08:00
* [08_Hotfix](Assets/XLua/Examples/08_Hotfix/): 热补丁的示例（需要开启热补丁特性，如何开启请看[指南](Assets/XLua/Doc/hotfix.md)）。
新增生成引擎二次开发指南
2017-02-09 19:01:15 +08:00
* [09_GenericMethod](Assets/XLua/Examples/09_GenericMethod/): 泛化函数支持的演示。
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
## 文档
first commit
2016-12-20 18:08:47 +08:00
hotfix document
2016-12-27 19:17:40 +08:00
* [XLua教程.doc](Assets/XLua/Doc/XLua教程.doc)：教程，其配套代码[这里](Assets/XLua/Tutorial/)。
* [XLua的配置.doc](Assets/XLua/Doc/XLua的配置.doc)：介绍如何配置xLua。
* [XLua增加删除第三方lua库.doc](Assets/XLua/Doc/XLua增加删除第三方lua库.doc)：如何增删第三方lua扩展库。
* [XLua API.doc](Assets/XLua/Doc/XLua_API.doc)：API文档。
文档更新:1、新增Hotfix操作指南链接；2、修改生成引擎文档的标题；3、删除XLua介绍.ppt
2017-02-14 15:36:06 +08:00
* [生成引擎二次开发指南](Assets/XLua/Doc/custom_generate.md)：介绍如何做生成引擎的二次开发。
一些描述的调整
2017-03-10 10:23:13 +08:00
* [热补丁操作指南](Assets/XLua/Doc/hotfix.md)：介绍如何使用热补丁特性。
first commit
2016-12-20 18:08:47 +08:00
更新QQ群信息
2017-01-18 16:21:44 +08:00
## 技术支持
QQ群：612705778
Reference in New Issue Copy Permalink