Update README.md
This commit is contained in:
45
README.md
45
README.md
@ -1,6 +1,6 @@
|
|||||||
# 🎬 LCS Pipeline
|
# 🎥 LCS Pipeline
|
||||||
|
|
||||||
**Automated livestream highlight rendering and publishing for Fortnite content featuring Gramps.**
|
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.
|
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.
|
||||||
|
|
||||||
@ -8,32 +8,32 @@ This project powers the backend of [Llama Chile Shop](https://www.youtube.com/@l
|
|||||||
|
|
||||||
## ⚙️ Features
|
## ⚙️ Features
|
||||||
|
|
||||||
* ✅ Daily folder scan for new stream sessions
|
* ✅ Daily folder scan for new stream sessions (2025‑07‑10) \[`v0.1.0`]
|
||||||
* 🎬 Clip classification (`hits/`, `misses/`, `montages/`, etc.)
|
* 📂 Clip classification (`hits/`, `misses/`, `montages/`, `outtakes/`, `timelapses/`) (2025‑08‑07) \[`v0.1.2`]
|
||||||
* 🧠 AI-generated titles and descriptions via OpenAI
|
* 🧠 AI‑generated titles and descriptions via OpenAI (2025‑07‑10) \[`v0.1.0`]
|
||||||
* 🪄 Auto-stitched intro + title card + outro
|
* 🎬 Auto‑stitched intro + title card + outro (2025‑07‑23) \[`v0.1.0`]
|
||||||
* 🖼️ Dynamic thumbnail creation with Fortnite styling
|
* 🖼️ Dynamic thumbnail creation with Fortnite styling (2025‑07‑25) \[`v0.1.0`]
|
||||||
* ⬆️ Uploads to YouTube (and PeerTube if enabled)
|
* ⬆️ Uploads to YouTube (2025‑07‑29) and PeerTube (2025‑08‑07) \[`v0.1.1` & `v0.1.2`]
|
||||||
* 🧾 Metadata archive and session history
|
* 📜 Metadata archive and session history (2025‑07‑26) \[`v0.1.0`]
|
||||||
* 🐘 (Planned) Social posts to Mastodon and Bluesky
|
* 🐘 (Planned) Social posts to Mastodon and Bluesky (2025‑07‑20) \[`v0.2.0`]
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/LCS-Gramps/video-pipeline.git
|
git clone https://llgit.llamachile.tube/gramps/video-pipeline.git
|
||||||
cd video-pipeline
|
cd video-pipeline
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
cp .env.example .env # Fill in your API keys and config
|
cp .env.example .env # Fill in your API keys and config
|
||||||
python main.py
|
python main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
> Requires Python 3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`).
|
> Requires Python 3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🗂️ Folder Structure
|
## 📁 Folder Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
video-pipeline/
|
video-pipeline/
|
||||||
@ -56,19 +56,18 @@ video-pipeline/
|
|||||||
|
|
||||||
## 📚 Documentation
|
## 📚 Documentation
|
||||||
|
|
||||||
Full documentation is hosted in the GitHub Wiki:
|
Full documentation is hosted in the [📖 Gitea Wiki](https://llgit.llamachile.tube/gramps/video-pipeline/wiki)
|
||||||
👉 [📖 LCS Pipeline Wiki](https://github.com/LCS-Gramps/video-pipeline/wiki)
|
|
||||||
|
|
||||||
Recommended pages:
|
Recommended pages:
|
||||||
|
|
||||||
* [`Home`](https://github.com/LCS-Gramps/video-pipeline/wiki)
|
* 🏠 [Home](https://llgit.llamachile.tube/gramps/video-pipeline/wiki)
|
||||||
* [`Clip Handling Logic`](https://github.com/LCS-Gramps/video-pipeline/wiki/Clip-Handling-Logic)
|
* 🎯 [Clip Handling Logic](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/Clip-Handling-Logic)
|
||||||
* [`Metadata Extraction`](https://github.com/LCS-Gramps/video-pipeline/wiki/Metadata-Extraction)
|
* 🗃️ [Metadata Extraction](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/Metadata-Extraction)
|
||||||
* [`YouTube Upload Logic`](https://github.com/LCS-Gramps/video-pipeline/wiki/YouTube-Upload-Logic)
|
* 📺 [YouTube Upload Logic](https://llgit.llamachile.tube/gramps/video-pipeline/wiki/YouTube-Upload-Logic)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧪 Development Mode
|
## 🛠️ Development Mode
|
||||||
|
|
||||||
* `DEBUG=True` in `.env` disables destructive operations
|
* `DEBUG=True` in `.env` disables destructive operations
|
||||||
* All modules can be run/tested independently
|
* All modules can be run/tested independently
|
||||||
@ -76,9 +75,9 @@ Recommended pages:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧙 About
|
## 👤 About
|
||||||
|
|
||||||
Created by **Gramps** for Llama Chile Shop — a custom content pipeline for old-school gaming chaos.
|
Created by Gramps for Llama Chile Shop — a custom content pipeline for old-school gaming chaos.
|
||||||
|
|
||||||
> Maintainer: `gramps@llamachile.shop`
|
> Maintainer: `gramps@llamachile.shop`
|
||||||
> Contributions welcome in the form of bug reports, pull requests, or Fortnite gifts. 🎁
|
> Contributions welcome in the form of bug reports, pull requests, or Fortnite gifts.
|
||||||
|
|||||||
Reference in New Issue
Block a user