Skip to content

fuqunaga/RosettaUI

Repository files navigation

RosettaUI

npm version openupm

Code-based UI library for development menu for Unity



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)
            )
        );
    }
}

✨ Features

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

    copyandpaste


πŸ”„ 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.


⬇️ Installation

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


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

Enter the following and click the Save button.

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

Window > Package Manager

Select MyRegistries> fuqunaga > RosettaUI and click the Install button


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


πŸš€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).

πŸ‘‰ Examples are available in this repository.
We recommend downloading and checking it out.


πŸ’» Environment

Platform Support
Windows βœ”
Mac Maybe (not tested)
Linux Maybe (not tested)
IL2CPP Not supported

πŸ’‘οΈ 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
}

For LegacyInputSystem, refer to RosettaUIRoot.IsFocused().

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

πŸ”Ž Related Libraries

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

About

Code-based UI library for development menus for Unity

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 7