Skip to main content

Installation and Usage

Adding the Asset to your project

Before you start, make sure you have Poiyomi Shader and VRCFury (creator companion) added to your project.
This asset was created with Poiyomi 9.2. Older and newer versions should work as well.

Add the prefab

Add the asset to your project by dragging the "Advent Wreath vx.x.xx.xx" from your downloads into the Project window and clicking Import.

Step 1Step 2

Add to Avatar

After adding the package, the asset will be located under
Assets->Kokos->AvatarAssets->Advent Wreath.

You can now drag and drop either the Wreath_Snow or the Wreath prefab directly onto your avatar. The difference between the two is that the second version only has one PhysBone component (candle flames do not move), two instead of three materials and the snow particles are missing. The rest is identical to the full version.

Image

Position the Wreath

Inside the prefab hierarchy, you can find a GameObject called Advent wreath. Position and scale this object to fit your avatar.

Image

Position the Snow Effect (only in "Wreath_Snow" prefab version)

Inside the prefab hierarchy, you can find a GameObject called Snow. Position this object above your avatar´s head.

Positioning

Be carefull not to place it too high, or the snow won´t reach the ground before despawning (you can adjust the particle lifetime in the particle settings though).

Colliders

Also be carefull with ceilings in certain worlds. If a ceiling is between your avatar and the particle system and this ceiling has collision, the particles will land on the ceiling so you won´t see them.

Change Menu Location

Should you want to place the asset's menu somewhere else (e.g., inside another submenu), you can do so by clicking on the prefab you are using in the file browser and then looking at the VRCFury Full Controller component.
In the menu section, simply enter the name of the menu you want the Wreath to be part of, which will be added as a submenu.
For example, if you want to have the menu placed inside your Extras menu, simply type the display name of your menu here.

Image

Usage

Enable the wreath, set the color and number of burning candles (one candle is fully lit every 25% in the radial menu). If necessary, adjust the flame brightness.
For the extra flair, enable the snow particles.

Image

That´s it.
Feel free to make changes, expand and adapt this asset to fit your needs.
If you encounter bugs, missing features, or run into troubles, feel free to reach out.