dev.UpdatingHomeTemplate - tixl3d/tixl GitHub Wiki

Updating the default home template

When user's create a new project it will be initialized with a template. This is stored in .Defaults/default-home/*.

These will use a {{handlebar}} syntax to describe the fields that will be initialized with the new project's name and author.

Here you will find three files:

  • {{PROJ}}.t3ui
  • {{PROJ}}.t3
  • {{PROJ}}.cs

To update the template...

  1. Create a new project called MyNewProject.
  2. Update the project's home with your new content.
  3. Save and exit TiXL editor.
  4. Copy the .t3, .t3ui, and .cs files from your project's folder (e.g. C:/Users/YourName/Documents/TiXl/MyNewProject) to .Defaults/default-home/ in your tixl source code folder.
  5. Rename the files (e.g. MyNewProject.t3 -> {{PROJ}}.t3, replacing the original once.
  6. Open all three files (or the folder) in a text editor like Visual Studio Code.
  7. Replace the Id, user name, project name and namespace as follows....
Name Example (in your file) Replace with
Class-Id 09a70ccd-f4b8-4640-b41d-62516a3f485d {{GUID}}
Your user name JonDoe {{USER}}
Project Name MyNewProject {{PROJ}}
Namespace JonDoe.MyNewProject {{NAMESPACE}}

in {{PROJ}}.cs replace...

using T3.Core.Operator;
using T3.Core.Operator.Attributes;
using System.Runtime.InteropServices;
using T3.Core.DataTypes;
using T3.Core.Operator.Interfaces;
using T3.Core.Operator.Slots;
using T3.Core.Resource;

namespace {{NAMESPACE}};

[Guid("{{GUID}}")]
internal sealed class {{PROJ}} : Instance<{{PROJ}}>
{
}

In {{PROJ}}.t3...

{
  "Name": "{{PROJ}}",
  "Id": "{{GUID}}",

In {{PROJ}}.t3ui...

{
  "Id": "{{GUID}}"/*{{PROJ}}*/,
  "Description": "{{USER}}'s workspace for {{PROJ}}.",
  "InputUis": [],
  "SymbolChildUis": [

After that...

  1. Start TiXL
  2. Create new project (e.g. MyNewProject2) and verify that your changes were applied
  3. Commit or push your changes as a pull request on GitHub.
⚠️ **GitHub.com Fallback** ⚠️