VRChat Avatar Dynamics Nut Button

This Nut Button uses Avatar Dynamics for picking it up, placing it in the world, and so that you and your friends can press the button! The prefab comes with a drag-and-drop Nut Button that is easy, quick, and simple to set up on your avatar and be pressing in no time in-game!

Disclaimer: This prefab is not quest-compatible.

If you have any issues with the prefab please contact me on discord (Wolfy#2727) and let me know so I can help you or fix the bug ASAP!

Version updates at the bottom of the page.

Nut Button Stats:

Triangles: 1,596

Materials: 1

Audio Sources: 1

Senders: 1

Receivers: 3

Memory (Parameter) Allocation: 3 Bits

Set-Up:

NOTE: This prefab works with Write Defaults On or Off, but they are defaulted to On so you will have to turn them Off in the animator if your avatar uses Write Defaults Off.

Import "Nut Button Prefab" into your project.

Drag and drop the "Nut Button" prefab located under "Assets/Wolfy_527/Nut Button" onto your avatar base, right-click it, then click "Unpack Completely."

Open up the "Nut Button" game object in your hierarchy and navigate to the "PLACE THESE ON AVATAR" game object and drag and drop the "Hand Constraint" and "Holster Constraint" game objects to their respective locations on your avatar's armature. Note: The "Holster Constraint" game object can be placed wherever you wish, but the "Hand Constraint" game object must go on the Hand on your avatar's armature.

Once you have placed the constraints, zero out their positions in the transform.

Next, open up the "Nut Button" game object and then the "Nut Button Container" game object and click on the "Nut Button" game object that is a child of "Nut Button Container" and turn it on.

We'll want to check the parent constraint locations. With the nut button still on, click on the "Holster Constraint" game object and move/rotate it around to get your desired location/look of the nut button when holstered.

You'll want to check that the nut button's scale is to your liking for your avatar, if not, press "R" with the nut button selected and scale it evenly in all directions to fit your avatar's size.

Click on the "Nut Button Container" game object and change the weight of the "Holster Constraint" game object to zero and the "Hand Constraint" game object to one and then adjust the "Hand Constraint" game object's position and rotation to your liking in your hand. Make sure to change the weight of the "Holster Constraint" game object back to one and the "Hand Constraint" game object back to zero when you are finished adjusting things.

Click on the "Nut Button" game object just under the "Nut Button Container" game object and turn off the "Nut Button" game object.

You will want Avatars 3.0 Manager from the VRLabs Github page to merge your FX layer with the nut button FX layer. With Avatars 3.0 Manager installed you will navigate through the top bar through "VRLabs" --> "Avatars 3.0 Manager" and with that screen opened you will drag and drop your avatar's base from the hierarchy into the "Avatar" slot in the AV3 Manager window.

Open up "FX" in the AV3 Manager window and scroll down to "Add Animator to Merge" and click it. Click the circle on the right of the "Controller" option in the AV3 Manager window and find "RH NutButton FX" or "LH NutButton FX" (or the quest-friendly gesture controls FX controllers) depending on which hand you are using and you set up your constraints for.

Click "Merge On Current" to have it merge your current FX with the nut button's FX.

Now we will want to make sure the networked parameters are in your avatar's expression parameter list. Click on the checkboxes to the right of "NutButton/Net/Toggle" and "NutButton/Net/Grabbed" and "NutButton/Net/Holstered". Click on the "Parameters" tab in the top left of Avatars 3.0 Manager and then make sure that the checkboxes to the right of "NutButton/Net/Toggle" and "NutButton/Net/Grabbed" and "NutButton/Net/Holstered" are checked there as well.

The next step is in the WD tab on Avatars 3.0 Manager. If there is a yellow warning at the top that is indicating that you are using mixed write defaults then you need to select "Set WD Off" or "Set WD On" based on what your avatar is using before importing the nut button. You can check this by going into a few different layers in your FX controller and selecting different states and looking if "Write Defaults" is checked on them. If it isn't checked, then you're likely using Write Defaults Off and you want to select "Set WD Off," if you saw "Write Defaults" checked, but you're still seeing the warning, then there are likely a few states in your FX that accidentally had "Write Defaults" unchecked. Select "Set WD On" and you should be set!

The last step is to set up the menu toggle! Just select your avatar expressions menu and click "Add Control" in the menu you want your nut button toggle to be in! Name it "Nut Button" and change the type from "Button" to "Toggle" and make sure you use the "NutButton/Net/Toggle" parameter in the parameter slot at the bottom of the toggle.

License:

Do not resell or claim ownership of this content, even if modified in any form.

Do not distribute to anyone in any form, except as described below.

This content may be shared between two parties only if both parties have gained access to this content legitimately.

The only other acceptable form of distribution of this content is via avatars or worlds publicly or privately uploaded to VRChat.com. Users viewing the content uploaded to VRChat.com must not be able to access the original source files.

If you wish to use this content in a manner not allowed by this license, please contact the author.

Commercial License:

Do not claim ownership of this content, even if modified in any form.

You are permitted to include the content in prefabs or packages you are selling so long as you are not directly reselling this prefab exclusively.

When including this prefab on avatar packages being sold commercially you must remove any files that do not directly prevent the prefab from working on the avatar itself. (I.e. you must remove the prefab itself and FX layers that came with it once merged with and set up on the avatar being sold).

Provide credit to the original creator via link to gumroad and booth pages.