示例就是一个可交互的手册,为插件配示例既贴心又显得专业,在本文,笔者就简述下怎么为UPM管理的插件配置示例。
前言
在UPM使用中,我们发现 UPM 导入的非 local 包文件都是只读的,于是我们好像无处安放自己做的UPM插件包的示例哎。
随着Unity 的迭代更新,现在UPM 也逐步完善了配置示例的工作流。
下面进入正题,图文教大家如何使用新版UPM 为自己的插件管理 Example (示例)。
实现
-
在插件目录根节点创建文件夹并命名为: Example~
文件夹的波浪号后缀绝对是强迫症一剂良药 -
把示例放在 Example~
为减少编译时间示例中也请配置好 Assembly Definition 文件 -
在插件包描述文件中插入如下 example 信息:
displayName值会被 Unity 抓取用于创建文件夹
PS:看到配置文件的中括号,你是不是想到了数组?没错,在这儿可以配置 N 多个示例的哦! 按【教程】开发Unity PackageManager 插件包 - 简书 中的流程发布这个带示例的插件包。
-
使用 git 链接的方式在UPM中下载插件,在插件详情页就能看到示例了:
-
点击导入,剩下的就交给 Unity,它会贴心的把示例放在 插件名/版本号/displayName 的路径下:
PS:笔者本文中使用的Unity版本是
2020.2.1f1c1
总结
- 模块化/组件式/插件式开发一直是提高开发效率、减少开发成本的有效途径,UPM 带来的功能模块管理便利值得开发人员重视。
- 配置示例,很好的减低了随着模块的增加,遗忘,新人等状况带来的学习成本,保持一贯的开箱即食,方便回味。
- 本文知识点是笔者在使用他人插件时学的乖哈,权当笔记分享给感兴趣的朋友。
2024年7月1日更新
我发现在插件开发阶段,每次修改了工程中从 Smples导入的示例,都需要把它同步拷贝到 Example~ 文件夹中,这极为不方便,其实,在开发阶段,你可以不用为 Examples 文件夹加 波浪号,这样就可以直接编辑示例啦!
此时你会问,这样示例就不会以按钮的形式出现在 UPM 插件详情面板上了!确实是这样,但是....,Unity会在你发布 UPM 为 .gz 插件包的时候,自动在 Examples 文件夹后面加上波浪号,同时更新 package.json。
这样一来,用户导入你发布的 .gz 插件包后 UPM 插件详情面板上就会出现示例导入的按钮了。