Skip to content

Commit ee220db

Browse files
committed
Update Readme
1 parent 3c41940 commit ee220db

2 files changed

Lines changed: 63 additions & 78 deletions

File tree

README.jp.md

Lines changed: 32 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,6 @@ Blenderのdecimateみたいな機能をUnity上で使えるようにするPlugin
1414

1515
<div align="left">
1616

17-
## VRCSDK3との互換性問題
18-
19-
現在、このDecimaterツールとVRCSDK3-AVATARとの間に重大な互換性の問題が発生しています。以下の症状が確認されています:
20-
21-
1. **アップロード時の異常動作**
22-
- Decimaterをインポートした状態でアバターをアップロードすると、VRCSDKが予期せぬ動作をします。
23-
- 具体的には、Hierarchy上のプレハブではなく、AssetsフォルダにBlueprint IDを名前とする新たなPrefabが生成され、それがアップロード対象として参照されてしまいます。
24-
25-
2. **エラーの発生**
26-
- 上記の動作により、`FileNotFoundException`が発生し、アップロードが失敗します。
27-
28-
### 問題の詳細
29-
30-
- この問題はDecimaterツールをプロジェクトにインポートしただけで発生します。
31-
- Decimating操作を実行しなくても問題が再現されます。
32-
- 問題の原因はVRCSDKとの相互作用にあると考えられますが、VRCSDKの`VRCAvatarBuilder`クラスと`VRC.SDK3.Builder.VRCAvatarBuilder.ExportCurrentAvatarResource`メソッドの内部実装の把握ができないため、対応が困難な状況です。
33-
34-
3517
### 導入方法
3618
---
3719

@@ -46,27 +28,38 @@ Blenderのdecimateみたいな機能をUnity上で使えるようにするPlugin
4628
導入方法(2)の項目に関しては、treeの構造が以下のようになるようにしてください。
4729

4830
```shell
49-
Assets
50-
├─MeshDecimater_Unity
51-
│ ├─Material
52-
│ ├─Shader
53-
│ └─src
54-
└─UnityMeshSimplifier
55-
├─.circleci
56-
│ ├─ProjectSettings
57-
│ └─scripts
58-
├─.github
59-
│ ├─ISSUE_TEMPLATE
60-
│ └─workflows
61-
├─Editor
62-
├─Runtime
63-
│ ├─Components
64-
│ ├─Exceptions
65-
│ ├─Internal
66-
│ ├─Math
67-
│ └─Utility
68-
└─Tests
69-
└─Editor
31+
MeshDecimater_Unity
32+
│ .gitignore
33+
│ LICENSE
34+
│ README.jp.md
35+
│ README.md
36+
│ Shader.meta
37+
│ Src.meta
38+
39+
├─.github
40+
│ └─ISSUE_TEMPLATE
41+
│ bugreport.yml
42+
│ config.yml
43+
44+
├─Editor
45+
│ DecimaterMain.cs
46+
│ DecimaterMain.cs.meta
47+
│ MeshInfoDisplay.cs
48+
│ MeshInfoDisplay.cs.meta
49+
│ MeshPreviewer.cs
50+
│ MeshPreviewer.cs.meta
51+
│ WireframeDrawer.cs
52+
│ WireframeDrawer.cs.meta
53+
54+
├─Runtime
55+
│ MeshDecimaterUtility.cs
56+
│ MeshDecimaterUtility.cs.meta
57+
│ MeshUtils.cs
58+
│ MeshUtils.cs.meta
59+
60+
└─Shader
61+
Wireframe.shader
62+
Wireframe.shader.meta
7063
```
7164

7265
### 使い方

README.md

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,6 @@ decimate functions are created by using **UnityMeshSimplifier**[[1]][UnityMeshSi
1414

1515
<div align="left">
1616

17-
## Compatibility Issue with VRCSDK3
18-
19-
Currently, there is a significant compatibility issue between this Decimater tool and VRCSDK3-AVATAR. The following symptoms have been observed:
20-
21-
1. **Abnormal Behavior During Upload**:
22-
- When attempting to upload an avatar with Decimater imported into the project, VRCSDK exhibits unexpected behavior.
23-
- Specifically, instead of referencing the prefab in the Hierarchy, VRCSDK generates a new Prefab in the Assets folder named after the Blueprint ID, and attempts to use this for the upload.
24-
25-
2. **Error Occurrence**:
26-
- As a result of the above behavior, a `FileNotFoundException` occurs, causing the upload to fail.
27-
28-
### Problem Details
29-
30-
- This issue occurs simply by importing the Decimater tool into the project.
31-
- The problem is reproducible even without executing any Decimating operations.
32-
- While the cause is believed to be related to interactions with VRCSDK, addressing the issue is challenging due to inability to access the internal implementations of VRCSDK's `VRCAvatarBuilder` class and the `VRC.SDK3.Builder.VRCAvatarBuilder.ExportCurrentAvatarResource` method.
33-
34-
3517
### Installation
3618
---
3719

@@ -46,27 +28,37 @@ Currently, there is a significant compatibility issue between this Decimater too
4628
tree have to looks like this
4729

4830
```shell
49-
Assets
50-
├─MeshDecimater_Unity
51-
│ ├─Material
52-
│ ├─Shader
53-
│ └─src
54-
└─UnityMeshSimplifier
55-
├─.circleci
56-
│ ├─ProjectSettings
57-
│ └─scripts
58-
├─.github
59-
│ ├─ISSUE_TEMPLATE
60-
│ └─workflows
61-
├─Editor
62-
├─Runtime
63-
│ ├─Components
64-
│ ├─Exceptions
65-
│ ├─Internal
66-
│ ├─Math
67-
│ └─Utility
68-
└─Tests
69-
└─Editor
31+
│ .gitignore
32+
│ LICENSE
33+
│ README.jp.md
34+
│ README.md
35+
│ Shader.meta
36+
│ Src.meta
37+
38+
├─.github
39+
│ └─ISSUE_TEMPLATE
40+
│ bugreport.yml
41+
│ config.yml
42+
43+
├─Editor
44+
│ DecimaterMain.cs
45+
│ DecimaterMain.cs.meta
46+
│ MeshInfoDisplay.cs
47+
│ MeshInfoDisplay.cs.meta
48+
│ MeshPreviewer.cs
49+
│ MeshPreviewer.cs.meta
50+
│ WireframeDrawer.cs
51+
│ WireframeDrawer.cs.meta
52+
53+
├─Runtime
54+
│ MeshDecimaterUtility.cs
55+
│ MeshDecimaterUtility.cs.meta
56+
│ MeshUtils.cs
57+
│ MeshUtils.cs.meta
58+
59+
└─Shader
60+
Wireframe.shader
61+
Wireframe.shader.meta
7062
```
7163

7264
### How to use

0 commit comments

Comments
 (0)