TL;DR: Step 1:
Right click on project view
Create -> deVoid UI -> UIFrame Prefab
then drag the Prefab onto your scene
Step 2:
Get a reference to your UI Frame and register some screens
uiFrame.RegisterScreen("YourScreenId", yourScreenPrefab);
Step 3:
Show your screens
uiFrame.OpenWindow("YourWindowId");
uiFrame.ShowPanel("YourPanelId");
Or, if you have some data payload
uiFrame.OpenWindow("YourWindowId", yourWindowProperties);
uiFrame.ShowPanel("YourPanelId", yourPanelProperties);
Step 4:
Now that you're familiar with the API, right click on project view
Create -> deVoid UI -> UI Settings
Rig your UI Frame prefab as the UI Template, drag all your screens in the Screens To Register list and simply do
uiFrame = yourUiSettings.CreateUIInstance();
Which will give you a new UI Frame instance and automatically do Step 2 for you.
Make sure to check out the examples repo and read the manual!
The deVoid UI Framework (or devUI for short) is a simple architecture for UI handling and navigation in Unity. It enforces one simple rule: you can never directly access the internals of your UI code from external code, but anything else is fair game. You want to read data from Singletons from inside your UI? Sure. You want to sandwich mediators, views and controllers and do MVC by the book? Go for it. You want to skip the data passing functionalities and use your own MVVM framework? Power to you. Do whatever floats your boat and works best for your needs.
Having worked with mobile F2P games for years, I've done my fair share of UI. And I hate doing UI. So I figured the more people learn how to do it, the smaller the chances that I ever have to do it again đŸŒˆ
(Also, sharing is caring and I'm secretly a hippie)
- Simple to extend and customize
- Support for navigation history and queuing
- Transition animations
- Blocking user input while screens transition (especially handy for touch input)
- Priority and layering
- Focus on type safety and flexibility
- No built in support for controller navigation
This is A solution to work with UI - I don't believe in perfect, one-size-fits-all solutions (and nor should you in anyone who tells you otherwise). But this architecture was battle tested in more than one game over the last few years (from game jams to medium and bigger sized games), and it ticked all the boxes for me so far.
While I tried to keep this it as flexible and as easy to deal with as possible, there is still some structure to be followed. I recommend checking out the examples repo and taking a look at the manual before using.
Although the architecture itself is sound and was tested in live environments, this implementation was made from scratch on my free time. I have been using it for a few months now and did some cleanup and bugfixes for the public release, so it Should Work(TM).
A lot of the structure is inspired by a design used by Renan RennĂ³ when we worked together. Special thanks to everyone who I made use this architecture through the years and to Sylvain Cornillon, who allowed me to open source it and helped me find more proper names for the classes, or I'd be still calling it "UIManagerOrWhatevs" cause I'm a rebel.
You can read my original (even more) verbose post about this architecture in my blog and poke me on twitter @yankooliveira.
This is the examples repository for the deVoid UI Framework. It was made in a recent Unity version (2018.3.8f1) but it should work fine with previous versions down to at least 2017.
While the main devUI repo is focused on being as lean as possible and having 0 dependencies, this one focuses on providing a showcase of the functionalities and covering most of the end user API provided by the framework. It includes external libraries (like DOTween and Signals), and exemplifies one possible way to organize your UI.
I tried to comment the code thoroughly and keep it as straightforward as possible - which means in some cases it might not be as pristine as it could be, but the focus was on showing the Framework's capabilities (and using some of the code polishing time to write documentation instead).
NOTE: even though it is possible, I have decided not to include example Transition Components for the Animator because I think it's a bad idea to use it for UI (both for workflow and performance reasons) - I have instead opted for the lesser evil and added one using the legacy Animation component - if it ever does get deprecated I'll forever refer to Unity as "The engine who cried wolf" at this point.
Download the project, open the StartHere scene, press play and explore away!