You can read in this guide how to upgrade Text Animator from old versions to new ones. (If you’re searching for patch notes, read them here.)
I should not say this every time, but:
PLEASE ALWAYS BACKUP YOUR PROJECTS BEFORE UPDATING ANYTHING - REALLY - BACKUP YOUR PROJECTS
If your project’s older version falls in any of the following sections (eg. “1.2.4” or “1.2.6”) and also meets their conditions, please follow the relative instructions for each section.
Otherwise you can just import the new version in your project (or perform a “clean import” by deleting its folder before importing the new version).
Enjoy the new version!
To 1.3.0+, from 1.2.12 or earlier
From version 1.3.0, the plugin has introduced Disappearance Effects and also Assembly Definition Files.
Since it’s a substantial update which also changes the folders structure, you have to perform a clean install in order to prevent an erroneous import by the package manager.
In other words, you must delete the plugin folders, and then import it again.
No worries, you will not loose your custom effects and you will be able to use the plugin better than before.
P.S. Based on your project configuration, you might need to reference TextAnimator’s assembly in your project’s one.
To 1.2.9+, from 1.2.8 or earlier
Only if you have created custom effects via c#
From version 1.2.9, the way to create custom effects (via #C) has changed.
👍🏻 If you didn’t write any custom effect class via c#, you can update as usual and skip this part.
As you know, to create custom effects via c# you previously had to manually assign the classes to a script, and do it for every update.
Now TextAnimator will recognize custom effects (C#) automatically, and their creation is also way easier and faster.
- You can read the new guide here: Creating Custom Effects via C#.
- You can also read the newly created Scripting Api.
To 1.2.7+, from 1.2.6 or earlier
Only if you have created custom features/actions
From version 1.2.7 “features” are now called “actions” and their implementation API has been improved.
If you had created any custom action, please:
- Save a list of their IDs (so you can add them back later)
- Update TextAnimator (it’s suggested if you delete its folder and perform a clean install)
- Don’t worry about the errors
- If the “CustomFunctionalities.cs” and the “DefaultFeatures.cs” scripts are still in your projects, you can delete them
- Read here how to implement custom actions with the new API.
To 1.2.5+, from 1.2.4 or earlier
Only if you are using message events in your texts
What changes: Since version 1.2.5 events are case sensitive.
What to do: Please assure that the scripts that are listening to message events match the ones written in the text.
Example: If you had a message event with
<?camShake> but had a switch case for “
camshake”, it would now fail. Please turn the event lowercase, or the “switch” case sensitive.
👍🏻 If you have only lowercase events in your text, you can skip this section and you don’t need to do anything.
P.S. A suggestion to speed up the check: You can just assure that events in your texts are all lowercase. If they are, everything will work as it did before (since presumibely the “switch” cases in your scripts were lower case as well).
Only if you have imported the "Typewriter sounds" extra package
(i.e. your projects contains the “
TAnimSoundWriter” script) What changes: custom Editor Attributes have been moved to a different namespace. What to do: Import the now-updated extra package. (it basically replaces
Attributes.MinValue(0) in TAnimSoundWriter.cs)
That’s it, have fun with a newer version of TextAnimator!
I’m always available if you need more help with updating.