UniVRM/README.md
2021-01-22 09:22:47 +09:00

50 lines
1.3 KiB
Markdown

# UniVRM
* [日本語](README.ja.md)
## License
* [MIT License](./LICENSE.txt)
## [VRM](https://vrm.dev/en)
"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.
## [UniVRM](https://github.com/vrm-c/UniVRM)
"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`
## Download
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/)
## Script Samples
* [UniVRM Samples](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM.Samples)
* [UniVRMTest](https://github.com/vrm-c/UniVRMTest)
## Contributing to UniVRM
Use the commands below to clone UniVRM repository, and open the UniVRM folder by Unity.
```console
$ git clone https://github.com/vrm-c/UniVRM.git
$ cd UniVRM
$ git submodule update --init --recursive
```
See [contributing guidelines](https://github.com/vrm-c/UniVRM/wiki/Contributing-Guidelines).
## Documents
* https://vrm.dev/
* https://vrm.dev/en/
* https://github.com/vrm-c/UniVRM/wiki