KO
|
EN
gitlite — search
Search
#python
#rust
#machine-learning
#docker
#reactjs
#deep-learning
#flutter
#llm
#unity
#unity3d
#nlp
#python3
UGUIDOTS
★ 115
Open GitHub ↗
Converting UGUI to be DOTS compliant
Download README (.md)
Explore Similar Repositories
skywalking-satellite
:
The Sidecar Project of Apache SkyWalking
Streamis
:
Streaming application development and management system, based on Linkis and DSS, planning to provide the workflow-like graphical drag-and-drop development capability.
Geochemistrypi
:
an open-sourced highly automated machine learning Python framework for data-driven geochemistry discovery
net_automatic_interface
:
.Net Source Generator for Automatic Interfaces
cyclonedx-python-lib
:
Functionality and DataModels of OWASP CycloneDX for Python
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
UGUIDOTS
?
Download (.md)
# UGUIDOTS <p align="center"> <img src="Wiki/Images/uguidots-logo.png" alt="Logo done by Sabrina Lam"> </p> UGUIDots is a Data Oriented Tech Stack library aimed to bridge the gap in between [Unity's WYSIWYG UI](https://docs.unity3d.com/Packages/com.unity.ugui@1.0/manual/index.html) and the [Entity Component System](https://docs.unity3d.com/Packages/com.unity.entities@0.1/manual/index.html). 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. ## Why do this? 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: * Android * iOS (? - currently hard for me to test) * Linux 64 bit * macOS * Windows 64 bit ## Beta/Experimental Content 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. ## Wiki The [wiki](Wiki/Home.md) is currently being worked on and contains basic information about Image/Text pipelines. ## Changelog General purpose change log can be found [here](CHANGELOG.md). ## Contributions If you would like to help contribute to the development of UGUIDots, please see the contribution guidelines [here](CONTRIBUTING.md). ## TODO Support for the following will come over time - depends on the needs for my own game. * [x] Canvas Scaling * [x] Anchoring * [x] Image stretching * [x] Button actions * [x] Button states (with color support) * [x] Hierarchy based disabling * [x] Text Rendering * [ ] Input fields * [ ] Subscene support * [x] Support manual image / text batching of static UI elements (static analysis) ## Installation ### OpenUPM 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 ``` git submodule add https://github.com/InitialPrefabs/UGUIDots.git <path-to-folder> ``` ### Manually Download the latest [release](https://github.com/InitialPrefabs/UGUIDots/releases) and add it to your project directly. ## QuickStart Below are the basic steps to get the package working in game. ### Setting up the Render Command * Set up project to use the Universal Render Pipeline * Add the RenderCommandAuthoring component with a scriptable render feature to a GameObject. * Add the `ConvertToEntity` component to the `RenderCommandAuthoring` GameObject ### Converting GameObjects to Entities * Design your UI normally using the WYSWYG editor in Unity * Add the BatchedMeshAuthoring component to your root canvas * Build the batch on the BatchedMeshAuthoring component * Add the `ConvertToEntity` component to convert the GameObject hierarchy to its Entities' format ### Setting up input * Add the `MobileMouseInputAuthoring` component to a GameObject for Mobile support * Add the `StandaloneInputAuthoring` component to a GameObject for Windows/macOS/\*nix support * Put the GameObject into a subscene _or_ add the `ConvertToEntity` component to it ## Sample Repository Please see the Sample repository [here](https://github.com/InitialPrefabs/UGUIDots.Samples). ## Dependencies * Unity 2020.1.x Grab these from Unity's package manager. * Burst 1.3.4 * Collections 0.12.0-preview.13 * Entities 0.14.0-preview.18 * Jobs 0.5.0-preview.14 * Mathematics 1.2.1 * TextMeshPro 3.0.1 * UGUI 1.0.0 * Universal RP 9.0.0-preview.35 ## Limitations 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. ## Credits Some thanks to a few folks who've helped me figure out things along the way * Sabrina Lam (Logo artwork) * Valentina S. * Arthur D. * Mason R.
