Jotunn 项目使用与配置指南

1. 项目目录结构及介绍

Jotunn 项目的主要目录结构如下：

• .github/：包含与 GitHub 仓库操作相关的文件，如工作流等。
• .idea/：包含 IntelliJ IDEA 编辑器的配置文件。
• .vscode/：包含 Visual Studio Code 编辑器的配置文件。
• JotunnBuildTask/：包含构建任务的代码。
• JotunnDoc/：包含项目文档的代码。
• JotunnLib/：包含 Jotunn 核心库的代码。
• JotunnTests/：包含对 Jotunn 库的单元测试。
• libraries/：包含项目依赖的库文件。
• resources/：包含项目资源文件，如图片、配置文件等。
• TestMod/：包含一个示例模组，用于演示如何使用 Jotunn。
• CHANGELOG.md：项目的更新日志。
• CONTRIBUTING.md：贡献指南，描述如何为项目贡献代码。
• JotunnLib.sln：Visual Studio 解决方案文件。
• LICENSE：项目的许可协议文件。
• README.bbcode：以 BBCode 格式编写的 README 文件。
• README.md：以 Markdown 格式编写的 README 文件。
• publish.ps1：用于发布项目的 PowerShell 脚本。

2. 项目的启动文件介绍

Jotunn 项目的启动主要是通过其核心库 JotunnLib 来实现。项目中并没有一个单一的启动文件，而是通过一系列的类和方法来集成到 Valheim 模组中。以下是一些关键的类和文件：

• Jotunn.cs：通常是模组的入口点，负责初始化 Jotunn 库。
• Main.cs：模组的启动类，通常用于挂载 Jotunn 库的事件和功能。

在 Valheim 模组中，你需要在 Main.cs 的 Load 方法中初始化 Jotunn，如下所示：

using Jotunn;
using UnityEngine;

public class Main : ModSystem
{
    public override void Load()
    {
        Jotunn/jotunn = new Jotunn();
    }
}

3. 项目的配置文件介绍

Jotunn 项目的配置文件主要用于设置和控制模组的行为。以下是一些重要的配置文件：

• config.json：包含模组的基本配置，如模组的名称、版本等。
• paths.props：用于定义项目中的路径和配置选项。

配置文件通常位于 resources/ 目录下。例如，一个典型的 config.json 文件可能如下所示：

{
  "name": "Jotunn Mod",
  "version": "1.0.0",
  "description": "A powerful modding library for Valheim."
}

开发者可以通过修改这些配置文件来定制化模组的行为和外观。确保在修改配置后重新编译模组，以便更改生效。