updated README

This commit is contained in:
pochang007
2021-04-07 17:39:15 +09:00
parent 987d60d3a0
commit be4f497f62
2 changed files with 57 additions and 17 deletions

View File

@@ -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` を任意のバージョンに読み替えてください。
```

View File

@@ -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
"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.
https://vrm.dev/en/docs/univrm/install/
## [UniVRM](https://github.com/vrm-c/UniVRM)
### Stable Version
"UniVRM" is a Unity implementation of VRM. It can create, import and export VRM models.
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:
* Currently UniVRM supports `Unity-2018.4LTS+` `.Net4.x`
* Recommended version is `Unity-2019.4LTS`
<img width=400 src=./right_latest.jpg>
## Download
1. Download ``UniVRM-0.xx.unitypackage``
1. Import ``UniVRM-0.xx.unitypackage`` into the Unity project
### 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",
// ...
}