Skip to content

Commit

Permalink
Updating docs for new installation procedure.
Browse files Browse the repository at this point in the history
  • Loading branch information
blackears committed Apr 23, 2024
1 parent 33645c5 commit bc75f25
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This is an addon for Blender that lets you automatically generate lip-synced dat

## Installation


Parrot Lipsync relies on you having some other applications already installed on your computer.

### Install Ffmpeg
Expand Down Expand Up @@ -41,22 +42,31 @@ scoop install ffmpeg
```


### Installing Parrot addon

Now that ffmpeg is installed, you can install Parrot by opening the `Edit > Preferences > Addons` window and clicking the `Install` button. Browse to the Parrot Lipsync zip file you downloaded and select it. Finally, make sure the check mark next to `View 3D: Parrot Lipsync` is checked so that the addon is activated.

### Install Whisper and Gruut

You will need to install some Python extensions to your Blender distribution of Python. Blender uses its own copy of Python, so you will need to install these packages there even if you already have Python installed elsewhere on your system.
Parrot needs some support libraries to function. The easiest way to install them is to open Parrot's configuration page in the `Addon` window to reveal the buttons on the bottom. Press the `Install whisper_timestamped` and `Install gruut` buttons to ensure these necessary libraries are added to your Blender's python packages. Some languages will require an additional package - for example, if you intend to use the Russian language, make sure to click the `Install gruut-lang-ru` button as well.

![Addon install panel](doc/addon_install_panel.jpg)


### Alternate installation procedure for Whisper and Gruut

It is also possible to install Whsiper and Gruut on the command line as well if you don't want to use the installation panel.

Open a terminal window and go into your Blender installation's python directory (on Windows it should be something like `C:\Program Files\Blender Foundation\Blender 4.0\4.0\python\bin`). Then issue the following commands:

```
./python.exe -m pip install --upgrade numpy
./python.exe -m pip install --upgrade whisper_timestamped
./python.exe -m pip install --upgrade gruut
```

For MacOS and Linux, the following should work:

```
./python -m pip install --upgrade numpy
./python -m pip install --upgrade whisper_timestamped
./python -m pip install --upgrade gruut
```
Expand All @@ -68,17 +78,6 @@ Russian:
./python.exe -m pip install --upgrade gruut-lang-ru
```


### Installing the ParrotLipsync addon

You can install the addon by:
* opening Blender's `Edit/Preferences` menu
* opening the Addons section
* clicking the Install button
* browsing to the `parrot_lipsync.zip` file

Once installed, make sure that you check the box to enable it. A new tab will appear in the viewport right hand tab menu.

## Usage

Once installed, click on the Parrot Lipsync panel to access Parrot's controls.
Expand Down
Binary file added doc/addon_install_panel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

2 comments on commit bc75f25

@tecio0101
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eu não consigo usalo diz erro. não sei se pega em blender 3.6.9

@blackears
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not tested this on Blender 3.6.9 or earlier. Please upgrade to Blender 4.1 to use it.

Please sign in to comment.