SALSA LipSync with Text-To-Lipsync (SalsaTextSync)

Overview

Our SalsaTextSync addon has been updated for SALSA LipSync v2 for realtime text-to-lipsync! This add-on allows for implementing a simulated lipsync playback for standard text -- no audio. It fills a niche where designers wish to have some animation on-screen while text dialog is being presented. Again, this add-on does not perform text-to-speech (TTS) output. If you wish to implement TTS, please see RT-Voice by Crosstales.

Support

We (Crazy Minnow Studio) are happy to provide SALSA LipSync Suite-related support. However, we do not provide support for third-party assets. If you have problems getting the third-party asset working, please contact the asset's publisher for assistance.

NOTE: Please remember, the source is included for this free add-on and this should be considered example code that you can use to jump-start your project. It is not intended to fit all scenarios or requirements -- you are free to update it as necessary for your needs. We do provide limited support for all of our products; however, we do not make development changes to support specific project needs.

For SALSA LipSync Suite-related support, please email (assetsupport@crazyminnow.com) the following information:

  • Invoice number (support will not be provided without a Unity Invoice Number).
  • Operating System and version.
  • SALSA Suite version.
  • Add-on version (generally located in an associated readme or the script header comment).
  • Full details of your issue (steps to recreate the problem), including any error messages.
  • Full, expanded component screenshots (or video).
  • Full, expanded, associated hierarchy screenshots (or video).
  • Super helpful: video capture of issue in action if appropriate.

Requirements for This Example Implementation Tutorial

ATTENTION: These instructions require you to download and install the appropriate assets and/or add-on scripts into your Unity project. If you skip this step, you will not find the applicable option in the menu and/or component library.

NOTE: While every attempt has been made to ensure the safe content and operation of these files, they are provided as-is, without warranty or guarantee of any kind. By downloading and using these files you are accepting any and all risks associated and release Crazy Minnow Studio, LLC of any and all liability.

Installation Instructions

NOTE: For information on how to import/install Unity AssetStore packages or unitypackage files, please read the Unity documentation.

  1. Import SALSA LipSync into your project and please familiarize yourself with SALSA using the online documentation for SALSA LipSync.

  2. Import this SALSA LipSync v2 add-on: SalsaTextSync and familiarize yourself with these instructions.

NOTE: While every attempt has been made to ensure the safe content and operation of these files, they are provided as-is, without warranty or guarantee of any kind. By downloading and using these files you are accepting any and all risks associated and release Crazy Minnow Studio, LLC of any and all liability.

Usage Instructions

  • Setup your SALSA-enabled character as you normally would.
  • Add the SalsaTextSync component to your SALSA-enabled character.
  • Enable the "Use preferred SALSA Settings" option (recommended).
  • If SALSA is not on this GameObject, ensure a link to your SALSA component is supplied in the SALSA LipSync slot.
  • Set the desired words-per-minute rate.
  • Enter some text in the "Say" block.
    textsync-editor
  • Run the scene and press the "Say" button in the SalsaTextSync component. NOTE: the "Say" and "Stop" buttons appear only when in runtime mode.
    textsync-runtime
  • Alternatively, programatically pass dialogue text to the SalsaTextSync.Say method (see API below).

API Information

Methods

void SetPreferredSalsaSettings()

Configures recommended SALSA settings. This is not required if you have enabled this option in the Editor.

void Say(string text)

Passing a string to this function will perform a text-to-lipsync action and your configured-character-model will perform simulated lipsync to the supplied string text.

void Stop()

Calling this function will stop a running, simulated text-to-lipsync action.

Troubleshooting and Operational Notes:

  • No known issues.

Release Notes:

NOTE: While every attempt has been made to ensure the safe content and operation of these files, they are provided as-is, without warranty or guarantee of any kind. By downloading and using these files you are accepting any and all risks associated and release Crazy Minnow Studio, LLC of any and all liability.

v2.0.0 - (2019-06-21):

+ Initial release for SALSA LipSync v2