Path Template System
======================

What It Is
----------

The Path Template System allows the creation of dynamic paths for files and directories based on predefined and user-created variables. The system can be used in the main EasyStates output, post-render tasks, and Blender compositor File Output nodes, enabling full control over output paths for passes.

.. image:: images/path_template_system/easystates_output.webp
  :width: 600
  :alt: EasyStates Output Example

**File Manager Result**

Each scene state will have its own directory and output files, organized according to the defined template.

.. image:: images/path_template_system/output_dir.webp
  :width: 400
  :alt: EasyStates Output Example in File Manager

.. image:: images/path_template_system/output_file.webp
  :width: 400
  :alt: EasyStates Output Example in File Manager

Compositor File Output
----------------------

The EasyStates Path Template System can also be used with Blender's Compositor File Output Node. This allows you to define dynamic paths for each rendered scene state, making file organization and management much easier.

.. image:: images/path_template_system/blender_5_compositor.webp
  :width: 600
  :alt: EasyStates Output Example in File Manager

.. note::
  In Blender 4.5 and earlier, each output file will use the name defined in the added input.
  Simply name the input using the Path Template System syntax to define the output file name.

  .. image:: images/path_template_system/blender_4_compositor.webp
    :width: 700
    :alt: EasyStates Output Example in File Manager

**File Manager Result**

As defined in the example, each scene state will have a folder called "compositor" containing its respective output files.

.. image:: images/path_template_system/result_compositor_dir.webp
  :width: 400
  :alt: EasyStates Compositor Output Example in File Manager

.. image:: images/path_template_system/result_compositor_dir_files.webp
  :width: 400
  :alt: EasyStates Compositor Output Example in File Manager

Available Variables
-------------------

To see the variables available in the Path Template System, click the button to the right of the "Render All" button.

.. image:: images/path_template_system/variables_list.gif
  :width: 700
  :alt: EasyStates Variables List

Clicking a variable will copy its name to the clipboard, allowing you to paste it directly where needed using Ctrl + V or Command + V. In addition to copying the variable, its description will appear at the bottom of the window, helping you understand what each variable does.

Custom Variables
----------------

In addition to predefined variables, EasyStates allows the creation of custom variables. These variables can be defined per scene, scene state, or user.

**Scene Variables**: Scene variables are defined within the current file and have a fixed value. They are useful for storing information that does not change between scene states, such as project name, client, delivery date, etc.

**Scene State Variables**: Scene state variables are saved within the scene state itself, so the same variable can have different values depending on the active scene state.

**User Variables**: User variables are saved in the add-on preferences, making them available for any file opened in that Blender installation. They are useful for storing information used across multiple files, such as an asset folder path.

These variables can be created directly from the variables list. Simply click the "+" button in the section where you want to create the variable (Scene, Scene State, or User), then define a name (without spaces or special characters) and a value. Once created, the variable will be available for use in the Path Template System.

.. image:: images/path_template_system/creating_variables.gif
  :width: 700
  :alt: Creating EasyStates Custom Variables