Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Tip

Check out this video tutorial to get started.

Image Added

The setup file contains the information about which config file to use for the software.
The config file contains the global configuration for all libraries (naming convention, file structure, …)
A library contains a collection of elements. It exists of the library file and the database for this one library.

Info

~ (tilde) is your users home directory: E.g..
Linux/macOS: /home/myuser or
Windows: C:\Users\myuser / %userprofile%

default location setup file

~/.das-element/setup.ini

default location config file or custom location

~/.das-element/das-element.conf

Here are some common file path locations that you might need:

type of file

description

path

setup file

Default location setup file
This file references

to the config file.As an alternative you can set the environment variable

to

specify

the config file

location

.


Order of validation:

Environment Variable

  • setup file

  • ~/.das-element/setup.ini

    or environment variable:
    DASELEMENT_CONFIG_PATH

    config file

    Default location config file or custom location

    ~/.das-element/das-element.conf
    or some custom location

    variables file

    File to store environment variables that are loaded on software startup

    ~/.das-element/variables.env

    models

    location for machine learning models

    ~/.das-element/models

    log files

    for error logs etc.

    ~/.das-element/logs

    preview files

    The software creates previews of your elements to increase performance.
    If you want to remove the previously created previews, just remove the temp folder. It automatically removes files older than 14 days.

    Linux: ~/tmp/das-element
    MacOS: /$TMPDIR/das-element
    Windows: %temp%/das-element

     

    Setup file

    The setup file contains the information about which config file to use for the software.

    ...

    Windows
    %userprofile%/.das-element/setup.ini

    As an alternative you can set the environment variable to specify the config file location.

    Order of validation:

    1. Environment Variable (DASELEMENT_CONFIG_PATH)

    2. setup file (setup.ini)

    Info

    If you want to force the creation of a new setup, simply delete the setup file.

    ...

    Info

    Create different setup files to control different setups scenarios.
    For example: for remote working artist that only should have access to the proxy files or individual projects that require a very specific setup.

    Create new config

    The dialog to create a new configuration (welcome screen) will automatically appear the first time you start the application, or if a configuration file specified in the setup.ini file or by the environment variable DASELEMENT_CONFIG_PATH cannot be found. To create a new configuration, navigate to:

    Settings → Global → Path to config → plus-icon button (Create new config)

    ...

    Library file

    A library contains a collection of elements.
    The library files are saved by default in a hidden folder .config in library root location.

    Each library exists of two parts:

    1. Library file
      contains the configuration of the library, like value overwrites and transcoding templates.
      {library_name}.lib - file content is JSON format

    2. Database
      holds all information about the elements of this library
      For file based database (SQLite): {library_name}.db

    Info

    For Studios it is recommended to use a server-based database like PostgreSQL, MySQL or MariaDB.

    Warning

    It is recommended to create a regular backup for the database!

    Note

    Security warning: the library file is saved in plain text so the database password will be visible and is not encrypted!Especially if you are using SQLite.


    Define the file structure in the global settings and overwrite values or path patterns that are relevant for this library. This way, the naming convention stays consistent through all libraries, but you can control individual parts by overwriting values depending on this specific library.

    ...