DebugUI 项目使用教程-CSDN博客

DebugUI 项目使用教程

1. 项目介绍

DebugUI 是一个基于 Unity UI Toolkit 的开源框架，旨在帮助开发者快速构建调试工具。通过 DebugUI，开发者可以轻松创建运行时调试工具，提升开发效率。DebugUI 提供了丰富的 UI 元素和配置选项，支持自定义主题和样式，适用于各种调试场景。

2. 项目快速启动

2.1 安装

方法一：通过 Package Manager 安装

打开 Unity 编辑器，进入 Window > Package Manager。
点击右上角的 "+" 按钮，选择 "Add package from git URL"。

输入以下 URL：

https://github.com/AnnulusGames/DebugUI.git?path=src/DebugUI/Assets/DebugUI

点击 "Add" 按钮完成安装。

方法二：通过 manifest.json 安装

打开项目根目录下的 Packages/manifest.json 文件。

在 dependencies 块中添加以下内容：

"com.annulusgames.debug-ui": "https://github.com/AnnulusGames/DebugUI.git?path=src/DebugUI/Assets/DebugUI"

保存文件，Unity 会自动安装包。

2.2 创建调试窗口

2.2.1 创建 DebugUIBuilderBase 组件

创建一个新的 C# 脚本，命名为 DebugUIBuilderExample.cs。

继承 DebugUIBuilderBase 类，并实现 Configure 方法：

using UnityEngine;
using DebugUI;

public class DebugUIBuilderExample : DebugUIBuilderBase
{
    [SerializeField] private float field;

    protected override void Configure(IDebugUIBuilder builder)
    {
        builder.AddLabel("Label");
        builder.AddButton("Button", () => Debug.Log("Hello"));
        builder.AddField("Field", () => field, x => field = x);
    }
}

将该脚本挂载到一个 GameObject 上，并在 Inspector 中指定目标 UIDocument。

2.2.2 使用 DebugUIBuilder 类

在需要创建调试窗口的地方，使用 DebugUIBuilder 类：

using UnityEngine;
using UnityEngine.UIElements;
using DebugUI;

public class DebugUIExample : MonoBehaviour
{
    [SerializeField] private UIDocument uiDocument;
    [SerializeField] private float field;

    void Start()
    {
        var builder = new DebugUIBuilder();
        builder.AddLabel("Label");
        builder.AddButton("Button", () => Debug.Log("Hello"));
        builder.AddField("Field", () => field, x => field = x);
        builder.BuildWith(uiDocument);
    }
}