updated export paths

2026-08-07 12:07:16 +02:00
parent 7caf41e17c
commit 7dcb9303e5
7 changed files with 452 additions and 90 deletions
@@ -6,7 +6,101 @@ A dockable ScriptUI panel for Adobe After Effects 2024+ that integrates with the

 ## Configuration

-At the top of the script, four global variables control how the panel connects to your project:
+Settings are stored per-machine via the **⚙ Settings** button in the panel (persisted in After Effects' built-in preferences — no need to edit the JSX file).
+
+| Setting | Purpose |
+|---|---|
+| **Server URL** | Base URL of the VFXReview server (e.g. `https://review.twotalesvfx.com`) |
+| **API Token** | Bearer token matching `API_SECRET_KEY` in the server `.env` |
+| **Export Root** | Local path where renders and deliverables are written |
+| **Footage Root** | Local path where EXR plate folders are read from |
+| **Banner Path** | Path to the panel banner image |
+| **Artist Email** | Used for render attribution in the pipeline |
+| **Handle Frames** | Plate handle frames prepended before the shot's source TC in-point (default: 8) |
+
+---
+
+## Pipeline Folder Structure
+
+### Export Root
+
+All outputs from the connector are written under **`<Export Root>/{SHOW_ID}/`** (e.g. `V:/_EXPORTS`). The show ID is appended automatically from the selected project — configure `exportRoot` as the bare root without a show ID.
+
+```
+<Export Root>/
+└── {SHOW_ID}/                                     # e.g. UNG/
+    ├── {SHOT_CODE}/                                # e.g. UNG_108_001_010/
+    │   ├── {shot}_cmp_TT_{ver}.[#####].exr         # Queue EXR / Queue EXR (Review)
+    │   └── {shot}_cmp_TT_{ver}.mp4 / .mov          # Queue MP4 / Queue MOV
+    │
+    ├── DELIVERY/
+    │   └── {EPISODE_OR_SCENE}/                     # e.g. UNG_108/
+    │       └── {YYYYMMDD}_Delivery/
+    │           └── {SHOT_CODE}/
+    │               └── {shot}_cmp_TT_{ver}.[#####].exr
+    │
+    └── (render farm outputs — managed by the server)
+        └── {PROJECT_CODE}/{EPISODE}/{SHOT_CODE}/{ver}/
+            └── {shot}_cmp_TT_{ver}.[#####].exr
+```
+
+**Version naming:** `{SHOT_CODE}_cmp_TT_{version}` — e.g. `UNG_108_001_010_cmp_TT_v003.[01001].exr`
+
+Versions are set manually via **Increment Shot Version** or the shot detail page. Queuing a render does **not** auto-increment the version.
+
+---
+
+### Footage Root
+
+Source EXR plates are read from **`<Footage Root>/{SHOW_ID}/`**. Configure `footageRoot` as the bare root (e.g. `V:/_FOOTAGE`).
+
+```
+<Footage Root>/
+└── {SHOW_ID}/                      # e.g. UNG/
+    ├── {EPISODE_CODE}/             # episodic: e.g. UNG_108/
+    │   └── {SHOT_CODE}_{CLIP}/     # e.g. UNG_108_001_010_A315C001/
+    │       └── *.exr               # EXR sequence
+    │
+    ├── {SCENE}/                    # standard: e.g. 001/
+    │   └── {SHOT_CODE}_{CLIP}/
+    │       └── *.exr
+    │
+    └── _PICLOCKS/
+        └── {EPISODE_CODE}_*.mov    # matched by episode prefix
+```
+
+Sequence folders must start with the shot code followed by an underscore (`{SHOT_CODE}_*`). The connector imports all matching folders as separate footage layers.
+
+---
+
+### Episodic vs. Standard productions
+
+| | Episodic | Standard |
+|---|---|---|
+| Shot code format | `{SHOW}_{EP}_{SCENE}_{NUM}` | `{SHOW}_{SCENE}_{NUM}` |
+| Shot Builder | Episode dropdown → Shot dropdown | Scene dropdown → Shot dropdown |
+| Footage path | `{footageRoot}/{showId}/{EPISODE}/` | `{footageRoot}/{showId}/{SCENE}/` |
+| Export path | `{exportRoot}/{showId}/{SHOT_CODE}/` | same |
+| Delivery subfolder | `DELIVERY/{EPISODE}/…` | `DELIVERY/{SCENE}/…` |
+
+---
+
+## Migrating an existing project (e.g. UNG)
+
+If you previously set `exportRoot = V:/_EXPORTS/UNG`, update it to `V:/_EXPORTS`. The code now appends `/{showId}/` automatically, so `V:/_EXPORTS/UNG/…` is still produced — no files need to move.
+
+Same applies to `footageRoot`: change `V:/_FOOTAGE/UNG` → `V:/_FOOTAGE`.
+
+---
+
+## New production checklist
+
+1. Create `<Footage Root>/{SHOW_ID}/{EPISODE or SCENE}/` and place EXR sequences inside, named `{SHOT_CODE}_{clip}`.
+2. `<Export Root>/{SHOW_ID}/` is created automatically on first render.
+3. Add the project to the VFXReview server with the correct **Show ID** set.
+4. Open the panel in After Effects, click **⚙**, enter the Server URL, API Token, bare `exportRoot`, and bare `footageRoot`, then click **Save**.
+5. The **Project** dropdown will populate automatically. Select the production and the episode/scene list will load.
+

 | Variable | Default | Description |
 |---|---|---|