summaryrefslogtreecommitdiff
path: root/Assets/ThirdParty/VRM/MeshUtility/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Assets/ThirdParty/VRM/MeshUtility/README.md')
-rw-r--r--Assets/ThirdParty/VRM/MeshUtility/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/Assets/ThirdParty/VRM/MeshUtility/README.md b/Assets/ThirdParty/VRM/MeshUtility/README.md
new file mode 100644
index 00000000..c96f8f90
--- /dev/null
+++ b/Assets/ThirdParty/VRM/MeshUtility/README.md
@@ -0,0 +1,58 @@
+# MeshUtility
+
+Mesh processing tool in Unity platform.
+
+## Utilities
+
+### MeshSeparator
+
+Separate the target mesh into different categories based on given conditions.
+
+Currently support BlendShape mesh separation. See [documentation](Documentation/notes/MeshSeparator.md) for more details.
+
+<img src="Documentation/images/blendshape_separator.jpg" width="300">
+
+### MeshIntegrator
+
+Integrate all the meshes of a Prefab (Project window).
+
+### Integrate Static Mesh
+
+Integrate all the static meshes in the Hierarchy (Root and its children).
+
+### MeshNormalizer
+
+Bake the Hierarchy. This is VRM normalize backend.
+MeshNormalizer can do blendShape bake.
+
+## Import MeshUtility
+
+There are two ways to import MeshUtility into a Unity project.
+
+### 1. Unity Package Manager (from Unity 2019)
+
+You can add MeshUtility package via `UPM`. First click `Window` from menu on top, then select `Package Manager`.
+
+<img src="Documentation/images/installation_1.jpg" width="200">
+
+In `Package Manager`, click `Add package from git URL` and paste `https://github.com/vrm-c/UniVRM.git?path=/Assets/MeshUtility`.
+
+<img src="Documentation/images/installation_2.jpg" width="200">
+
+Now check your project window. You shall see MeshUtility in the `Packages` folder.
+
+### 2. Add package name and its url in manifest.json
+
+Another way of importing MeshUtility is manually adding necessary information in manifest.json, which is in the directory of `Package folder` in your Unity project. Open manifest.json with text editor and add the followings in `dependencies`:
+
+```json
+{
+ "dependencies": {
+ "com.vrmc.meshutility": "https://github.com/vrm-c/UniVRM.git?path=/Assets/MeshUtility",
+ }
+}
+```
+
+Go back to the Unity project. The system will automatically load the package.
+
+<img src="Documentation/images/installation_3.jpg" width="200"> \ No newline at end of file