Installation & Setup
A quickstart guide to setting up LipSync Pro.
Last updated
A quickstart guide to setting up LipSync Pro.
Last updated
After downloading and importing LipSync from the Asset Store, the following directory structure will have been created in your project:
Make sure to read and follow the instructions in the text file before importing the LipSyncPro_1.XX UnityPackage. Once the import is complete, you will have a few other directories in your project:
You can safely delete the .UnityPackage now if you wish.
Since version 1.5, we have included a setup wizard to handle this setup process automatically. You can get to this wizard from the Window > Rogo Digital > LipSync Pro > AutoSync Setup Wizard menu, or from the AutoSync > Setup menu inside the Clip Editor. Once opened, you'll see a screen like the following:
The wizard should have auto-detected the correct version of the SoX audio-conversion application bundled with LipSync Pro based on your operating system. This and any other paths will be stored globally (not project-specific) so it's best to leave the relative path here.
Press the Continue button to move to the next step, where the wizard will check which AutoSync Modules you have installed. See the AutoSync documentation for more details on this system. We recommend installing the Montreal Forced Aligner Module for best results from AutoSync and compatibility with macOS. If this module isn't installed, you should see a button to download it on this page:
Clicking this button will cause the Extensions Window to open and start downloading the module. Wait for this to finish. When complete, the window should close and the setup wizard should now report that all recommended modules are installed.
If you're running the wizard on an existing project, this step may already be completed.
Clicking Continue now will take you to a settings screen for any modules installed. By default, if you only have the pre-installed modules and the downloaded Montreal Forced Aligner module, you'll only see settings for that module here. Again, any paths required should be auto-detected and relative to the project - if not, you may have to manually browse for the files.
Press "Finish" to save these settings. AutoSync is now set-up and ready to use. If you install other modules in the future, you can run this wizard again to set them up - not all modules will require this, and it won't disturb any existing settings you have unless you change them.
This step is optional.
If you are working with Git/SVN or some other source control system, and want the large Montreal Forced Aligner application files to be outside the project, you can manually configure this.
First, find the montreal-forced-aligner-win (or montreal-forced-aligner-mac on macOS) inside Rogo Digital/LipSync Pro/AutoSync/Editor/Modules/Montreal Forced Aligner and move it to whatever location outside the project you wish.
Next, open the Clip Editor and go to the AutoSync tab of the Settings page.
Assuming the MFA module has been installed, you should see an Application Path option under "Phoneme Detection/Montreal Forced Aligner (Phonemes)". This needs to point to the the MFA aligner application in its new location. Click the "Verify" button - this will turn the small circle next to the path red, so you can check that the new path is correct later. You can now either click the "Browse" button and find where you moved this file (bin/mfa_align.exe on Windows, or lib/align on macOS), or manually update the path to point to the new location.
Once done, make sure you click the "Verify" button to ensure the change is checked and applied! If done correctly, the red circle will turn green to indicate the module is set up.
