diff --git a/README.md b/README.md index 6cca0e1..aec3f6f 100644 --- a/README.md +++ b/README.md @@ -108,12 +108,12 @@ luban支持在excel中解析任意复杂的数据结构，哪怕复杂如技能 支持 bool,int,float,string,text,datetime,vector2,vector3,vector4 等等类型，它们的填写跟常规认知一致。 -| x1 | x3 | x4 | x5 | x6 | x7 | s1 | s2&sep=# | v2 | v3 | v4 | t1 | -| - | - | - | - | - | - | - | - | - | - | - | - | -|bool|short|int|long|float|double|string|text |vector2|vector3|vector4|datetime| -|desc1|id|desc4|desc5|desc6|desc7|desc1|desc2 |desc2|desc3|desc4|desc1| -|false| 10| 100| 1000| 1.23| 1.2345|hello |key1#world1|1,2|1,2,3|1,2,3,4|1999-10-10 11:12:13| -|true | 20| 200| 1000| 1.23| 1.2345|world |key2#world2|1,2|1,2,3|1,2,3,4|1999-10-12 11:12:13| +|##| x1 | x3 | x4 | x5 | x6 | x7 | s1 | s2&sep=# | v2 | v3 | v4 | t1 | +| -| - | - | - | - | - | - | - | - | - | - | - | - | +|##type|bool|short|int|long|float|double|string|text |vector2|vector3|vector4|datetime| +|##|desc1|id|desc4|desc5|desc6|desc7|desc1|desc2 |desc2|desc3|desc4|desc1| +|| false| 10| 100| 1000| 1.23| 1.2345|hello |key1#world1|1,2|1,2,3|1,2,3,4|1999-10-10 11:12:13| +|| true | 20| 200| 1000| 1.23| 1.2345|world |key2#world2|1,2|1,2,3|1,2,3,4|1999-10-12 11:12:13| ### 原生数据列表 @@ -122,6 +122,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -129,6 +130,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -136,6 +138,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -144,6 +147,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -152,6 +156,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -174,12 +179,12 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 ``` -| id| quality| quality2 | -| - | - | - | -|int|ItemQuality|ItemQuality| -| 1| 白 | RED | -| 2| GREEN | 红 | -| 3| RED | WHITE | +| ##|id| quality| quality2 | +| -| - | - | - | +|##type|int|ItemQuality|ItemQuality| +| | 1| 白 | RED | +| | 2| GREEN | 红 | +| | 3| RED | WHITE | @@ -198,22 +203,27 @@ array与list类型都能表示列表，它们区别在于array生成的代码为
## id arr1 arr2arr4
##type int array,int list,intlist,string
## id desc1 desc2
1 1,2,3 12
2 2,4 3456
+ + + + + @@ -238,24 +248,28 @@ array与list类型都能表示列表，它们区别在于array生成的代码为
## id reward
##type int Reward
## id item idcountdesc
1 item11desc1
2 item2100desc2
+ + + + @@ -263,6 +277,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -290,38 +305,44 @@ array与list类型都能表示列表，它们区别在于array生成的代码为
## id rewards1 rewards2&sep=, rewards3&sep=,|
##type int list,Reward list,Reward list,Reward
## id reward list desc1 reward list desc2 reward list desc3
1 item11desc1item22desc2 item1,1,desc1item2,2,desc2item3,3,desc3
2 item11desc1 item1,1,desc1item2,2,desc2
+ + + + + - + + - +
## id name *stage2
##type int string list,Stage
## id desc stage info
1 task1 1stage1stage desc11,2,310011
2stage2stage desc21,2,310011
3stage3stage desc31,2,3100213stage3stage desc31,2,310021
2 task2 1stage1stage desc11,2,310011
2stage2stage desc21,2,3100212stage2stage desc21,2,310021
@@ -330,24 +351,24 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 ### 单例表 有一些配置全局只有一份，比如 公会模块的开启等级，背包初始大小，背包上限。此时使用单例表来配置这些数据比较合适。 -| guld_open_level | bag_init_capacity | bag_max_capacity | newbie_tasks | -| - | - | - | - | -|int | int | int | list,int| -|desc1 | desc 2 | desc 3 | desc 4 | -|10 | 100| 500| 10001,10002 | +| ##| guld_open_level | bag_init_capacity | bag_max_capacity | newbie_tasks | +| - |- | - | - | - | +| ##type | int | int | int | list,int| +| ## |desc1 | desc 2 | desc 3 | desc 4 | +| | 10 | 100| 500| 10001,10002 | ### 纵表 -大多数表都是横表，即一行一个记录。有些表，比如单例表，如果纵着填，一行一个字段，会比较舒服。meta行添加 orientation=c 则使用纵表模式来填写内容。 上面的单例表，以纵表模式填如下。 +大多数表都是横表，即一行一个记录。有些表，比如单例表，如果纵着填，一行一个字段，会比较舒服。A1为##column表示使用纵表模式。 上面的单例表，以纵表模式填如下。 + + - - @@ -379,6 +400,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为
##column##type ##orientation=ctitle_rows=3
+ @@ -386,6 +408,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -393,6 +416,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -400,6 +424,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -407,6 +432,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -422,12 +448,12 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 对于这些字段添加属性 path=unity或者path=ue或path=normal;xxxx。 -| id | icon | -| - | - | -| int | string&path=unity| -|id | icon desc | -| 1| Assets/UI/item1.jpg| -|2| Assets/UI/item2.jpg| +| ## | id | icon | +| - | - | - | +| ##type| int | string&path=unity| +| ##|id | icon desc | +| | 1| Assets/UI/item1.jpg| +| | 2| Assets/UI/item2.jpg| ### 分组导出 @@ -440,10 +466,10 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 开发期经常会制作一些仅供开发使用的配置，比如测试道具，比如自动化测试使用的配置，希望在正式发布时不导出这些数据。 -|\_\_tag\_\_ | id | name | | +| ## | id | name | | | - | - | - | - | -| | int | string | | -| 导出标记 | id | desc1| 注释 | +| ##type | int | string | | +| ## | id | desc1| 注释 | | | 1 | item1 | 永远导出 | |##| 2 | item2 | 永远不导出 | |test| 4 | item4 | --export_exclude_tags test 时不导出 | @@ -459,13 +485,14 @@ array与list类型都能表示列表，它们区别在于array生成的代码为
## id item_id itemsrewards&sep=,
##type int int int&ref=item.TbItemreward
## id desc1 desc2desc4
1 1001 1001,10021001,10,item11002,2,item2
2 1002 1003,1004,1005
- + - + + @@ -475,13 +502,13 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 - - @@ -518,13 +545,13 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 ### 可空数据类型 配置数据中经常有空值的语义需求，实际项目中往往混杂地使用0或-1表达空值，既不自然清晰也不统一。luban借鉴了c#中的可空变量的概念，特地提供可空数据支持。所有原生数据类型，以及enum、bean、和多态bean类型都有相应的可空数据类型。定义方式为 <类型名>?，与c#里的Nullable类型定义方式相同。例如 bool?,int?,long?,double?, EColor?, DemoType? -|id|x1|x2|x3|x4|x5| -|-|-|-|-|-|-| -|int|bool?|int?|float?|datetime?|QualityType?| -|id|desc1|desc2|desc3|desc4|desc5| -|1|true|1|1.2|1999-09-09 10:10:10| RED| -|2|null|null|null|null|null| -|3| ||||| +|##|id|x1|x2|x3|x4|x5| +| - |-|-|-|-|-|-| +|##type|int|bool?|int?|float?|datetime?|QualityType?| +|##|id|desc1|desc2|desc3|desc4|desc5| +||1|true|1|1.2|1999-09-09 10:10:10| RED| +||2|null|null|null|null|null| +||3| ||||| ### 类型继承(inheritance) @@ -556,18 +583,22 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 ```
## id name stages
##field id namenum
+ ##type int string list,Stage
+ ## id desc1 desc1
+ + + + @@ -575,6 +606,7 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 + @@ -589,13 +621,13 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 如示例，id=2的记录，x1与x2皆为空，x1=0,x2=-1。 -|id | x1 | x2&default=-1| -| - | - | - | -| int | int | int | -|id|desc1|desc2| -|1 | 10 |20| -|2| | | -|3| | 30| +|##|id | x1 | x2&default=-1| +| - | - | - | - | +|##type| int | int | int | +|##|id|desc1|desc2| +||1 | 10 |20| +||2| | | +||3| | 30| ### 常量别名 @@ -609,13 +641,13 @@ array与list类型都能表示列表，它们区别在于array生成的代码为 ``` -|id| item_id | -| - | - | -|int| int&convert=EFunctionItemId| -|id| desc| -|1 | SHENG_JI_DAN| -|2| 进阶丹| -|3| 1001| +|##|id| item_id | +|-| - | - | +|##type|int| int&convert=EFunctionItemId| +|##|id| desc| +||1 | SHENG_JI_DAN| +||2| 进阶丹| +||3| 1001| ### 灵活的配置文件组织形式 支持以下几种组织形式，允许开发者根据情况灵活组织配置文件结构。例如可以一个表对应一个xlsx文件；可以多个表都放到同个xlsx文件；可以一个表对应多个xlsx文件；可以一个表对应一个目录。 diff --git a/docs/images/examples/e_10.jpg b/docs/images/examples/e_10.jpg index 4dafadc..8498be4 100644 Binary files a/docs/images/examples/e_10.jpg and b/docs/images/examples/e_10.jpg differ diff --git a/docs/l10n.md b/docs/l10n.md index 415f65e..c409447 100644 --- a/docs/l10n.md +++ b/docs/l10n.md @@ -10,30 +10,35 @@
## id shapes&sep=,
##type int list,Shape
## id shape desc
1 Circle,10 Rectangle,100,200
2 Circle,20 Rectangle,100,200
+ + + + + @@ -44,12 +49,12 @@ #### 文本值映射文件 -| key | origin_text | text_tw | text_en | -| - | - | - | - | -|本地化key| 原始值 | 繁体值 | 英文 | -|本地化key| 原始值 | 繁体值 | 英文 | -|/demo/key1|苹果|苹果|apple| -|/demo/key2|香蕉|香蕉|banana| +| ## | key | origin_text | text_tw | text_en | +| - | - | - | - | - | +|##type|string|string|string|string| +|##|本地化key| 原始值 | 繁体值 | 英文 | +||/demo/key1|苹果|苹果|apple| +||/demo/key2|香蕉|香蕉|banana| ### Luban.Client 命令 有三个参数跟静态文本值本地化相关 @@ -122,12 +127,12 @@ - 运行时调用 cfg.Tables.TranslateText函数，一键切换配置中所有text类型值到目标语言 本地化映射函数实现比较简单，核心在于如何制作文本值本地化映射配置？使用者既可以使用自定义本地化映射表，可以使用普通的 luban配置表来提供 文本值映射配置，如下图: -| key | origin_text | text_tw | text_en | -| - | - | - | - | -| string| string| string| string| -|本地化key| 原始值 | 繁体值 | 英文 | -|/demo/key1|苹果|苹果|apple| -|/demo/key2|香蕉|香蕉|banana| +|##| key | origin_text | text_tw | text_en | +|-| - | - | - | - | +|##type| string| string| string| string| +|##|本地化key| 原始值 | 繁体值 | 英文 | +||/demo/key1|苹果|苹果|apple| +||/demo/key2|香蕉|香蕉|banana| 假设想切换到en，配置表的表名为 l10n.TbTextMapper，示例c#版本地化映射函数如下： ```c#
## id name desc count
##type int text string int
1 /demo/key1苹果 这是一个苹果 100
2 /demo/key2香蕉 这是香蕉 100
3 /demo/key3西瓜 这是西瓜