diff --git a/README.en-us.md b/README.en-us.md index d037335..d5c1006 100644 --- a/README.en-us.md +++ b/README.en-us.md @@ -32,6 +32,7 @@ If you have any questions about the use, please add the QQ group to ask in time, - QQ group: 692890842 - Email: taojingjian#gmail.com + - Skypy group: https://join.skype.com/xr2nhdMKjac0 ## Documentation @@ -94,8 +95,40 @@ If you have any questions about the use, please add the QQ group to ask in time, ![pipeline](docs/images/pipeline.jpg) ## Quick preview +**luban is compatible with commonplace excel table generation tools, and a complete data table can be defined in excel**. Unlike common table guide tools that focus on excel, because luban supports a powerful type system and supports json, xml, lua and other file types, luban’s native usage is to separate definition and data, and use separate xml to define tables and structures* *, the data file only contains data. -Unlike common table guide tools that focus on excel, the definition of luban is separated from the data, and a separate xml definition is used to define the table and structure. The data file only contains data. +After showing the examples of common compatible horizontal and vertical tables below, the remaining examples are all in the luban style of **definition and data separation**. The user chooses whether to define the method of mixing with the data or the method of separating it from the data or mixture of these two style. At present, most of the examples in the luban_examples project use the method of separating definition and data. + +### commonplace compatible horizontal table + +Add table definition in xml +```xml + +``` + +Or add in the tables.xlsx file + +![tables.xlsx](docs/images/examples/ex_03.png) + +excel file + +![excel](docs/images/examples/ex_01.png) + +### commonplace compatible vertical table + +Add table definition in xml + +```xml +
+``` + +Or add in the tables.xlsx file + +![tables.xlsx](docs/images/examples/ex_04.png) + +excel file + +![Compatible vertical table](docs/images/examples/ex_02.png) ### Regular primitive data diff --git a/README.md b/README.md index c8f5790..9299b58 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ Luban适合有以下需求的开发者： - [特性](docs/traits.md) - [快速上手](docs/install.md) - [Excel 配置数据简介](docs/data_excel.md) +- [client&server安装与使用说明](docs/luban_install_manual.md) - [文档目录](docs/catalog.md) - [[TODO] 完整手册](docs/manual.md) - **====>强烈推荐查看：示例项目** ([github](https://github.com/focus-creative-games/luban_examples)) ([gitee](https://gitee.com/focus-creative-games/luban_examples)) **<====** @@ -45,9 +46,7 @@ Luban适合有以下需求的开发者： - 支持与联系 - QQ群: 692890842 （Luban开发交流群）。有使用方面的疑问请及时加QQ群询问，随时有人帮助解决。 - 邮箱: taojingjian#gmail.com - - 微信群: - - ![link](docs/images/wxg.png) + - Skypy群: https://join.skype.com/xr2nhdMKjac0 ## 特性 - 支持增强的excel格式，可以在excel里比较简洁填写出任意复杂的数据 @@ -101,7 +100,7 @@ Luban适合有以下需求的开发者： **luban兼容传统的excel导表工具，可以在excel定义完整的数据表**。与常见的专注于excel的导表工具不同，由于luban支持强大的类型系统以及支持json、xml、lua等文件类型，luban原生做法为定义与数据分离，使用单独的xml定义 **表和结构**，数据文件只包含数据。 -下面展示完普通兼容横表和纵表的例子后，剩余例子都是**定义与数据分离**的luban风格。使用者自己选择是定义与数据混合的方式还是定义与数据分离的方式。目前luban_examples项目中大多数示例使用定义与数据分离的方式。 +下面展示完普通兼容横表和纵表的例子后，剩余例子都是**定义与数据分离**的luban风格。使用者自己选择是定义与数据混合的方式还是定义与数据分离的方式或者混用两种方式。目前luban_examples项目中大多数示例使用定义与数据分离的方式。 ### 传统兼容横表 @@ -828,27 +827,9 @@ return - 安装 [VS2019 社区版](https://visualstudio.microsoft.com/zh-hans/vs/) - 安装 [.dotnet core sdk 5.0](https://dotnet.microsoft.com/download/dotnet/5.0) -## 部属 luban-server +## 安装与使用 -- 基于 docker - - docker run -d --rm --name luban-server -p 8899:8899 focuscreativegames/luban-server:latest - -- 基于 .net 5 runtime （推荐win平台使用，可跨平台，不需要重新编译） - - 自行安装 .net 5 runtime. - - 从[示例项目](https://github.com/focus-creative-games/luban_examples/tree/main/Tools/Luban.Server)拷贝 Luban.Server（**可跨平台，即使在linux、mac平台也不需要重新编译**） - - 在Luban.Server目录下运行 dotnet Luban.Server.dll - -## 使用 luban-client -- 基于 docker (推荐 linux、mac平台使用) - - docker run --rm -v $PWD/.cache.meta:/bin/.cache.meta focuscreativegames/luban-client <参数> - - 提醒！ .cache.meta这个文件用于保存本地生成或者提交到远程的文件md5缓存，**强烈推荐** 添加-v 映射，不然每次重新计算所有涉及文件的md5,这可能在项目后期会造成多达几秒的延迟。 -- 基于 .net 5 runtime （推荐win平台使用，可跨平台，不需要重新编译） - - 自行安装 .net 5 runtime. - - 从[示例项目](https://github.com/focus-creative-games/luban_examples/tree/main/Tools/Luban.Client)拷贝 Luban.Client（**可跨平台，即使在linux、mac平台也不需要重新编译**） - - 在Luban.Client目录下运行 dotnet Luban.Client.dll <参数> +参见 [client&server安装与使用说明](docs/luban_install_manual.md) ## 如何贡献 diff --git a/docs/images/wxg.png b/docs/images/wxg.png deleted file mode 100644 index 387578b..0000000 Binary files a/docs/images/wxg.png and /dev/null differ diff --git a/docs/luban_install_manual.md b/docs/luban_install_manual.md new file mode 100644 index 0000000..ffd7401 --- /dev/null +++ b/docs/luban_install_manual.md @@ -0,0 +1,186 @@ + +## 部属 + +### 部属 luban-server + +- 基于 docker (强烈推荐以这种方式在服务器上部属luban-server，因为可以充分利用缓存机制大幅缩短生成时间) + + docker run -d --rm --name luban-server -p 8899:8899 focuscreativegames/luban-server:latest + +- 基于 .net 5 runtime （可跨平台，不需要重新编译） + - 自行安装 .net 5 runtime. + - 从[示例项目](https://github.com/focus-creative-games/luban_examples/tree/main/Tools/Luban.Server)拷贝 Luban.Server（**可跨平台，即使在linux、mac平台也不需要重新编译**） + - 在Luban.Server目录下运行 dotnet Luban.Server.dll (Win平台可以直接运行 Luban.Server.exe) + +### 安装 luban-client +- 基于 docker (只推荐与jenkins之类devops工具配合使用，因为docker容器启动会增加一定的延迟) + + docker run --rm -v $PWD/.cache.meta:/bin/.cache.meta focuscreativegames/luban-client <参数> + + 提醒！ .cache.meta这个文件用于保存本地生成或者提交到远程的文件md5缓存，**强烈推荐** 添加-v $PWD/.cache.meta:/bin/.cache.meta 映射，不然每次重新计算所有涉及文件的md5,这可能在项目后期会造成多达几秒的延迟。 +- 基于 .net 5 runtime （推荐win平台使用，可跨平台，不需要重新编译） + - 自行安装 .net 5 runtime. + - 从[示例项目](https://github.com/focus-creative-games/luban_examples/tree/main/Tools/Luban.Client)拷贝 Luban.Client（**可跨平台，即使在linux、mac平台也不需要重新编译**） + + +----- +## 使用 + +### luban-server 使用介绍 + +命令行使用 + + dotnet Luban.Server.dll [-p ] [-l ] + + 参数介绍： + -p 可选参数。 监听端口 ，默认为8899。 + -l 可选参数。 日志级别。默认为INFO。 有效值有: TRACE,DEBUG,INFO,WARN,ERROR,FATAL,OFF + +## luban-client 使用介绍 + + 命令行使用 + + dotnet Luban.Client.dll [-h ] [-p ] [-l ] [-c ] [-w ] [-h ] -j cfg -- + + 参数介绍： + -h,--host 可选参数。 luban-server的地址。默认为 127.0.0.1 + -p,--port 可选参数。 luban-server的端口。默认为 8899 + -j,--job 必选参数。 生成类型。目前支持的生成类型有: cfg,proto,db。 生成配置请取cfg。 + -l,--loglevel 可选参数。 日志级别。默认为INFO。有效值有: TRACE,DEBUG,INFO,WARN,ERROR,FATAL,OFF + -c,--cachemetafile 可选参数。 meta缓存文件名。 默认为 .cache.meta + -w,--watch 可选参数。 监测目录或者目录列表，以逗号','分隔。当开启此选项后，生成结束后不会退出程序，而是进入自动生成模式。监听到目标目录发生变化后，自动重新运行生成。省去改动后手动运行生成脚本的麻烦。 + -h,--help 可选参数。显示帮助信息 + -- 必选参数。 从此参数起，便是 不同job的特有选项 + +---- + + cfg的介绍： + + -d,--define_file 必选参数。 根定义文件名。 + --input_data_dir 必选参数。 配置数据文件根目录。 + -c,--output_code_dir 可选参数。 生成代码文件的目录。 + -s,--service 必选参数。生成分组目标。一般来说，会定义client,server,editor等好几个目标，不同目标的生成内容不同。 + --gen_types 必选参数。生成任务类型。既可以是生成代码也可以是生成数据或者其他。目前支持的有 code_cs_bin,code_cs_json,code_cs_unity_json,code_lua_bin,code_java_bin,code_go_bin,code_go_json,code_cpp_bin,code_python27_json,code_python3_json，code_typescript_bin,code_typescript_json,data_bin,data_lua,data_json,data_json_monolithic + --output_data_dir 可选参数。 导出的数据文件的目录。 + --validate_root_dir . 可选参数。 配置path检查的根目录。 + --export_test_data 可选参数。 是否导出测试数据。默认为false + + -t,--l10n_timezone 可选参数。 指定所在时区。影响datetime类型转换为utc时间。 默认为中国北京时间。 + --input_l10n_text_files 可选参数。 本地化的文本映射表。可以有多个。 + --l10n_text_field_name 可选参数。 文本映射表中，目标映射列的列名，默认为text + --output_l10n_not_converted_text_file 可选参数。 未被本地化映射的text key和value的输出文件。不提供该参数则不生成 + --branch 可选参数。当前需要生成的分支名称。 + --branch_input_data_dir 可选参数。分支数据的根目录。 + + +## 示例 + +假设 + + luban.server 运行在本机，端口为8899 + luban.client的位置在 d:\tools\Luban.Client + 配置定义在 d:\raw_config\defines + 配置定义的根定义文件为 d:\raw_config\defines\__root__.xml + 配置数据在 d:\raw_configs\datas + + client项目为unity项目，位置在 d:\client + 你期望client生成的代码在 d:\client\Assets\Gen 目录 + 你期望client生成的数据在 d:\client\Assets\StreamingAssets\GameData 目录 + + 你们服务器项目为 dotnet c#项目，位置在d:\server + 你期望server生成的代码在 d:\server\src\Gen + 你期望server生成的数据在 d:\server\GameData + +案例1： + + 你要为客户端生成代码和数据。 + 你期望使用bin格式的导出数据类型 + 你为客户端选择的service分组为 client + 当前在开发期，你期望导出数据中包含测试数据 + + 则win下命令为： + + dotnet d:\tools\Luban.Client\Luban.Client.dll ^ + -h 127.0.0.1 ^ + -p 8899 ^ + -j cfg ^ + -- ^ + --define_file d:\raw_config\defines\__root__.xml ^ + --input_data_dir d:\raw_configs\datas ^ + --output_code_dir d:\client\Assets\Gen ^ + --output_data_dir d:\client\Assets\StreamingAssets\GameData ^ + --gen_types code_cs_bin,data_bin ^ + --service client ^ + --export_test_data + + linux bash命令同理。 + +案例2： + + 你要为客户端生成代码和数据。 + 你期望使用json格式导出数据类型。 + 你不期望导出数据中包含测试数据 + + 则win下命令为: + + dotnet d:\tools\Luban.Client\Luban.Client.dll ^ + -h 127.0.0.1 ^ + -p 8899 ^ + -j cfg ^ + -- ^ + --define_file d:\raw_config\defines\__root__.xml ^ + --input_data_dir d:\raw_configs\datas ^ + --output_code_dir d:\client\Assets\Gen ^ + --output_data_dir d:\client\Assets\StreamingAssets\GameData ^ + --gen_types code_cs_unity_json,data_json ^ + --service client + +案例3： + + 你要为服务器生成代码和数据。 + + 你期望使用json导出数据格式。 + 你期望包含测试数据。 + 你为服务器选择的service为server + + 则 win下命令为： + + dotnet d:\tools\Luban.Client\Luban.Client.dll ^ + -h 127.0.0.1 ^ + -p 8899 ^ + -j cfg ^ + -- ^ + --define_file d:\raw_config\defines\__root__.xml ^ + --input_data_dir d:\raw_configs\datas ^ + --output_code_dir d:\server\src\Gen ^ + --output_data_dir d:\server\GameData ^ + --gen_types code_cs_json,data_json ^ + --service server ^ + --export_test_data +案例4： + + luban-server 被你部属在 192.168.1.10这台机器上，端口为1111。其他的如案例3。 + + 则 win下的生成命令为： + + dotnet d:\tools\Luban.Client\Luban.Client.dll ^ + -h 192.168.1.10 ^ + -p 1111 ^ + -j cfg ^ + -- ^ + --define_file d:\raw_config\defines\__root__.xml ^ + --input_data_dir d:\raw_configs\datas ^ + --output_code_dir d:\server\src\Gen ^ + --output_data_dir d:\server\GameData ^ + --gen_types code_cs_json,data_json ^ + --service server ^ + --export_test_data + + + + + + + + + diff --git a/src/Luban.Job.Cfg/Source/DataSources/Excel/Sheet.cs b/src/Luban.Job.Cfg/Source/DataSources/Excel/Sheet.cs index be7be61..e073072 100644 --- a/src/Luban.Job.Cfg/Source/DataSources/Excel/Sheet.cs +++ b/src/Luban.Job.Cfg/Source/DataSources/Excel/Sheet.cs @@ -269,16 +269,12 @@ namespace Luban.Job.Cfg.DataSources.Excel switch (value) { case "r": - case "row": - case "l": - case "landscape": IsOrientRow = true; break; + case "row": IsOrientRow = true; break; case "c": - case "column": - case "p": - case "portrait": IsOrientRow = false; break; + case "column": IsOrientRow = false; break; default: { - throw new Exception($"单元薄 meta 定义 row:{value} 属性值只能为landscape(l,row,r)或portrait(p,row,r)"); + throw new Exception($"单元薄 meta 定义 orientation:{value} 属性值只能为row|r|column|c"); } } break; @@ -298,7 +294,7 @@ namespace Luban.Job.Cfg.DataSources.Excel } default: { - throw new Exception($"非法单元薄 meta 属性定义 {attr}, 合法属性有: orientation=landscape|l|r|row|portrait|p|r|row,title_rows="); + throw new Exception($"非法单元薄 meta 属性定义 {attr}, 合法属性有: orientation=r|row|c|column,title_rows="); } } }