From 73f80a18f2209d18ee78112f11ff91217455c85c Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Tue, 6 Dec 2022 19:38:07 +0900 Subject: [PATCH 1/2] improve release template according to latest Unity --- docs/release_template.md | 90 ++++++++++++++++++++++++---------------- 1 file changed, 55 insertions(+), 35 deletions(-) diff --git a/docs/release_template.md b/docs/release_template.md index b898c5584..afb692516 100644 --- a/docs/release_template.md +++ b/docs/release_template.md @@ -1,52 +1,72 @@ -# Download +## Release Notes -* for `Unity-2020.3 LTS` or later +- [日本語](https://vrm-c.github.io/UniVRM/ja/release/100/v{version}.html) +- [English](https://vrm-c.github.io/UniVRM/en/release/100/v{version}.html) -* `for vrm-0.x` [UniVRM-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/UniVRM-{version_hash}.unitypackage) -* `for vrm-1.0` [VRM-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/VRM-{version_hash}.unitypackage) +## Installation -ReleaseNote -* [日本語](https://vrm-c.github.io/UniVRM/ja/release/100/v{version}.html) -* [English](https://vrm-c.github.io/UniVRM/en/release/100/v{version}.html) +The UniVRM supports Unity 2020.3 LTS or later. -## other unitypackage +You can install UniVRM using the UnityPackage or the UPM Package. -* `VRM-0.x API sample` [UniVRM_Samples-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/UniVRM_Samples-{version_hash}.unitypackage) -* `VRM-1.0 API sample` [VRM_Samples-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/VRM_Samples-{version_hash}.unitypackage) +### VRM 1.0 Import/Export -## 1.0 development (1.0 開発ドキュメント) +- via UnityPackage + - **Download [VRM-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/VRM-{version_hash}.unitypackage)** -- [日本語](https://vrm-c.github.io/UniVRM/ja/vrm1/index.html) -- [English](https://vrm-c.github.io/UniVRM/en/vrm1/index.html) +- via UPM Package + - `com.vrmc.vrmshaders` + - `com.vrmc.gltf` + - `com.vrmc.vrm` -# UPM +### VRM 0.x Import/Export -| UPM package | rename | UPM url | -|---------------------|------------------|------------------------------------------------------------------------| -| com.vrmc.vrmshaders | | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v{version} | -| com.vrmc.gltf | com.vrmc.unigltf | https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v{version} | -| com.vrmc.univrm | | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v{version} | -| com.vrmc.vrm | com.vrmc.univrm1 | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v{version} | +- via UnityPackage + - **Download [UniVRM-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/UniVRM-{version_hash}.unitypackage)** -```json -// manifest.json -{{ - "dependencies": {{ - /// +- via UPM Package + - `com.vrmc.vrmshaders` + - `com.vrmc.gltf` + - `com.vrmc.univrm` + +### UPM Package Information +You can install these UPM packages via `Package Manager` -> `+` -> `Add package from git URL...` in UnityEditor. + +| UPM package | git URL | +| :------------------ | :--------------------------------------------------------------------- | +| com.vrmc.vrmshaders | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v{version} | +| com.vrmc.gltf | https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v{version} | +| com.vrmc.univrm | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v{version} | +| com.vrmc.vrm | https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v{version} | + +You can also install via editing `Packages/manifest.json` directly. + +```json5 +// Packages/manifest.json +{ + "dependencies": { + // ... "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v{version}", "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v{version}", "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v{version}", "com.vrmc.vrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v{version}", - /// - }} -}} + // ... + } +} ``` -# UPM packages and folders and unitypackage +## Development +### Samples +- via UnityPackage + - VRM 1.0 Development Samples + - [VRM_Samples-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/VRM_Samples-{version_hash}.unitypackage) + - VRM 0.x Development Samples + - [UniVRM_Samples-{version_hash}.unitypackage](https://github.com/vrm-c/UniVRM/releases/download/v{version}/UniVRM_Samples-{version_hash}.unitypackage) +- via UPM Package + - You can find `Samples` in the Package Manager and then submit `Import` button. + - `Window` -> `Package Manager` -> `Packages: In Project` -> `VRM-1.0` or `VRM` -| UPM package | folder | unitypackage | note | -|---------------------|------------------|------------------------------------------------------------------------|-| -| com.vrmc.vrmshaders | Assets/VRMShaders | UniVRM-XXX, VRM-XXX | 0.x and 1.0 shared | -| com.vrmc.gltf | Assets/UniGLTF | UniVRM-XXX, VRM-XXX | 0.x and 1.0 shared | -| com.vrmc.univrm | Assets/VRM | UniVRM-XXX | import/export 0.x | -| com.vrmc.vrm | Assets/VRM10 | VRM-XXX | import/export 1.0 and import 0.x | +### Documentation + +- [日本語](https://vrm-c.github.io/UniVRM/ja/vrm1/index.html) +- [English](https://vrm-c.github.io/UniVRM/en/vrm1/index.html) From 345bb59346056a593cf3273e36af7073fd02b59a Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Tue, 6 Dec 2022 19:41:15 +0900 Subject: [PATCH 2/2] fix --- docs/release_template.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release_template.md b/docs/release_template.md index afb692516..8325fcf92 100644 --- a/docs/release_template.md +++ b/docs/release_template.md @@ -30,7 +30,9 @@ You can install UniVRM using the UnityPackage or the UPM Package. - `com.vrmc.univrm` ### UPM Package Information -You can install these UPM packages via `Package Manager` -> `+` -> `Add package from git URL...` in UnityEditor. +You can install these UPM packages via Package Manager in UnityEditor. + +- `Window` -> `Package Manager` -> `+` -> `Add package from git URL...` | UPM package | git URL | | :------------------ | :--------------------------------------------------------------------- |