Dalamud 插件开发框架安装与使用教程

Dalamud 插件开发框架安装与使用教程

DalamudFFXIV plugin framework and API项目地址:https://gitcode.com/gh_mirrors/da/Dalamud

1. 项目目录结构及介绍

Dalamud 的源码仓库包含了多个子模块，它们各自负责不同的功能：

Dalamud/
├── core/         # 核心库，包含 C# 和 C++ 组件
│   ├── CSharp/    # C# 部分的核心插件框架
│   └── Cpp/       # C++ 部分的游戏绑定和加载器
├── plugins/      # 示例或测试用插件
├── tools/        # 开发辅助工具，如构建脚本
└── etc/          # 配置文件和其他资源

• core/CSharp: 提供了主要的 C# 插件API以及游戏数据访问接口。
• core/Cpp: 包含游戏注入和进程加载逻辑的 C++ 代码。
• plugins: 示例插件存放区，用于开发者参考。
• tools: 用于构建、调试和部署 Dalamud 的命令行工具。

2. 项目启动文件介绍

Dalamud 是一个动态加载框架，通常不通过直接执行来运行。它的启动涉及以下组件：

• Dalamud.Injector.exe: C# 版本的注入器，用于在目标进程中注入 .NET Core 运行时并引导 Dalamud 加载。
• Dalamud_Boot.dll: C++ 启动组件，负责在目标进程中加载.NET Core 运行时。

实际使用中，这些文件会由 XIVLauncher 管理和运行，用户不需要手动处理启动文件。

3. 项目配置文件介绍

Dalamud 使用的配置文件主要位于 %AppData%\XIVLauncher\ 目录下，包括：

• dalamud.ini: 用户级别的 Dalamud 设置文件，可以调整插件行为、启用测试版本等。
• dalamudUI.ini: 控制 Dalamud UI 显示位置和设置。
• plugin-settings.json: 存储各个插件的个人设置。

此外，如果你是开发者，可能会遇到的其他配置文件有：

• filterConfig.yml: 文档过滤配置，用于自定义 JSONDocFX 文档生成。
• global.json: 指定全局构建选项的 JSON 文件。
• stylecop.json: StyleCop 分析规则配置，保持编码风格一致性。

在对 Dalamud 进行个性化配置或开发新的插件时，了解这些文件的作用至关重要。

---

请注意，由于 Dalamud 是一个不断更新的项目，具体文件结构和配置可能随着时间推移有所变动。建议始终参照官方文档和最新的源码进行操作。

DalamudFFXIV plugin framework and API项目地址:https://gitcode.com/gh_mirrors/da/Dalamud