gramps/video-pipeline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Llama Chile Shop
2025-08-12 00:54:14 +00:00
parent 90c5d6992e
commit 75055dca56
1 changed files with 37 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
README.md
View File

@ -1,97 +1,46 @@
# LCS Video Pipeline Wiki # 🎯 LCS Video Pipeline Wiki
Welcome to the **LCS Video Pipeline** documentation! Welcome to the **LCS Video Pipeline Wiki** — the central knowledge base for the entire project.
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. This wiki covers setup, workflows, troubleshooting, and developer documentation for the **Llama Chile Shop** video automation pipeline.
--- ---
## 📑 Table of Contents ## 📚 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)
--- - [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)
## Overview - [Project Structure](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Project-Structure)
The **LCS Video Pipeline** automates the transformation of raw livestream recordings into fully branded, published videos on YouTube and PeerTube — with minimal manual effort. - [Automation Workflow](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Automation-Workflow)
It’s built to be fast, flexible, and scalable. - [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)
---
## 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)
- [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting) - [Troubleshooting](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Troubleshooting)
- [Changelog](https://llgit.llamachile.tube/code/gramps/video-pipeline/wiki/Changelog) - [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.