Configuration¶

A Toml configuration is used to define templates and default options.

The configuration file must be named nomenclator.toml. It is located in ~/.nuke or by using the NOMENCLATOR_CONFIG_PATH environment variable.

The configuration can be edited via the Settings dialog:

Global¶

Global configuration options include the following:

default-padding¶

Define default value for the padding token.

default-padding = "###"

Note

The default padding will be 1. It will use the Hash notation (#) or the printf notation (%01d) following the preferences.

default-description¶

Define default value for the description token.

default-description = "comp"

Note

The default description will be the first item of the descriptions list.

descriptions¶

Define all available values for the description token.

descriptions = ["desc1", "desc2", "desc3"]

Note

The default descriptions are “comp”, “precomp”, “roto” and “cleanup”.

create-subfolders¶

Define whether sub-folders defined for render outputs must be created when a naming convention is applied.

create-subfolders = true

Note

By default, sub-folders are not created when a naming convention is applied.

comp-templates¶

Define the template configurations available to define the naming convention of a composition scene file (.nk) and associated render outputs.

[[comp-templates]]
id = "Episodic"
pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/scripts"
pattern-base = "{project}_{episode}_{shot}_{description}_v{version}"

[[comp-templates.outputs]]
id = "comps"
pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/comps"
pattern-base = "{project}_{episode}_{shot}_comp_v{version}"

[[comp-templates.outputs]]
id = "precomps"
pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/precomps"
pattern-base = "{project}_{episode}_{shot}_precomp_v{version}"

Note

By default, no composition templates are set.

project-templates¶

Define the template configurations available to define the naming convention of a project file (.hrox).

[[project-templates]]
id = "Conform"
pattern-path = "/path/{project}/edit/hiero"
pattern-base = "{project}_{description}_v{version}"

Note

By default, no project templates are set.

colorspace-aliases¶

Define all aliased to use for colorspace values returned by Nuke to resolve the colorspace token.

[colorspace-aliases]
"Gamma1.8" = "gamma18"
linear = "lin"
sRGB = "srgb"

Note

By default, the “lin” alias is defined for the “linear” value and the “srgb” alias is defined for the “sRGB” value.

tokens¶

Define any additional token values that could be found in templates.

[tokens]
foo = "bar"

Note

If the token {foo} is found in any templates, it will be replaced by “bar” following this example. An error will be raised if no value is defined.

See also

Custom Tokens

max-locations¶

Define the maximum number of recent locations to display in the comp and project management dialog.

max-locations = 10

Note

By default, only 5 recent locations will be displayed.

See also

max-padding¶

Define the maximum available value of padding for image sequences. It will adjust the list of padding available in the comp and output management dialogs.

max-padding = 10

Note

By default, the maximum value of padding is 5.

username¶

Define the value for the username token.

username = "steve"

Note

The default username will be the value returned by getpass.getuser().

Template¶

A template configuration is a subset of the configuration which define the naming convention for a composition scene file and its outputs or for a project file.

The list of template configurations can be defined via the “Comp Resolvers” and “Project Resolvers” tabs of the Settings dialog:

pattern-path¶

Define the pattern of a location path compatible with the naming convention.

It can be defined without any tokens:

pattern-path = "/path/scripts"

If tokens are defined, the matching values will be extracted to be reused in the pattern-base option:

pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/scripts"

See also

Extracted Tokens

pattern-base¶

Define the naming convention of the base of a scene file name (without additional elements and extension).

It can be defined without any tokens:

pattern-base = "foo"

It can also be defined with tokens which will be dynamically resolved:

pattern-base = "{project}_{episode}_{shot}_{description}_v{version}"

See also

Using Tokens

Warning

If a token can not be resolved, an error will be raised.

default-expression¶

Define a custom expression to extract token values.

default-expression = "\w+"

Note

By default the regular expression used to search the token is [\w_.-]+.

See also

Extracted Tokens

match-start¶

Define whether compatible paths must match exactly the start of the corresponding pattern-path value.

match-start = false

If this value is set to false, it is possible to define a flexible root folder for scene files where the naming convention will be applied.

Note

By default, this value is set to true.

match-end¶

Define whether compatible paths must match exactly the end of the corresponding pattern-path value.

match-end = false

If this value is set to false, it is possible to define flexible subfolders for scene files where the naming convention will be applied.

Note

By default, this value is set to true.

append-username-to-name¶

Define whether the username should be appended to the scene file by default.

append-username-to-name = true

This feature is only available when the comp manager dialog or the project manager dialog is opened and the current file name is matching the template.

Note

By default, this value is set to false.

outputs¶

Define the output template configurations available to define the naming convention of render outputs.

[[comp-templates.outputs]]
id = "comps"
pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/comps"
pattern-base = "{project}_{episode}_{shot}_comp_v{version}"

[[comp-templates.outputs]]
id = "precomps"
pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/precomps"
pattern-base = "{project}_{episode}_{shot}_precomp_v{version}"

Note

By default, no render output templates are set.

Warning

No render outputs can be set for project files (.hrox).

Output Template¶

An output template configuration is a subset of a Template which define the naming convention for a render output video or image sequence.

id¶

Define the identifier of the output destination. It will be displayed in the destination selector within the comp manager dialog.

id = "comps"

pattern-path¶

Like the pattern-path option used for the scene files, this option define the pattern of an output location path compatible with the naming convention.

pattern-path = "/path/{project}/{episode:ep\d+}/{shot:sh\d+}/comps"

pattern-base¶

Like the pattern-base option used for the scene files, this option define the naming convention of the base of a render output.

pattern-base = "{project}_{episode}_{shot}_comp_v{version}"

append-username-to-name¶

Define whether the username should be appended to the render output file by default.

append-username-to-name = true

This feature is only available when the comp manager dialog is opened and the current output file name is matching the template.

Note

By default, this value is set to false.

append-colorspace-to-name¶

Define whether the colorspace should be appended to the render output file by default.

append-colorspace-to-name = true

This feature is only available when the comp manager dialog is opened and the current output file name is matching the template.

Note

By default, this value is set to false.

append-passname-to-name¶

Define whether the passname should be appended to the render output file by default.

append-passname-to-name = true

This feature is only available when the comp manager dialog is opened and the current output file name is matching the template.

Note

By default, this value is set to false.

append-passname-to-subfolder¶

Define whether the passname should be appended to the render output subfolder by default.

append-passname-to-subfolder = true

This feature is only available when the comp manager dialog is opened and the current output file name is matching the template.

Note

This option is ignored if the corresponding pattern-base value does not define a subfolder.

Note

By default, this value is set to false.