Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,115 @@
|
|
| 1 |
---
|
| 2 |
title: README
|
| 3 |
emoji: 😻
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: static
|
| 7 |
-
pinned:
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: README
|
| 3 |
emoji: 😻
|
| 4 |
+
colorFrom: indigo
|
| 5 |
+
colorTo: indigo
|
| 6 |
sdk: static
|
| 7 |
+
pinned: true
|
| 8 |
---
|
| 9 |
|
| 10 |
+
|
| 11 |
+
# Nomad Karaoke
|
| 12 |
+
|
| 13 |
+
**Building a better karaoke experience** - open source tools for singers, KJs, and karaoke businesses.
|
| 14 |
+
|
| 15 |
+
<p align="center">
|
| 16 |
+
<a href="https://nomadkaraoke.com">Website</a> •
|
| 17 |
+
<a href="https://gen.nomadkaraoke.com">Generator</a> •
|
| 18 |
+
<a href="https://decide.nomadkaraoke.com">Song Finder</a> •
|
| 19 |
+
<a href="https://www.youtube.com/@nomadkaraoke/videos">YouTube</a>
|
| 20 |
+
</p>
|
| 21 |
+
|
| 22 |
+
---
|
| 23 |
+
|
| 24 |
+
## What We're Building
|
| 25 |
+
|
| 26 |
+
We're creating tools to generate **high-quality karaoke videos fully automatically in under 30 minutes** - professional results that rival commercial karaoke tracks.
|
| 27 |
+
|
| 28 |
+
Our technology stack handles the entire pipeline:
|
| 29 |
+
- **Audio separation** - Isolate vocals from instrumentals using state-of-the-art AI models
|
| 30 |
+
- **Lyrics transcription** - Word-level synchronized lyrics with automatic correction
|
| 31 |
+
- **Video rendering** - Professional 4K karaoke videos with multiple output formats (CDG, MP4, LRC, and more)
|
| 32 |
+
|
| 33 |
+
### The Hard Problem
|
| 34 |
+
|
| 35 |
+
Getting lyrics synced with the right timestamps reliably for *any* song is genuinely difficult. No existing tooling does it well consistently. We've gotten close by combining:
|
| 36 |
+
- Advanced audio separation models
|
| 37 |
+
- Proprietary and open-source transcription
|
| 38 |
+
- LLM-powered correction workflows
|
| 39 |
+
|
| 40 |
+
This complexity is why we offer both **open source tools** (use and modify freely) and a **hosted service** (for those who want reliable results without the infrastructure overhead).
|
| 41 |
+
|
| 42 |
+
---
|
| 43 |
+
|
| 44 |
+
## Our Projects
|
| 45 |
+
|
| 46 |
+
### Core Tools
|
| 47 |
+
|
| 48 |
+
| Project | Description | Stars |
|
| 49 |
+
|---------|-------------|-------|
|
| 50 |
+
| [**python-audio-separator**](https://github.com/nomadkaraoke/python-audio-separator) | Easy-to-use stem separation (vocals/instrumentals) from CLI or Python, using pre-trained UVR models |  |
|
| 51 |
+
| [**python-lyrics-transcriber**](https://github.com/nomadkaraoke/python-lyrics-transcriber) | Create synchronized lyrics files (ASS/LRC) with word-level timestamps using Whisper + LLM correction |  |
|
| 52 |
+
| [**karaoke-gen**](https://github.com/nomadkaraoke/karaoke-gen) | Full karaoke video generation pipeline - download, separate, sync, render, upload |  |
|
| 53 |
+
|
| 54 |
+
### Supporting Tools
|
| 55 |
+
|
| 56 |
+
| Project | Description |
|
| 57 |
+
|---------|-------------|
|
| 58 |
+
| [**karaokehunt-app**](https://github.com/nomadkaraoke/karaokehunt-app) | Build the ideal karaoke playlist based on your music taste and friends |
|
| 59 |
+
| [**lyrics-from-genius**](https://github.com/nomadkaraoke/lyrics-from-genius) | Fetch lyrics from Genius for songs or entire artists |
|
| 60 |
+
| [**karaoke-lyrics-processor**](https://github.com/nomadkaraoke/karaoke-lyrics-processor) | Process lyrics for karaoke production (line splitting, formatting) |
|
| 61 |
+
| [**flacfetch**](https://github.com/nomadkaraoke/flacfetch) | CLI tool to fetch high-quality audio from various sources |
|
| 62 |
+
|
| 63 |
+
---
|
| 64 |
+
|
| 65 |
+
## Our Philosophy
|
| 66 |
+
|
| 67 |
+
**Everything we build is open source.** We believe in community and sharing what we create.
|
| 68 |
+
|
| 69 |
+
That said, building *reliable* fully-automated karaoke generation requires significant compute resources (GPU for separation, LLM tokens for correction, CPU for rendering). Each track costs several dollars to generate at production quality.
|
| 70 |
+
|
| 71 |
+
So we offer both paths:
|
| 72 |
+
- **Self-host**: Run everything yourself with our open source tools
|
| 73 |
+
- **Hosted service**: Pay a few dollars per track at [gen.nomadkaraoke.com](https://gen.nomadkaraoke.com) for hassle-free generation
|
| 74 |
+
|
| 75 |
+
If you can improve our open source tools to work reliably without expensive APIs or LLMs, we actively welcome that contribution!
|
| 76 |
+
|
| 77 |
+
---
|
| 78 |
+
|
| 79 |
+
## Contributing
|
| 80 |
+
|
| 81 |
+
Contributions are very welcome! We're a small team and appreciate help from the community.
|
| 82 |
+
|
| 83 |
+
**How to contribute:**
|
| 84 |
+
1. Fork the repository you want to work on
|
| 85 |
+
2. Make your changes
|
| 86 |
+
3. Submit a pull request
|
| 87 |
+
|
| 88 |
+
We'll review and merge promptly. All our projects use the **MIT License** - free for anyone to use and modify.
|
| 89 |
+
|
| 90 |
+
**Ways to help:**
|
| 91 |
+
- Improve model accuracy or performance
|
| 92 |
+
- Add new output formats or integrations
|
| 93 |
+
- Fix bugs and improve documentation
|
| 94 |
+
- Share your karaoke creations!
|
| 95 |
+
|
| 96 |
+
If the maintenance workload ever becomes too much, we'll ask for volunteers to share maintainership - though we don't expect that to happen.
|
| 97 |
+
|
| 98 |
+
---
|
| 99 |
+
|
| 100 |
+
## Get Involved
|
| 101 |
+
|
| 102 |
+
- **Questions or feedback?** Open an issue on the relevant repo
|
| 103 |
+
- **Want to discuss ideas?** [Book a call with Andrew](https://cal.com/beveradb)
|
| 104 |
+
- **Stay updated on releases?** [Sign up for updates](https://nomadkaraoke.kit.com/)
|
| 105 |
+
- **Business inquiries?** Email [andrew@nomadkaraoke.com](mailto:andrew@nomadkaraoke.com)
|
| 106 |
+
|
| 107 |
+
---
|
| 108 |
+
|
| 109 |
+
|
| 110 |
+
|
| 111 |
+
**275K+ songs in catalog** • **4K video quality** • **Videos in under 30 minutes**
|
| 112 |
+
|
| 113 |
+
[nomadkaraoke.com](https://nomadkaraoke.com)
|
| 114 |
+
|
| 115 |
+
</div>
|