Unity AI Tools Template

Unity AI Tools Template

此模板存储库旨在轻松更新为真正的Unity包。请按照以下说明进行操作，它将帮助您完成包创建、分发和安装的整个过程。

制作包裹的步骤

1.️⃣ 单击按钮-创建存储库

2.️⃣ 克隆您的新存储库

3.️⃣ 初始化项目

使用初始化脚本重命名包并替换所有占位符。

./commands/init.ps1 -PackageId "com.company.package" -PackageName "My Package"

此脚本将：

• 重命名目录和文件。
• 替换 YOUR_PACKAGE_ID, YOUR_PACKAGE_NAME，等等。

4.️⃣ 更新 package.json

打开 Unity-Package/Assets/root/package.json 并更新：

• description
• author
• keywords
• unity （最低支持Unity版本）

1. 生成元文件

为确保正确生成所有Unity元文件： - 打开Unity Hub。 - 添加 Installer 文件夹作为一个项目。 - 添加 Unity-Package 文件夹作为一个项目。 - 在Unity编辑器中打开这两个项目。这将产生必要的 .meta 文件夹。

5.️⃣ 生成元文件

使用脚本

打开Unity项目以生成 .meta 文件夹。 在Mac和Linux上:

./commands/open-all-projects-unix.sh

在Windows上:

./commands/open-all-projects-windows.ps1

或手动

您可以手动打开项目以获得相同的结果。

• 打开Unity Hub。
• 添加 Installer 文件夹作为一个项目。
• 添加 Unity-Package 文件夹作为一个项目。
• 在Unity编辑器中打开这两个项目。这将产生必要的 .meta 文件夹。

6.️⃣ 添加MCP工具

确定您需要哪种类型的MCP工具：

• Unity编辑器的MCP工具

- ✔️ 在Unity编辑器中工作（编辑模式） - ✔️ 在Unity编辑器中工作（播放模式） - ✔️ 有权访问编辑器API - ❌ 在游戏版本中可用

• Unity运行时的MCP工具

- ✔️ 在Unity编辑器中工作（编辑模式） - ✔️ 在Unity编辑器中工作（播放模式） - ❌ 有权访问编辑器API - ✔️ 在游戏版本中可用

根据您的选择，在指定位置创建脚本

• 编辑： Unity-Package/Assets/root/Editor
• 运行时间： Unity-Package/Assets/root/Runtime

阅读有关自定义工具开发的详细说明 这里.

[McpPluginToolType]
public static class MyCustomTool
{
    [McpPluginTool("my-custom-feature", Title = "Do my custom feature")]
    [Description("Put here the tool description for LLM.")]
    public static Task DoTurn(
        [Description("Add description to the input property, help LLM better understand it.)]
        int figureId,
        [Description("Add description to the input property, help LLM better understand it.)]
        Vector2Int position)
    {
        // do any logic in background thread here
        return MainThread.Instance.RunAsync(() =>
        {
            // do any logic in main thread here

            return true;
        });
    }
}

______________________________________________________________________

可选步骤

1.版本管理

要更新所有文件（package.json、Installer.cs等）的包版本，请使用bump version脚本：

.\commands\bump-version.ps1 -NewVersion "1.0.1"

2.设置CI/CD

要启用自动测试和部署：

1. 配置GitHub机密

首选 Settings > Secrets and variables > Actions > New repository secret 并添加：

- UNITY_EMAIL：您的Unity帐户电子邮件。 - UNITY_PASSWORD：您的Unity帐户密码。 - UNITY_LICENSE：您的内容 Unity_lic.ulf 文件。 - 窗户： C:/ProgramData/Unity/Unity_lic.ulf - 雨衣： /Library/Application Support/Unity/Unity_lic.ulf - Linux： ~/.local/share/unity3d/Unity/Unity_lic.ulf

1. 启用工作流

重命名示例工作流文件以启用它们：

- .github/workflows/release.yml-sample ➡️ .github/workflows/release.yml - .github/workflows/test_pull_request.yml-sample ➡️ .github/workflows/test_pull_request.yml

1. 更新Unity版本

打开两个 .yml 文件并更新 UNITY_VERSION （或类似变量）以匹配项目的Unity编辑器版本。

1. 自动部署

当您按下按钮时，发布工作流会自动触发 main 在中具有递增版本的分支 package.json.

3.将文件添加到 Unity-Package/Assets/root 文件夹

Unity指南 关于将文件组织到包根目录中

  
  ├── package.json
  ├── README.md
  ├── CHANGELOG.md
  ├── LICENSE.md
  ├── Third Party Notices.md
  ├── Editor
  │   ├── [company-name].[package-name].Editor.asmdef
  │   └── EditorExample.cs
  ├── Runtime
  │   ├── [company-name].[package-name].asmdef
  │   └── RuntimeExample.cs
  ├── Tests
  │   ├── Editor
  │   │   ├── [company-name].[package-name].Editor.Tests.asmdef
  │   │   └── EditorExampleTest.cs
  │   └── Runtime
  │        ├── [company-name].[package-name].Tests.asmdef
  │        └── RuntimeExampleTest.cs
  ├── Samples~
  │        ├── SampleFolder1
  │        ├── SampleFolder2
  │        └── ...
  └── Documentation~
       └── [package-name].md

最终润色

• 更新 README.md 包含您的包信息的文件（此文件）。
• 复制更新的 README.md 到 Assets/root 也。

⚠️ 外面的一切 root 文件夹不会添加到您的包中。但仍然可以用于在存储库中测试或展示您的包。

1.部署到您喜欢的任何注册表

• 部署到OpenUPM （推荐）

2.将您的软件包安装到Unity项目中

当您的软件包分发后，您可以将其安装到任何Unity项目中。

不要安装到同一个Unity项目中，请使用另一个。

• 安装OpenUPM命令行界面

• 在Unity项目的根目录（包含以下内容的文件夹）打开命令行 Assets)

• 执行命令（for OpenUPM 托管包）

  openupm add YOUR_PACKAGE_NAME

Unity包管理器中的最终视图