refined README.md

This commit is contained in:
NicholaiVogel 2025-09-30 19:44:05 -06:00
parent 9fcb35406d
commit c43a45ae1a

118
README.md
View File

@ -1,24 +1,112 @@
<div align="center">
[![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 # Biohazard VFX — Nuke Master Templates
A curated collection of **production-ready Nuke templates** developed by **Biohazard VFX**. Production-ready Nuke templates that standardize workflows, accelerate shot setup, and keep projects consistent.
These templates **standardize workflows**, **accelerate shot setup**, and provide a rock-solid starting point for a wide range of VFX tasks.
</div>
--- ---
## 📂 Repository Structure ## Table of Contents
- [Overview](#overview)
| Directory | Description | - [Repository Tree](#repository-tree)
|-----------|-------------| - [Templates](#templates)
| **`Biohazard Master Rev 01/`** | Initial revision of the master Nuke template. A reliable foundation for general VFX tasks. | - [Quick Start](#quick-start)
| **`Biohazard Master Rev 02/`** | Updated version with refinements, optimizations, and new features. | - [Conventions](#conventions)
| **`Covert Template/`** | Template stolen from WeAreCovert | - [Maintenance](#maintenance)
- [License](#license)
Each folder contains `.nk` script files representing the templates node graph, structure, and configuration.
--- ---
## ⚡ 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
<details>
<summary><strong>Biohazard Master Rev 01</strong> — foundation</summary>
* Baseline master graph for general VFX tasks
* Balanced defaults for comp, color, and IO
* Safe starting point for new shows and quick turnarounds
</details>
<details>
<summary><strong>Biohazard Master Rev 02</strong> — refined</summary>
* Optimized node ordering and caching
* Cleaner label/annotation system
* <code>LIGHT</code> variant for rapid look-dev and previz
</details>
<details>
<summary><strong>Covert Template</strong> — special-purpose</summary>
* Alternate layout used on select spots
* Keeps parity with Biohazard IO and color blocks
</details>
---
## 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.