发布自定义UnityPackage到代码托管平台

Everyglow丶

于 2024-06-11 00:16:05 发布

阅读量971

点赞数 10

文章标签： unity 游戏引擎

本文链接：https://blog.csdn.net/qq_45723821/article/details/139584722

版权

背景

笔者正筹划搭建自己的游戏框架，并希望基于Github和Gitee这类代码托管平台维护和迭代，实现在开发新游戏时快速移植。本文记录笔者将代码发布到Gitee上的过程。

制定规范

一个标准UnityPackage的内部结构大致如下：

.
├── CHANGELOG.md
├── README.md
├── LICENSE.md
├── Code
└── package.json

README用来介绍Package的功能和用法；CHANGELOG用来记录Package所有历史版本功能修改、新增和维护日志；README和CHANGELOG不是必须的，但它们可以作为辅助文档帮助使用者更好的理解和使用该Package；而且维护README和CHANGELOG更新可以督促我们养成良好的开发习惯。
LICENSE是开源许可，如果你对你的代码版权不是很重视的话，这也是非必需的；你也可以使用最宽松的MIT开源许可。
Code是Package中实现功能的代码部分了，这一部分的细节会在实践章节中阐述。
package.json是Package中最重要的文件，它记录了Package的版本、url等各种能够标识该Package的信息，模板可以参考npm官方文档，笔者在实践章节也会给出自己使用到的模版中的字段。

实践

首先创建好本地项目和远端的仓库，在Asset下创建一个文件夹作为Package的根路径，依次创建好：README、CHANGELOG、LICENSE和package.json文件。

编写package.json信息

{
"name": "com.eddielee.candle-gameframework",
"displayName": "Candle Game Framework",
"description": "This is a game framework",
"version": "0.2.2",
"repository": {
  "type": "git",
  "url": "git+https://gitee.com/SoIncredible/candle-game-framework.git"
},
"author": {
  "name": "eddie-lee",
  "email": "2636060652@qq.com",
  "url": "https://soincredible777.com.cn"
},
"dependencies": {}
}

编写Package代码
如果我们不做任何操作，我们编写的代码会被归属到名为Assembly-CSharp的程序集中，你可以在Unity项目的根目录下看到这个文件。为了让Package的代码独属于一个程序集，我们要划分程序集。虽然这一步是非必需的，但是有意识的划分程序集能够加快你的编译速度和代码结构的清晰度，使整个项目更易于管理和维护。
在本文示例中，笔者在Package根目录下创建Editor和Runtime两个子目录包含在Editor和Runtime下运行的代码，然后在这两个目录下执行Assets -> Create -> Assembly Definition, 创建asmdef文件。注意程序集文件的名字和编译后程序集名字和该是没有关系的，程序集的命名由Inspector窗口中的Name字段决定。另外在Inspector窗口中，Runtime目录下的程序集要在Platforms部分勾所有平台都使用，而Editor目录下的程序集勾选只在Editor环境下使用。

编写好代码之后我们就可以将我们的代码上传了。按顺序输入以下指令

git subtree split --prefix=Assets/yourPackageName --branch upm

git tag 1.0.0 upm

git push origin upm --tags

完成以上操作我们就完成了UnityPackage的发布。

安装我们的Package

打开Packages下面的manifest.json文件，在"dependencies"中输入我们的包名和Git仓库的地址，注意，从浏览器上复制的Git仓库地址是不带.git的，如果不带.git Unity会提示你找不到这个仓库，同时我们还需要添加#1.0.0这样的数字在末尾来安装指定版本的Package版本

开发后续版本的时候，记得更新ChangeLog、Readme还有package.json中的信息。