Installation

Automatic Installation via Unity Editor

MeshSync's Preferences page provides easy installation on several DCC tools.
Alternatively, we can also install the plugins manually.

Manual Installation

Preparation

First, get MeshSync DCC Plugins package in a Unity project.

  1. Open Package Manager.
  2. Click the + button, and choose Add package from git URL.
  3. Type in com.unity.meshsync.dcc-plugins.

Maya

  1. Open Packages/MeshSync DCC Plugins/Editor/Plugins folder using a file explorer and uncompress the appropriate zip file for Maya.

  2. Copy the uncompressed files:

    • Windows:
      If MAYA_APP_DIR environment variable is setup, copy the modules directory there.
      If not, go to %USERPROFILE%\Documents\maya in Windows Explorer, and copy the modules directory there.
    • Mac:
      Copy the UnityMeshSync directory and UnityMeshSync.mod file to /Users/Shared/Autodesk/modules/maya.
    • Linux:
      Copy the modules directory to ~/maya/<maya_version>

  3. Start Maya, then go to Windows → Settings/Preferences → Plug-in Manager.

  4. Activate MeshSync DCC plugin by checking Loaded under MeshSyncClient.
  5. Notice that UnityMeshSync should now be available on the shelf UI.
    Click on the gear icon to open the settings menu and start playing around with MeshSync.

MeshSyncClientMaya

3ds Max

  1. Open Packages/MeshSync DCC Plugins/Editor/Plugins folder using a file explorer and uncompress the appropriate zip file for 3ds Max.
  2. Start 3ds Max
  3. Copy MeshSyncClient3dsMax.dlu that corresponds to the used version of 3ds Max into one of the following directories:
    • (Recommended) A custom directory for plugins that has been added in 3ds Max by the following menu:
      • 3ds Max 2019 and earlier: Customize → Configure System Paths. Then select 3rd Party Plug-Ins tab.
      • 3ds Max 2020: Customize → Configure User and System Paths. Then select 3rd Party Plug-Ins tab.
    • The plugin path under the installation directory, e.g: C:\Program Files\Autodesk\3ds Max 2019\Plugins
  4. Restart 3ds Max
  5. Confirm that "UnityMeshSync" has been added to the main menu bar. The settings window can be opened by clicking "Window". > If we change the menu bar, "UnityMeshSync" will be added under Action, which > still allows us to access MeshSync features.

MeshSyncClient3dsMax

MotionBuilder

  1. Open Packages/MeshSync DCC Plugins/Editor/Plugins folder using a file explorer and uncompress the appropriate zip file for MotionBuilder.
  2. Start MotionBuilder.
  3. Add a path for custom plugins by clicking on Settings → Preferences → SDK menu.
  4. Copy MeshSyncClientMotionBuilder.dll that corresponds to the used version of MotionBuilder into the custom plugin path.
  5. Restart MotionBuilder.
  6. Confirm that "UnityMeshSync" is added in the AssetBrowser under Templates → Devices folder.
  7. Add "UnityMeshSync" to the scene.
  8. Start playing around with various MeshSync settings and features by selecting Devices → UnityMeshSync in the Navigator.

MeshSyncClientMotionBuilder

Blender

  1. Open Packages/MeshSync DCC Plugins/Editor/Plugins folder using a file explorer and uncompress the appropriate zip file for Blender.
  2. Start Blender
  3. Go to Edit → User Preferences
  4. Click "Install" at the top right of the window, and select the appropriate blender-x.xx.zip file.

  5. Confirm that "Import-Export: Unity Mesh Sync" is added to the Add-ons tab.
    MeshSyncClientBlender_Installation

  6. Check "Import-Export: Unity Mesh Sync" to enable it.

  7. Confirm that MeshSync panel is added.

drawing

Caveat

When installing a Blender plugin, the older version has to be uninstalled first if it exists.
Steps to uninstall:

  1. Select "Import-Export: Unity Mesh Sync" from the Add-ons menu.
  2. Click "Remove" button.
  3. Restart Blender.

  4. On Mac OSX, delete the installed plugin files in the following folder:

    ~/Library/ApplicationSupport/Blender/2.xx/scripts/addons/MeshSyncClientBlender

---

### Metasequoia

1. Open `Packages/MeshSync DCC Plugins/Editor/Plugins` folder using a file explorer 
and uncompress the appropriate zip file for Metasequoia.
1. Start Metasequoia.
1. Go to Help &rarr; About Plug-ins, and click "Install" at the lower left of the Plug-win window.
1. Select the plugin file from the extracted zip file that corresponds to the version of Metasequoia.  
For example: *MeshSyncClientMQ472.plugin*
1. Go to Panel &rarr; Unity Mesh Sync.  
If this menu doesn't exist, confirm that "Unity Mesh Sync" is checked in the Plug-in window.

![MeshSyncClientMQ](images/MeshSyncClientMQ.png)

---

### Modo

1. Follow the instructions in [Building Plugins](https://github.com/Unity-Technologies/MeshSyncDCCPlugins/blob/dev/Plugins~/Docs/en/BuildDCCPlugins.md)
to build MeshSync plugin for Modo.   
Due to Modo's licensing, manual building is required at the moment.
1. Start Modo.
3. Go to System &rarr; Add Plug-in, and select *MeshSyncClientModo.fx* for the applicable Modo version.
4. Go to Modo's tabs UI, click on *+*, and choose Application &rarr; Custom View &rarr; UnityMeshSync.
1. Confirm that UnityMeshSync view is added in the tabs UI.

![MeshSyncClientModo](images/MeshSyncClientModo.png)

#### Caveat

When installing a newer version of the plugin, the existing version must be removed first if it exists.  
Steps to remove:
1. Close all UnityMeshSync views.
1. Restart Modo.

If installing a newer version still fails even after doing the above steps, 
then please try to remove manually after closing Modo.
1. Windows:
- Open settings file using a text editor.  
  Example: `C:\Users\<user_name>\AppData\Roaming\Luxology\MODO<modo_version>.CFG`
- Remove UnityMeshSync items like the following:
  ```
  <hash type="Server" key="12345678-abcd-1234-abcd-111122223333:UnityMeshSync">
    <atom type="Module">C:\ModoPlugins\Modo14\MeshSyncClientModo.lx</atom>
    <atom type="Direct">1</atom>
  </hash>
  ```
- Save the settings file, and restart Modo.

---

## Unity Project Setup via DCC tools
We can install MeshSync on a Unity project through DCC tools. This install method is designed for users who are not familiar with the Unity Editor or the Unity Package Manager.

Currently, this install method is available only for Blender. For other DCC tools, see [MeshSync](https://docs.unity3d.com/Packages/com.unity.meshsync@latest)'s installation page.
### Blender
Install the Blender add-on:
1. Download the latest MeshSyncDCCPlugins release from the [releases page on Github](https://github.com/Unity-Technologies/MeshSyncDCCPlugins/releases).
1. Install the add-on manually, as described in the [manual installation for Blender](./Installation.md#blender).

Setup MeshSync for a Unity Project:
1. Select the location of an existing Unity Project and the location of the Unity Editors.
![](images/BlenderUnityProjectSection.png)
1. Click on **Auto Sync** or **Manual Sync**.
![](images/BlenderSyncButtons.png)

The Unity project will be launched with the Blender scene synchronised.