Skip to content

Commit

Permalink
Merge pull request #848 from ousttrue/feature/update_readme
Browse files Browse the repository at this point in the history
Feature/update readme
  • Loading branch information
PoChang007 authored Apr 6, 2021
2 parents b0d9b5f + ee61c28 commit 338dbce
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 29 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/------bug-report-ja--.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ''

---

**バグについて**
## バグについて

バグがどのようなものか明確かつ簡潔に記述してください。

**再現方法**
## 再現方法

例: 動作の再現させる手順:

Expand All @@ -22,20 +22,20 @@ assignees: ''

動作を再現できる最小の例(モデルファイルなど)がある場合は、このissueに添付してください。

**期待する動作**
## 期待する動作

期待する動作を明確かつ簡潔に記述してください。

**スクリーンショット**
## スクリーンショット

ある場合は、問題の説明に役立つスクリーンショットを追加してください。

**環境情報**
## 環境情報

- OS: [e.g. `Windows 10`]
- Unity version: [e.g. `Unity-2018.4`]
- UniVRM version: [e.g. `0.52.0`]

**追加の状況・背景**
## 追加の状況・背景

この問題に関するその他の状況・背景など記載したい場合にここに記載してください。
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/-----feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ assignees: ''

---

** 問題 Is your feature request related to a problem? Please describe.**
## 問題 Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

** 追加する機能 Describe the solution you'd like**
## 追加する機能 Describe the solution you'd like
A clear and concise description of what you want to happen.

** 記録内容の変更の有無 Requirement to update gltf **
## 記録内容の変更の有無 Requirement to update gltf
必要な場合はこちら。 If gltf update is required, below.

https://github.com/vrm-c/vrm-specification/issues
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report-------en--.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ''

---

**Describe the bug**
## Describe the bug

A clear and concise description of what the bug is.

**To Reproduce**
## To Reproduce

e.g. Steps to reproduce the behavior:

Expand All @@ -22,20 +22,20 @@ e.g. Steps to reproduce the behavior:

If there are some minimal examples(e.g. model files) to reproduce the behavior, please attach them to this issue.

**Expected behavior**
## Expected behavior

A clear and concise description of what you expected to happen.

**Screenshots**
## Screenshots

If applicable, add screenshots to help explain your problem.

**Environments (please complete the following information):**
## Environments (please complete the following information):

- OS: [e.g. `Windows 10`]
- Unity version: [e.g. `Unity-2018.4`]
- UniVRM version: [e.g. `0.52.0`]

**Additional context**
## Additional context

Add any other context about the problem here.
69 changes: 55 additions & 14 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,62 @@
# UniVRM

* [English](README.md)

## License
# UniVRM

* [MIT License](./LICENSE.txt)
https://github.com/vrm-c/UniVRM

UniVRM は、VRMフォーマットを読み書きする Unity package です。

## [VRM](https://vrm.dev/)
* [Unityのバージョン](https://vrm.dev/docs/univrm/install/unity_version/)
* [UniVRMのバージョン](https://vrm.dev/docs/univrm/install/univrm_version/)
* [UniVRMマニュアル](https://vrm.dev/docs/univrm/)

「UniVRM」は [VRM](https://vrm.dev/vrm_about/) の Unity 実装で、VRMモデルの作成・インポート・エクスポートができます。

「VRM」はVRアプリケーション向けの人型3Dアバター(3Dモデル)データを扱うためのファイルフォーマットです。
glTF2.0をベースとしており、誰でも自由に利用することができます。

## [UniVRM](https://github.com/vrm-c/UniVRM)
インポートされたモデルは、

* [ヒューマノイド](https://vrm.dev/docs/univrm/humanoid/)
* [モデル情報](https://vrm.dev/docs/univrm/meta/)
* [マテリアル](https://vrm.dev/docs/univrm/shaders/)
* [表情制御](https://vrm.dev/docs/univrm/blendshape/)
* [視線制御](https://vrm.dev/docs/univrm/lookat/)
* [SpringBone](https://vrm.dev/docs/univrm/springbone/)
* [FirstPerson](https://vrm.dev/docs/univrm/firstperson/)

のデータがあります。

## License

* [MIT License](./LICENSE.txt)

## Install

https://vrm.dev/docs/univrm/install/
### 安定版

トラブルの無さそうなバージョンをピックアップする予定です。
バージョン選択の参考にしてください。
github の右側にある下のようなリンクを辿ってください。

「UniVRM」は VRM の Unity 実装で、VRMモデルの作成・インポート・エクスポートができます。
<img width=400 src=./right_latest.jpg>

* `Unity-2018.4LTS以降` `.Net4.x`をサポートしています。
* 推奨バージョンは、 `Unity-2019.4LTS` です。
1. ``UniVRM-0.xx.unitypackage``をダウンロードしてください。
1. ``UniVRM-0.xx.unitypackage``をUnityのプロジェクトにインポートしてください。

### 最新版

## Download
リリース時に preview の印を付けることにしました。

1. 本リポジトリの[リリースページ](https://github.com/vrm-c/UniVRM/releases)へ移動してください。
1. 最新の``UniVRM-0.xx.unitypackage``をダウンロードしてください。
1. ``UniVRM-0.xx.unitypackage``をUnityのプロジェクトにインポートしてください。
1. [UniVRMのインストール](https://vrm.dev/univrm/univrm_install/)も参照してください。


## Script Samples

* [Programming](https://vrm.dev/docs/univrm/programming/)
* [UniVRMサンプル](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM.Samples)
* [UniVRMTest(テストとサンプル)](https://github.com/vrm-c/UniVRMTest)

Expand All @@ -37,12 +67,23 @@ glTF2.0をベースとしており、誰でも自由に利用することがで
```console
$ git clone https://github.com/vrm-c/UniVRM.git
$ cd UniVRM
# MToon などの取得
$ git submodule update --init --recursive
```

[コントリビューションガイド](https://github.com/vrm-c/UniVRM/wiki/コントリビューションガイド(ja))を参照してください。

## Documents
## UPM

`v0.66.0` を任意のバージョンに読み替えてください。

* https://vrm.dev/
* https://github.com/vrm-c/UniVRM/wiki
```
{
"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",
// ...
}
```
Binary file added right_latest.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 338dbce

Please sign in to comment.