Updated Home (markdown)

Gramps
2025-08-07 10:30:52 -07:00
parent 243119fb5b
commit 81b9571736

88
Home.md

@ -1,70 +1,84 @@
## 🦙 LCS Pipeline: Automated Video Highlights with Gramps
# 🎮 LCS Pipeline
Welcome to the **Llama Chile Shop (LCS) Pipeline**, a fully automated content-creation workflow built for **gaming livestreams**. This system transforms raw gameplay and AI-generated clips into polished videos — complete with intros, title cards, dynamic descriptions, thumbnails, and uploads to YouTube and PeerTube.
**Automated livestream highlight rendering and publishing for Fortnite content featuring Gramps.**
Everything's tuned for Gramps-style: 💥 fast, 🤣 funny, and 🌟 hands-off.
This project powers the backend of [[Llama Chile Shop](https://www.youtube.com/@llamachileshop)](https://www.youtube.com/@llamachileshop), transforming raw livestream clips into polished, uploaded videos — complete with titles, thumbnails, intros/outros, and social metadata.
---
### 🎮 Key Features
## ⚙️ Features
***Daily Scan & Session Detection**
* 🎬 **Auto-rendered highlight reels** (vertical & widescreen)
* 🧠 **AI-generated video titles + descriptions**
* 🪄 **Intro/outro stitching + title cards**
* 🖼️ **Branded YouTube thumbnails**
* **Uploads to YouTube + PeerTube**
* 📣 **Social posts to Mastodon and Bluesky** (coming soon)
* ✅ Daily folder scan for new stream sessions *(2025-07-10)* \[`v0.1.0`]
* 🎮 Clip classification (`hits/`, `misses/`, `montages/`, `outtakes/`, `timelapses/`) *(2025-08-07)* \[`v0.1.2`]
* 🧠 AI-generated titles and descriptions via OpenAI *(2025-07-10)* \[`v0.1.0`]
* 🪄 Auto-stitched intro + title card + outro *(2025-07-23)* \[`v0.1.0`]
* 🖼️ Dynamic thumbnail creation with Fortnite styling *(2025-07-25)* \[`v0.1.0`]
* Uploads to YouTube *(2025-07-29)* and PeerTube *(2025-08-07)* \[`v0.1.1` & `v0.1.2`]
* 🗾 Metadata archive and session history *(2025-07-26)* \[`v0.1.0`]
* 🐘 (Planned) Social posts to Mastodon and Bluesky *(2025-07-20)* \[`v0.2.0`]
---
### 🚀 Quick Start
## 🚀 Quick Start
```bash
git clone https://github.com/LCS-Gramps/video-pipeline.git
cd video-pipeline
pip install -r requirements.txt
cp .env.example .env # and fill in your secrets
cp .env.example .env # Fill in your API keys and config
python main.py
```
Requires Python 3.13+ and a mapped NAS directory (e.g., `Z:\2025.07.01\montages`).
> Requires Python 3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`).
---
### 📁 Folder Structure
## 🗂️ Folder Structure
```
Z:\
── YYYY.MM.DD\
├── hits\
├── misses\
├── montages\
├── outtakes\
── rendered\
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
```
Each clip gets processed into a full video with overlays, metadata, and upload instructions. Vertical clips are suffixed with `-vert`.
---
## 📚 Documentation
Full documentation is hosted in the GitHub Wiki:
👉 [[📖 LCS Pipeline Wiki](https://github.com/LCS-Gramps/video-pipeline/wiki)](https://github.com/LCS-Gramps/video-pipeline/wiki)
Recommended pages:
* [`[Home](https://github.com/LCS-Gramps/video-pipeline/wiki)`](https://github.com/LCS-Gramps/video-pipeline/wiki)
* [`[Clip Handling Logic](https://github.com/LCS-Gramps/video-pipeline/wiki/Clip-Handling-Logic)`](https://github.com/LCS-Gramps/video-pipeline/wiki/Clip-Handling-Logic)
* [`[Metadata Extraction](https://github.com/LCS-Gramps/video-pipeline/wiki/Metadata-Extraction)`](https://github.com/LCS-Gramps/video-pipeline/wiki/Metadata-Extraction)
* [`[YouTube Upload Logic](https://github.com/LCS-Gramps/video-pipeline/wiki/YouTube-Upload-Logic)`](https://github.com/LCS-Gramps/video-pipeline/wiki/YouTube-Upload-Logic)
---
### 📚 Wiki Map
## 🧪 Development Mode
* [`Setup Guide`](./Setup-Guide)
* [`Rendering Engine`](./Rendering-Engine)
* [`YouTube Uploading`](./Uploading)
* [`Metadata Handling`](./Metadata)
* [`Social Automation`](./Social-Automation)
* [`Troubleshooting`](./Troubleshooting)
* `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`
---
### 🧪 Project Status
## 🧙 About
| Version | Status | Notes |
| ------- | ---------- | -------------------------------------------- |
| v0.1.1 | ✅ LIVE | YouTube uploads, dynamic titles/descriptions |
| v0.1.2 | ⏳ Building | PeerTube support, clip upload pipeline |
| v0.2.0+ | 🧠 Planned | Social posting, metadata dashboard |
Created by **Gramps** for Llama Chile Shop — a custom content pipeline for old-school gaming chaos.
> Maintained by **[gramps@llamachile.shop](mailto:gramps@llamachile.shop)**. Built with ❤️ and Python.
> Maintainer: `gramps@llamachile.shop`
> Contributions welcome in the form of bug reports, pull requests, or Fortnite gifts. 🏱