UPM Git 扩展
本包专门为从 git 仓库安装的包增强了 Unity 包管理器(UPM)的用户界面(UI)。
<< 📝 描述 | ⚙ 安装 | 🚀 使用方法 | 🛠 开发说明 | 🤝 贡献 >>
📝 描述
在 Unity 2018.3 中,Unity 包管理器(UPM)引入了 Git 支持,为从 GitHub 等代码托管服务安装包提供了便捷方式。然而,发现了一些限制和不足之处,包括:
- 文档链接(readme、changelog、license)不正确
- 缺少直接链接到仓库 URL
- 通过 UI 添加、更新和移除包的功能有限
本项目通过扩展使用 Git 安装的包的 Unity 包管理器 UI 来解决这些问题。
特性
- 直接链接到 Git 仓库 URL
- 离线文档链接,包括:
- 文档
- 更新日志
- 许可证
- 支持多种 Git 托管平台,如 GitHub、GitLab、Bitbucket、Azure DevOps 等
- 使用 UI 从 Git 仓库 URL 安装包
- 使用特定标签/分支更新包
- 移除包
- 兼容 Unity 2018.3 或更高版本
- 支持
.Net 3.5
、.Net 4.x
和.Net Standard 2.0
- 版本筛选
- 支持路径查询参数(适用于 Unity 2019.3.4f 或更高版本)
- (2.0.0 版本)Git 仓库被缓存,已安装/搜索的包自动索引:
- 缓存的仓库在不同项目间共享
- 缓存的仓库 URL 在安装窗口中显示为历史记录
- 索引的包显示在"我的注册表"中
- (2.0.0 版本)额外的菜单选项,用于使用代码编辑器打开
manifest.json
、打开缓存目录、清除缓存和获取包:
⚙ 安装
本包要求如下:
- v1.x: Unity 2018.3 至 2019.4
- v2.x: Unity 2020.1 或更高版本
通过 OpenUPM 安装
本包可在 OpenUPM 包注册表中获得。 这是推荐的安装方法,因为您可以轻松接收发布的更新。
如果您已安装 openupm-cli,则在项目目录中运行以下命令:
# 适用于 Unity 2020 或更高版本
openupm add com.coffee.upm-git-extension
# 适用于 Unity 2018 或 2019
openupm add com.coffee.upm-git-extension@v1
通过 UPM 安装(使用 Git URL)
导航到项目的 Packages 文件夹并打开 manifest.json
文件。然后在 dependencies
块中添加此包:
{
"dependencies": {
// 适用于 Unity 2020 或更高版本
"com.coffee.upm-git-extension": "https://github.com/mob-sakai/UpmGitExtension.git",
// 适用于 Unity 2018 或 2019
"com.coffee.upm-git-extension": "https://github.com/mob-sakai/UpmGitExtension.git#v1",
...
},
}
要更新包,将后缀 #{version}
更改为目标版本。
- 例如
"com.coffee.upm-git-extension": "https://github.com/mob-sakai/UpmGitExtension.git#2.1.0",
🚀 使用方法
从 Git 仓库安装包
在包管理器UI中点击 按钮以打开"安装包窗口"。
-
输入Git仓库URL并点击"查找版本"按钮。在Unity 2019.3.4或更高版本中,您可以指定子目录。
-
选择一个标签或分支,然后点击"查找包"按钮。
-
等待几秒钟进行验证。
-
点击"安装包"按钮以安装该包。
使用特定标签或分支作为版本更新包
您可以像处理官方包一样更新或移除项目中的包。
🛠 开发说明
为UPM开发包
请参阅 https://www.patreon.com/posts/25070968, https://www.jianshu.com/u/275cca6e5f17 (中文)
🤝 贡献
问题
问题对本项目非常有价值:
- 想法为他人提供了宝贵的贡献来源。
- 问题有助于识别需要改进的领域。
- 问题表明贡献者可以在哪些方面改善用户体验。
拉取请求
拉取请求是向这个仓库贡献您想法的绝佳方式。 请参阅 CONTRIBUTING.md 和 develop 分支 了解指南。
支持
这是一个在我空闲时间开发的开源项目。 如果您觉得它有价值,请考虑支持我。 您的支持让我能够投入更多时间进行开发。😊
许可证
- MIT
作者
另请参阅
- GitHub页面:https://github.com/mob-sakai/UpmGitExtension
- 发布:https://github.com/mob-sakai/UpmGitExtension/releases
- 问题追踪器:https://github.com/mob-sakai/UpmGitExtension/issues
- 当前项目:https://github.com/mob-sakai/UpmGitExtension/projects/1
- 更新日志:https://github.com/mob-sakai/UpmGitExtension/blob/main/CHANGELOG.md