34 Getting Started
Francesco Bellini edited this page 2024-11-10 18:59:49 +01:00

Getting Started

Custom Templates is very simple to use!

Just create or download your templates files and define them in the preferences of the add-on.

Once defined, you can easily start from one of your templates, either from the File > New menu, as well as from the Splash Screen (according to preferences).

Steps

  1. Prepare your templates

    • Create your template in a new project and save it to .blend file on you computer
    • or download online Blender templates that suit your need (see Find templates online page)

      You can place your .blend files where you prefer on your PC.
      Keep in mind that using a single folder for your templates, you will be able to add them from folder, in one click.

    • Make sure your templates only has absolute paths in case of external resources.
      If you have relative paths for external resources in your templates, you can either manually update them, executing File > External Data > Make Paths Absolute on them, or by using the feature from custom templates.
      This feature will do the same thing, in background, and will update your file, but only if relative paths are detected in your file.
      An option to backup your file before update, it's available.
      You can do this for single templates, or for all templates at once.

      Note: In case of many templates, it may take a while to complete.
      The results of this updates are described in the Info area of blender.

  2. Define your templates

    There are many ways to define your templates:

    • [+] button, from add-on preferences, select the path to .blend file and give it a name
    • [Folder] button, from add-on preferences, select a directory containing .blend files
      By default, adding from folder, only lookup the first level of the folder (will not lookup nested folders), but you can incrase the Depth parameter while selecting the folder, to also lookup the given number of nested folders.
      Every template added from folder, will use as name the clean file name.
    • Import templates list from JSON file
      If you previously exported your templates list to JSON, you can easily import it back. Either from preferences menu near templates list, as well as from File > Defaults > Import templates.
      Note: This will replace the current list!
    • File > Defaults > Select new template, will open a popup where you can select the path and name your template
    • File > Defaults > Use current file as template, will open a popup where you can name your template (only avaliable with a .blend file loaded)
  3. Export your templates (optional, but recommended)
    Once your templates are ready, you can export the list to JSON file. Either from preferences menu near templates list, as well as from File > Defaults > Export templates.
    This way you will be able to restore the list later, if needed. For example after disabling and re-enabling the add-on, or on a fresh Blender install.

Note

You can add, remove, update, reorder your templates any time.
Since your template file is read each time you open your template, you can update the content of your .blend templates any time.

And that's it!
As soon as you define your templates you will see them in the File > New menu and in the Splash Screen.


Custom Template - Preview Image

Additional functions

  • Choose Splash Screen Templates
    You can decide if you prefer to see default templates or your custom templates in the splash screen.
    You can switch this option from add-on preferences, or directly from the menu in the splash screen.

    Now you can also decide which templates are visible in the splash screen.
    Show or hide any template with the Blender button in the template row (preferences).

  • File > New > Start From... option
    Select any .blend file and use it immidiatly as template. Optionally, add it to the list, on the fly.
    You can activate this option from add-on preferences Extra section.

  • Clear current templates
    Maybe you added from the wrong folder, maybe it's just time for a fresh start... It doesn't matter...
    You can always reset your templates from the add-on preferences menu as well as using File > Defaults > Clear current templates
    For safety, it will ask a confirm before deletion.

  • Manage templates
    A simple button to open Custom Templates preferences (located in Preferences > Add-Ons > Custom Templates)
    You can find it in the Splash Screen menu as well as in the File > Defaults menu.

  • Ensure absolute paths in templates external resources
    Having relative paths for external resources, in templates, will not work, because templates has no path, initially.
    Custom Templates wants to make you life easier, so we can automate the process of ensuring absolute paths on your templates, in background. You can process single templates to ensure absolute paths, by using the file-process icon in the template row (preferences).
    You can process al your templates to ensure absolute paths, by using the options of the list menu (preferences), or by using File > Defaults > Ensure absolute paths in templates.

    You can optionally check Backup Template to save a copy of your original template before saving this changes.
    This backup will be saved at the same location as the original with suffix .backup.blend (or .backup_<number>.blend if the file is already present)

    At any time, if you prefer, you can always make your template paths relative by using File > External Data > Make Paths Relative on your file. Anyway this will affect any external data path.

  • Add workspace from templates
    Usually while adding a new workspace, Blender let you choose from the workspaces avaliable in the 5 default templates.
    Now you can add a workspace to the current project, from one of your templates!
    Right-click one of your workspace and use the menu Add from Custom Templates (first select the template, and then the workspace to copy in the current project).

Custom Template - Add workspace from templates