From e3dff54b7826019861b31af1b02cefbc9f436314 Mon Sep 17 00:00:00 2001 From: Daniel Wolf Date: Sun, 23 Jun 2019 21:56:43 +0200 Subject: [PATCH] Improve documentation for extras --- extras/AdobeAfterEffects/README.adoc | 2 +- extras/EsotericSoftwareSpine/README.adoc | 2 +- extras/MagixVegas/README.adoc | 17 ++++++++++++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/extras/AdobeAfterEffects/README.adoc b/extras/AdobeAfterEffects/README.adoc index 1cf1c62..f25a144 100644 --- a/extras/AdobeAfterEffects/README.adoc +++ b/extras/AdobeAfterEffects/README.adoc @@ -6,7 +6,7 @@ The script in this directory generates After Effects compositions with mouth ani === 1. Download and extract -Download the archive file containing Rhubarb Lip-Sync, then extract in a directory on your computer. +Download the archive file containing Rhubarb Lip Sync, then extract in a directory on your computer. === 2. Make Rhubarb available to After Effects diff --git a/extras/EsotericSoftwareSpine/README.adoc b/extras/EsotericSoftwareSpine/README.adoc index 9154300..080012c 100644 --- a/extras/EsotericSoftwareSpine/README.adoc +++ b/extras/EsotericSoftwareSpine/README.adoc @@ -8,7 +8,7 @@ image:../../img/spine.png[image] https://github.com/DanielSWolf/rhubarb-lip-sync/releases[Download Rhubarb Lip Sync] for your platform, then extract the archive file in a directory on your computer. You’ll find Rhubarb Lip Sync for Spine in the directory `extras/EsotericSoftwareSpine`. -To create lip sync animation, you’ll need Spine 3.7 or better. As of this writing, Spine 3.7 is still in beta stage. To get the beta version, go to _Spine_ | _Settings…_, then check ``Beta updates''. +To create lip sync animation, you’ll need Spine 3.7 or better. == Preparing your Spine project diff --git a/extras/MagixVegas/README.adoc b/extras/MagixVegas/README.adoc index b378cea..0edb4c3 100644 --- a/extras/MagixVegas/README.adoc +++ b/extras/MagixVegas/README.adoc @@ -2,7 +2,22 @@ If you own a copy of http://www.vegascreativesoftware.com/[Magix Vegas] (previously Sony Vegas), you can use this script to visualize Rhubarb Lip Sync’s output on the timeline. This can be useful for creating lip-synced videos or for debugging. +== Installation + Copy (or symlink) the files in this directory to `\Script Menu`. When you restart Vegas, you’ll find two new menu items: * _Tools > Scripting > Import Rhubarb:_ This will create a new Vegas project and add two tracks: a video track with a visualization of Rhubarb Lip Sync’s output and an audio track with the original recording. -* _Tools > Scripting > Debug Rhubarb:_ This will create markers or regions on the timeline visualizing Rhubarb Lip Sync’s internal data from a log file. You can obtain a log file by redirecting `stdout`. I’ve written this script mainly as a debugging aid for myself; feel free to contact me if you’re interested and need a more thorough explanation. +* _Tools > Scripting > Debug Rhubarb:_ This will create markers or regions on the timeline visualizing Rhubarb Lip Sync’s internal data from a log file. You can obtain a log file by redirecting `+stdout+`. I’ve written this script mainly as a debugging aid for myself; feel free to contact me if you’re interested and need a more thorough explanation. + +== How to perform lip sync + +You cannot perform lip sync directly from the Vegas scripts. Instead, run Rhubarb Lip Sync from the command line, specifying the XML output format. + +== How to create an animation + +Select _Tools > Scripting > Import Rhubarb_. Fill in at least the following fields: + +* One image file: You need a set of image files, one for each mouth shapes. All image files should have the same size and should end with "`-`", for instance _alison-a.png_, _alison-b.png_, and so on. Click the "`...`" button at the right of this field and select one of these image files. The script will automatically find the other image files. +* XML file: Click the "`...`" button at the right of this field and select the XML file created by Rhubarb Lip Sync. + +Click _OK_ to create the animation. \ No newline at end of file