Dts2Hx 项目启动与配置教程

1. 项目目录结构及介绍

Dts2Hx 是一个开源项目，用于将 DTS（Deus Ex Story File）文件转换为 HX（High Level Language）格式。项目的目录结构如下：

dts2hx/
├── .github/                # GitHub 相关文件
│   └── workflows/          # GitHub Actions 工作流文件
├── .vscode/                # Visual Studio Code 项目设置
├── benches/                # 性能测试代码
├── build/                  # 构建脚本和输出文件
├── dts2hx/                 # 项目源代码
│   ├── __init__.py
│   ├── common/             # 通用工具和函数
│   ├── converts/           # 转换器相关代码
│   ├── dts/                # DTS 文件解析相关代码
│   ├── hx/                 # HX 文件生成相关代码
│   └── tests/              # 测试代码
├── docs/                   # 文档资源
├── examples/               # 示例文件和项目
├── include/                # 包含的头文件
├── lib/                    # 项目依赖库
├── pydts2hx/               # Python 版本的 dts2hx
├── README.md               # 项目说明文件
└── scripts/                # 脚本文件

每个目录和文件的用途在上面的结构中已经做了简要说明。

2. 项目的启动文件介绍

项目的启动文件是位于 dts2hx/dts2hx.py 的 Python 脚本。这个脚本包含了主函数和命令行参数处理，是项目运行的入口点。

以下是启动文件的主要功能：

• 解析命令行参数
• 加载和解析 DTS 文件
• 将解析后的数据转换为 HX 格式
• 输出转换结果到文件或标准输出

要运行这个脚本，你需要在命令行中执行以下命令：

python dts2hx/dts2hx.py input.dts [output.hx]

这里 input.dts 是输入的 DTS 文件，output.hx 是可选的输出 HX 文件名。

3. 项目的配置文件介绍

Dts2Hx 项目使用配置文件来定义转换过程中的行为。配置文件通常是 JSON 格式，位于项目根目录下名为 config.json。

配置文件可能包含以下内容：

{
    "input": "input.dts",
    "output": "output.hx",
    "options": {
        "strip_comments": true,
        "convert_types": true,
        "keep_formatting": false
    }
}

在上面的示例中：

• input 键定义了输入文件的名字。
• output 键定义了输出文件的名字。
• options 键包含了转换过程中的一些选项，比如是否去除注释、是否转换类型、是否保留格式等。

在运行转换脚本之前，你可以根据需要修改 config.json 文件中的设置。