Skip to main content

Getting Started

Thank you for purchasing or taking an interest in the the ValueFactory Fast Voxel shader! The documentation here lays out the various aspects of this shader.

The documentation here is meant for Fast Voxel Shader version v1.0.0.0.

This shader is meant for VRChat but it might work on other platforms. No support is guaranteed however.

Supported Unity versions:

  • 2022.3.22f1
  • 2019.4.31f1

For the best experience, we recommend 2022.3.22f1.

A video is available for the start-to-end process of setting this shader up on your avatar:

Or follow along the documentation as we'll lay out the initial steps for starting to use this shader from scratch:

Preparation​

Purchase​

The fast voxel shader can be purchased here

Downloading​

Once you have purchased the shader, you can download it from your Gumroad or Lemonsqueezy library.

An email will also be delivered to the email used in the purchase. You can find the download link and license key there.

Importing the package​

Open the Unity project with your avatar and import the fast voxel shader unitypackage that you downloaded.

info

Make sure there are no script errors in your project! If Unity tells you that compilation errors must be fixed before entering play mode, or if the voxel shader UI isn't showing up, you have script errors.

These need to be fixed for the voxel shader (and most other shaders) to work properly. They are fixed on a case per case basis but usually boil down to:

  • Having an out of date tool installed.
  • Having two or more of the same tool installed.
  • Installing a old version of a tool while already having a newer version installed.

License Activation​

Once the voxel shader package has been imported, you will be prompted to verify your purchase.

The license key that's included in your Gumroad & Lemonsqueezy project will need to be provided here.

Using the Shader​

Converting your avatar​

A easy way to get started is to use the auto-convert utility. The utility doesn't always copy your avatar material 1:1, so some manual tweaking will be required!

warning

This utility will not take into account VRCFury material swaps or animation clip swaps. Those need to be handled manually.

  1. Make a duplicate of your avatar by clicking on it and pressing CTRL+D. Hide the old version or move it off to the side.
  2. Right-click on the new avatar and select ValueFactory/Fast Voxel Shader/Convert to Fast Voxel Shader. This will open a new window which will let you prepare your avatar for conversion.
  3. Decide how the materials will be converted.
  • Skip - the material will not be touched.
  • Convert - a new voxel material will be created and we'll try to convert the existing material settings into the voxel shader settings.
  • Hide - the material will be hidden using the included Hide Material utility shader.
  1. Click Convert and pick a folder to save your new voxel materials into.
  • This will also calculate the scaling factor for the new voxel materials!
  1. Tweak the newly created voxel materials. The utility cannot handle all possible shader configurations so some manual tweaking will be likely!

If you do not want to overwrite your usual avatar, detach the blueprint ID on the Pipeline Manager component on the avatar root object.

Creating a new voxel material​

You can right-click anywhere in your Project view and selecte Create/ValueFactory/Fast Voxel Material.

This will create a brand new voxel material for you to edit.

Scaling Factor​

If your avatar has a scale that isn't 1, you'll have to specify it in the voxel materials of your avatar.

If you used the conversion utility, the materials will have the scaling factor already applied.

More information about scaling can be found here

Customizing it​

Now you get to make changes to the material. The most important step is to set up your base color. Just simply drag the "base color" or "albedo" texture of your avatar into the base color slot.

Afterward, you can drag the material on a part of your avatar.

You may need to have multiple voxel materials for different parts of your avatar, either to change the base color or to change various other different options of the material.

But that's about it! You can now go ahead and mess around with the voxel shader and customize it to your liking.

The rest of the documentation here explains every other feature of the voxel shader so we recommend browsing around.