README.md

Basic Video Puppet example

This example shows how the basic features of Video Puppet.

Check out the outcome in result.mp4.

Try it out

Upload the script directory to a Video Puppet project. The main script file is source.md.

How it works

Video Puppet creates a video from one or scenes. Each scene can include videos, images, audio or narration.

Adding images and videos

In the Markdown script file format, you can add images or videos by using the standard Markdown syntax (![](file)).

![](london.jpg)

Adding narration

Video Puppet automatically generates narration from scene text. The following scene will include an image, and automatically generated voice narration:

![](london.jpg)

Welcome to London

Using your audio

Instead of automatically generated narration, you can add your own audio files, with recorded voice, music or something else to play during a scene. To do so, just add (audio: file) in a separate paragraph. For example, this scene will show an image from london.jpg and play the audio from london-audio.mp3:

![](london.jpg)

(audio: london-audio.mp3)

Adding scenes

To add more scenes, use three or more dashes (---) as a separator. The following script file creates two scenes:

![](london.jpg)

Welcome to London

---

![](berlin.jpg)

Welcome to Berlin

More examples

Next, check out the voices example to see how to control the narration voice, or the subtitles example for information on how to generate subtitles for your video.