Skip to content

Commit 00f1ddb

Browse files
committed
Add doc.
1 parent d166f21 commit 00f1ddb

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,47 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55

66
# Unity Lua
7-
> Use Lua scripting language in Unity to accomplish hot update/fox functionalitiy.
7+
> Use Lua scripting language in Unity to accomplish hot update/fix functionality.
88
99
Project built on top of the [tolua](https://github.com/topameng/tolua) by [topameng](https://github.com/topameng).
10+
11+
This is the minimal project that shows you how to use `tolua` in your
12+
own project.
13+
14+
## Why use ToLua for your game?
15+
16+
When you came of hot-update, you would need a scripting language that can be
17+
compile or use after the binary is built.
18+
19+
### Pros
20+
21+
* Hot update/fix - you are able to change game logic without compile from
22+
C# to binary.
23+
* Lua is easy to learn.
24+
25+
### Cons
26+
27+
* No auto-completion and debugging tool. (Maybe in the future?)
28+
* You would have to do extra comilation every time you want to port a function
29+
from C# to Lua programming interface.
30+
31+
## About ToLua
32+
33+
Here is a quick start that teaches you to use `tolua` in under a minute.
34+
35+
* `Assets/ToLua/Editor/Custom/CustomSettings.cs`
36+
* `Assets/ToLua/Source/LuaConst.cs`
37+
38+
These files are the only files that you need to be aware of to customize `tolua`.
39+
Basically all the export and path settings are listed in these files.
40+
41+
Done!!!
42+
43+
## Examples
44+
45+
There are few files that you would need to see before you know how to use
46+
`tolua`'s functionality.
47+
48+
All C# & Lua scripts under `/Assets/_Project/Scripts` folder.
49+
50+
Done!!!

0 commit comments

Comments
 (0)