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)
-.1.7版本

											
										
										
											2017-05-17 10:16:20 +08:00
+								[![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tencent/xLua/blob/master/LICENSE.TXT)
-.1.14版本图标修改

											
										
										
											2019-02-27 16:22:44 +08:00
+								[![release](https://img.shields.io/badge/release-v2.1.14-blue.svg)](https://github.com/Tencent/xLua/releases)
-												PRs welcome icon

											
										
										
											2017-05-02 10:32:22 +08:00
+								[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/xLua/pulls)
-												加入build状态图标

											
										
										
											2017-07-20 14:11:45 +08:00
+								[![Build status](https://travis-ci.org/Tencent/xLua.svg?branch=master)](https://travis-ci.org/Tencent/xLua)
-												first commit

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

											
										
										
											2018-06-22 18:02:29 +08:00
+								[(English Documents Available)](README_EN.md)
-												通用版本的介绍文档

											
										
										
											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-04-20 21:32:30 +08:00
+								打开zip包，你会看到一个Assets目录，这目录就对应Unity工程的Assets目录，保持这目录结构放到你的Unity工程。
-												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的章节调整

											
										
										
											2018-05-03 16:00:57 +08:00
+								## 文档
-												readme加入Lua53和luajit版本说明

											
										
										
											2017-01-04 09:04:36 +08:00
-												更新文档说明

											
										
										
											2018-05-03 16:06:28 +08:00
+								* [常见问题解答](Assets/XLua/Doc/faq.md)：常见问题都总结在这里，初使用大多数问题都可以在这里找到答案。
-												readme的章节调整

											
										
										
											2018-05-03 16:00:57 +08:00
+								* (必看)[XLua教程](Assets/XLua/Doc/XLua教程.md)：教程，其配套代码[这里](Assets/XLua/Tutorial/)。
 								* (必看)[XLua的配置](Assets/XLua/Doc/configure.md)：介绍如何配置xLua。
 								* [热补丁操作指南](Assets/XLua/Doc/hotfix.md)：介绍如何使用热补丁特性。
 								* [XLua增加删除第三方lua库](Assets/XLua/Doc/XLua增加删除第三方lua库.md)：如何增删第三方lua扩展库。
 								* [XLua API](Assets/XLua/Doc/XLua_API.md)：API文档。
 								* [生成引擎二次开发指南](Assets/XLua/Doc/custom_generate.md)：介绍如何做生成引擎的二次开发。
-												readme加入Lua53和luajit版本说明

											
										
										
											2017-01-04 09:04:36 +08:00
-												hotfix document

											
										
										
											2016-12-27 19:17:40 +08:00
+								## 快速入门
 								一个完整的例子仅需3行代码：
-												更明确的安装方式介绍

											
										
										
											2017-04-20 21:32:30 +08:00
+								安装好xLua，建一个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
+、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
+、一个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的。
 								## 热补丁
-												新增hotfix特性的一些应用经验，以及hotfix特性的描述修改。

											
										
										
											2017-03-15 14:33:40 +08:00
+								* 侵入性小，老项目原有代码不做任何调整就可使用。
 								* 运行时影响小，不打补丁基本和原有程序一样。
 								* 出问题了可以用Lua来打补丁，这时才会走到lua代码逻辑；
-												一些描述的调整

											
										
										
											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/): 泛化函数支持的演示。
-												数字签名例子的链接及介绍更新

											
										
										
											2017-03-13 17:13:45 +08:00
+								* [10_SignatureLoader](Assets/XLua/Examples/10_SignatureLoader/): 展示如何读取经数字签名的lua脚本，参见[数字签名](Assets/XLua/Doc/signature.md)的文档介绍。
-												文档刷新：新增配置的md格式文档；新增首页到例子11的链接也介绍

											
										
										
											2017-06-27 17:13:12 +08:00
+								* [11_RawObject](Assets/XLua/Examples/11_RawObject/): 当C#参数是object时，如何把一个lua number指定以boxing后的int传递过去。
-												支持C#复杂值类型改为lua实现

											
										
										
											2017-08-02 14:19:18 +08:00
+								* [12_ReImplementInLua](Assets/XLua/Examples/12_ReImplementInLua/): 展示如何将复杂值类型改为lua实现。
-												first commit

											
										
										
											2016-12-20 18:08:47 +08:00
-												更新QQ群信息

											
										
										
											2017-01-18 16:21:44 +08:00
+								## 技术支持
-												入群问题及答案相关说明

											
										
										
											2019-04-23 15:34:10 +08:00
+								一群：612705778
-												二群信息更新

											
										
										
											2018-01-31 16:09:26 +08:00
-												更新二群信息

											
										
										
											2018-01-31 15:58:02 +08:00
+								二群：703073338
-												入群问题及答案相关说明

											
										
										
											2019-04-23 15:34:10 +08:00
+								入群的问题：有问题该先从哪找答案
-												更新QQ群信息

											
										
										
											2017-01-18 16:21:44 +08:00
-												入群问题及答案相关说明

											
										
										
											2019-04-23 15:34:10 +08:00
+								回答：FAQ
 								平时也要谨记这答案，90%以上问题都可以在[FAQ](Assets/XLua/Doc/faq.md)里头找到答案。这些问题就别在群刷屏了。
-												更新QQ群信息

											
										
										
											2017-01-18 16:21:44 +08:00