Skip to main content

Render Tokens

Intro

Render tokens can be added to the File Name or Path attributes in the Render Manager and used to automate the file names of renders.

To add a Render Token, simply right click in the File Name or Path input and select one from the drop down menu. Each token will appear between angle brackets e.g. <Token> and be highlighted. Alternatively tokens can be added by manually typing them. If an invalid token is accidentally entered it will be highlighted red and will not be used.

Render Tokens

  • Composition - <Composition> the name of the composition.
  • Scene - <Scene> the name of the Scene (e.g. name.cv).
  • Project - <Project> the name of the current Project. A project must be set in Project Settings for this to work.
  • Frame Number - <Frame> the frame number.
  • Resolution - <Resolution> the resolution of the Composition.
  • FPS - <FPS> the FPS (frames per second) of the Composition.
  • Render Format - <Format> the format (.png, .jpg, .mov etc).
  • Dynamic Index - <Dynamic> outputs the Dynamic Index for each dynamic render.
info

A <Token> will be used in place of, rather than in addition to, any automatically generated value (like the frame number or dynamic index). e.g.

  • A File Name of Composition with Padding set to 3 would output Composition.000.png
  • A File Name of Composition.<Frame> with Padding set to 3 would also output Composition.000.png and not Composition.000.000.png.

Date and Time Tokens

  • Day (Name) - <D> e.g. if the current day is Monday the token would output Monday.
  • Day of the Month (Number) - <DD> e.g. if the current date is 11th August the token would output 11.
  • Month (Number) - <MM> e.g. if the current date is 11th August the token would output 8.
  • Month (Name) - <M> e.g. if the current date is 11th August the token would return August
  • Month (Short Name) - <m> e.g. if the current date is 11th August the token would return Aug.
  • Year (YYYY) - <YYYY> e.g. if the current year is 2024 the token would output 2020.
  • Year (YY) - <YY> e.g. if the current year is 2024 the token would output 20.
  • Time (HH:MM) - <T> e.g. if the current time is 5:15pm the token would output 17:15.
  • Time Zone - <TZ> e.g. if in Manchester (UK), the token would output GMT.
  • Weekday-Day-Month - <d>-<DD>-<m> e.g. if the current date is 11th August, 2020 the token would output Tue-11-August.

Custom Time Formats

It's also possible to create custom time formats. For example <%Y> or <%H%M> or <%B-%Y>.

Syntax

%Y - writes year as a decimal number, e.g. 2017
%y - writes last 2 digits of year as a decimal number (range [00..99])
%b - writes abbreviated month name, e.g. Oct
%B - writes full month name, e.g. October
%m - writes month as a decimal number (range [01..12])
%V - writes ISO 8601 week of the year (range [01..53]). In IS0 8601 weeks begin with Monday
%j - writes day of the year as a decimal number (range [001..366])
%d - writes day of the month as a decimal number (range [01..31])
%a - writes abbreviated weekday name, e.g. Fri
%A - writes full weekday name, e.g. Friday
%u - writes weekday as a decimal number, where Monday is 1 (ISO 8601 format)
%H - writes hour as a decimal number, 24 hour clock (range [00-23])
%I - writes hour as a decimal number, 12 hour clock (range [01..12])
%M - writes minute as a decimal number (range [00..59])
%S - writes second as a decimal number (range [00..60])
%c - writes standard date and time string, e.g. Sun Oct 17 04-41-13 2010
%X - writes localised time representation, e.g. 18-40-20 or 6-40-20 PM
%D - equivalent to %m-%d-%y
%F - equivalent to %Y-%m-%d (the ISO 8601 date format)
%r - writes localised 12-hour clock time
%R - equivalent to %H-%M
%T - equivalent to %H-%M-%S (the ISO 8601 time format)
%p - writes localised a.m. or p.m.
%z - writes offset from UTC in the ISO 8601 format (e.g. -0430)
%Z - writes locale-dependent time zone name or abbreviation e.g BST.

Environment Variables

Environment Variables can also be used as Render Tokens. Use the syntax <Env:VARIABLENAME>. For example:

  • macOS - adding <Env:HOME> to the Path would result in files being written to Macintosh HD/Users/<YourUser>.
  • Windows - adding <Env:USERPROFILE> to the Path would result in files being written to C:\Users\<YourUser>.

To find out which environment variables are in use:

  • macOS - type printenv into Terminal.
  • Windows - type set into Command Prompt.
tip

The Formatted String Generator can be used to concatenate Tokens with other attribute values/strings as a way to generate dynamic file names.

Tokens can be entered manually (e.g. <Resolution>) but they will only appear highlighted once they are passed to the Render Manager by connecting the String Generator to the Render Queue Item's File Name.

A String Generator containing Tokens connected to the RQI's File Name.