From d473b05d89a3e8554382ddb88ae76bc51ac9358c Mon Sep 17 00:00:00 2001 From: "gramps@llamachile.shop" Date: Mon, 11 Aug 2025 18:18:03 -0700 Subject: [PATCH] Restore README.md from commit 2c08fce --- README.md | 98 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 68 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 5a2316f..1c15185 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,84 @@ -# ๐ŸŽฏ LCS Video Pipeline Wiki +# ๐ŸŽฌ LCS Pipeline -Welcome to the **LCS Video Pipeline Wiki** โ€” the central knowledge base for the entire project. -This wiki covers setup, workflows, troubleshooting, and developer documentation for the **Llama Chile Shop** video automation 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. --- -## ๐Ÿ“š Table of Contents +## โš™๏ธ Features -- [Getting Started](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Getting-Started) -- [System Requirements](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/System-Requirements) -- [Project Structure](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Project-Structure) -- [Automation Workflow](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation-Workflow) -- [Rendering Engine](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Rendering-Engine) -- [Social Posting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Social-Posting) -- [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting) -- [Changelog](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Changelog) +* โœ… Daily folder scan for new stream sessions +* ๐ŸŽฌ Clip classification (`hits/`, `misses/`, `montages/`, etc.) +* ๐Ÿง  AI-generated titles and descriptions via OpenAI +* ๐Ÿช„ Auto-stitched intro + title card + outro +* ๐Ÿ–ผ๏ธ Dynamic thumbnail creation with Fortnite styling +* โฌ†๏ธ Uploads to YouTube (and PeerTube if enabled) +* ๐Ÿงพ Metadata archive and session history +* ๐Ÿ˜ (Planned) Social posts to Mastodon and Bluesky --- -## ๐Ÿ—‚ Site Index +## ๐Ÿš€ Quick Start -| Page | Description | -|------|-------------| -| [Home](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Home) | Overview & quick links | -| [Getting Started](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Getting-Started) | Install & configure your environment | -| [System Requirements](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/System-Requirements) | Hardware & software prerequisites | -| [Project Structure](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Project-Structure) | Folder layout & file descriptions | -| [Automation Workflow](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation-Workflow) | End-to-end processing flow | -| [Rendering Engine](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Rendering-Engine) | Video editing & rendering details | -| [Social Posting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Social-Posting) | YouTube, PeerTube, Mastodon, Bluesky | -| [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting) | Common problems & fixes | -| [Changelog](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Changelog) | Version history | +```bash +git clone https://github.com/LCS-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 Python 3.13+ and access to mapped NAS directory (e.g. `Z:\2025.08.05\hits\`). --- -## ๐Ÿ’ก About This Project +## ๐Ÿ—‚๏ธ Folder Structure -The **LCS Video Pipeline** automates the entire process of turning livestream footage into polished highlight videos โ€” complete with intros, outros, titles, and metadata โ€” then uploads them to social platforms with dynamic descriptions and hashtags. - -This wiki is the **source of truth** for all documentation. -If something is unclear, out of date, or missing โ€” update it here first. +``` +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 +``` --- -> ๐Ÿ“ **Tip:** Each wiki page automatically displays a Table of Contents on the right-hand side. Use it to jump quickly between sections. +## ๐Ÿ“š Documentation + +Full documentation is hosted in the GitHub Wiki: +๐Ÿ‘‰ [๐Ÿ“– LCS Pipeline Wiki](https://github.com/LCS-Gramps/video-pipeline/wiki) + +Recommended pages: + +* [`Home`](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) +* [`YouTube Upload Logic`](https://github.com/LCS-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. ๐ŸŽ