{"id":26483936,"url":"https://github.com/vrlabs/world-constraint","last_synced_at":"2025-03-20T04:59:10.506Z","repository":{"id":41263921,"uuid":"414947063","full_name":"VRLabs/World-Constraint","owner":"VRLabs","description":"A world-fixed object, held in place with a constraint.","archived":false,"fork":false,"pushed_at":"2024-12-04T20:40:09.000Z","size":26363,"stargazers_count":54,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-04T21:34:23.295Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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":"2021-10-08T10:43:10.000Z","updated_at":"2024-12-04T20:40:13.000Z","dependencies_parsed_at":"2023-09-25T01:59:15.127Z","dependency_job_id":"9594657a-c939-4296-b353-eff9e00e1e57","html_url":"https://github.com/VRLabs/World-Constraint","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FWorld-Constraint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FWorld-Constraint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FWorld-Constraint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VRLabs%2FWorld-Constraint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VRLabs","download_url":"https://codeload.github.com/VRLabs/World-Constraint/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:09.996Z","updated_at":"2025-03-20T04:59:10.498Z","avatar_url":"https://github.com/VRLabs.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# World Constraint\n\n[![Generic badge](https://img.shields.io/github/downloads/VRLabs/World-Constraint/total?label=Downloads)](https://github.com/VRLabs/World-Constraint/releases/latest)\n[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/World-Constraint/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\nA world-fixed object, held in place with a constraint\n\n![WorldConstraint](https://github.com/VRLabs/World-Constraint/assets/76777936/d80ef068-8b3c-4bcb-8010-f9702a016533)\n\n### ⬇️ [Download Latest Version](https://github.com/VRLabs/World-Constraint/releases/latest)\n\n### 📦 [Add to VRChat Creator Companion](https://vrlabs.dev/packages?package=dev.vrlabs.world-constraint)\n\n\u003c/div\u003e\n\n---\n\n## How it works\n\n* ``World Constraint`` uses ``World.prefab`` from the assets as a parent constraint source. ``World.prefab`` is not in the scene, so ``World Constraint`` will always stay at position 0, 0, 0.\n* The parent constraint on ``Container`` uses ``Reset Target`` as a source, which is used to bring ``Container`` to your avatar.\n\n## Install guide\n\nhttps://github.com/VRLabs/World-Constraint/assets/76777936/464287a8-c43c-4cf0-bc6b-5ec700a3eb9b\n\n* Drag \u0026 drop the ``World Constraint`` prefab into the base of your Hierarchy.\n* Right click and unpack the prefab, then drag \u0026 drop it onto your avatar.\n* Expand the prefab hierarchy and find ``Reset Target``\n* Move ``Reset Target`` outside of ``World Constraint`` and place it anywhere in your avatars hierarchy as needed.\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* Place the objects you want to leave in world space inside ``World Constraint`` -\u003e ``Container``.\n  * Alternatively you can constrain the objects to ``Container``.\n* Disable the ``Container`` parent constraint component to leave it in world space, and enable it to reset the ``Container`` to ``Reset Target``.\n\n## Additional notes\n\n* By default, the Container and its contents will not scale with your avatar. If you want the Container and its contents to scale with your avatar, add a Scale Constraint to the ``Container`` object, set your avatar as the source, and activate it.\n* If your Reset Target is directly under your avatar, it won't properly rotate with you in full body.\n\n## Performance stats\n\n```c++\nConstraints:        3\nConstraint Depth:   3\n```\n\n## Hierarchy layout\n\n```html\nWorld Constraint\n|-Container\n|  |-Cube\n|-Reset Target\n```\n\n## Contributors\n\n* [lin](https://github.com/oofdesu)\n\n## License\n\nWorld Constraint is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/World-Constraint/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%2Fworld-constraint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvrlabs%2Fworld-constraint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrlabs%2Fworld-constraint/lists"}