Skip to content

Commit

Permalink
add docs for UE
Browse files Browse the repository at this point in the history
  • Loading branch information
@owent
owent committed Apr 9, 2019
1 parent 51685b2 commit 9d36e1d
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 48 deletions.
105 changes: 58 additions & 47 deletions source/users/data_mapping.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,54 +56,65 @@
可用的配置项
---------------------------------------------

+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| 字段 | 简介 | 主配置 | 次配置 | 补充配置 | 说明 |
+================+========================+==================+===================+===================+====================================+
| DataSource | 配置数据源 | 文件路径 | 表名 | 数据起始行号,列号 | **必须**。 |
| | | | | (英文逗号分隔) | 可多个。多个则表示把多个Excel表数 |
| | | | | | 据合并再生成配置输出，这意味着这多 |
| | | | | | 个Excel表的描述Key的顺序和个数必须 |
| | | | | | 相同。 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| MacroSource | 元数据数据源 | 文件路径 | 表名 | 数据起始行号,列号 | + **可选** |
| | | | | (英文逗号分隔) | |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| 字段 | 简介 | 主配置 | 次配置 | 补充配置 | 说明 |
+====================+========================+====================+====================+======================+====================================+
| DataSource | 配置数据源 | 文件路径 | 表名 | 数据起始行号,列号 | **必须**。 |
| | | | | (英文逗号分隔) | 可多个。多个则表示把多个Excel表数 |
| | | | | | 据合并再生成配置输出，这意味着这多 |
| | | | | | 个Excel表的描述Key的顺序和个数必须 |
| | | | | | 相同。 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| MacroSource | 元数据数据源 | 文件路径 | 表名 | 数据起始行号,列号 | + **可选** |
| | | | | (英文逗号分隔) | |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| 编程接口配置 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| ProtoName | 协议描述名称 | 如: role_cfg | | | + **必须** |
| | | | | | + 协议类型名称 |
| | | | | | + 也可以是 ``包名`` . ``协议名`` |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| OutputFile | 输出文件 | 如: role_cfg.bin | | | + **必须** |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeyRow | 字段名描述行 | 如: 2 | | | + **必须** |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeyCase | 字段名大小写 | 如: 小写 | | | + 字段名映射时的大小写转换 |
| | | | | | + 可选值: 大写/小写/不变 |
| | | | | | + 如果不需要则留空 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeyWordSplit | 字段名分词字符 | | | | + **可选** |
| | | | | | + 字段名映射时单词之间填充的字符串 |
| | | | | | + 如果不需要则留空 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeyPrefix | 字段名固定前缀 | | | | + **可选** |
| | | | | | + 字段名映射时附加的前缀 |
| | | | | | + 如果不需要则留空 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeySuffix | 字段名固定后缀 | | | | + **可选** |
| | | | | | + 字段名映射时附加的后缀 |
| | | | | | + 如果不需要则留空 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| KeyWordRegex | 分词规则（正则表达式） | 判断规则 | 移除分词符号规则 | 前缀过滤规则 | + **可选** |
| | | | | | + 字段名映射时单词的分词规则 |
| | | | | | + 正则表达式 |
| | | | | | + 如果不需要则留空 |
| | 示例: | [A-Z_$ \t\r\n] | [_$ \t\r\n] | [a-zA-Z_$] | |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
| Encoding | 编码转换 | UTF-8 | | | 注：Google的protobuf库的代码里写死 |
| | | | | | 了UTF-8，故而该选项对Protobuf的二 |
| | | | | | 进制输出无效 |
+----------------+------------------------+------------------+-------------------+-------------------+------------------------------------+
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| ProtoName | 协议描述名称 | 如: role_cfg | | | + **必须** |
| | | | | | + 协议类型名称 |
| | | | | | + 也可以是 ``包名`` . ``协议名`` |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| OutputFile | 输出文件 | 如: role_cfg.bin | | | + **必须** |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeyRow | 字段名描述行 | 如: 2 | | | + **必须** |
+-------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeyCase | 字段名大小写 | 如: 小写 | | | + 字段名映射时的大小写转换 |
| | | | | | + 可选值: 大写/小写/不变 |
| | | | | | + 如果不需要则留空 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeyWordSplit | 字段名分词字符 | | | | + **可选** |
| | | | | | + 字段名映射时单词之间填充的字符串 |
| | | | | | + 如果不需要则留空 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeyPrefix | 字段名固定前缀 | | | | + **可选** |
| | | | | | + 字段名映射时附加的前缀 |
| | | | | | + 如果不需要则留空 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeySuffix | 字段名固定后缀 | | | | + **可选** |
| | | | | | + 字段名映射时附加的后缀 |
| | | | | | + 如果不需要则留空 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| KeyWordRegex | 分词规则（正则表达式） | 判断规则 | 移除分词符号规则 | 前缀过滤规则 | + **可选** |
| | | | | | + 字段名映射时单词的分词规则 |
| | | | | | + 正则表达式 |
| | | | | | + 如果不需要则留空 |
| | 示例: | [A-Z_$ \t\r\n] | [_$ \t\r\n] | [a-zA-Z_$] | |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| Encoding | 编码转换 | UTF-8 | | | 注：Google的protobuf库的代码里写死 |
| | | | | | 了UTF-8，故而该选项对Protobuf的二 |
| | | | | | 进制输出无效 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| UeCfg-UProperty | UnrealEngine配置 | 字段分组 | 蓝图权限 | 编辑权限 | + *可选* |
| | 支持的字段属性 | 默认值: XResConfig | 默认值: XResConfig | 默认值: EditAnywhere | |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| UeCfg-CaseConvert | 是否开启驼峰命名转换 | true/false | | | + *可选* |
| | （默认开启） | | | | + 开启后将使用首字母大写的 |
| | | | | | 驼峰命名法生成字段名和类名 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+
| UeCfg-CodeOutput | 设置UE代码输出目录 | 代码输出目录 | Publich目录前缀 | Private目录前缀 | + *可选* |
| | | | | | + 生成的cpp文件的包含路径和 |
| | | | | | Publich目录前缀有关 |
+--------------------+------------------------+--------------------+--------------------+----------------------+------------------------------------+

如果Excel里字段名使用上面示例里的规则，如果填的是 0UnlockLevel\_num，则会忽略第一个0（不符合前缀过滤规则）,按分词规则分词为Unlock、Level和num，
同时移除下划线分词符号（移除分词符号规则）。 然后按上面的大小写规则和 ``字段名分词字符`` 组成新的字段名，最后应用大小写规则。
Expand Down
13 changes: 12 additions & 1 deletion source/users/output_format.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,23 @@ Lua和Javacript的输出方式和输出设置有关，也很容易看懂，这
使用Msgpack的话， https://github.com/xresloader/xresloader/tree/master/loader-binding/msgpack 里有python2和node.js的读取示例。

.. _output-format-export ue:

导出为UE支持的CSV或JSON数据和代码 (可选)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

xresloader从2.0.0版本开始支持导出UE所支持的CSV或者JSON格式数据，使用 ``-t ue-csv`` 或 ``-t ue-json`` 可以指定导出的UE支持的数据格式内容。

导出UE数据后，我们还会导出对应加载数据的UE C++类代码，具体可用的控制选项参见 :ref:`data-mapping-available-options` 。我们可以通过以下代码加载：

生成完数据后我们在输出目录生成一个 **UnreaImportSettings.json** 文件，用于 **UEEditor-Cmd** 的导入命令。

.. _output-format-export enum:

导出枚举类型成代码 (可选)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

对应 ``-c`` 然后可以使用 ``-t json`` 、 ``-t xml`` 、 ``-t lua`` 、 ``-t js`` 来指定按哪种方式输出枚举量。
对应 ``-c`` 然后可以使用 ``-t json`` 、 ``-t xml`` 、 ``-t lua`` 、 ``-t js`` 、 ``-t ue-csv`` 、 ``-t ue-json`` 来指定按哪种方式输出枚举量。
比如把protobuf协议里的枚举输出成Lua代码，proto文件：

.. code-block:: proto
Expand Down

0 comments on commit 9d36e1d

Please sign in to comment.