Skip to content

charlesangus/DeepC

Repository files navigation

DeepC

DeepCAnglerfish

Welcome to the DeepC, a suite of Deep compositing plugins for Foundry's Nuke. While I'm sure large studios have something similar to these tools, this open-source project makes them available to small and mid-size studios.

TOC

Plugins

What are the tools offered in the DeepC toolkit? The Wiki has a description for each and an overview of all available plugins.

Also, head over to the Examples page for some visuals.

You can read a quick description of some below.

Why DeepC?

DeepC has several advantages over DeepExpression-based solutions to working with Deep data.

Unique Features

World-position noise in Nuke has always been limited by Nuke's 3D noise algorithm. It's fine for a 2D image, but when working with 3D noise, your really need that fourth dimension so the noise can change over time. DeepCPNoise brings 4D noise to Nuke for the first time, by including and extending the open-source FastNoise library. 4D simplex noise in Nuke!

Familiar Tools, Familiar Power

DeepCGrade works just like the regular Grade node. You can mask it with rotos from the side input (incredibly, this is not available in the standard toolset, or with the DeepExpression node). You can use Deep masks coming in from the top. You can easily configure the channels to process and those to use as masks, just as you normally would.

Endlessly Extensible

The power of DeepC is limited only by the power of the NDK. Features like DeepCAddChannels and DeepCShuffle were made possible using the NDK.

Speed

Now that basic functionality is implemented, the focus will be on accelerating the speed of the toolset using the NDK.

Get Them!

Check the releases page for this repo to get compiled versions of the plugins for Linux and Windows.

Build

DeepC uses NukeDockerBuild for containerised cross-platform builds targeting Nuke 16+.

Prerequisites

  • Docker
  • git and zip (for release archive creation)

Note: On first run, NukeDockerBuild will download and build its Docker images (~1 GB Nuke installer download). You must accept the Foundry EULA when prompted.

Usage

Build for both Linux and Windows (default Nuke 16.0):

./docker-build.sh

Build for a specific platform:

./docker-build.sh --linux
./docker-build.sh --windows

Build for specific Nuke versions:

./docker-build.sh --versions 16.0 16.1

Output

Release archives are placed in the release/ directory:

release/DeepC-Linux-Nuke16.0.zip
release/DeepC-Windows-Nuke16.0.zip

Examples

We created a repository which includes some example deep render scenes to try/test/use this plugin.
In futur we will add nuke project files to show how the plugins work.
https://github.com/charlesangus/DeepCExamples

Contributing

Currently, DeepC is maintained by me and Falk Hofmann. I'd love your contributions, though!

If you'd like to contribute, please fork the project make a new feature branch for your contribution. Ideally, also let me know what you're up to so we don't duplicate efforts!

Once you're happy with your work, submit a pull request so I can merge your work back in.

Conventions

  • 4-space hard tabs
  • private/protected variable names start with '_' (one underscore)
  • variable/function names use lowerCamelCase