From 12a41cf651a79c947445e8d90b11cdfc2217e20a Mon Sep 17 00:00:00 2001 From: bug Date: Sun, 29 Nov 2020 23:10:13 +0800 Subject: [PATCH] update doc --- README.md | 24 ++++---- config/生成lua数据.bat | 2 +- docs/data_excel.md | 117 ++++++++++++++++++++++++++----------- docs/deploy.md | 10 ++++ docs/faq.md | 17 ++++-- 5 files changed, 119 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 979fc7f..25bb277 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,22 @@ ## 介绍 -- Luban 是一个强大的配置生成与缓存工具。 -- Luban 最初是为了解决传统 excel 导出工具功能过于薄弱，无法很好处理 MMORPG 游戏复杂配置需求的痛点问题。 -- 生成目标可以是常规代码、配置数据、类似 protobuf 的消息代码，也可以是游戏资源如 assetbundle。 -- 在大型项目中，由于配置或资源数据庞大，生成对象可能会花费相当多的时间。 - - 比如一个典型的 MMORPG 项目，后期全量生成配置，即使用了多线程加速，所需时间也在 10 秒的级别。 - - 因此除了使用缓存，还使用了 client/server 模式，来加速生成过程。 -- 自 2015 年以来，经历过 MMORPG、卡牌、SLG 等多个上线项目的考验， -- 实际项目过程中不断迭代和优化，最终由一个增强型的配置工具成为一个相对完备的游戏配置数据解决方案。 +Luban 是一个强大的配置生成与缓存工具。该工具最初是为了解决传统 excel 导出工具功能过于薄弱，无法很好处理 MMORPG 游戏复杂配置需求的痛点问题。工具生成的目标可以是常规代码、配置数据、类似 protobuf 的消息代码，也可以是游戏资源如 assetbundle。 + +在大型项目中，由于配置或资源数据庞大，生成对象可能会花费相当多的时间。比如一个典型的 MMORPG 项目，后期全量生成配置，即使用了多线程加速，所需时间也在 10 秒的级别。Luban 在优化过程中，除了使用缓存，还使用了 client/server 模式，来加速生成过程。 + +自2015年以来，Luban 经历过 MMORPG、卡牌、SLG 等多个上线项目的考验，实际项目过程中不断迭代和优化，最终由一个增强型的配置工具成为一个相对完备的游戏配置数据解决方案。 ## 快速生成 lua 的例子 -- 进入 config 目录 -- 双击 生成lua数据.bat -- 生成的 output_lua 目录即对像数据 -- 修改 bat 脚本路径，即可使用至项目中 +1) 进入 config 目录 +2) 双击 生成 lua 数据.bat +3) 生成的 output_lua 目录即对像数据 +4) 修改 bat 脚本路径，即可使用至项目中 ## 使用示例 +- 配置示例 + ![](docs/images/adv/def_01.png) - Lua 使用示例 ```Lua @@ -34,6 +33,7 @@ local cfg = data[32] print(cfg.name) ``` + - C# 使用示例 ```C# // 一行代码可以加载所有配置。 cfg.Tables 包含所有表的一个实例字段。 diff --git a/config/生成lua数据.bat b/config/生成lua数据.bat index 8c9a9d1..05d2765 100644 --- a/config/生成lua数据.bat +++ b/config/生成lua数据.bat @@ -1,5 +1,5 @@ ..\src\Luban.Client\bin\Debug\netcoreapp3.1\Luban.Client.exe ^ - -h 139.196.55.78 ^ + -h 81.69.4.240 ^ -j cfg ^ -- ^ -d Defines/root.xml ^ diff --git a/docs/data_excel.md b/docs/data_excel.md index 5f6b494..75c8e7f 100644 --- a/docs/data_excel.md +++ b/docs/data_excel.md @@ -5,8 +5,6 @@ - 新增 一个字段 batch_useable，表示能否批量使用 - 用 true 或 false 表示 bool 值，只需要小写后是这两个值即可，比如 true,True,True 都是合法的值。excel 会自动将输入的值大写化。 -- 配置: - ![如图](images/adv/def_01.png) - [定义](images/adv/def_02.png): ```xml @@ -15,12 +13,12 @@ ``` +- 配置: + ![如图](images/adv/def_01.png) ## float 类型 - 新增一个 float 类型字段，掉落概率 drop_prob. -- 配置: - ![如图](images/adv/def_03.png) - [定义](images/adv/def_04.png): ```xml @@ -29,12 +27,12 @@ ``` +- 配置: + ![如图](images/adv/def_03.png) ## 列表类型 list,int - 我们新增一个字段， 宝箱的随机抽取道具列表 random_item_ids。 -- 配置: - ![如图](images/adv/def_05.png) - [定义](images/adv/def_06.png) ```xml @@ -43,13 +41,13 @@ ``` +- 配置: + ![如图](images/adv/def_05.png) ## 向量类型 vector3 - vector3 有三个字段 float x, float y, float z, 适合用于表示坐标之类的数据。 - 我们新增一个 spawn_location 字段，表示物品产生的场景位置。 -- 配置: - ![如图](images/adv/def_07.png) - [定义](images/adv/def_08.png): ```xml @@ -58,6 +56,8 @@ ``` +- 配置: + ![如图](images/adv/def_07.png) ## 枚举类型 @@ -65,7 +65,7 @@ - 有一种更优雅的方式是定义枚举。 - [枚举定义](images/adv/def_09.png) - ```xml + ``` xml @@ -83,7 +83,7 @@ - alias 是可选项，枚举项别名。 - value 是枚举值，主要给程序使用。 - [完整用法](images/adv/def_10.png) - ``` + ``` xml @@ -108,7 +108,7 @@ - 比如，我们想用一个字段 level_range 来表示道具可以使用的等级范围，它包含两个字段，最小等级和最大等级。 - 此时，可以通过定义 bean 来解决。 [定义](images/adv/def_12.png) - ``` + ``` xml @@ -127,7 +127,7 @@ 2. 使用 sep 分割单元格 字段定义中指定 sep 属性，用某些字符分割单元格，这样就能识别为两个整数了。 [定义](images/adv/def_15.png) - ``` + ``` xml @@ -145,7 +145,7 @@ 比如说 道具不同等级会增加不同的血量。我们定义一个 ItemLevelAttr 结构。 [定义](images/adv/def_17.png) - ``` + ``` xml @@ -169,7 +169,7 @@ - 有两种办法。 1. bean ItemLevelAttr 增加属性 sep=”,” [定义](images/adv/def_21.png) - ``` + ``` xml @@ -179,7 +179,7 @@ 如果不想用逗号”,” ，想用;来分割单元格内的数据，只要将 sep=”;” 即可。 2. 字段 level_attrs 增加属性 sep=”,”，即 [定义](images/adv/def_22.png) - ``` + ``` xml @@ -193,7 +193,7 @@ ![如图](images/adv/def_23.png) 想用 | 来分割不同 ItemLevelAttr ,用 , 来分割每个记录的数据。只需要 字段 level_attrs 的 sep=”,|” 即可。 [定义](images/adv/def_24.png) - ``` + ``` xml @@ -213,7 +213,7 @@ Cicle 有 2 个字段 int id; float radius; Rectangle 有 3 个字段 int id; float width; float height; [定义](images/adv/def_25.png) - ``` + ``` xml @@ -233,7 +233,7 @@ - 注意到，多态 bean 与普通 bean 填写区别在于，多态 bean 需要一个类型名。这也好理解，如果没有类型名，如何知道使用哪个 bean 呢。 - 有时间策划不太习惯填写英文，或者说类型名有时候会调整，不希望调整类型名后配置也跟着改变，因为，多态 bean 支持别名的概念。 [定义](images/adv/def_27.png) - ``` + ``` xml @@ -252,7 +252,22 @@ ## multi_rows 多行 记录 - 使用数据表经常会遇到某个字段是列表类型的情形。有时候列表的 bean 的字段特别多，比如多达 10 个字段，列表包含了好几个 bean。如果此时配置成一行，会导致 excel 列过多，策划编辑维护不方便直观。 Luban 支持这个列表 多行配置。 -- ![如图](images/adv/def_29.png) +- [定义](images/adv/def_29.png) + ``` xml + + + + + + + + + + + ... + + + ``` - 和 普通 非多行记录的区别在于 lines 字段多了一个 multi_rows=”1” 字段，表示这个字段要多行配置。 - ![如图](images/adv/def_30.png) - 和普通不包括多行数据的 excel 表比，meta 行多了 multi_rows:1 这个属性。为了防止被误识别为多行，multi_rows 需要手动打开。 @@ -261,8 +276,19 @@ - 经常会有字段占了多列，比如 Shape, 如果按顺序填写，有个问题在于，字段很多时，容易对应错误，不方便定位。 - 假设 有个 show_info 字段，包含 如下字段 string name; string desc; string tip; -- ![如图](images/adv/def_31.png) -- 填写数据如下 +- [定义](images/adv/def_31.png) + ``` xml + + + + + + + ... + + + ``` +- 配置 ![如图](images/adv/def_32.png) - 有几处改动 1. 我们新插入了一行标题头，第 2 行变成了两行。同时 A2,A3 单元格合并，表示标题头占了 2 行。 @@ -273,9 +299,15 @@ - 不是所有数据都是 类似 map 这样的多记录结构。有些配置只有一份，比如 开启装备系统的最小角色等级。 这些数据 所在的表，也只有一个记录。称之为 单例表。 - 我们创建一个单例表，来存放这些数据。 - 定义如下： - ![如图](images/adv/def_33.png) - 数据如下： +- [定义](images/adv/def_33.png) + ``` xml + + + + + + ``` +- 配置 ![如图](images/adv/def_34.png) ## 横表与纵表 @@ -289,9 +321,14 @@ - 有时候会有一种变量，我们希望它 功能生效时填一个有效值，功能不生效里，用一个值来表示。 例如 int 类型，常常拿 0 或者-1 作无效值常量。 但有时候，0 或-1 也是有效值时，这种做法就不生效了。或者说 项目组内 有时候拿 0，有时候拿-1 作无效值标记，很不统一。我们借鉴 sql 及 c#,引入 可空值概念，用 null 表达空值。 - 我们为 Item 添加 min_use_level 字段，类型为 int? 当填有效值时，使用时要检查等级，否则不检查。 -- 定义如下 - ![如图](images/adv/def_36.png) -- 数据如下 +- [定义](images/adv/def_36.png) + ``` xml + + ... + + + ``` +- 配置 ![如图](images/adv/def_37.png) ## datetime 类型 @@ -303,17 +340,31 @@ - yyyy-mm-dd hh 如 2001-09-05 07 - yyyy-mm-dd 如 2003-04-05 - 为 Item 新增一个 失效时间字段 expire_time 。 - 定义如下: - ![如图](images/adv/def_38.png) - 数据如下: +- [定义](images/adv/def_38.png) + ``` xml + + ... + + + ``` +- 配置 ![如图](images/adv/def_39.png) ## convert 常量替换 - 游戏里经常会出现一些常用的类似枚举的值，比如说 升级丹的 id,在很多地方都要填，如果直接它的道具 id,既不直观，也容易出错。 Luban 支持常量替换。 - 对于需要常量替换的字段，添加 convert=”枚举类”。 如果填写的值是 枚举名或者别名，则替换为 相应的整数。否则 按照整数解析。 -- 定义如下: - ![如图](images/adv/def_40.png) - 数据如下: +- [定义](images/adv/def_40.png) + ``` xml + + + + + + ... + + + ``` +- 配置: ![如图](images/adv/def_41.png) - 添加了 convert 的字段，既可以填 convert 指向的枚举类里的一个合法枚举名，也可以是其他整数。 diff --git a/docs/deploy.md b/docs/deploy.md index 14df1b0..e048a76 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -4,7 +4,17 @@ # 服务端布署 ## Docker 镜像布署 +- 镜像会自动更新至最新版 +- 在有 docker 的环境下，执行下面的指令 ``` bash docker pull hugebug4ever/luban:latest docker run --name luban-server -d -p 8899:8899 hugebug4ever/luban:latest +``` + +## Windows 下命令行布署 +- 下载 [release](https://github.com/focus-creative-games/luban/releases) 版本 +- 解压 Luban.Server.zip +- 执行下面的命令即可 +``` + Luban.Server.exe ``` \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index f472ac7..5c09b66 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,8 @@ [//]: # "Author: bug" [//]: # "Date: 2020-11-15 23:59:21" +=============================================================================== + ## 为什么要使用"客户端/服务器"模式 - 最初的想法是服务端闭源，因为代码生成部分花了很多心思，也方便加密之类的操作 @@ -11,9 +13,14 @@ - 再快的技术，也挡不住大量数据的处理 ## 如果用客户端生成，再通过服务器端分享缓存，不是更快么 - - 是的 - - 但服务器模式还方便更新 - - 如果有效率提升，更佳的 feature (比如统计？) + - 是的。 + - 但服务器模式还有方便更新的优势，就像网页访问，不需要每个客户端升级浏览器。 - 通知每个使用者要更新本地目录这件事，在实践中也产生过很多麻烦。 - - c-s 本身是个流行的设计，虽然万物皆可客户端 ^_^ - - 考虑至此，就没有继续深究这个问题 + - 如果有效率提升，更佳的 feature (比如统计？), 在服务端实施更方便。 + - c-s 本身是个流行的设计，虽然万物皆可客户端 ^_^。 + - 考虑至此，就没有继续深究这个问题。 + +## 为什么 excel 的配置不像别的工具，用文件头描述数据？ +- 数据描述除了 excel 还可以为 json 等其它数据源。用 xml 可以更统一。 +- 数据类型可以描述地更详细，毕竟 excel 的表达只是强在数据。 +- 数据关系可以更好地表达，比在 excel 中用一些技巧实现更舒服。