Voxel Maker Manual

Overview:

The Voxel Maker is an advanced script designed to convert 2D sprite renderers into 3D voxel meshes.

Quick Start:

Add the SpriteVoxelMaker script: Ensure that the GameObject to which you're attaching the script already has a SpriteRenderer component. Simply add the SpriteVoxelMaker to the GameObject by dragging it from your project assets or by using the 'Add Component' button in the inspector.
Set Depth: In the Inspector panel, locate the new SpriteVoxelMaker component. There, you will find the Depth field. Enter the desired thickness value for the voxel mesh in this field.
Configure SpriteRenderer: Configure your sprite renderer's properties as desired. These settings (including the sprite itself, its color, and flip settings) will be automatically applied to the voxel mesh.

That's it! You've set up the SpriteVoxelMaker script for your GameObject. The script will now automatically convert your 2D sprite into a 3D voxel mesh based on your SpriteRenderer settings and the Depth value you've provided.

Configuration

This script offers several configuration options:

Depth

The only field in the API is Depth, which sets the thickness of the voxel mesh. You can adjust this value according to your needs.

Sprite Renderer Options

Color: The color set on the sprite renderer will be applied to the voxel mesh.
Sprite: Changes to the sprite renderer's sprite will be applied to the voxel mesh.
FlipX and FlipY: Flip actions on the sprite renderer will also be applied to the voxel mesh.

Shaders

Default sprite shader: If this shader is used for the sprite, the voxel mesh renderer will use the standard Unity material with full emission.
Sprite/Diffuse shader: If this shader is used for the sprite, the voxel mesh will use the standard Unity material.
Custom shader: If any other shader is used for the sprite, the voxel mesh will use that shader.

Mesh Cache Capacity

All generated meshes are cached and reused to minimize resource usage. This is especially useful when you have many prefabs or identical sprites in a scene, as it avoids the cost of additional generation.

By default, the cache can hold up to 50 meshes. You can adjust this value according to your needs by changing the SpriteVoxelMaker.MeshCacheCapacity property from your code.

Once you have set up the SpriteVoxelMaker script on your GameObject, you can disable the SpriteRenderer component if desired. Disabling the SpriteRenderer will not affect the functionality of the voxel mesh conversion and can potentially improve performance by reducing unnecessary rendering overhead.

Happy voxelizing!

Voxel Maker

Transform your flat 2D sprites into vibrant 3D voxel art!

Voxel Maker

Bring Your 2D Sprites To Life In 3D!

Damage Flash

TextMesh Pro Effect

Fire Effect