【新增】补充start_up.md及manual.md文档（待完待续）
walon
parent
147ce91166
commit
c39761273f
|
|
@ -30,6 +30,8 @@ Luban另一优点是生成过程极快。对于普通的导表工具，一个典
|
||||||
- [Excel 配置数据简介](docs/data_excel.md)
|
- [Excel 配置数据简介](docs/data_excel.md)
|
||||||
- [使用说明](docs/catalog.md)
|
- [使用说明](docs/catalog.md)
|
||||||
- [常见问题](docs/faq.md)
|
- [常见问题](docs/faq.md)
|
||||||
|
- [快速上手及进阶](docs/start_up.md)
|
||||||
|
- [完整手册](docs/manual.md)
|
||||||
- [示例项目](https://github.com/focus-creative-games/luban_examples)
|
- [示例项目](https://github.com/focus-creative-games/luban_examples)
|
||||||
|
|
||||||
## 特性
|
## 特性
|
||||||
|
|
|
||||||
|
|
@ -1,23 +1,13 @@
|
||||||
<root>
|
<root>
|
||||||
|
|
||||||
<topmodule name="cfg"/>
|
<topmodule name="cfg"/>
|
||||||
|
|
||||||
<group name="client,c" default="1"/>
|
<group name="c" default="1"/> client 分组
|
||||||
<group name="server,s" default="1"/>
|
<group name="s" default="1"/> server 分组
|
||||||
<group name="editor,e" default="1"/>
|
<group name="e" default="1"/> editor分组
|
||||||
<group name="ue,u"/>
|
|
||||||
|
|
||||||
<import name="."/>
|
<import name="."/>
|
||||||
|
|
||||||
<service name="server" manager="Tables" group="s,server"/>
|
<service name="server" manager="Tables" group="s"/>
|
||||||
|
<service name="client" manager="Tables" group="c"/>
|
||||||
<service name="client" manager="Tables" group="c,client"/>
|
<service name="all" manager="Tables" group="c,s,e"/>
|
||||||
|
|
||||||
<service name="all" manager="Tables" group="c,s"/>
|
|
||||||
|
|
||||||
<service name="ue4_editor" manager="Tables" group="e"/>
|
|
||||||
|
|
||||||
<service name="unity_editor" manager="Tables" group="e"/>
|
|
||||||
|
|
||||||
<service name="ue4" manager="Tables" group="u,ue"/>
|
|
||||||
</root>
|
</root>
|
||||||
|
|
@ -1,114 +0,0 @@
|
||||||
<module>
|
|
||||||
|
|
||||||
<bean name="DemoPrimitiveTypesTable">
|
|
||||||
<var name="x1" type="bool"/>
|
|
||||||
<var name="x2" type="byte"/>
|
|
||||||
<var name="x3" type="short"/>
|
|
||||||
<var name="x4" type="int?" />
|
|
||||||
<var name="x5" type="long" />
|
|
||||||
<var name="x6" type="float"/>
|
|
||||||
<var name="x7" type="double"/>
|
|
||||||
<var name="x10" type="string" />
|
|
||||||
<var name="v2" type="vector2"/>
|
|
||||||
<var name="v3" type="vector3"/>
|
|
||||||
<var name="v4" type="vector4"/>
|
|
||||||
<var name="t1" type="datetime"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
<enum name="DemoEnum">
|
|
||||||
<var name="RED" alias="红" value="1"/>
|
|
||||||
<var name="BLUE" alias="蓝" value="3"/>
|
|
||||||
<var name="GREEN" alias="绿" value="5"/>
|
|
||||||
</enum>
|
|
||||||
|
|
||||||
<bean name="DemoEnumTable">
|
|
||||||
<var name="x1" type="int"/>
|
|
||||||
<var name="x2" type="DemoEnum"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="IntRange">
|
|
||||||
<var name="min" type="int"/>
|
|
||||||
<var name="max" type="int"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
<bean name="DemoBeanTable">
|
|
||||||
<var name="x1" type="int"/>
|
|
||||||
<var name="x2" type="IntRange"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="Shape">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<bean name="Circle">
|
|
||||||
<var name="radius" type="float"/>
|
|
||||||
</bean>
|
|
||||||
<bean name="Rectangle" alias="长方形">
|
|
||||||
<var name="width" type="float"/>
|
|
||||||
<var name="height" type="float"/>
|
|
||||||
</bean>
|
|
||||||
<bean name="Curve">
|
|
||||||
<bean name="Line" alias="直线">
|
|
||||||
<var name="direction" type="vector2"/>
|
|
||||||
</bean>
|
|
||||||
<bean name="Parabola" alias="抛物线">
|
|
||||||
<var name="param_a" type="float"/>
|
|
||||||
<var name="param_b" type="float"/>
|
|
||||||
</bean>
|
|
||||||
</bean>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="ShapeTable">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="shape" type="Shape"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="NullableTable">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="min_level" type="int?"/>
|
|
||||||
<var name="color" type="DemoEnum?"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="CollectionTable">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="items" type="list,int"/>
|
|
||||||
<var name="coefs" type="list,int"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="Item">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="name" type="string"/>
|
|
||||||
<var name="num" type="int"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
<bean name="CollectionTable2">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="items" type="list,Item"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
|
|
||||||
<bean name="CollectionTable3">
|
|
||||||
<var name="id" type="int"/>
|
|
||||||
<var name="shapes" type="list,Shape" sep=","/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
<bean name="TwoKeyTable">
|
|
||||||
<var name="key1" type="int"/>
|
|
||||||
<var name="key2" type="string"/>
|
|
||||||
<var name="name" type="string"/>
|
|
||||||
</bean>
|
|
||||||
<table name="TbTowKey" value="TwoKeyTable" index="key1,key2" input="examples.xlsx"/>
|
|
||||||
|
|
||||||
<bean name="SingletonTable">
|
|
||||||
<var name="init_gold_num" type="int"/>
|
|
||||||
<var name="guild_module_open_level" type="int"/>
|
|
||||||
</bean>
|
|
||||||
|
|
||||||
<table name="TbSingleton" value="SingletonTable" mode="one" input="examples.xlsx"/>
|
|
||||||
|
|
||||||
|
|
||||||
</module>
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
|
||||||
|
# TODO 待补充
|
||||||
|
|
@ -0,0 +1,72 @@
|
||||||
|
# 快速上手
|
||||||
|
|
||||||
|
|
||||||
|
## 准备工作
|
||||||
|
1. 安装 .net 5 dsk
|
||||||
|
1. 下载luban_examples项目
|
||||||
|
|
||||||
|
下载项目 [luban_examples](https://github.com/focus-creative-games/luban_examples)。
|
||||||
|
项目中包含测试配置、最新的luban_client&luban_server工作以及大量的示例项目。为方便起见，后续提及到的文件，默认都指这个项目中的文件。
|
||||||
|
|
||||||
|
1. 设置全局环境变量
|
||||||
|
|
||||||
|
set_global_envs.bat 脚本文件，它会设置全局环境变量 LUBAN_SERVER_IP 为 127.0.0.1。如果你在其他机器上部属luban.server，可以将LUBAN_SERVER_IP改为相应地址。
|
||||||
|
1. 启动luban.server
|
||||||
|
|
||||||
|
运行 run_luban_server.bat 脚本文件，启动luban.server程序。由于luban工具使用client/server的工作
|
||||||
|
模块，必须有一个运行中的luban.server程序，才能完成生成工作，**请保持luban.server持续运行**。
|
||||||
|
|
||||||
|
新手测试时可以在本机启动luban.server，实际开发中，建议**一个项目部属一个luban.server**。
|
||||||
|
|
||||||
|
|
||||||
|
## 创建起始的游戏配置目录结构
|
||||||
|
1. 创建配置根目录
|
||||||
|
创建一个目录来存放所有游戏配置相关的文件。假设目录名为 Config（名字随意）。 目录下将包含数据目录、定义文件目录、检查脚本、高级自定义检查工程。
|
||||||
|
1. 在Config目录下创建数据目录Datas(名字随意)。将来用于存放所有游戏原始数据文件。
|
||||||
|
1. 在Config目录下创建定义目录Defines(名字随意)。目录下将包含根定义及各个模块子定义文件。
|
||||||
|
1. 在Defines目录下创建\_\_root__.xml 文件。文件内容如下：
|
||||||
|
```xml
|
||||||
|
<root>
|
||||||
|
<topmodule name="cfg"/> 额外的顶层命名空间
|
||||||
|
|
||||||
|
<group name="c" default="1"/> client 分组
|
||||||
|
<group name="s" default="1"/> server 分组
|
||||||
|
<group name="e" default="1"/> editor分组
|
||||||
|
|
||||||
|
<import name="."/> 从当前目录导入所有子模块定义文件
|
||||||
|
|
||||||
|
<service name="server" manager="Tables" group="s"/> 输出目标 server，包含s分组的表和字段
|
||||||
|
<service name="client" manager="Tables" group="c"/> 输出目标 client，包含c分组的表和字段
|
||||||
|
<service name="all" manager="Tables" group="c,s,e"/> 输出目标 editor，包含c,s,e分组的表和字段
|
||||||
|
</root>
|
||||||
|
```
|
||||||
|
|
||||||
|
直接从 luban_examples项目的 config/Defines/\_\_root__.xml 拷贝即可。
|
||||||
|
|
||||||
|
1. 在配置根目录下，创建 check.bat，内容如下：
|
||||||
|
|
||||||
|
```bat
|
||||||
|
set WORKSPACE=..
|
||||||
|
set GEN_CLIENT=%WORKSPACE%\Tools\Luban.Client\Luban.Client.exe
|
||||||
|
set CONF_ROOT=%WORKSPACE%\DesignerConfigs
|
||||||
|
set DEFINE_FILE=%CONF_ROOT%\Defines\__root__.xml
|
||||||
|
|
||||||
|
<luaban.client.exe的路径> -h %LUBAN_SERVER_IP% -j cfg --^
|
||||||
|
-d Defines\__root__.xml^
|
||||||
|
--input_data_dir Datas ^
|
||||||
|
--output_data_dir output_data ^
|
||||||
|
--gen_types data_bin ^
|
||||||
|
-s all ^
|
||||||
|
--export_test_data
|
||||||
|
pause
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
执行 check.bat，如果输出最后为
|
||||||
|
```
|
||||||
|
== succ ==
|
||||||
|
```
|
||||||
|
表明命令行是正确的，能够正常生成，否则仔细检查参数。
|
||||||
|
|
||||||
|
|
||||||
|
# 进阶
|
||||||
Loading…
Reference in New Issue