Skip to main content

TextMeshPro

TextMeshPro (TMP) is a replacement for Unitys existing text components. It makes use of Advanced Text Rendering techniques as well as custom shaders to create vast visual improvements over Unitys default text system, while also giving users access to many new tools for styling and texturing.

Installing TMP​

The TMP package is included with the Unity Editor so there is no installation requirement. However, you do need to add the TMP Essential Resources in order for it to work.

images-small

Including Resources​

TMP loads font settings via the Resources folder in Unity, and Luna's default export settings excludes this folder from builds. To include the Resources folder please tick the box next to "Resources" under the Export type section in the Basic Settings tab (Settings -> Basic).

images-medium

TMP Versions Supported in Luna​

Supported Versions

Unity VersionTMP Version
2019.4+2.0.0
2020.1+3.0.0 or 3.0.6
2020.3+3.0.6
2021.33.0.6

We do not currently support 2.1.0

As we do not support the default version of TMP, we have listed some workarounds to get the right TMP version with Luna:

Project in Unity 2018.4+ - Install 1.3.0​

Unity 2018.4 have been deprecated and no longer supported by Luna.
Install TMP for Unity 2018.4
  1. If you are using Unity 2018, navigate to the Package Manager window (Window → Package Manager). Find TextMeshPro and select it.
  2. From here change the version to install in the top right corner of the window and select "1.3.0".

images-medium

After this has been updated you are good to go!

Project in Unity 2019.4+ - Install 2.0.0​

  1. If you are using Unity 2019, you will need to modify the package manifest.json file.
  2. Open the manifest and find com.unity.textmeshpro and change the corrispondent number to 2.0.0.

images-small

After this has been updated you are good to go!

Project in Unity 2020.3+ and newer versions - Install 3.0.6​

  • With Unity 2020 you can use TMP version 3.0.0 or 3.0.6
  1. When the project has opened, navigate to the Package Manager window (Window → Package Manager). From here find TextMeshPro and open the drop down via clicking the arrow to the left (circled below).

images-medium

  1. To make sure you got the correct version of TMP you will need to modify the package manifest.json. Open the manifest and find com.unity.textmeshpro and change the corrispondent number to 3.0.6.

images-small

Once you save the file, your version will be correctly updated. You can double check if the changes have gone through in the Package Manager (image below).

images-small

Now you're all good to go!

Upgrading project to Unity 2020 and newer versions​

Note: Updating to a newer version of Unity can cause unforeseen problems in your project, it is recommended that you create a backup before doing this.

  1. To update your project to Unity 2020 first open Unity Hub and navigate to the project you wish to upgrade.

  2. Under the 'Unity Version' column select the drop-down arrow to the right of your project's version number, and select a Unity 2020 version you have installed.

    Note: The newer the Unity 2020 version, the more likely it is that it will contain new features that we do not yet support in Luna. Making use of such features will cause errors in your Unity Playworks Plugin build. Please keep this in mind when using Unity 2020 with Luna, or consider using previous versions of Unity.

images-medium

  1. After selecting your desired version, click confirm on the warning window that will pop up. Your project will update itself to the version selected and open.