diff --git a/README.md b/README.md index 7e80443..1c15185 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,84 @@ -# Llama Chile Shop Video Automation Pipeline +# ๐ŸŽฌ LCS Pipeline -This project automates the rendering, branding, and publishing of Fortnite gameplay clips for YouTube and PeerTube. +**Automated livestream highlight rendering and publishing for Fortnite content featuring Gramps.** -## Features +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. -- Auto-detection of new stream folders -- Dynamic title card overlay -- Automated rendering and social post generation -- Vertical & widescreen output +--- -## Setup +## โš™๏ธ Features -1. Clone the repo. -2. Create a `.env` file (see `ENVIRONMENT.md` for required keys). -3. Install dependencies: +* โœ… 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 + +--- + +## ๐Ÿš€ 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 # 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\`). + +--- + +## ๐Ÿ—‚๏ธ 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 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. ๐ŸŽ