# Rosalina [![openupm](https://camo.githubusercontent.com/c85c8cff29acca4625486555b37fd8516b3a91734fcb2041e5bf79d366d3c620/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f636f6d2e65617374796c6162732e726f73616c696e613f6c6162656c3d6f70656e75706d2672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d)](https://openupm.com/packages/com.eastylabs.rosalina/) Rosalina is a code generation tool for Unity's UI documents make with the new UI Toolkit. It automatically generates C# UI binding scripts based on a UXML document template. ## Key features * [UI Documents](https://docs.unity3d.com/Manual/UIE-simple-ui-toolkit-workflow.html) * Automatic C# bindings generation * C# document script * [`EditorWindow`](https://docs.unity3d.com/ScriptReference/EditorWindow.html) support * Automatic C# bindings generation * C# document script * Custom Components * Automatic C# bindings generation * C# document script ## How to install Rosalina can either be installed via OpenUPM: https://openupm.com/packages/com.eastylabs.rosalina/ Or by using the following git repository: ``https://github.com/Eastrall/Rosalina.git`` ### Installing via OpenUPM Rosalina is now available via OpenUPM: https://openupm.com/packages/com.eastylabs.rosalina/ OpenUPM provides a detailed explanation of how to add packages to unity. ### Installing via git repository In Unity, navigate to ``Window -> Package Manager``: ![image](https://user-images.githubusercontent.com/4021025/204278700-989b139c-cbf3-4c56-8ebe-91309258aac2.png) In the ``Package Manager``, click on the ``+`` on the top left and select ``Add package from git URL...`` ![image](https://user-images.githubusercontent.com/4021025/204278730-38f06044-b298-484e-b6ad-43cb1684134e.png) No use the following path to install Rosalina ``https://github.com/Eastrall/Rosalina.git`` ![image](https://user-images.githubusercontent.com/4021025/204278754-8bfa4b2d-dd57-4a59-af45-ff05470272fc.png) You can now start to work with Rosalina. ## How it works Rosalina watches your changes related to all `*.uxml` files contained in the `Assets` folder of your project, parses its content and generates the according C# UI binding code based on the element's names. Take for instance the following UXML template: **`SampleDocument.uxml`** ```xml ``` Rosalina's `AssetProcessor` will automatically genearte the following C# UI bindings script: > ℹ️ Note: All generated files are located in the `Assets/Rosalina/AutoGenerated/` folder. **`SampleDocument.g.cs`** ```csharp // using UnityEngine; using UnityEngine.UIElements; public partial class SampleDocument { [SerializeField] private UIDocument _document; public Label TitleLabel { get; private set; } public Button Button { get; private set; } public VisualElement Root => _document?.rootVisualElement; public void InitializeDocument() { TitleLabel = Root?.Q("TitleLabel"); Button = Root?.Q