From be4f497f625325cfa73b391c31f32836b003c6df Mon Sep 17 00:00:00 2001 From: pochang007 Date: Wed, 7 Apr 2021 17:39:15 +0900 Subject: [PATCH 1/2] updated README --- README.ja.md | 4 ++- README.md | 70 ++++++++++++++++++++++++++++++++++++++++------------ 2 files changed, 57 insertions(+), 17 deletions(-) diff --git a/README.ja.md b/README.ja.md index 750e4ec744..79073d12ad 100644 --- a/README.ja.md +++ b/README.ja.md @@ -32,7 +32,7 @@ glTF2.0をベースとしており、誰でも自由に利用することがで * [MIT License](./LICENSE.txt) -## Install +## Installation https://vrm.dev/docs/univrm/install/ ### 安定版 @@ -75,6 +75,8 @@ $ git submodule update --init --recursive ## UPM +https://vrm.dev/docs/univrm/install/univrm_upm/ + `v0.66.0` を任意のバージョンに読み替えてください。 ``` diff --git a/README.md b/README.md index 367751c4d3..1e71806bcc 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,58 @@ -# UniVRM * [日本語](README.ja.md) +# UniVRM + +https://github.com/vrm-c/UniVRM + +`UniVRM` is a Unity implementation of [VRM](https://vrm.dev/vrm_about/). It can import/export VRM models. + +* [Unity Version](https://vrm.dev/en/docs/univrm/install/unity_version/) +* [UniVRM Version](https://vrm.dev/en/docs/univrm/install/univrm_version/) +* [UniVRM Manual](https://vrm.dev/en/docs/univrm/) + +`VRM` is a file format for using 3d humanoid avatars (3D models) in VR applications. +It is based on glTF2.0. Anyone is free to use it. + +The imported VRM model has the following Data: + +* [Humanoid](https://vrm.dev/en/docs/univrm/humanoid/) +* [Meta](https://vrm.dev/en/docs/univrm/meta/) +* [Material](https://vrm.dev/en/docs/univrm/shaders/) +* [Expression](https://vrm.dev/en/docs/univrm/blendshape/) +* [Eyelook](https://vrm.dev/en/docs/univrm/lookat/) +* [Spring Bone](https://vrm.dev/en/docs/univrm/springbone/) +* [First Person](https://vrm.dev/en/docs/univrm/firstperson/) + ## License * [MIT License](./LICENSE.txt) -## [VRM](https://vrm.dev/en) +## Installation + +https://vrm.dev/en/docs/univrm/install/ -"VRM" is a file format for using 3d humanoid avatars (and models) in VR applications. -VRM is based on glTF2.0. If you comply with the MIT license, you are free to use it. +### Stable Version -## [UniVRM](https://github.com/vrm-c/UniVRM) +Versions without bug fixes will be picked up as stable versions. +To download the stable version, click the release tag (marked as `Latest`) as shown in the image below: -"UniVRM" is a Unity implementation of VRM. It can create, import and export VRM models. + -* Currently UniVRM supports `Unity-2018.4LTS+` `.Net4.x` -* Recommended version is `Unity-2019.4LTS` +1. Download ``UniVRM-0.xx.unitypackage`` +1. Import ``UniVRM-0.xx.unitypackage`` into the Unity project -## Download +### Latest Version + +The latest version is marked as `Pre-release`: 1. Go to the [releases page](https://github.com/vrm-c/UniVRM/releases) 1. Download the latest ``UniVRM-0.xx.unitypackage`` -1. Import the downloaded package into the Unity project. - 1. See also [UniVRM installation](https://vrm.dev/en/univrm/univrm_install/) - +1. Import ``UniVRM-0.xx.unitypackage`` into the Unity project + ## Script Samples +* [Programming](https://vrm.dev/en/docs/univrm/programming/) * [UniVRM Samples](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM.Samples) * [UniVRMTest](https://github.com/vrm-c/UniVRMTest) @@ -37,13 +63,25 @@ Use the commands below to clone UniVRM repository, and open the UniVRM folder by ```console $ git clone https://github.com/vrm-c/UniVRM.git $ cd UniVRM +# Update submodules such as MToon, etc. $ git submodule update --init --recursive ``` See [contributing guidelines](https://github.com/vrm-c/UniVRM/wiki/Contributing-Guidelines). -## Documents +## UPM -* https://vrm.dev/ -* https://vrm.dev/en/ -* https://github.com/vrm-c/UniVRM/wiki +https://vrm.dev/en/docs/univrm/install/univrm_upm/ + +Copy and paste the following git urls in `Packages/manifest.json` for UniVRM installation. +To upgrade/downgrade UniVRM version, for example, replace `v0.66.0` with `v0.71.0` or `v0.63.2`. + +``` +{ + "dependencies": { + // ... + "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.66.0", + "com.vrmc.unigltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.66.0", + "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.66.0", + // ... +} From 5001ed5c91b0740d5155b580642a22572e80d229 Mon Sep 17 00:00:00 2001 From: pochang007 Date: Wed, 7 Apr 2021 17:45:48 +0900 Subject: [PATCH 2/2] updated link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e71806bcc..5fa3e3427f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ https://github.com/vrm-c/UniVRM -`UniVRM` is a Unity implementation of [VRM](https://vrm.dev/vrm_about/). It can import/export VRM models. +`UniVRM` is a Unity implementation of [VRM](https://vrm.dev/en/vrm_about/). It can import/export VRM models. * [Unity Version](https://vrm.dev/en/docs/univrm/install/unity_version/) * [UniVRM Version](https://vrm.dev/en/docs/univrm/install/univrm_version/)