semvec/pypi-packages huggingface dataset:
xlights-auto-lyrics 1.0
Xtiming generator for singing faces

# XLights xtiming Generator

This repo is a simple python CLI script that takes a generated JSON file from [Auto Lyrix Align](https://autolyrixalign.hltnus.org) & outputs a valid xtiming file ready to use in Xlights.

## Dependencies
Install ths in a python environment.

```shell
pip install xlight-lyrics
```

[comment]: <> (Do you?? You need a Python environment > 3.0 with setuptools & pip)


## How Do I Generate a Singing Face?
You'll need a YouTube video or MP3 of your chosen track.

Pop over to [Auto Align Lyrix](https://autolyrixalign.hltnus.org/). 

Choose YouTube or MP3

Give the form the location of the YouTube vid, or the MP3 you have locally.

Find the lyrics for the audio track & save them to your local device ie. "SladeChristmas.txt"

Fill in the 2 boxes on the website & press 'Next' on the form

Wait a few mins until your lyric track is ready for download.

When it is ready, you'll see a screen with the lyrics & a play button. If you press play you can sense check the audo & lyric combo to ensure you have a sensible output. There is some limitations to the output, like warbling, ohohoh on an "oh" word, the timings aren't going to pick that up so a manual tweak in xlights will be required. 

During testing, sometimes I found it will add a lyric saying 'BREATH*', you'll need to tweak these before or after importing to xlights.

### IMPORTANT 
After generating lyrics, click 'Download Aligned Lyrics' & choose the 'Json Lyrics' option.

Save the file somewhere thats easy to access ie "/home/User/SladeJson.txt"

Usng this lib, execute:

```shell
lyrics -t "Slade - Merry Christmas Everybody" /home/User/SladeChristmasJson.txt xtimingSlade.xtiming
```

If you want the help text run:

```shell
lyrics --help
```