UPM Creator

一个用于创建 Unity Package Manager（UPM）包的 CLI 工具，支持交互式向导和命令行参数。

English README

功能特点

• 交互模式：通过向导一步步创建 UPM 包
• 命令行模式：通过参数直接生成包
• 混合模式：命令行参数与交互式输入结合使用
• 生成符合 UPM 规范的目录结构
• 支持自定义模板
• 自动生成常见包文件，如 package.json、README.md、LICENSE
• 创建一个空的 Samples~ 目录，方便后续按需添加示例内容

生成时使用的模板统一放在 src/templates，构建时会复制到 dist/templates。

安装

npm install -g @xionghanli/upm-creator

或者直接使用 npx：

npx @xionghanli/upm-creator

使用方式

交互模式

不带参数运行命令即可进入交互式向导：

npx @xionghanli/upm-creator

命令行模式

通过完整参数直接创建包：

npx @xionghanli/upm-creator \
  --name=com.example.awesome-package \
  --pkg-version=1.0.0 \
  --displayName="Awesome Package" \
  --description="An awesome Unity package" \
  --author="John Doe <[email protected]>" \
  --license=MIT \
  --unity=2022.3 \
  --output=./Packages

混合模式

先提供一部分参数，其余内容由向导补全：

npx @xionghanli/upm-creator --name=com.example.package

命令行选项

| 选项 | 说明 | 默认值 | |------|------|--------| | --name | 包名，例如 com.company.product | - | | --pkg-version | 包版本 | 1.0.0 | | --displayName | Unity 中显示的名称 | - | | --description | 包描述 | - | | --author | 作者信息 | - | | --license | 许可证类型 | MIT | | --unity | Unity 版本要求 | 2022.3 | | --output | 输出目录 | ./Packages |

生成目录结构

工具会生成符合 UPM 规范的目录结构：

Packages/[PackageName]/
├── package.json          # 包清单
├── README.md             # 文档
├── LICENSE               # 许可证
├── CHANGELOG.md          # 版本记录
├── Editor/               # Unity Editor 脚本
│   └── [PackageName].Editor.asmdef
├── Runtime/              # 运行时代码
│   └── [PackageName].asmdef
└── Samples~              # 空目录，可按需放置示例内容

开发

# 安装依赖
npm install

# 构建项目
npm run build

# 以开发模式运行
npm run dev

# 测试构建后的 CLI
npm start

License

MIT

Contributing

欢迎提交 Issue 和 Pull Request。