Files
video-pipeline/README.md
2025-08-12 01:33:30 +00:00

84 lines
2.8 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🎥 LCS Pipeline
Automated livestream highlight rendering and publishing for Fortnite content featuring Gramps.
This project powers the backend of [Llama Chile Shop](https://www.youtube.com/@llamachileshop), transforming raw livestream clips into polished, uploaded videos — complete with titles, thumbnails, intros/outros, and social metadata.
---
## ⚙️ Features
* ✅ Daily folder scan for new stream sessions (20250710) \[`v0.1.0`]
* 📂 Clip classification (`hits/`, `misses/`, `montages/`, `outtakes/`, `timelapses/`) (20250807) \[`v0.1.2`]
* 🧠 AIgenerated titles and descriptions via OpenAI (20250710) \[`v0.1.0`]
* 🎬 Autostitched intro + title card + outro (20250723) \[`v0.1.0`]
* 🖼️ Dynamic thumbnail creation with Fortnite styling (20250725) \[`v0.1.0`]
* ⬆️ Uploads to YouTube (20250729) and PeerTube (20250807) \[`v0.1.1` & `v0.1.2`]
* 📜 Metadata archive and session history (20250726) \[`v0.1.0`]
* 🐘 (Planned) Social posts to Mastodon and Bluesky (20250720) \[`v0.2.0`]
---
## 🚀 Quick Start
```bash
git clone https://llgit.llamachile.tube/gramps/video-pipeline.git
cd video-pipeline
pip install -r requirements.txt
cp .env.example .env # Fill in your API keys and config
python main.py
```
> Requires Python3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`).
---
## 📁 Folder Structure
```
video-pipeline/
├── main.py
├── config.py
├── .env.example
├── modules/
│ ├── render_engine.py
│ ├── title_utils.py
│ ├── thumbnail_utils.py
│ ├── yt_poster.py
│ └── ...
├── assets/ # Branding assets (intros, fonts, logos)
├── logs/ # Sync logs, wiki publish logs, etc.
└── metadata/
└── history/ # Per-clip metadata archive
```
---
## 📚 Documentation
Full documentation is hosted in the [📖 Gitea Wiki](https://llgit.llamachile.tube/gramps/video-pipeline/wiki)
Recommended pages:
* 🏠 [Home](https://llgit.llamachile.tube/gramps/video-pipeline/wiki)
* 🎯 [Clip Handling Logic](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/Clip-Handling-Logic)
* 🗃️ [Metadata Extraction](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/Metadata-Extraction)
* 📺 [YouTube Upload Logic](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/YouTube-Upload-Logic)
---
## 🛠️ Development Mode
* `DEBUG=True` in `.env` disables destructive operations
* All modules can be run/tested independently
* Wiki editing is supported via local Markdown and `wiki_publish.log`
---
## 👤 About
Created by Gramps for Llama Chile Shop — a custom content pipeline for old-school gaming chaos.
> Maintainer: `gramps@llamachile.shop`
> Contributions welcome in the form of bug reports, pull requests, or Fortnite gifts.