refined README.md
This commit is contained in:
parent
9fcb35406d
commit
c43a45ae1a
114
README.md
114
README.md
@ -1,24 +1,112 @@
|
||||
<div align="center">
|
||||
|
||||
[](https://biohazardvfx.com)
|
||||
[](https://www.foundry.com/products/nuke)
|
||||
[](#)
|
||||
[](#)
|
||||
|
||||
# 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.
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📂 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.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
1. **Clone the repository**
|
||||
```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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user