Installation.md

Installation

PackageManager

First, get MeshSync DCC Plugins package.

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

DCC Tools Setup

1. Maya
2. 3ds Max
3. MotionBuilder
4. Blender
5. Metasequoia
6. Modo

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.

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.

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.

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. Depending on the Blender version, the installation is a bit different.

   • Blender 2.79:

     • Go to File -> User Preferences -> Add-ons
     • Click "Install Add-on from file" at the bottom of the window, and select blender-2.79.zip file.
     • Confirm that "Import-Export: Unity Mesh Sync" is added to the menu.

   • Blender 2.80 or after:

     • Go to Edit -> User Preferences
     • Click "Install" at the top right of the window, and select the appropriate blender-2.xx.zip file.
     • Confirm that "Import-Export: Unity Mesh Sync" is added to the Add-ons tab.

     

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

5. Confirm that MeshSync panel is added.

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.
2. Start Metasequoia.
3. Go to Help -> About Plug-ins, and click "Install" at the lower left of the Plug-win window.
4. Select the plugin file from the extracted zip file that corresponds to the version of Metasequoia.
   For example: MeshSyncClientMQ472.plugin
5. Go to Panel -> Unity Mesh Sync.
   If this menu doesn't exist, confirm that "Unity Mesh Sync" is checked in the Plug-in window.

Modo

1. Follow the instructions in Building Plugins to build MeshSync plugin for Modo.
   Due to Modo's licensing, manual building is required at the moment.
2. Start Modo.
3. Go to System -> Add Plug-in, and select MeshSyncClientModo.fx for the applicable Modo version.
4. Go to Modo's tabs UI, click on +, and choose Application -> Custom View -> UnityMeshSync.
5. Confirm that UnityMeshSync view is added in the tabs UI.

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.
2. 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.