ikaroon / tmp3d Goto Github PK

A small extension that makes 3D text with Unity's TextMeshPro possible. It uses raymarching and a geometry shader to work around the limitations of TMP at the moment

License: Other

C# 38.17% HLSL 42.06% ShaderLab 19.77%

extension shader textmeshpro unity unity3d 3d textmesh tmp volumetric

tmp3d's Introduction

Text Mesh Pro 3D

This is a small extension that makes 3D text with Unity's TextMeshPro possible. It uses raymarching and a geometry shader to work around the limitations of TMP at the moment.

Features

In Evaluation

Bevelled text¹
Full fledged freeform text using textures¹
Translucent, unlit shader
VR optimizations²

Compatibility

Graphics API	Built-in	HDRP	URP
DirectX 11	✔️ Compatible	✔️ Compatible	✔️ Compatible
DirectX 12	✔️ Compatible	✔️ Compatible	✔️ Compatible
Vulkan	✔️ Compatible	✔️ Compatible	✔️ Compatible
OpenGL Core	✔️ Compatible	⚠️ Invalid	✔️ Compatible
OpenGLES2³	❌ Incompatible	⚠️ Invalid	❌ Incompatible
OpenGLES3	✔️ Compatible	⚠️ Invalid	✔️ Compatible
Metal⁴	〰️ To Be Tested	〰️ To Be Tested	〰️ To Be Tested

If the shader doesn't work for a compatible combination try to reimport the shader file first! When the issue persists contact me!

Installation

Open the package manager in Unity from Window>Package Manager
Select the + dropdown button in the top-left corner of the package manager
Select Add package from git URL...
Enter https://github.com/Ikaroon/TMP3D.git as url and confirm

This method will always install the current state of the git. To get a released version head to the release page!

How to use

To understand how to setup a TextMeshPro for 3D you can check out the sample in the package. For downloading that follow these steps:

Open the package manager in Unity from Window>Package Manager
Select Text Mesh Pro 3D Support in the section Ikaroon
Expand Samples
Click Import next to Solid Text
Now open the scene from Assets/Samples/Text Mesh Pro 3D Support/<version>/Solid Text/Scenes/Sample_TMP3D

If you still need help, here are some steps how you setup a TextMeshPro for 3D. There are two ways of creating a TextMeshPro 3D.

The Automatic way:

Create a TextMeshPro in a scene from 3D Object>Text - TextMeshPro (3D)
Replace the FontAsset with another font
Click Create 3D Font Asset Variant if it's not a 3D font already (The button will be disabled otherwise)
You have now access to 3D text!

The Manual way:

Create a new FontAsset by using the Font Asset Creator from Window>Text Mesh Pro>Font Asset Creator
Expand the created Asset and select the Material
Change the Material's shader to TextMeshPro/3D/Unlit
Create a TextMeshPro in a scene from 3D Object>Text - TextMeshPro NOT from UI>Text - TextMeshPro this is not supported yet.
Add a TMP3D_Handler component from Script>Ikaroon.TMP3D>TMP3D_Handler
Apply the FontAsset to the TextMeshPro component
You have now access to 3D text!

Notice

Work on this project happens in my freetime and, therefore, I cannot promise if and when certain features are added. I am considering to open this up for contribution but for now you can manipulate the code as you please. This project is MIT licensed and may be used freely. (Check the license file for more information)

Bugs

When you find a bug you can create a bug report on Github! I will try to cover them as quickly as possible.

Donation

If this project helped you, you can treat me to a coffee if you want ☕

Contact

If you need support with this package please contact me: [email protected]

Tempering with the SDF values in the distance makes raymarching more difficult, I need to find a good way of evaluating the shortest distance. ↩ ↩²
I currently don't have access to any VR device and, therefore, cannot optimize for it right now. ↩
Support for OpenGLES2 is currently NOT planned. ↩
I currently don't have access to any Mac and, therefore, cannot test it for Metal right now. ↩

tmp3d's People

Contributors

Stargazers

Watchers

Forkers

avatarchik bmjoy alyfreym xiaokubuku jackfang theraindasheddust thetestgame u3d-resources

tmp3d's Issues

Solid, unlit shader (UI)

We need an unlit shader that can be used in the UI.

Remove unused shader properties and uniforms

At the moment the shader contains a lot of uniforms and properties that are copied over from TMP shaders. Most of which are not used.

Reduce usage of "if" in shader

At the moment the shader uses a lot of ifs. Given that they aren't recommended in shaders and should be used with caution they should be reduced if they cannot be eliminated.