{"id":26483951,"url":"https://github.com/vrlabs/custom-object-sync","last_synced_at":"2025-03-20T04:59:15.521Z","repository":{"id":245823521,"uuid":"748748928","full_name":"VRLabs/Custom-Object-Sync","owner":"VRLabs","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-26T19:49:16.000Z","size":9410,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-26T23:03:12.510Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VRLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-26T17:21:20.000Z","updated_at":"2024-08-20T19:28:01.000Z","dependencies_parsed_at":"2024-06-24T11:06:05.402Z","dependency_job_id":"35638d98-6fa5-466c-8e47-760e9873c723","html_url":"https://github.com/VRLabs/Custom-Object-Sync","commit_stats":null,"previous_names":["vrlabs/custom-object-sync"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FCustom-Object-Sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FCustom-Object-Sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FCustom-Object-Sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FCustom-Object-Sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VRLabs","download_url":"https://codeload.github.com/VRLabs/Custom-Object-Sync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244554067,"owners_count":20471173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-20T04:59:14.908Z","updated_at":"2025-03-20T04:59:15.510Z","avatar_url":"https://github.com/VRLabs.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Custom Object Sync\n\n[![Generic badge](https://img.shields.io/github/downloads/VRLabs/Custom-Object-Sync/total?label=Downloads)](https://github.com/VRLabs/Custom-Object-Sync/releases/latest)\n[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/Custom-Object-Sync/blob/main/LICENSE)\n[![Generic badge](https://img.shields.io/badge/Quest-Compatible-green?logo=Meta)](https://img.shields.io/badge/Quest-Compatible-green?logo=Meta)\n[![Generic badge](https://img.shields.io/badge/Unity-2022.3.22f1-lightblue?logo=Unity)](https://unity.com/releases/editor/whats-new/2022.3.22)\n[![Generic badge](https://img.shields.io/badge/SDK-AvatarSDK3-lightblue.svg)](https://vrchat.com/home/download)\n\n[![Generic badge](https://img.shields.io/discord/706913824607043605?color=%237289da\u0026label=DISCORD\u0026logo=Discord\u0026style=for-the-badge)](https://discord.vrlabs.dev/)\n[![Generic badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dvrlabs%26type%3Dpatrons\u0026style=for-the-badge)](https://patreon.vrlabs.dev/)\n\nSync objects across the network with custom range, precision, and parameter usage.\n\n![Preview](https://github.com/VRLabs/Custom-Object-Sync/assets/76777936/eb729e1f-d590-4810-bc3a-88df6915ed6a)\n\n### ⬇️ [Download Latest Version](https://github.com/VRLabs/Custom-Object-Sync/releases/latest)\n\n### 📦 [Add to VRChat Creator Companion](https://vrlabs.dev/packages?package=dev.vrlabs.custom-object-sync)\n\n\u003c/div\u003e\n\n---\n\n## How it works\n\n* Contacts and Physbones read the location and rotation of your object(s).\n* Parameter Drivers convert this location and rotation into boolean values.\n* Those boolean values are synced over the network in multiple steps. Choosing more steps means we can use fewer parameters.\n* Once the values arrive at the remote side, they get converted back into floats.\n* These floats get used to set the object back in its place on the remote side.\n* This can be useful when:\n  * You want to late sync a world drop.\n  * You want to fly an object around and have it sync reliably.\n  * You have an object that moves based on some local-only/fps dependent mechanism.\n\n## Install guide\n\nhttps://github.com/VRLabs/Custom-Object-Sync/assets/76777936/4d12a815-bb1f-4c03-b0fc-83f9ea98638a\n\n* Click `VRLabs -\u003e Custom Object Sync` at the top of the screen.\n* Drag the object you want to sync into the `Objects to Sync` field.\n* Adjust the values until you're happy with them:\n  * Add Local Debug View: Adds a toggle to view the object's remote position and rotation.\n  * Quick Sync:\n    * Position Precision: The position precision to be synced. Since this sync mode syncs floats, Position Precision also affects Range, and Rotation Precision is locked at 1 float per axis.\n  * Non Quick Sync:\n    * Position Precision: Precision of the synced object's Position.\n    * Rotation Precision: Precision of the synced object's Rotation.\n    * Radius: Radius of the sync. For more information, see `Sync Type`\n    * Bits per Sync: Amount of bits per sync step. Lower bits means longer before the full object is synced, but also less parameter usage.\n  * Enable Rotation Sync: Whether or not rotation should be Synced.\n  * Sync Type: Whether or not the sync should be based on avatar root or on world origin.\n    * Avatar Centered: The sync is based off of a point which is dropped when-ever you start the sync. This means you can use way lower range, but also it won't late sync.\n      * This is forced for quick sync.\n    * World Centered: The sync is based off of world origin. This means you'll need a big range to support big worlds, but it will late sync.\n  * Add Damping Constraint to Object: Whether or not the remote object should be damped. This means the object moves to its new position smoothly whenever it receives a new position.\n    * Damping value: How the damping behaves: 0 = don't move at all. 1 = move to the new position very fast.\n* Press Generate Custom Sync\n\n\u003e [!NOTE]  \n\u003e When building for Quest, you will have to remove unsupported components and shaders\n\n## How to use\n\n* Enable the `CustomObjectSync/Enabled` bool to start the sync.\n* Now the location of the Target objects will be synced over the network.\n\n## Performance stats\n\nRotation Sync:\n\n```c++\nConstraints:            11-13 + 3 per object \nContact Receivers:      6\nContact Senders:        3\nFX Animator Layers:     2 + 2 per object\nPhys Bones:             6\nPhys Bone Colliders:    3\nRigidbodies:            1\nJoints:                 1\nExpression Parameters:  1-256\n```\n\nNo Rotation Sync:\n\n```c++\nConstraints:            11-13 + 3 per object \nContact Receivers:      6\nContact Senders:        3\nFX Animator Layers:     2 + 1 per object\nRigidbodies:            1\nJoints:                 1\nExpression Parameters:  1-256\n```\n\n## Hierarchy layout\n\nRotation Sync:\n\n```html\nCustom Object Sync\n|-Target\n|-Measure\n|  |-Position\n|  |  |-SenderX\n|  |  |-SenderY\n|  |  |-SenderZ\n|  |  |-Receiver X+\n|  |  |-Receiver X-\n|  |  |-Receiver Y+\n|  |  |-Receiver Y-\n|  |  |-Receiver Z+\n|  |  |-Receiver Z-\n|  |-Rotation\n|  |  |-Measure Bones\n|  |  |  |-Measure X Magnitude\n|  |  |  |-Measure X Sign\n|  |  |  |-Measure Y Magnitude\n|  |  |  |-Measure Y Sign\n|  |  |  |-Measure Z Magnitude\n|  |  |  |-Measure Z Sign\n|  |  |-Measure Planes\n|  |  |  |-X Angle Plane\n|  |  |  |-Y Angle Plane\n|  |  |  |-Z Angle Plane\n|-Set\n|  |-Result\n```\n\nNo Rotation Sync:\n\n```html\nCustom Object Sync\n|-Target\n|-Measure\n|  |-Position\n|  |  |-SenderX\n|  |  |-SenderY\n|  |  |-SenderZ\n|  |  |-Receiver X+\n|  |  |-Receiver X-\n|  |  |-Receiver Y+\n|  |  |-Receiver Y-\n|  |  |-Receiver Z+\n|  |  |-Receiver Z-\n|-Set\n|  |-Result\n```\n\n## Contributors\n\n* [jellejurre](https://github.com/jellejurre)\n\n## License\n\nCustom Object Sync is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/Custom-Object-Sync/blob/main/LICENSE).\n\n​\n\n\u003cdiv align=\"center\"\u003e\n\n[\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/VRLabs.png\" width=\"50\" height=\"50\"\u003e](https://vrlabs.dev \"VRLabs\")\n\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png\" width=\"10\"\u003e\n[\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Discord.png\" width=\"50\" height=\"50\"\u003e](https://discord.vrlabs.dev/ \"VRLabs\")\n\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png\" width=\"10\"\u003e\n[\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Patreon.png\" width=\"50\" height=\"50\"\u003e](https://patreon.vrlabs.dev/ \"VRLabs\")\n\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Empty.png\" width=\"10\"\u003e\n[\u003cimg src=\"https://github.com/VRLabs/Resources/raw/main/Icons/Twitter.png\" width=\"50\" height=\"50\"\u003e](https://twitter.com/vrlabsdev \"VRLabs\")\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrlabs%2Fcustom-object-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvrlabs%2Fcustom-object-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrlabs%2Fcustom-object-sync/lists"}