UGUIDots is a Data Oriented Tech Stack library aimed to bridge the gap in between Unity's WYSIWYG UI and the Entity Component System. This is a low level library which augments on top of Unity's UI and does not serve as a replacement - so the workflow of authoring UI designs in games largely remains the same.
A DOTS compliant UI is still underway (which will be based off of UIElements). Until then, I need a UI solution the works with the Scriptable Render Pipeline - without building too many custom tooling. Similarly - one that has the performance capabilities and low overhead for both mobile and desktops. That said supported platforms are primarily for:
Check out the develop
branch of the repository for the redesigned system! This is something I've been working on
lately and it redesigns how conversion and transformations are done. I haven't decided to merge this into the master
branch as of late because I am trying to update the entire documentation and some features are missing.
The wiki is currently being worked on and contains basic information about Image/Text pipelines.
General purpose change log can be found here.
If you would like to help contribute to the development of UGUIDots, please see the contribution guidelines here.
Support for the following will come over time - depends on the needs for my own game.
There is currently a known issue with OpenUPM, where Unity internal scopes are added to the registry. After adding the
package via OpenUPM, head over to the manifest file and delete the com.unity.*
under the scopes
entry.
cd <path-to-project>
openupm add com.initialprefabs.uguidots
git submodule add https://github.com/InitialPrefabs/UGUIDots.git <path-to-folder>
Download the latest release and add it to your project directly.
Below are the basic steps to get the package working in game.
ConvertToEntity
component to the RenderCommandAuthoring
GameObjectConvertToEntity
component to convert the GameObject hierarchy to its Entities' formatMobileMouseInputAuthoring
component to a GameObject for Mobile supportStandaloneInputAuthoring
component to a GameObject for Windows/macOS/*nix supportConvertToEntity
component to itPlease see the Sample repository here.
Grab these from Unity's package manager.
Development is still underway - so not all of the features Unity has by default is supported. Similarly - there are certain cases that are not accounted for, like sub canvases as I barely use features like that.
Some thanks to a few folks who've helped me figure out things along the way