Updated File Naming & Directory Conventions (markdown)

Gramps
2025-08-05 22:10:32 -07:00
parent 5570968474
commit 82c18ba298
2 changed files with 67 additions and 3 deletions

@ -1,3 +0,0 @@
# File Naming & Directory Conventions
_TODO: Add content here._

@ -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 = 299 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).