RosettaUI

Code-based UI library for development menu for Unity

<img src="https://github.com/user-attachments/assets/4313a51f-e319-457b-a227-a0caf4d0f908" /> <br> <br> <table> <tr> <td>

public class ExampleSimple : MonoBehaviour
{
    public string stringValue;
    public float floatValue;
    public int intValue;
    public Color colorValue;

    
    void Start()
    {
        var root = GetComponent<RosettaUIRoot>();
        root.Build(CreateElement());
    }

    Element CreateElement()
    {
        return UI.Window(nameof(ExampleSimple),
            UI.Page(
                UI.Field(() => stringValue),
                UI.Slider(() => floatValue),
                UI.Row(
                    UI.Field(() => intValue),
                    UI.Button("+", () => intValue++),
                    UI.Button("-", () => intValue--)
                ),
                UI.Field(() => colorValue)
            )
        );
    }
}

</td> <td width="50%"> <img src="https://github.com/user-attachments/assets/16f31cf9-5608-4acc-8629-6c22bc8ef261" /> </td> </tr> </table> <br>

✨ Features

• Undo/Redo surpport (runtime only)
• Inspector-like visual editor for Gradient and AnimationCurve at runtime

<table> <tr> <td width="45%"> <img src="https://github.com/user-attachments/assets/66e4ccff-5800-4ef1-a026-370370d36bcb" /> </td> <td> <img src="https://github.com/user-attachments/assets/6f58a454-47e3-402f-8f99-1774ad8f0825" /> </td> </tr> </table>

• Inspector-compatible Copy and Paste

  

<br>

🔄 Ver1 → Ver2 Migration

Please remove the RosettaUI.UIToolkit package from the Package Manager.
In Ver2, the RosettaUI.UIToolkit package is now included in the RosettaUI package.

Keyboard.current.onTextInput

If you are using Keyboard.current.onTextInput, be aware that it now also fires during UI operations..
Consider using KeyControl (e.g., Keyboard.current[Key.A].wasPressedThisFrame) as an alternative.

<br>

⬇️ Installation

This package uses the scoped registry feature to resolve package dependencies.

<br>

Edit > ProjectSettings... > Package Manager > Scoped Registries

Enter the following and click the Save button.

"name": "fuqunaga",
"url": "https://registry.npmjs.com",
"scopes": [ "ga.fuquna" ]

<br>

Window > Package Manager

Select MyRegistries> fuqunaga > RosettaUI and click the Install button

<br>

Input System (optional)

RosettaUI recommends using Input System.
See Tips.

Install according to the official documentation.
https://docs.unity3d.com/Packages/com.unity.inputsystem@1.5/manual/Installation.html

<br>

🚀How to use

1. Add Packages/RosettaUI/UIToolkit/Runtime/RosettaUIRootUIToolkit.prefab to the Hierarchy.
2. Write code to generate an Element instance.
3. Call RosettaUIRoot.Build(Element) to generate the actual UI (see ExampleSimple).

👉 <b>Examples are available in this repository.</b>
We recommend downloading and checking it out.

<br>

💻 Environment

| Platform | Support | | -------- |--------------------| | Windows | ✔ | | Mac | Maybe (not tested) | | Linux | Maybe (not tested) | | IL2CPP | Not supported |

<br>

💡️ Tips

Disable input when UI focused

During UI operations, input to the application is suppressed by replacing the keyboard, pointer, and mouse devices with dummies.

// false while RosettaUI focused
if ( Keyboard.current[Key.A].wasPressedThisFrame )
{
    // do something
}

[!WARNING] the Keyboard.current.onTextInput event will still be called.

For LegacyInputSystem, refer to RosettaUIRoot.IsFocused().

if ( !RosettaUIRoot.IsFocused() && Input.GetKeyDown(KeyCode.A) )
{
    // do something
}

<br>

Custom Undo/Redo

Users can register custom Undo/Redo actions.
For details, try running ExampleUndo.

<br>

🔎 Related Libraries

PrefsGUI - Accessors and GUIs for persistent preference values using a JSON file