Merge pull request #1951 from Santarh/releaseNoteFix

improve release template according to latest Unity
This commit is contained in:
ousttrue 2022-12-13 12:40:26 +09:00 committed by GitHub
commit 02ebca8ec7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,52 +1,74 @@
# 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 in UnityEditor.
- `Window` -> `Package Manager` -> `+` -> `Add package from git URL...`
| 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)