Unity 功能 之 创建 【Unity Package】 Manager 自定义管理的包使用配置URL,使用 git URL加载的简单整理
目录
Unity 功能 之 创建 【Unity Package】 Manager 自定义管理的包使用配置URL,使用 git URL加载的简单整理
一、简单介绍
二、Unity Package 的目录结构
三、上传 Package 工程到 Git
四、Unity 上 git URL 加载 Package
附录
一、添加标签tag 或者分支 branch 管理版本
二、git URL 加载指定版本的方法罗列
一、简单介绍
Unity Package 是一种模块化的资源管理和分发方式,用于将游戏开发所需的代码、资源、配置文件等内容打包成一个独立的、可重用的组件。Unity Package 可以在多个项目之间共享,从而简化了项目的管理和维护。
为什么要使用 Unity Package
- 模块化管理: 将功能、资源和代码模块化,便于维护和更新。
- 复用性: 同一个包可以在多个项目中使用,避免重复劳动,提高开发效率。
- 版本控制: 可以对包进行版本管理,确保项目中使用的包是稳定和可控的。
- 团队协作: 团队成员可以共享和分发自己的包,促进协同开发。
- 依赖管理: Unity Package Manager 可以自动处理包之间的依赖关系,简化项目配置。
Unity Package 官网:Unity - Manual: Creating custom packages
Unity Package 使用 Git URL 添加是一种在 Unity 项目中集成自定义或第三方库的方法,通过 Git 仓库的 URL 来引用包。Unity Package Manager (UPM) 允许开发者直接从 Git 仓库拉取包,而不需要通过 Unity Asset Store。这种方式提供了更大的灵活性和控制权,允许开发者使用最新的代码或者特定版本的代码。
以下是使用 Git URL 添加 Unity Package 的基本步骤:
打开 Unity 编辑器:启动你的 Unity 项目。
访问 Package Manager:在 Unity 编辑器的顶部菜单栏中,选择 "Window" > "Package Manager"。
添加 Git URL:在 Package Manager 窗口中,点击窗口左上角的 "+" 按钮,然后选择 "Add package from git URL..." 选项。
输入 Git URL:在弹出的对话框中,输入你的 Git 仓库 URL。例如:
https://xxx-package-git-url.git
如果你想要特定的分支或者标签,可以在 URL 后面添加
#branchname
或#tagname
。例如,要获取标签为v1.0.0
的版本,URL 将是:https://gitee.com/XANone/test-unity-package-git-url.git#v1.0.0
确认添加:点击 "Add" 按钮,Unity 将开始从指定的 Git URL 克隆代码到你的项目中。
等待同步完成:Unity 将自动下载并同步包的内容到你的项目中。这可能需要一些时间,取决于包的大小和网络速度。
使用包:添加完成后,你可以在项目中使用这个包,就像使用 Unity 内置的或其他通过 UPM 安装的包一样。
使用 Git URL 添加 Unity Package 的好处包括:
- 灵活性:能够直接从源代码管理工具获取最新的代码。
- 版本控制:可以指定特定的分支或标签,确保使用的是正确的版本。
- 自定义:适合使用自定义开发或第三方库,特别是那些不在 Unity Asset Store 上的。
- 社区贡献:方便地集成社区贡献的代码或工具。
请注意,使用 Git URL 添加的包需要在其目录中包含一个
package.json
文件,该文件定义了包的元数据,如名称、版本、描述和依赖关系。Unity 通过这个文件来识别和管理包。
二、Unity Package 的目录结构
Package 目录结构说明官网地址:Unity - Manual: Package layout
Packages/
com.example.mypackage/ # 包的根目录
package.json # 包的配置文件,包含包的元数据和依赖项
README.md # 包的说明文档,提供使用说明和其他信息
CHANGELOG.md # 包的变更日志,记录包的每个版本的更改内容
LICENSE.md # 包的许可证文件,声明包的开源许可证
Editor/ # 包含编辑器扩展脚本和资源
MyEditorScript.cs # 示例编辑器脚本
Runtime/ # 包含运行时脚本和资源
MyScript.cs # 示例运行时脚本
Tests/ # 包含测试脚本和测试资源
Editor/ # 编辑器测试脚本
MyEditorTests.cs # 示例编辑器测试脚本
Runtime/ # 运行时测试脚本
MyRuntimeTests.cs # 示例运行时测试脚本
Documentation~ # 包的文档目录,波浪号表示该目录不会被导入到项目中
index.md # 包的主文档文件
Samples~ # 包的示例目录,波浪号表示该目录不会被导入到项目中
ExampleSample/ # 示例的具体目录
SampleScene.unity # 示例场景文件
SampleScript.cs # 示例脚本文件
这里会沿用之前创建自定义UnityPackage 的博文案例来进行。
博文地址:
Unity 功能 之 创建 【Unity Package】 Manager 自己自定义管理的包的简单整理_unitypackage-CSDN博客
三、上传 Package 工程到 Git
这里使用 Gitee 进行代码仓库,使用 GitHub、GitLab 或者其他也可以
1、创建一个仓库
2、找到 Package 工程
(这里使用之前创建的工程)
3、git 初始化
命令:git init
4、把代码文件添加准备提交
命令:git add .
5、进行提交说明
命令:git commit -m "[add]添加 package 工程代码文件"
6、绑定远程仓库地址
命令: git remote add origin https://xxxx-git-url.git
7、把代码推到远程仓库
命令:git push -u origin "master"
8、远程仓库已经有了当前仓库的文件代码
四、Unity 上 git URL 加载 Package
1、打开 Unity ,点击菜单栏 Window - Package Manager
2、点击左上角 + ,选择 Add package from git URL
3、拷贝你的 git URL
4、 粘贴后,Add 进行加载
5、不久之后,加载成功
6、调整更新一下文件,版本 1.0.0 改为 1.0.1
7、添加提交修改到仓库
8、在 Packagemanager 点击 update 更新
9、之后就自动更新为 1.0.1版本了
附录
一、添加标签tag 或者分支 branch 管理版本
1、gitk 打开如下界面,然后使用标签tag 管理版本,创建 tag ,分支同理
2、关闭 gitk,查看 tag ,并推送到远程仓库
命令:git tag 和 git push --tag 或者 git push origin :<tagname>
3、远程仓库查看标签 tag
4、加载 v1.0.0 版本
url 格式类似为:https://gitee.com/XXXXX-unity-package-used-git-url.git#v1.0.0
5、不久版本,就更新为 1.0.0 版本了
二、git URL 加载指定版本的方法罗列
1、使用分支引用:
引用特定分支的代码,例如:
https://github.com/yourusername/yourpackage.git#branchname
2、使用标签引用:
引用特定标签的代码,通常是发布版本:
https://github.com/yourusername/yourpackage.git#tagname
3、使用提交哈希:
引用特定提交的代码 ,用于精确到特定更改:
https://github.com/yourusername/yourpackage.git#commithash
4、使用子目录(如果仓库包含多个包):
引用仓库中特定子目录的代码:
https://github.com/yourusername/yourrepository.git#branchname?path=subdirectory