# MeshSync

**Repository Path**: dang050/MeshSync

## Basic Information

- **Project Name**: MeshSync
- **Description**: A package for synchronizing meshes/models editing in DCC tools into Unity in real time.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-22
- **Last Updated**: 2024-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![demo](Documentation~/images/Demo.gif)
# Other Languages
- [日本語](Readme_JP.md)


# MeshSync

[![](https://badge-proxy.cds.internal.unity3d.com/f4d1069b-1233-4324-ae75-2fac980576a4)](https://badges.cds.internal.unity3d.com/packages/com.unity.meshsync/build-info?branch=dev&testWorkflow=package-isolation)
[![](https://badge-proxy.cds.internal.unity3d.com/6cfcda56-5e8d-4612-abfa-6de23df068fb)](https://badges.cds.internal.unity3d.com/packages/com.unity.meshsync/dependencies-info?branch=dev&testWorkflow=updated-dependencies)
[![](https://badge-proxy.cds.internal.unity3d.com/45cf24da-7561-4983-9e11-fc920996015c)](https://badges.cds.internal.unity3d.com/packages/com.unity.meshsync/dependants-info)
[![](https://badge-proxy.cds.internal.unity3d.com/0998ee7c-b3f2-4ef9-97cd-628296f29c4a)](https://badges.cds.internal.unity3d.com/packages/com.unity.meshsync/warnings-info?branch=dev)

![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/9cb90abe-572c-440c-b7f9-f212c5573261)
![ReleaseBadge](https://badge-proxy.cds.internal.unity3d.com/4661afc4-7953-410d-a4fa-9668ed7da2b9)

Working together with [MeshSyncDCCPlugins](https://github.com/Unity-Technologies/MeshSyncDCCPlugins), MeshSync is a package for synchronizing meshes/models editing in DCC tools into Unity in real time. 
This allows devs to immediately see how things will look in-game while modelling.  

MeshSync is currently a preview package and the steps to install it 
differ based on the version of Unity.

* Unity 2019.x  
  ![PackageManager2019](Documentation~/images/PackageManager2019.png)
  1. Open [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) 
  2. Ensure that **Show preview packages** is checked. 
  3. Search for *MeshSync*.
  
* Unity 2020.1  
  ![PackageManager2020](Documentation~/images/PackageManager2020.1.png)
  1. Open [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) 
  2. Click the **+** button, and choose **Add package from git URL** 
  3. Type in `com.unity.meshsync@` followed by the version.  
     For example: `com.unity.meshsync@0.2.5-preview`


## Supported Platforms

- Windows 64 bit
- Mac
- Linux

# Basic usage

From the **GameObject** menu, choose **MeshSync > Create Server** to create a server object.  
This object has [MeshSyncServer](Documentation~/en/MeshSyncServer.md) component that handles the sync process.

![Menu](Documentation~/images/MenuCreateServer.png)

# Settings

Default settings for MeshSync components can be configured on the 
[Project Settings](Documentation~/en/ProjectSettings.md) window.

![Server Settings](Documentation~/images/ProjectSettingsServer.png)

Similarly, DCC Tools integration can be configured on the 
[Preferences](Documentation~/en/Preferences.md) window

![Server Settings](Documentation~/images/Preferences.png)


# Advanced Features
- [SceneCache](Documentation~/en/SceneCache.md)
  - [SceneCache in Timeline](Documentation~/en/SceneCacheInTimeline.md)


# Plugins
- [Building](Plugin~/Docs/en/BuildPlugins.md)

# License
- [License](LICENSE.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Third Party Notices](Third%20Party%20Notices.md)
- [Contributing](CONTRIBUTING.md)

#  Related Tools
- [NormalPainter](https://github.com/unity3d-jp/NormalPainter): Tool for editing vectors in Unity
- [BlendShapeBuilder](https://github.com/unity3d-jp/BlendShapeBuilder): Tool for building BlendShapes in Unity