From 745f601ef49a4eed574295cd61fc2121c6c3241b Mon Sep 17 00:00:00 2001 From: Daniel Wolf Date: Mon, 10 Jul 2017 20:47:37 +0200 Subject: [PATCH] Updated documentation --- README.adoc | 2 +- VERSION.md | 3 ++- extras/AdobeAfterEffects/README.md | 30 ++++++++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 extras/AdobeAfterEffects/README.md diff --git a/README.adoc b/README.adoc index 338ff08..d3f4585 100644 --- a/README.adoc +++ b/README.adoc @@ -14,7 +14,7 @@ image:https://img.shields.io/twitter/follow/RhubarbLipSync.svg?style=social&labe https://github.com/DanielSWolf/rhubarb-lip-sync[Rhubarb Lip Sync] is a command-line tool that automatically creates 2D mouth animation from voice recordings. You can use it for animating speech in computer games, animated cartoons, or any similar project. -Rhubarb Lip Sync produces output files in various text formats (TSV/XML/JSON). If you're a programmer, this makes it easy for you to use the output in whatever way you like. If you're not a programmer, there is currently no direct way to import the result into your favorite animation tool. If this is what you need, feel free to https://github.com/DanielSWolf/rhubarb-lip-sync/issues[create an issue] telling me what tool you're using. I might add support for a few popular animation tools in the future. +Rhubarb Lip Sync produces output files in various text formats (TSV/XML/JSON). In addition, it comes with integrations for Adobe After Effects and Magix Vegas. == Demo video diff --git a/VERSION.md b/VERSION.md index 06407e8..fd919ef 100644 --- a/VERSION.md +++ b/VERSION.md @@ -2,7 +2,8 @@ ## Unreleased -* Added `--output` command-line option +* Added a script for lip-syncing in Adobe After Effects. +* Added `--output` command-line option. * Dropped the hyphen: Rhubarb Lip-Sync is now Rhubarb Lip Sync. ## Version 1.5.0 diff --git a/extras/AdobeAfterEffects/README.md b/extras/AdobeAfterEffects/README.md new file mode 100644 index 0000000..5e32572 --- /dev/null +++ b/extras/AdobeAfterEffects/README.md @@ -0,0 +1,30 @@ +# Animation script for Adobe After Effects + +The script in this directory generates After Effects compositions with mouth animation. + +## How to install + +### 1. Download and extract + +Download the archive file containing Rhubarb Lip-Sync, then extract in a directory on your computer. + +### 2. Make Rhubarb available to After Effects + +On **Windows**, add the Rhubarb directory (the directory containing `rhubarb.exe`) to your `PATH` environment variable. + +On **OS X**, create a symbolic link to the executable (`rhubarb`) in `/usr/local/bin/`. You can do that by executing `ln -s /rhubarb-directory/rhubarb /usr/local/bin/` (make sure to replace `rhubarb-directory` with the actual directory). + +### 3. Install After Effects script + +Copy (or symlink) the script file `Rhubarb Lip Sync.jsx` into your After Effects scripts directory. + +On **Windows**, that directory is usually `C:\Program Files\Adobe\Adobe After Effects \Support Files\Scripts`. + +On **OS X**, that directory is usually `Applications/Adobe After Effects /Scripts`. + +### 4. (Re-)start After Effects + +## How to use + +In After Effects, select *File > Scripts > Rhubarb Lip Sync.jsx*. That will open a dialog window where you can specify the WAVE file with the dialog recording and a number of other options. To get information about any input field, just hover above it with your mouse and you'll see a tooltip. + \ No newline at end of file