Skip to main content

Lemon Tea v1.0 Instructions

Installation Instructions

Dependencies

This gimmick depends on the following packages. Make sure you have installed them before you install this gimmick.

Dependencies end

Importing Unity Package

Drag Lemon Tea.unitypackage into Project window, click the Import button on the dialog to import the package to your avatar project:

Import

Importing Unity Package end

Installing Lemon Tea

1. Add Prefab to Scene

This gimmick contains:

  • Normal Edition Which can show/hide with action menu toggle.
  • Squeezable While Holding Fist Edition Which... is squeezable while holding fist...

And left-handed editions, 4 editions in total.

The prefab names for each editions:

  • Normal Edition: Lemon_Tea_MA.prefab
  • Squeezable Edition: Lemon_Tea_Squeeze_MA.prefab
  • Normal Edition (Left-handed): Lemon_Tea_Left_Handed_MA.prefab
  • Squeezable Edition (Left-handed): Lemon_Tea_Left_Handed_Squeeze_MA.prefab

This instruction will use the squeezable edition as an example.

Drag Assets/LuiStudio/Lemon Tea/Lemon_Tea_Squeeze_MA.prefab (Or prefab of other editions) from project window into your avatar locates in hierarchy, it should looks like this after the drag:

Prefab

2. Reposition

1. Asign the Animator Controller for your Avatar
Attention

This step is for adjusting both lemon tea's position and the gesture holding lemon tea, when in animation preview.

This step is temporary. Although VRChat will ignore the controller inside your avatar's animator, please revert the controller after the whole installation if you can.

The Animator Controller names for each edition:

  • Normal Edition: LemonTeaAnimatorGesture
  • Squeezable Edition: LemonTeaSqueezeAnimatorGesture
  • Normal Edition (Left-handed): LemonTeaLeftHandedAnimatorGesture
  • Squeezable Edition (Left-handed): LemonTeaLeftHandedSqueezeAnimatorGesture

Head to Assets/LuiStudio/Lemon Tea/Animations/Controllers in project window, drag LemonTeaSqueezeAnimatorGesture[1] (Or animator controller of other editions) into your avatar's[2] (Sample_Avatar for example) Animator's Controller[3], you should see the result below after you've done it:

Gesture_Controller_Drag

2. Enable Animation Preview

Select your avatar[1] (Sample_Avatar for example) in Hierarchy, and click "Preview" in the animation window[2]. The scene[3] should looks like this after the step:

Attention

If you don't see the Animation Window, right click on the tab of the Project Window -> Add Tab -> Animation.

Animation_Preview

3. Reposition the Lemon Tea

Select Model/Lemon_Tea[1] in prefab located in Hierarchy, use the Move Tool, Rotate Tool and Scale Tool[2] to reposition the lemon tea:

Adjust_Position

Position the lemon tea until you're happy. Such as the image below:

Adjust_Position_Finished

4. Adjust the Gesture Holding Lemon Tea

After following the steps above, we might see fingers clipping into lemon tea carton, that looks cheap. We need to adjust the gesture to make our avatar "holding" the carton. Click on the first keyframe[1] in animation window, set the fingers' angles to make the hand visibly holding the carton:

Adjust_Gesture

Adjust the gesture until you're happy. Such as image below:

Adjust_Gesture_Finished

Attention

If you are not satisfying with the result. You can repeat Step 3 and Step 4 to find the best postiion and gesture.

5. Adjust the Gesture Squeezing Lemon Tea
Attention

If you choose to install normal editions, please skip and follow Disable Preview and Revert Animator Controller.

Select Model/Lemon Tea/Lemon_Tea[1] in prefab located in Hierarchy, set Skinned Mesh Renderer -> BlendShapes -> Squeeze to 100[2]:

Shape_Key_100

After that, the carton in the scene will be slightly squeezed:

Squeezed_Lemon_Tea

Copy and paste the first keyframe's data to the last keyframe: Select your avatar[1] in Hierarchy, click on the first keyframe[2] in animation window. Press Ctrl + C to copy the keyframe, set the timeline to 60[3] and hit Enter, then click on the last keyframe[4] of the animation and press Ctrl + V to paste the frame data. Adjust fingers' angles to make the hand visibly squeezing the carton:

Adjust_Gesture_Squeeze

Adjust the gesture until you're happy. Such as image below:

Adjust_Gesture_Squeeze_Finished

Select Model/Lemon Tea/Lemon_Tea[1] in prefab located in Hierarchy, and set Skinned Mesh Renderer -> BlendShapes -> Squeeze back to 0[2]:

Shape_Key_0

6. Disable Preview and Revert Animator Controller

Select your avatar[1] and disable preview[2] in animation window:

Animation_Cancel_Preview

(Optional) Select your avatar[1], revert the animator controller to previous[2] (None for example):

Gesture_Controller_Reset

7. (Optional) Hide the Lemon Tea

If you don't want the lemon tea to be visible in avatar preview in VRChat, please follow steps below:

Select Model/Lemon Tea[1] in prefab located in Hierarchy, and deactivate it[2] in Inspector:

Hide_Lemon_Tea

8. Reposition the Mouth Contact Receiver

This gimmick use Contact Sender and Contact Receiver to simulate the straw tracking the mouth (Without occupying DPS, SPS etc.). This step is for moving Contact Receiver to your avatar's mouth.

Select Receiver/Mouth[1] in prefab located in Hierarchy, use the Move Tool and Rotate Tool[2] to reposition the receiver:

Adjust_Mouth_Position

Move the receiver to avatar's mouth, as image below:

Adjust_Mouth_Position_Result

Well Done

You have done the installation, head to How to Use and try it in VRChat.

Installing end

How to Use

You've done the installation, it's time to try it out in VRChat.

Basic Usage

  • Open the Action Menu, find and toggle the Lemon Tea Switch to show / hide the lemon tea.
  • Move the carton toward your avatar's face, the straw will automatically aim to your mouth.

Squeezable Edition Usage

  • Make your hand fist to squeeze the carton.
How to Use end

Miscellaneous

Change the Switch Position in Action Menu

The switch is installed to the root menu by default, that's not friendly to avatars having many other gimmicks. You can change the position of the switch using Modular Avatar:

  • Select Menu/Lemon Tea under the added prefab.
  • Head to the Inspector, click on the Select Menu inside the MA Menu Installer component.
  • Select the submenu where you want to put in.
Miscellaneous end