From 82c18ba2983cec72cd28b5a2d68812a335a1f704 Mon Sep 17 00:00:00 2001 From: Gramps Date: Tue, 5 Aug 2025 22:10:32 -0700 Subject: [PATCH] Updated File Naming & Directory Conventions (markdown) --- File Naming & Directory Conventions.md | 3 -- File-Naming-&-Directory-Conventions.md | 67 ++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 3 deletions(-) delete mode 100644 File Naming & Directory Conventions.md create mode 100644 File-Naming-&-Directory-Conventions.md diff --git a/File Naming & Directory Conventions.md b/File Naming & Directory Conventions.md deleted file mode 100644 index c2ed273..0000000 --- a/File Naming & Directory Conventions.md +++ /dev/null @@ -1,3 +0,0 @@ -# File Naming & Directory Conventions - -_TODO: Add content here._ \ No newline at end of file diff --git a/File-Naming-&-Directory-Conventions.md b/File-Naming-&-Directory-Conventions.md new file mode 100644 index 0000000..2d00886 --- /dev/null +++ b/File-Naming-&-Directory-Conventions.md @@ -0,0 +1,67 @@ +## ๐Ÿงพ File Naming & Directory Conventions + +This page defines the standard folder structure and file naming rules used by the LCS Pipeline to automate detection, classification, and processing. + +--- + +### ๐Ÿ—‚๏ธ Session Directory Format + +All input clips are organized under **session folders**, named using one of the following formats: + +``` +YYYY.MM.DD/ +YYYY.MM.DD.N/ โ† (N = 2โ€“99 for multiple sessions on the same day) +``` + +Examples: +- `2025.07.21/` +- `2025.07.21.2/` โ†’ treated as "Video 2" from the same day + +--- + +### ๐Ÿ“ Required Subdirectories + +Each session folder must contain the following subdirectories: + +| Folder Name | Purpose | +|------------------|---------------------------------------------------| +| `hits/` | Great moments / eliminations | +| `misses/` | Funny fails or embarrassing clips | +| `outtakes/` | Manually marked highlights during stream | +| `montages/` | Pre-edited reels (multi-event highlight mixes) | +| `timelapses/` | 3D print time-lapse captures (special case) | +| `rendered/` | Final videos after intro/outro, overlay, export | + +These folders are required for consistent processing. + +--- + +### ๐ŸŽฅ File Naming Rules + +#### Clip file: +``` +clip-name.mp4 +clip-name-vert.mp4 โ† treated as vertical +``` + +#### Metadata file: +``` +clip-name.notes.json +``` + +All metadata files must: +- Use the same basename as their associated `.mp4` file +- Reside in the same subdirectory + +--- + +### ๐Ÿง  Format Inference + +- Vertical clips: filenames ending in `-vert` or `-vertical` +- Output names retain the original base name (with `-vert` preserved) +- Montages are treated as full reels and auto-titled +- All other clips prompt for `notes.json` input + +--- + +This page works hand-in-hand with [`Clip Handling Logic`](./Clip-Handling-Logic).