From 05278983079ada325cf194afffdfa8b6dd2ea40c Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Sun, 6 Nov 2022 17:21:28 +0900 Subject: [PATCH 1/4] Enhance README.md --- README.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 75 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ce0536d68..c495e4244 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,86 @@ # UniVRM -UniVRM is `unity package` for Import and Export [VRM Format](https://vrm.dev/vrm_about/) +![GitHub latest release](https://img.shields.io/github/v/release/vrm-c/UniVRM?color=green) +![GitHub license](https://img.shields.io/github/license/vrm-c/UniVRM) -## Download +The standard implementation of 3D Avatar file format [VRM](https://vrm-consortium.org/en/) for [Unity](https://unity.com/). -* https://github.com/vrm-c/UniVRM/releases +UniVRM supports import and export the VRM file at both runtime and editor. +VRM is an extension of [glTF 2.0](https://www.khronos.org/gltf/), so this library also support the glTF file. -## Manual +## Features -* https://vrm.dev/docs/univrm/ +UniVRM supports the [VRM 1.0 specification](https://github.com/vrm-c/vrm-specification) and the [glTF 2.0 specification](https://registry.khronos.org/glTF/). -## API Document +UniVRM can import/export following supported file types at both runtime and editor. -* https://vrm-c.github.io/UniVRM/ +### Supported file types +- VRM 1.0 (.vrm) +- VRM 0.x (.vrm) +- glTF 2.0 (.glb | .gltf | .zip) + +### Import features +- You can import supported file types at both runtime and editor. +- Support for async/await importing at runtime. +- Support for Migration VRM 0.x files into VRM 1.0 files. +- Support for ScriptedImporter for VRM 1.0 and glTF 2.0. +- You can import glTF's PBR materials into Unity Built-in RP's Standard materials. + +### Export features +- You can export supported file types at both runtime and editor. +- You can export Unity Built-in RP's Standard materials into glTF's PBR materials. + +## Requirements + +The latest UniVRM supports Unity 2020.3 LTS or later. + +## Installation + +![GitHub latest release](https://img.shields.io/github/v/release/vrm-c/UniVRM?color=green) + +You can install UniVRM using the UnityPackager or UPM Package. + +### UnityPackage + +From the [latest release](https://github.com/vrm-c/UniVRM/releases/latest), you can download the `.unitypackage` files. + +- For handling VRM 1.0 + - You can download **VRM-0.XXX.X-YYYY.unitypackage**. + - You can also download sample projects as **VRM_Samples-0.XXX.X-YYYY.unitypackage**. +- For handling VRM 0.x + - You can download **UniVRM-0.XXX.X-YYYY.unitypackage**. + - You can also download sample projects as **UniVRM_Samples-0.XXX.X-YYYY.unitypackage**. +- For handling glTF 2.0 + - You can download **VRM-0.XXX.X-YYYY.unitypackage**. + +### UPM Package + +From the [latest release](https://github.com/vrm-c/UniVRM/releases/latest), you can find UPM package urls. + +- For import/export VRM 1.0 + - You have to install all of the following UPM packages. + - `com.vrmc.vrmshaders` + - `com.vrmc.gltf` + - `com.vrmc.vrm` +- For import/export VRM 0.x + - You have to install all of the following UPM packages. + - `com.vrmc.vrmshaders` + - `com.vrmc.gltf` + - `com.vrmc.univrm` +- For import/export glTF 2.0 + - You have to install all of the following UPM packages. + - `com.vrmc.vrmshaders` + - `com.vrmc.gltf` + +You can install these UPM packages via `Package Manager` -> `+` -> `Add package from git URL...` in UnityEditor. + +## Documentation + +- https://vrm.dev/en/vrm/index.html + +### For developers + +- https://vrm-c.github.io/UniVRM/en/ ## License From fcaaf03572f65660de62de4303a141dc50819c73 Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Sun, 6 Nov 2022 17:29:48 +0900 Subject: [PATCH 2/4] fix --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c495e4244..9f68a20dc 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@ The standard implementation of 3D Avatar file format [VRM](https://vrm-consortium.org/en/) for [Unity](https://unity.com/). -UniVRM supports import and export the VRM file at both runtime and editor. -VRM is an extension of [glTF 2.0](https://www.khronos.org/gltf/), so this library also support the glTF file. +VRM is an extension of [glTF 2.0](https://www.khronos.org/gltf/), so this library also support glTF 2.0 files. ## Features @@ -44,13 +43,13 @@ You can install UniVRM using the UnityPackager or UPM Package. From the [latest release](https://github.com/vrm-c/UniVRM/releases/latest), you can download the `.unitypackage` files. -- For handling VRM 1.0 +- For import/export VRM 1.0 - You can download **VRM-0.XXX.X-YYYY.unitypackage**. - You can also download sample projects as **VRM_Samples-0.XXX.X-YYYY.unitypackage**. -- For handling VRM 0.x +- For import/export VRM 0.x - You can download **UniVRM-0.XXX.X-YYYY.unitypackage**. - You can also download sample projects as **UniVRM_Samples-0.XXX.X-YYYY.unitypackage**. -- For handling glTF 2.0 +- For import/export glTF 2.0 - You can download **VRM-0.XXX.X-YYYY.unitypackage**. ### UPM Package From b3d3b4f0dbe841d9194e057b343f859c3a8d7bbd Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Sun, 6 Nov 2022 20:35:48 +0900 Subject: [PATCH 3/4] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f68a20dc..37f29aa6a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The latest UniVRM supports Unity 2020.3 LTS or later. ![GitHub latest release](https://img.shields.io/github/v/release/vrm-c/UniVRM?color=green) -You can install UniVRM using the UnityPackager or UPM Package. +You can install UniVRM using the UnityPackage or the UPM Package. ### UnityPackage From a57374d24de08996288b2ecf9d67e26804454929 Mon Sep 17 00:00:00 2001 From: Masataka SUMI Date: Sun, 6 Nov 2022 20:49:37 +0900 Subject: [PATCH 4/4] add description about supported environments. --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37f29aa6a..a2607b881 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,21 @@ UniVRM can import/export following supported file types at both runtime and edit - You can export supported file types at both runtime and editor. - You can export Unity Built-in RP's Standard materials into glTF's PBR materials. -## Requirements +## Supported Environments The latest UniVRM supports Unity 2020.3 LTS or later. +UniVRM supports scripting backends both .NET and IL2CPP. + +UniVRM supports the following building target platforms: + +- Standalone (Windows/Mac/Linux) +- iOS +- Android +- WebGL + +The other platforms maybe work but they are not tested. + ## Installation ![GitHub latest release](https://img.shields.io/github/v/release/vrm-c/UniVRM?color=green) @@ -57,17 +68,17 @@ From the [latest release](https://github.com/vrm-c/UniVRM/releases/latest), you From the [latest release](https://github.com/vrm-c/UniVRM/releases/latest), you can find UPM package urls. - For import/export VRM 1.0 - - You have to install all of the following UPM packages. + - You have to install all of the following UPM packages: - `com.vrmc.vrmshaders` - `com.vrmc.gltf` - `com.vrmc.vrm` - For import/export VRM 0.x - - You have to install all of the following UPM packages. + - You have to install all of the following UPM packages: - `com.vrmc.vrmshaders` - `com.vrmc.gltf` - `com.vrmc.univrm` - For import/export glTF 2.0 - - You have to install all of the following UPM packages. + - You have to install all of the following UPM packages: - `com.vrmc.vrmshaders` - `com.vrmc.gltf`