|
Window Framework for UI Toolkit v2.0.x
|
Start with a project-owned setup, then build your interface around it. Theme Manager can create a repository from the supplied WindowFramework defaults and connect its theme data, controller prefab, root UXML, and panel settings for you.
The workflow below uses that guided setup. You do not need to assemble the starter references one by one, copy Demo windows into your application, or edit the shipped default repository.
Addressables configuration is a separate, optional workflow, described later on this page. It is not enabled by creating a repository.
The main setup ends with a configured window host in your scene. Your custom window content comes next, in Windows and Layout.
From Unity's main menu, choose:
Tools > Garage-Ware Games > Window Framework > Theme Manager**
Click New Repository in the toolbar to open the guided setup form. You can also reach the workflow through Create Project Theme Repository in the repository browser.
For a first setup, keep the supplied asset defaults as the source. These are distinct from the repositories inside the Demo folder: the defaults provide the starter setup, while Demo repositories illustrate usage and appearance.
Work through the setup form from top to bottom. The fields describe the repository you are about to create; browsing and checking the form do not create it.
The form starts with the supplied WindowFramework defaults. This is the straightforward starting point for a new application.
Choose Another Project Repository** is for copying an eligible repository you already own. That copy preserves its existing layout and configuration rather than rebuilding it as a fresh default setup. Demo-folder repositories are not offered as copy sources.
The names serve different purposes:
For example, a parent of Assets/MyProject/UI/Resources and a repository folder name of ProjectThemes produce Assets/MyProject/UI/Resources/ProjectThemes.
A Resources location is suggested for convenience, but supported direct project references are also allowed. Choose a fresh destination: creation does not merge into or overwrite an existing repository folder.
For a setup created from the supplied defaults, review these controller choices:
Use Window Frames Only when you want the theme to target framework windows rather than the surrounding interface. Parent Panel extends the scope to the controller's panel. All Panels reaches more broadly and can affect other UI through stylesheet precedence; choose it deliberately when integrating with an existing interface.
Memory enablement remains your controller policy. Player themes, saved preferences, and preference resets do not override it.
You can request a new PanelSettings asset or select an existing project-owned panel.
Enable I have a PanelSettings asset only when you want to reuse one, then assign it in Existing project panel. The selected panel is shared intentionally: repository creation does not rewrite its stylesheet, scaling, or text settings.
Otherwise, the workflow creates a new PanelSettings asset beside the generated theme data. WindowFramework's theme composition is supplied through the controller; the setup does not add a WindowFramework stylesheet to the panel asset itself.
Click Check Setup to review the current source and inputs. Resolve any validation messages, then click Create Repository.
The form displays progress while it copies and reconnects the setup. Wait for the success message before using the result. If you cancel, the form asks for confirmation and removes operation-created output after the current Unity asset operation finishes.
On success, Theme Manager opens the new ThemeData and reports the generated asset locations.
For the supplied-default workflow, the result includes:
References inside the copied source are reconnected to their copies. References to artwork or other assets outside that source boundary remain external references; creation does not silently replace every shared dependency.
Place the generated controller prefab from your project repository into the intended scene.** Do not use the shipped template as your application's repository setup, and do not add a second host if that scene already contains your intended controller. The controller is a singleton and persists across scene loads.
Inspect your generated instance and confirm:
Save your scene after placing and configuring the instance.
Repository creation does not place an instance in the scene, add Demo windows or hotbar content, or create your application's custom controls. A blank root is expected at this stage; it is not a missing-window error.
You now have the host and theme configuration for your interface. Add WindowFrame content through C# or UXML, following Windows and Layout for window creation, placement, behavior, docking, tabs, and memory identifiers.
You can retain the generated blank root or extend the project-owned UXML with your application's content. Keep your working layout and themes in your project repository rather than editing the installed asset defaults.
When you have added a window, enter Play Mode and check that it appears and behaves as intended. A host with no window content is not a complete visual demonstration.
Use this section if your application will load theme data through Addressables. The repository setup above does not enable the integration, select an Addressables default, or build a content catalog.
The runtime loading path uses the active label to obtain its theme data. If loading fails, check the Console, the active collection label, group schemas, and catalog/build configuration. See Troubleshooting for the troubleshooting guide.
Player-editable theme files use their configured filesystem folder; they are not automatically made Addressables assets by this setup.
Before moving on, check that:
Continue to Windows and Layout to build the interface, or Theme Studio and Manager to customize its appearance. Graph-based users can consult Visual Scripting Integration for the preview integration. Player customization is covered separately in Developer Extensions and Player Themes.