https://github.com/vrlabs/rigidbody-throw
System for letting you throw physics objects
https://github.com/vrlabs/rigidbody-throw
Last synced: 8 months ago
JSON representation
System for letting you throw physics objects
- Host: GitHub
- URL: https://github.com/vrlabs/rigidbody-throw
- Owner: VRLabs
- License: mit
- Created: 2023-07-06T21:45:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T13:47:39.000Z (over 1 year ago)
- Last Synced: 2025-04-05T20:35:16.431Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 8 MB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rigidbody Throw
[](https://github.com/VRLabs/Rigidbody-Throw/releases/latest)
[](https://github.com/VRLabs/Rigidbody-Throw/blob/main/LICENSE)
[](https://img.shields.io/badge/Quest-Incompatible-red?logo=Meta)
[](https://unity.com/releases/editor/whats-new/2022.3.22)
[](https://vrchat.com/home/download)
[](https://discord.vrlabs.dev/)
[](https://patreon.vrlabs.dev/)
Throw an object with collision against the world
### ⬇️ [Download Latest Version](https://github.com/VRLabs/Rigidbody-Throw/releases/latest)
### 📦 [Add to VRChat Creator Companion](https://vrlabs.dev/packages?package=dev.vrlabs.rigidbody-throw)
---
## How it works
* A particle system is parented to the throw target, which emits particles as it moves.
* When the system is enabled, these particles hit the Force Collider, which adds force to the Rigidbody.
* This Rigidbody then flies forward as if thrown, and collides with the world using the Collision Collider.
* Meanwhile, Contact Senders and Receivers, in combination with Constraints, are used to figure out the position of the thrown object, and this is synced to the remote client (since parameter force is local only).
* This remote sync is not incredibly accurate to not spend too many bits on it: 25m from where you throw, with 0.2m precision, so landing location might differ slightly between local and remote.
* If you want rotation sync, install the components from the Rotation-Synced directory.
## Install guide
https://github.com/VRLabs/Rigidbody-Throw/assets/76777936/57fbfe66-ddfd-4b0c-b168-e739ffc0a1ef
* Merge the Animator Controller ``Rigidbody Throw FX`` to your own FX Controller, using the [Avatars 3.0 Manager](https://github.com/VRLabs/Avatars-3.0-Manager) tool.
* Merge the Expression Parameter List ``Rigidbody Throw Parameters`` to your own Expression Parameter List, using the [Avatars 3.0 Manager](https://github.com/VRLabs/Avatars-3.0-Manager) tool.
* Drag & drop the ``Rigidbody Throw`` prefab into the base of your Hierarchy.
* Right click and unpack the prefab, then drag & drop it onto your avatar.
* Move ``Throw Target`` outside of ``Rigidbody Throw/Throw`` and place it anywhere in your avatar's hierarchy. Adjust the transforms as needed.
## How to use
* Place the objects you want to to use inside ``Rigidbody Throw`` -> ``Throw`` -> ``Container``.
* Alternatively you can constrain the objects to ``Container``.
* Your right hand gesture must be 2 (HandOpen) for the system to release, and 1 (Fist) to reset.
* To change the friction and the bounciness, change the parameters on the ``Resources/Physics Material`` Physics Material and apply that Physics Material to your Collision Collider.
* To have a custom throwing/reset condition, change the ``GestureRight Equals 1 or 2`` conditions in the ``Rigidbody Throw Main`` layer.
* To change world collision, only use Colliders on the `Collision Collider` object. This can be a Box Collider, Sphere Collider, Capsule Collider, but it has to be on the `Collision Collider` object.
## Performance stats
Default version:
```c++
Colliders: 2
Constraints: 10
Constraint Depth: 7
Contact Receivers: 4
Contact Senders: 2
FX Animator Layers: 4
Particle Systems: 2
Rigidbodies: 2
Joints: 1
Expression Parameters: 27
```
Rotation synced version:
```c++
Colliders: 2
Constraints: 14
Constraint Depth: 8
Contact Receivers: 4
Contact Senders: 2
FX Animator Layers: 4
Particle Systems: 2
PhysBones: 6
PhysBone Colliders: 3
Rigidbodies: 2
Joints: 1
Expression Parameters: 51
```
## Hierarchy layout
Default version:
```html
Rigidbody Throw
|-Throw
| |-Throw Target
| |-Force Particle
| |-Container
| | |-Colliders
| | | |-Force Collider
| | | |-Colission Collider
| | | |-Collision Detection
| | |-Example Sphere
| |-Quick Position Sync
| | |-Position Sync
| | | |-Contacts
| | | | |-Sender
| | | | |-Receiver X
| | | | |-Receiver Y
| | | | |-Receiver Z
| | | |-Local Target
| | | |-Remote Target
```
Rotation synced version:
```html
Rigidbody Throw
|-Throw
| |-Throw Target
| |-Force Particle
| |-Container
| | |-Colliders
| | | |-Force Collider
| | | |-Colission Collider
| | | |-Collision Detection
| | |-Example Cube
| |-Quick Position Sync
| | |-Position Sync
| | | |-Contacts
| | | | |-Sender
| | | | |-Receiver X
| | | | |-Receiver Y
| | | | |-Receiver Z
| | | |-Local Target
| | | |-Remote Target
| | |-Rotation Sync
| | | |-Measure Bones
| | | | |-Measure X Magnitude
| | | | |-Measure X Sign
| | | | |-Measure Y Magnitude
| | | | |-Measure Y Sign
| | | | |-Measure Z Magnitude
| | | | |-Measure Z Sign
| | | |-Measure Planes
| | | | |-X Angle Plane
| | | | |-Y Angle Plane
| | | | |-Z Angle Plane
```
## Contributors
* [hfcred](https://github.com/hfcred)
* [jellejurre](https://github.com/jellejurre)
* [jetees](https://github.com/jetees)
* [JustSleightly](https://links.sleightly.dev)
* [Liindy](https://liindy.gumroad.com/)
## License
Rigidbody Throw is available as-is under MIT. For more information see [LICENSE](https://github.com/VRLabs/Rigidbody-Throw/blob/main/LICENSE).
[
](https://vrlabs.dev "VRLabs")
[
](https://discord.vrlabs.dev/ "VRLabs")
[
](https://patreon.vrlabs.dev/ "VRLabs")
[
](https://twitter.com/vrlabsdev "VRLabs")