diff --git a/README.md b/README.md index 1a1f339..9a2f4cd 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,112 @@ +
+ +[![Biohazard VFX](https://img.shields.io/badge/Maintainer-Biohazard%20VFX-111111.svg)](https://biohazardvfx.com) +[![NukeX](https://img.shields.io/badge/Built%20for-NukeX-0a7d63.svg?logo=nuke&logoColor=white)](https://www.foundry.com/products/nuke) +[![Status](https://img.shields.io/badge/Status-Production%20Ready-1e88e5.svg)](#) +[![License](https://img.shields.io/badge/License-Internal-616161.svg)](#) + # Biohazard VFX β€” Nuke Master Templates -A curated collection of **production-ready Nuke templates** developed by **Biohazard VFX**. -These templates **standardize workflows**, **accelerate shot setup**, and provide a rock-solid starting point for a wide range of VFX tasks. +Production-ready Nuke templates that standardize workflows, accelerate shot setup, and keep projects consistent. + +
--- -## πŸ“‚ Repository Structure - -| Directory | Description | -|-----------|-------------| -| **`Biohazard Master Rev 01/`** | Initial revision of the master Nuke template. A reliable foundation for general VFX tasks. | -| **`Biohazard Master Rev 02/`** | Updated version with refinements, optimizations, and new features. | -| **`Covert Template/`** | Template stolen from WeAreCovert | - -Each folder contains `.nk` script files representing the template’s node graph, structure, and configuration. +## Table of Contents +- [Overview](#overview) +- [Repository Tree](#repository-tree) +- [Templates](#templates) +- [Quick Start](#quick-start) +- [Conventions](#conventions) +- [Maintenance](#maintenance) +- [License](#license) --- -## ⚑ Usage +## Overview +A curated set of master templates for Nuke/NukeX. Each `.nk` ships with sensible defaults, labeled node graphs, and project-ready structure. -1. **Clone the repository** - ```bash - git clone https://git.biohazardvfx.com/BiohazardVFX/Nuke-Templates.git +--- + +## Repository Tree +```text +/ +β”œβ”€ Biohazard Master Rev 01/ +β”‚ β”œβ”€ Biohazard Master Rev 01.nk +β”‚ β”œβ”€ Biohazard Master Rev 01.nk~ # backup +β”‚ └─ desktop.ini +β”œβ”€ Biohazard Master Rev 02/ +β”‚ β”œβ”€ Biohazard Master Rev 02 LIGHT.nk # lightweight preset +β”‚ β”œβ”€ Biohazard Master Rev 02.nk +β”‚ └─ desktop.ini +β”œβ”€ Covert Template/ +β”‚ β”œβ”€ Covert Template.nk +β”‚ β”œβ”€ Covert Template.nk~ # backup +β”‚ └─ desktop.ini +└─ README.md +``` +--- + +## Templates + +
+Biohazard Master Rev 01 β€” foundation + +* Baseline master graph for general VFX tasks +* Balanced defaults for comp, color, and IO +* Safe starting point for new shows and quick turnarounds + +
+ +
+Biohazard Master Rev 02 β€” refined + +* Optimized node ordering and caching +* Cleaner label/annotation system +* LIGHT variant for rapid look-dev and previz + +
+ +
+Covert Template β€” special-purpose + +* Alternate layout used on select spots +* Keeps parity with Biohazard IO and color blocks + +
+ +--- + +## Quick Start + +```bash +git clone https://git.biohazardvfx.com/BiohazardVFX/Nuke-Templates.git +``` + +1. Open NukeX and load a template `.nk` as your starting script. +2. Update project paths, write nodes, and show tags in the designated setup group. +3. Save as your shot file; do not overwrite the master. + +--- + +## Conventions + +* **Color Management** β€” ACES-ready blocks; confirm show IDT/ODT in the config section. +* **IO** β€” Write nodes named per show spec; versioned outputs `.../renders/{shot}/{task}/v###`. +* **Structure** β€” Inputs β†’ Prep β†’ Comp β†’ Look/FX β†’ QC β†’ IO. +* **Notes** β€” Critical ops are annotated; use TODO tags for per-shot items. + +--- + +## Maintenance + +* Changes to masters require a new **Rev** directory and a short changelog in commit message. +* Keep backup files (`.nk~`) out of delivery packages. +* Report issues via internal tracker; attach script fragment or screenshot. + +--- + +## License + +Internal Biohazard VFX use only. Redistribution or external use is prohibited.