From e57e5b82facf20e53c1d390d47c5d1607413d9f3 Mon Sep 17 00:00:00 2001 From: Gramps Date: Tue, 5 Aug 2025 22:03:09 -0700 Subject: [PATCH] Updated Metadata Extraction (markdown) --- Metadata Extraction.md | 0 Metadata-Extraction.md | 51 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) delete mode 100644 Metadata Extraction.md create mode 100644 Metadata-Extraction.md diff --git a/Metadata Extraction.md b/Metadata Extraction.md deleted file mode 100644 index e69de29..0000000 diff --git a/Metadata-Extraction.md b/Metadata-Extraction.md new file mode 100644 index 0000000..7fec278 --- /dev/null +++ b/Metadata-Extraction.md @@ -0,0 +1,51 @@ +## ๐Ÿ” Metadata Extraction + +This page describes how the LCS Pipeline reads and interprets per-clip metadata, especially from `notes.json` files used to guide title generation, overlays, and social copy. + +--- + +### ๐Ÿ“‚ Location + +For each clip file, the system expects a corresponding file named: + +``` +.notes.json +``` + +This file should reside in the same directory as the clip (`hits/`, `misses/`, `outtakes/`, or `montages/`). + +--- + +### ๐Ÿ“„ File Format + +Each `notes.json` file contains: + +| Field | Required? | Description | +|-------------|-----------|-------------| +| `highlight` | โœ… Yes | Short, vivid sentence summarizing the moment | +| `tags` | Optional | List of keywords (used in social media metadata) | +| `gag_name` | Optional | Alternative title, meme reference, or inside joke | + +--- + +### ๐Ÿ”„ Fallback Behavior + +- If no `notes.json` is found: + - For `hits/`, `misses/`, or `outtakes/`: the user is prompted to enter one interactively. + - For `montages/`: the system attempts to auto-title from the filename. + +--- + +### ๐Ÿงช Example + +```json +{ + "highlight": "Gramps sticks a 3-elim clutch with only 2 HP left!", + "tags": ["Fortnite", "Clutch", "ZeroBuild"], + "gag_name": "The Wrinkle Reaper" +} +``` + +--- + +Next page: [`Metadata Format`](./Metadata-Format)