Loxodon Framework 开发教程

1. 项目的目录结构及介绍

Loxodon Framework 是一个为 Unity3D 设计的轻量级 MVVM（Model-View-ViewModel）框架，它包含了数据绑定和各种有用的组件。以下是项目的目录结构及各个部分的简要介绍：

Loxodon.Framework/
|-- .github/             # GitHub 工作流和其他 GitHub 相关配置
|-- docs/                # 项目文档
|-- plugins/             # 插件目录，包含各种扩展功能
|-- scripts/             # 脚本目录，包含框架的核心代码
|-- tests/               # 测试代码目录
|-- tools/               # 工具目录，包含项目所需的辅助工具
|-- .gitignore           # Git 忽略文件列表
|-- Installation.md      # 安装指南
|-- LICENSE              # 项目许可证文件
|-- README.md            # 项目自述文件

• .github/: 包含 GitHub Actions 工作流和其他与 GitHub 相关的配置文件。
• docs/: 存放项目文档的目录，包括用户指南、API 文档等。
• plugins/: 包含框架的插件，如 OSA、TextFormatting、TextMeshPro 等。
• scripts/: 框架的核心代码存放目录，包括 Model、View 和 ViewModel 的相关代码。
• tests/: 存放单元测试和其他测试代码。
• tools/: 包含一些项目开发过程中可能使用的工具和脚本。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• Installation.md: 提供了项目的安装指南。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的主自述文件，通常包含项目的概述和基本信息。

2. 项目的启动文件介绍

项目的启动文件通常是 scripts/ 目录下的某个主脚本文件，比如 Bootstrap.cs 或 GameEntry.cs。这个文件负责初始化框架和游戏环境，通常包括以下步骤：

• 初始化日志系统。
• 初始化数据绑定和事件系统。
• 加载配置数据。
• 初始化游戏场景。

using Loxodon.Framework.Contexts;
using Loxodon.Framework.Execution;
using UnityEngine;

public class Bootstrap : MonoBehaviour
{
    void Start()
    {
        // 初始化框架上下文
        Contexts.ContextManager.Init();

        // 执行游戏启动逻辑
        Executor executor = new Executor();
        executor.Execute(() =>
        {
            // 加载配置数据
            // 初始化游戏场景
            // 等等
        });
    }
}

3. 项目的配置文件介绍

配置文件通常用于存储和管理项目的设置和数据。在 Loxodon Framework 中，配置文件可以是 JSON、XML、CSV 或其他格式。以下是一些常见的配置文件类型和它们的作用：

• JSON 配置文件: 用于存储结构化数据，如游戏设置、关卡信息等。
• XML 配置文件: 用于存储更复杂的数据结构，如游戏的实体定义。
• CSV 配置文件: 用于存储表格数据，如物品属性、角色技能等。

配置文件通常放在资源目录中，比如 Resources/Config/ ，并通过框架提供的工具或 API 来加载和解析。

using System.IO;
using Loxodon.Framework.Data;
using Loxodon.Framework.LocalizationsForCsv;

public class ConfigManager
{
    public Localization LoadLocalization(string filePath)
    {
        string content = File.ReadAllText(filePath);
        return new Localization(content, new CsvParser());
    }
}

以上代码示例展示了如何使用 CSV 格式的本地化文件。ConfigManager 类负责读取和解析 CSV 文件，生成 Localization 对象，供游戏其他部分使用。