Skip to content

Repository files navigation

Typography

A shader suite for rendering and animating text, images, and particles on VRChat avatars. Its material properties can be driven by Animator, with no runtime C# scripts.

Unity 2022.3+ License: MIT

Documentation | Releases | Changelog

Included shaders

Shader Purpose
Typography Renders and animates up to 32 layers of text using generated font atlases and meshes.
Imagery Renders and animates up to 32 image layers.
Particler Renders GPU particles with controls modeled after After Effects CC Particle World.

Requirements

  • Unity 2022.3 LTS or later
  • Built-in Render Pipeline (URP and HDRP are not supported)
  • Thry Editor
  • PC and PC VR; Quest standalone is not supported

Generating Typography font atlases and meshes requires the Unity Editor on Windows. Generated materials can be displayed without running the generator.

Installation

  1. Install Thry Editor.
  2. Download the latest unitypackage from Releases and import it into your Unity project.
  3. Duplicate the sample material you want to use from Prefab/:
    • GekikaraStore_Typography.mat
    • GekikaraStore_Imagery.mat
    • GekikaraStore_Particler.mat

Getting started

Use a dedicated GameObject with a MeshFilter and MeshRenderer for each material.

  • Typography: Add a font to Fonts, enter text in a layer, click Gen, and enable the layer.
  • Imagery: Assign Imagery_Mesh.asset, select an image, and enable the layer.
  • Particler: Assign Particler_Mesh.asset, then enable and adjust its Emission, Producer, Physics, and Particle groups.

See the documentation for setup, animation, effects, updates, and troubleshooting.

License

Typography's original code is licensed under the MIT License. Notices for bundled third-party components are provided in THIRD-PARTY-LICENSES.md.

About

High-performance GPU text rendering Shader for Unity/VRChat.

Topics

Resources

Stars

64 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages