Update documentation
This commit is contained in:
Daniel Wolf
parent
c078e6186e
commit
44d6cb83de
17
README.adoc
17
README.adoc
|
|
@ -18,9 +18,16 @@ image:img/logo.png[align="center"]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
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 allows you to quickly create 2D mouth animation from voice recordings. It analyzes your audio files, recognizes what is being said, then automatically generates lip sync information. You can use it for animating speech in computer games, animated cartoons, or any similar project.
|
||||||
|
|
||||||
Rhubarb Lip Sync produces text files in various <<outputFormats,output formats>> (<<tsv,TSV>>/<<xml,XML>>/<<json,JSON>>). In addition, it comes with integrations for <<afterEffects,Adobe After Effects>>, <<spine,Spine>>, and <<vegas,Vegas Pro>>.
|
Rhubarb Lip Sync integrates with the following applications:
|
||||||
|
|
||||||
|
* *Adobe After Effects* (see <<afterEffects,below>>)
|
||||||
|
* *Spine* by Esoteric Software (see <<spine,below>>)
|
||||||
|
* *Vegas Pro* by Magix (see <<vegas,below>>)
|
||||||
|
* *Visionaire Studio* (see https://www.visionaire-studio.net/forum/thread/mouth-animation-using-rhubarb-lip-sync[external link])
|
||||||
|
|
||||||
|
In addition, you can use Rhubarb Lip Sync's command line interface (*CLI*) to generate files in various <<outputFormats,output formats>> (<<tsv,TSV>>/<<xml,XML>>/<<json,JSON>>).
|
||||||
|
|
||||||
== Demo video
|
== Demo video
|
||||||
|
|
||||||
|
|
@ -333,10 +340,14 @@ Note that the output format <<Versioning,adheres to SemVer>>. That means that th
|
||||||
|
|
||||||
Rhubarb Lip Sync uses Semantic Versioning (SemVer) for its command-line interface. For general information on Semantic Versioning, have a look at the http://semver.org/[official SemVer website].
|
Rhubarb Lip Sync uses Semantic Versioning (SemVer) for its command-line interface. For general information on Semantic Versioning, have a look at the http://semver.org/[official SemVer website].
|
||||||
|
|
||||||
As a rule of thumb, everything you can use through the command-line interface adheres to SemVer. Everything else (i.e., the source code) does not. Here are some examples and clarifications:
|
As a rule of thumb, everything you can use through the command-line interface adheres to SemVer. Everything else (i.e., the source code, integrations with third-party software, etc.) does not.
|
||||||
|
|
||||||
== I'd love to hear from you!
|
== I'd love to hear from you!
|
||||||
|
|
||||||
Have you created something great using Rhubarb Lip Sync? -- *https://twitter.com/RhubarbLipSync[Let me know on Twitter]* or *send me an email* at +++dwolf@dannad.de+++!
|
Have you created something great using Rhubarb Lip Sync? -- *https://twitter.com/RhubarbLipSync[Let me know on Twitter]* or *send me an email* at +++dwolf@dannad.de+++!
|
||||||
|
|
||||||
Do you need help? Have you spotted a bug? Do you have a suggestion? -- *https://github.com/DanielSWolf/rhubarb-lip-sync/issues[Create an issue!]*
|
Do you need help? Have you spotted a bug? Do you have a suggestion? -- *https://github.com/DanielSWolf/rhubarb-lip-sync/issues[Create an issue!]*
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
https://www.jetbrains.com/[image:img/resharper-cpp.svg[]] https://www.jetbrains.com/[JetBrains] have been kind enough to supply me with a free Open Source license of https://www.jetbrains.com/resharper-cpp/[ReSharper C++].
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,46 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Generator: Adobe Illustrator 19.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||||
|
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||||
|
width="70px" height="70px" viewBox="0 0 70 70" style="enable-background:new 0 0 70 70;" xml:space="preserve">
|
||||||
|
<g>
|
||||||
|
<g>
|
||||||
|
<g>
|
||||||
|
<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="8.0628" y1="16.1412" x2="29.2598" y2="69.7572">
|
||||||
|
<stop offset="0.2204" style="stop-color:#C40B55"/>
|
||||||
|
<stop offset="0.6828" style="stop-color:#E343E6"/>
|
||||||
|
<stop offset="0.9247" style="stop-color:#F59252"/>
|
||||||
|
</linearGradient>
|
||||||
|
<polygon style="fill:url(#SVGID_1_);" points="20.2,15.2 34,36.7 11.6,70 0,23.1 "/>
|
||||||
|
|
||||||
|
<linearGradient id="SVGID_2_" gradientUnits="userSpaceOnUse" x1="875.7187" y1="73.2924" x2="927.5556" y2="18.1521" gradientTransform="matrix(-1 0 0 1 928 -2.064169e-004)">
|
||||||
|
<stop offset="0.1129" style="stop-color:#FFBD00"/>
|
||||||
|
<stop offset="0.586" style="stop-color:#E343E6"/>
|
||||||
|
<stop offset="0.8172" style="stop-color:#EC841B"/>
|
||||||
|
<stop offset="0.9355" style="stop-color:#FFBD00"/>
|
||||||
|
</linearGradient>
|
||||||
|
<polygon style="fill:url(#SVGID_2_);" points="18.9,15.7 21,0 51.2,33.6 42.4,42.3 49.2,70 11.6,70 "/>
|
||||||
|
</g>
|
||||||
|
<linearGradient id="SVGID_3_" gradientUnits="userSpaceOnUse" x1="25.5002" y1="-1.9302" x2="69.9604" y2="51.1679">
|
||||||
|
<stop offset="0.129" style="stop-color:#FFBD00"/>
|
||||||
|
<stop offset="0.6398" style="stop-color:#E343E6"/>
|
||||||
|
<stop offset="0.9086" style="stop-color:#C40B55"/>
|
||||||
|
</linearGradient>
|
||||||
|
<polygon style="fill:url(#SVGID_3_);" points="35.3,47.1 70,47.1 58.4,0 21,0 "/>
|
||||||
|
</g>
|
||||||
|
<g>
|
||||||
|
<g>
|
||||||
|
<rect x="13.4" y="13.4" style="fill:#000000;" width="43.2" height="43.2"/>
|
||||||
|
<path style="fill:#FFFFFF;" d="M17.4,19h8.2c2.3,0,4,0.6,5.2,1.8c1,1,1.5,2.4,1.5,4.1V25c0,1.5-0.4,2.6-1.1,3.5
|
||||||
|
c-0.7,0.9-1.6,1.6-2.8,2l4.4,6.4h-4.6l-3.7-5.5h-3.3l0,5.5h-3.9V19z M25.4,27.7c1,0,1.7-0.2,2.2-0.7c0.5-0.5,0.8-1.1,0.8-1.8
|
||||||
|
v-0.1c0-0.9-0.3-1.5-0.8-1.9c-0.5-0.4-1.3-0.6-2.3-0.6h-3.9v5.1H25.4z"/>
|
||||||
|
<rect x="17.4" y="48.5" style="fill:#FFFFFF;" width="16.2" height="2.7"/>
|
||||||
|
</g>
|
||||||
|
<g>
|
||||||
|
<path style="fill:#FFFFFF;" d="M43.7,24.4h-4v-3.6h4v-4h3.7v4h4v3.6h-4v4h-3.7V24.4z"/>
|
||||||
|
</g>
|
||||||
|
<g>
|
||||||
|
<path style="fill:#FFFFFF;" d="M37.1,34.6h-4V31h4v-4h3.7v4h4v3.6h-4v4h-3.7V34.6z"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 2.4 KiB |
Loading…
Reference in New Issue