From 44cc51bf797f7ad73577f3d40979121d7b7cc31a Mon Sep 17 00:00:00 2001 From: ousttrue Date: Wed, 8 Sep 2021 20:38:59 +0900 Subject: [PATCH] =?UTF-8?q?README=20=E3=81=AB=E3=81=84=E3=81=A3=E3=81=B1?= =?UTF-8?q?=E3=81=84=E6=9B=B8=E3=81=84=E3=81=A6=E3=81=82=E3=81=A3=E3=81=A6?= =?UTF-8?q?=E3=82=82=E3=82=8F=E3=81=8B=E3=82=8A=E3=81=AB=E3=81=8F=E3=81=84?= =?UTF-8?q?=E3=81=AE=E3=81=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.ja.md | 68 ---------------------------------------------------- README.md | 66 +++++++------------------------------------------- 2 files changed, 8 insertions(+), 126 deletions(-) delete mode 100644 README.ja.md diff --git a/README.ja.md b/README.ja.md deleted file mode 100644 index e78560672..000000000 --- a/README.ja.md +++ /dev/null @@ -1,68 +0,0 @@ - -* [English](README.md) - -# UniVRM - -UniVRM は、[VRMフォーマット](https://vrm.dev/vrm_about/) を読み書きする Unity package です。 -VRMモデルの作成・インポート・エクスポートができます。 - -「VRM」はVRアプリケーション向けの人型3Dアバター（3Dモデル）データを扱うためのファイルフォーマットです。 -glTF2.0をベースとしており、誰でも自由に利用することができます。 - -## Manual - -* [UniVRMマニュアル](https://vrm.dev/docs/univrm/) -* [サポートするUnityのバージョン](https://vrm.dev/docs/univrm/install/unity_version/) -* [UniVRMのバージョン](https://vrm.dev/docs/univrm/install/univrm_version/) - -## License - -* [MIT License](./LICENSE.txt) - -## Install - -バージョン `v0.80.0` から、`Unity-2019.4LTS` 以降をサポートしています。 - -https://vrm.dev/docs/univrm/install/ - -### UnityPackage - -[Release](https://github.com/vrm-c/UniVRM/releases) から unitypackage をダウンロードしてください。 - -`v0.81.0` からパッケージの分割方法を変更しました。 - -| | UniGLTF_VRMShaders | UniVRM | VRM | -|--------------------|--------------------|---------|---------| -| GLTF だけ使うとき | install | | | -| VRM-0.X を使うとき | install | install | | -| VRM-1.0 を使うとき | install | | install | - -### UPM(開発者向け) - -https://vrm.dev/docs/univrm/install/univrm_upm/ - -`v0.81.0` を任意のバージョンに読み替えてください。 - -`v0.81.0` で一部の id が変更になりました。 - -`Packages/manifest.json` の抜粋 -```json -{ - "dependencies": { - "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.81.0", - "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.81.0", // unigltf to gltf - "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.81.0", - // VRM-1.0βを試す場合 - "com.vrmc.vrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v0.80.0", // rename univrm1 to vrm -} -``` - -#### サンプル - -Unity の `PackageManager` Windows から Sample を install できます。 - -* `com.vrmc.univrm` と `com.vrmc.vrm` にサンプルがあります。 - -* [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) diff --git a/README.md b/README.md index bb1e13506..b622dec51 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,18 @@ - -* [日本語](README.ja.md) - # UniVRM -`UniVRM` is a Unity implementation of [VRM](https://vrm.dev/en/vrm_about/). It can create, import and export VRM models. +UniVRM is `unity pacakge` for Import and Export [VRM Format](https://vrm.dev/vrm_about/) +## Download -`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. +* https://github.com/vrm-c/UniVRM/releases ## Manual -* [UniVRM Manual](https://vrm.dev/en/docs/univrm/) -* [Unity Version](https://vrm.dev/en/docs/univrm/install/unity_version/) -* [UniVRM Version](https://vrm.dev/en/docs/univrm/install/univrm_version/) +* https://vrm.dev/docs/univrm/ + +## API Document + +* https://vrm-c.github.io/UniVRM/ ## License * [MIT License](./LICENSE.txt) - -## Installation - -From version `v0.80.0`, UniVRM supports `Unity-2019.4LTS` or later. - -https://vrm.dev/en/docs/univrm/install/ - -### UnityPackage - -Download from [Release](https://github.com/vrm-c/UniVRM/releases) - -From `v0.81.0` UniVRM has 3 unitypackages. - -| | UniGLTF_VRMShaders | UniVRM | VRM | -|-------------|--------------------|---------|---------| -| for GLTF | install | | | -| for VRM-0.X | install | install | | -| for VRM-1.0 | install | | install | - -## UPM(developer) - -https://vrm.dev/en/docs/univrm/install/univrm_upm/ - -To upgrade/downgrade UniVRM version, for example, replace `v0.80.0` with any version. - -From `v0.81.0` package rename, reversion. - -Copy and paste the following git urls in `Packages/manifest.json` for UniVRM installation. -```json -{ - "dependencies": { - "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.81.0", - "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.81.0", // rename unigltf to gltf - "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.81.0", - // for VRM-1.0β - "com.vrmc.vrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v0.81.0", // rename univrm1 to vrm - } -} -``` - -#### Script Samples - -Enable sample on Unity `PackageManager` Window. - -* `com.vrmc.univrm` and `com.vrmc.vrm` has 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)