https://github.com/vrlabs/follower

A constraint-based follower.
https://github.com/vrlabs/follower

Last synced: 12 months ago
JSON representation

A constraint-based follower.

• Host: GitHub
• URL: https://github.com/vrlabs/follower
• Owner: VRLabs
• License: mit
• Created: 2021-11-17T17:09:42.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-04T20:40:25.000Z (over 1 year ago)
• Last Synced: 2025-04-05T20:35:15.758Z (about 1 year ago)
• Language: C#
• Homepage:
• Size: 27.4 MB
• Stars: 41
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Follower

[![Generic badge](https://img.shields.io/github/downloads/VRLabs/Follower/total?label=Downloads)](https://github.com/VRLabs/Follower/releases/latest)

[![Generic badge](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/VRLabs/Follower/blob/main/LICENSE)

[![Generic badge](https://img.shields.io/badge/Quest-Compatible-green?logo=Meta)](https://img.shields.io/badge/Quest-Compatible-green?logo=Meta)

[![Generic badge](https://img.shields.io/badge/Unity-2022.3.22f1-lightblue?logo=Unity)](https://unity.com/releases/editor/whats-new/2022.3.22)

[![Generic badge](https://img.shields.io/badge/SDK-AvatarSDK3-lightblue.svg)](https://vrchat.com/home/download)

[![Generic badge](https://img.shields.io/discord/706913824607043605?color=%237289da&label=DISCORD&logo=Discord&style=for-the-badge)](https://discord.vrlabs.dev/)

[![Generic badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dvrlabs%26type%3Dpatrons&style=for-the-badge)](https://patreon.vrlabs.dev/)

Make something slowly follow you and look at you

![Follower](https://github.com/VRLabs/Follower/assets/76777936/f36a5cf9-8ac2-4a18-bae8-4d13e9a9c2ac)

### ⬇️ [Download Latest Version](https://github.com/VRLabs/Follower/releases/latest)

### 📦 [Add to VRChat Creator Companion](https://vrlabs.dev/packages?package=dev.vrlabs.follower)



---

## How it works

* Using a [Damping Constraint](https://github.com/VRLabs/Damping-Constraints) inside of a [World Constraint](https://github.com/VRLabs/World-Constraint) we can make an object slowly follow the player.

* By using Contact Senders and Contact Receivers we can dynamically change the speed of the follower over time.

## Install guide

https://github.com/VRLabs/Follower/assets/76777936/eee1dcbb-0e9d-4f92-bb69-9bcbe50d9948

* Merge the Animator Controller ``Follower FX`` to your own FX Controller, using the [Avatars 3.0 Manager](https://github.com/VRLabs/Avatars-3.0-Manager) tool.

* Drag & Drop the ``Follower`` prefab into the base of your Hierarchy.

* Right click and unpack the prefab, then drag & drop it onto your avatar.

* Expand the prefab hierarchy and find ``Follower Target``.

* Move ``Follower Target`` outside of ``Follower`` and place it anywhere in your avatars hierarchy as needed.

> [!NOTE]  

> When building for Quest, you will have to remove unsupported components and shaders

## How to use

* Place the objects you want to follow you inside ``Container``.

  * Alternatively you can constrain the objects to ``Container``.

* Editing the ``Follow`` animation clip will let you change the speed of the follower.

## Performance stats

```c++

Constraints:        3

Constraint Depth:   3

Contact Receivers:  1

Contact Senders:    1

```

## Hierarchy layout

```html

Follower

|-Container

|  |-Cube

|-Look Constraint

|-Follower Target

|  |-Look Target

```

## Contributors

* [lin](https://github.com/oofdesu)

## License

Follower is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/Follower/blob/main/LICENSE).

​



[](https://vrlabs.dev "VRLabs")



[](https://discord.vrlabs.dev/ "VRLabs")



[](https://patreon.vrlabs.dev/ "VRLabs")



[](https://twitter.com/vrlabsdev "VRLabs")