Blame: README.md - Tencent/xLua

Tencent / xLua UNCLAIMED

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

-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
+								![](Assets/XLua/Doc/xLua.png)
 								![](https://img.shields.io/badge/release-v2.1.5-blue.png)
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+								## Unity3D下Lua编程支持
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+								xLua为Unity3D增加Lua脚本编程的能力，进而提供代码逻辑增量更新的可能。当然不仅仅如此，在coco2dx上的实践告诉我们，以Lua为主打语言的游戏客户端编程是可行的。
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+								## xLua的突破
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												readme

											
										
										
											2016-12-27 20:42:57 +08:00
+								xLua在功能、性能、易用性都有不少突破，这几方面分别最具代表性的突破是：
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												支持泛化类型

											
										
										
											2017-01-02 20:41:16 +08:00
+								* Unity3D全平台热补丁技术，可以运行时把C#实现（整个类，或者单个方法，操作符，属性，事件，构造函数，析构函数，支持泛化）替换成lua实现；
-												readme

											
										
										
											2016-12-27 20:42:57 +08:00
+								* 自定义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
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+								直接解压到Assets下可用。第一次使用建议把例子包也安装，运行看看效果。
-												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
-												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
 								Lua.LuaEnv luaenv = new XLua.LuaEnv();
 								luaenv.DoString("CS.UnityEngine.Debug.Log('hello world')");
 								luaenv.Dispose();
 								```
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+、DoString参数为string，可输入任意合法的Lua代码，本示例在lua里调用C#的UnityEngine.Debug.Log打印了个日志。
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+、一个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的。
 								## 热补丁
 								xLua支持热补丁，这意味着你可以：
 								* 1、开发只用C#；
 								* 2、运行也是C#，性能可以秒杀lua；
-												update doc

											
										
										
											2016-12-28 16:04:33 +08:00
+								* 3、出问题了才用Lua来改掉C#出问题的部位，下次整体更新时换回正确的C#；能做到用户不重启程序fix bug；
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
 								如果你仅仅希望用热更新来fix bug，这是强烈建议的做法。[这里](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)）。
-												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介绍.ppt](Assets/XLua/Doc/XLua介绍.ppt)：总体介绍文档。
 								* [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文档。
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00