From 75055dca5642f851c9e17eb472ab4270310d3245 Mon Sep 17 00:00:00 2001 From: Llama Chile Shop Date: Tue, 12 Aug 2025 00:54:14 +0000 Subject: [PATCH] Update README.md --- README.md | 125 ++++++++++++++++-------------------------------------- 1 file changed, 37 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index f2403a0..5a2316f 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,46 @@ -# LCS Video Pipeline Wiki +# 🎯 LCS Video Pipeline Wiki -Welcome to the **LCS Video Pipeline** documentation! -This wiki is the living source of truth for the project β€” workflows, automation scripts, branding guidelines, and everything else that keeps the pipeline running smoothly. +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. --- -## πŸ“‘ Table of Contents -- [Overview](#overview) -- [Project Goals](#project-goals) -- [Core Components](#core-components) -- [Workflow Summary](#workflow-summary) -- [Branding Guidelines](#branding-guidelines) -- [Automation Scripts](#automation-scripts) -- [Contributing](#contributing) -- [License](#license) -- [Site Index](#site-index) +## πŸ“š Table of Contents ---- - -## Overview -The **LCS Video Pipeline** automates the transformation of raw livestream recordings into fully branded, published videos on YouTube and PeerTube β€” with minimal manual effort. -It’s built to be fast, flexible, and scalable. - ---- - -## Project Goals -- **Full Automation** – Minimize manual intervention in video processing and uploads. -- **Brand Consistency** – Apply intros, outros, titles, and descriptions according to predefined rules. -- **Platform Flexibility** – Publish to multiple platforms without extra steps. -- **Metadata Tracking** – Maintain a detailed archive of uploads, formats, and performance data. - ---- - -## Core Components -1. **Video Processing** – Handles clip trimming, intro/outro insertion, title card generation, and format adjustments. -2. **Metadata Generation** – Pulls session data and user notes into dynamic titles and descriptions. -3. **Publishing** – Uploads to YouTube, PeerTube, and optionally Mastodon/Bluesky. -4. **Branding Assets** – Logos, fonts, and color palettes for consistent look-and-feel. -5. **Automation Scripts** – Python modules that orchestrate the entire pipeline. - ---- - -## Workflow Summary -1. **Clip Intake** – Source files are added to the `hits/`, `misses/`, `montages/`, or `outtakes/` folders. -2. **Brand Application** – The system injects title cards, branding assets, and date stamps. -3. **Rendering** – Produces both widescreen (16:9) and vertical (9:16) versions where applicable. -4. **Upload & Publish** – Posts videos to target platforms with optimized descriptions and hashtags. -5. **Archive** – Updates the metadata repository for auditing and analytics. - ---- - -## Branding Guidelines -- **Main Font**: Fortnite-style font (Burbank Big Condensed Black) -- **Main Colors**: - - Pink: `#f7338f` - - Aqua: `#10abba` - - Dark Shadow: `#1c0c38` -- **Logo**: Brand llama (`LlamaLlama.png`) used on all thumbnails. - ---- - -## Automation Scripts -Key helper scripts include: -- `render_engine.py` – Builds final videos with intros, titles, and outros. -- `title_utils.py` – Generates title cards dynamically. -- `yt_poster.py` – Handles YouTube uploads. -- `pt_poster.py` – Handles PeerTube uploads. -- `sync_wiki.py` – Pushes updated wiki pages to the repository. -- `discovery.py` – Detects new session folders for processing. - ---- - -## Contributing -Pull requests are welcome on the [llgit repository](https://llgit.llamachile.tube/code/gramps/video-pipeline). -Please follow the established coding style and commit message conventions. - ---- - -## License -This project is licensed under the MIT License. - ---- - -## πŸ“š Site Index -Here’s a quick jump list to all wiki pages: - -- [Home](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki) -- [Installation](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Installation) -- [Configuration](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Configuration) -- [Usage](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Usage) -- [Branding](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Branding) -- [Automation](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation) +- [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) --- + +## πŸ—‚ Site Index + +| 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 | + +--- + +## πŸ’‘ About This Project + +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. + +--- + +> πŸ“ **Tip:** Each wiki page automatically displays a Table of Contents on the right-hand side. Use it to jump quickly between sections.