245 lines
15 KiB
Markdown
245 lines
15 KiB
Markdown
# Unity UI Extensions README
|
|
|
|
This is an extension project for the new Unity UI system which can be found at: [Unity UI Source](https://bitbucket.org/Unity-Technologies/ui)
|
|
|
|
> [Check out the control demos on our Tumblr page](https://unityuiextensions.tumblr.com/)
|
|
|
|
## [Intro](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
|
|
|
|
For more info, here's a little introduction video for the project:
|
|
|
|
[](http://www.youtube.com/watch?v=njoIeE4akq0 "Unity UI Extensions intro video")
|
|
|
|
You can follow the UI Extensions team for updates and news on:
|
|
|
|
### [Twitter](https://twitter.com/hashtag/UnityUIExtensions?src=hash) / [Facebook](https://www.facebook.com/UnityUIExtensions/) / [YouTube](https://www.youtube.com/channel/UCG3gZOkmL-2rmZat4ufv28Q)
|
|
|
|
> ## Chat live with the Unity UI Extensions community on Gitter here: [UI Extensions Live Chat](https://gitter.im/Unity-UI-Extensions/Lobby)
|
|
|
|
-----
|
|
|
|
## [What is this repository for?](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/About)
|
|
|
|
In this repository is a collection of extension scripts / effects and controls to enhance your Unity UI experience. These scripts have been gathered from many sources, combined and improved over time.
|
|
|
|
> The majority of the scripts came from the Scripts thread on the [Unity UI forum here](http://bit.ly/UnityUIScriptsForumPost)
|
|
|
|
You can either download / fork this project to access the scripts, or you can also download these pre-compiled Unity Assets, chock full of goodness for each release:
|
|
|
|
## [Download - 2019.5 (aka 2.3)](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
|
|
|
|
We have expanded where you can download the UnityPackage asset and widened the options to contribute to the project.
|
|
|
|
> I will still stress however, ***contribution is optional***. **The assets / code will always remain FREE**
|
|
|
|
| [](https://unityuiextensions.itch.io/uiextensions2-0 "Download from Itch.IO") | [](https://unionassets.com/unity-ui-extensions "Download from Union Assets") | [](https://www.patreon.com/UnityUIExtensions "Support Unity UI Extensions on Patreon & download")|
|
|
| :--- | :--- | :--- |
|
|
| [Grab from Itchio](https://unityuiextensions.itch.io/uiextensions2-0) | [Obtain via Union Assets](https://unionassets.com/unity-ui-extensions) |[Support through Patreon](https://www.patreon.com/UnityUIExtensions) |
|
|
|
|
> Still available to download on the [BitBucket site](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads) if you prefer
|
|
|
|
To view previous releases, visit the [release archive](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
|
|
|
|
-----
|
|
|
|
## [Supporting the UI Extensions project](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=89L8T9N6BR7LJ)
|
|
|
|
If you wish to further support the Unity UI Extensions project itself, then you can either subsidise your downloads above, or using the links below.
|
|
|
|
All funds go to support the project, no matter the amount. **Donations in code are also extremely welcome**
|
|
|
|
| | |
|
|
|---|---|
|
|
| [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=89L8T9N6BR7LJ "Donating via Paypal") | [](https://ko-fi.com/uiextensions "Buy us a Coffee") |
|
|
|
|
> (PayPal account not required and you can remain anonymous if you wish)
|
|
|
|
-----
|
|
|
|
## [Getting Started](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
|
|
To get started with the project, here's a little guide:
|
|
|
|
[](http://www.youtube.com/watch?v=sVLeYmsNQAI "Unity UI getting started video")
|
|
|
|
-----
|
|
|
|
## [Updates:](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ReleaseNotes/RELEASENOTES)
|
|
|
|
## Update 2019.5 - 2.3 - Accelerated Deployment
|
|
|
|
Since the move to UPM, the team have been able to react quicker and push out fixes a lot easier, without affecting previous installation (whilst still adhering to Unity's backwards compatibility pattern). So it is with great news we announce this new release, faster that ever :D (and thanks to UPM, easier to upgrade than ever).
|
|
Be sure to also check out the "Examples" option in the Package Manager window to import the samples to your project.
|
|
|
|
> Be sure to logon to the new [Gitter Chat](https://gitter.im/Unity-UI-Extensions/Lobby) site for the UI Extensions project, if you have any questions, queries or suggestions
|
|
>
|
|
> Much easier that posting a question / issue on YouTube, Twitter or Facebook :D
|
|
>
|
|
> ## [UIExtensions Gitter Chanel](https://gitter.im/Unity-UI-Extensions/Lobby)
|
|
|
|
### New / updated features
|
|
|
|
* Add squircle primitive
|
|
* Adding new magnetic scroll control
|
|
* Added a static library to collate shaders on first use.
|
|
* Finalized new InputManagerHelper, which translates input based on the operating input system, new or old Updated CardStack2D to have defined keyboard input or specific gamepad input over the older axisname for new input system.
|
|
* Examples now included with UPM delivery and available as a button on the UPM package manager window
|
|
* Updated DropDown and Autocomplete controls based on feedback in #204
|
|
* Updated Accordion to support both Vertical as well as Horizontal layout
|
|
* Updated ComboBox controls to improve better programmatic controls
|
|
* Updates to the Infinite scroll to support content of various sizes
|
|
* Updated UI Knob control - enabled dragging outside the target area, added example scene
|
|
* Minor update to MagneticInfinite Scroll
|
|
* Refactored and extended the ContentScrollSnap control
|
|
* Added protection against errors and empty scrollrect content
|
|
* Added new SetNewItems function to add children programmatically to the control and reset accordingly
|
|
* Patch supplied by a contributor to improve the texture sheet use with the UIParticlesystem
|
|
* Added "SetKnobValue" function which allows the setting of Value and loops
|
|
* Added the programmatic capability to change the parent scroll rect on the ScrollConflictManager at runtime.
|
|
|
|
### Examples / Examples / Examples
|
|
|
|
Examples now have their own package, this simplifies their use and deployment. Especially in 2019 with the UPM deployment.
|
|
|
|
* New UI Knob examples
|
|
* New Magnetic Scroll Example
|
|
* Updated ComboBox examples for programmatic testing
|
|
|
|
### Fixes
|
|
|
|
* Fix to add a "RequireComponent" to Primitives as Unity 2020 does not add them by default
|
|
* Remove old Examples submodule
|
|
* Updated submodules to hide Examples folder Additionally, updated Package manifest to allow importing of examples direct from UPM package.
|
|
* Fixed hard swipe to ensure it only ever moves one page, no matter how far you swipe.
|
|
* Fixed a conflict when using the ScrollConflictManager in child content of a HSS or VSS
|
|
* Fix for UI Particle system looping
|
|
* Fixed public GoToScreen call to only raise events internally (not multiple)
|
|
* Final roll-up and fix. Resolved race condition for associated pagination controls.
|
|
* Fixed issue with page events not being raised when inertia was disabled (velocity was always zero)
|
|
* When cloned, reorderable list was creating a second List Content component that was not initialized. Refactored to ensure only one list content was present and is initialized correctly
|
|
* Reorderable list items marked as transferable, remain transferable after being dropped
|
|
* Patch to resolve issues without the new Input System installed
|
|
* Refined magnetic scroll and dependencies while documenting Updated example
|
|
* Patch Tooltip
|
|
|
|
### Known issues
|
|
|
|
No new issues in this release, but check the issues list for things we are currently working on:
|
|
|
|
* [UI Extensions Issue log](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/issues?status=new&status=open)
|
|
|
|
## Upgrade Notes
|
|
|
|
Due to the restructure of the package to meet Unity's new package guidelines, we recommend **Deleting the current Unity UI Extensions** folder prior to importing the new package.
|
|
|
|
For Unity 2019 users using the new UPM deployment, be sure to delete the existing folder in your assets folder before adding the new package to avoid conflict.
|
|
|
|
-----
|
|
|
|
## Release History
|
|
|
|
For the full release history, follow the below link to the full release notes page.
|
|
|
|
### [Release Notes](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ReleaseNotes/RELEASENOTES)
|
|
|
|
-----
|
|
|
|
## [Controls and extensions listed in this project](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls)
|
|
|
|
There are almost 70+ extension controls / effect and other utilities in the project which are listed on the following page:
|
|
|
|
> ## [Check out the control demos on our Tumblr page](https://www.tumblr.com/blog/unityuiextensions)
|
|
>
|
|
> | [](https://www.tumblr.com/blog/unityuiextensions "UI Line Renderer") | [](https://www.tumblr.com/blog/unityuiextensions "UI Knob") | [](https://www.tumblr.com/blog/unityuiextensions "Scroll Snap")|
|
|
> | :--- | :--- | :--- |
|
|
> | [UI Line Renderer](https://www.tumblr.com/blog/unityuiextensions) | [UI Knob](https://www.tumblr.com/blog/unityuiextensions) |[Scroll Snap](https://www.tumblr.com/blog/unityuiextensions) |
|
|
|
|
## [UI Extensions controls list](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls)
|
|
|
|
[Controls](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-controls)|||||
|
|
------|------|------|------|
|
|
Accordion|ColorPicker|Selection Box|UI Flippable|ComboBox
|
|
AutoComplete ComboBox|DropDown List|BoundToolTip|UIWindowBase|UI Knob
|
|
TextPic|Input Focus|Box Slider|Cooldown Button|Segmented Control
|
|
Stepper|Range Slider|Radial Slider|MultiTouch Scroll Rect|
|
|
||||
|
|
|
|
[Primitives](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-primitives)|||||
|
|
------|------|------|------|
|
|
UILineRenderer|UILineTextureRenderer|UICircle|DiamondGraph|UICornerCut
|
|
UIPolygon||||
|
|
||||
|
|
|
|
[Layouts](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-layouts)|||||
|
|
------|------|------|------|
|
|
Horizontal Scroll Snap|Vertical Scroll Snap|Flow Layout Group|Radial Layout|Tile Size Fitter
|
|
Scroll Snap (alt implementation)|Reorderable List|UI Vertical Scroller|Curved Layout|Table Layout
|
|
FancyScrollView|Card UI|Scroll Position Controller||
|
|
||||
|
|
|
|
[Effects](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-effect_components)|||||
|
|
------|------|------|------|
|
|
Best Fit Outline|Curved Text|Gradient|Gradient2|Letter Spacing
|
|
NicerOutline|RaycastMask|UIFlippable|UIImageCrop|SoftAlphaMask
|
|
CylinderText|UIParticleSystem|CurlyUI|Shine Effect|Shader Effects
|
|
||||
|
|
|
|
[VR Components](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-vr_components)|||||
|
|
------|------|------|------|
|
|
VRCursor|VRInputModule|||
|
|
||||
|
|
|
|
[Additional Components](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-additional_components)|||||
|
|
------|------|------|------|
|
|
ReturnKeyTrigger|TabNavigation|uGUITools|ScrollRectTweener|ScrollRectLinker
|
|
ScrollRectEx|UI_InfiniteScroll|UI_ScrollRectOcclusion|UIScrollToSelection|UISelectableExtension
|
|
switchToRectTransform|ScrollConflictManager|CLFZ2 (Encryption)|DragCorrector|PPIViewer
|
|
UI_TweenScale|UI_MagneticInfiniteScroll|UI_ScrollRectOcclusion|NonDrawingGraphic|
|
|
UILineConnector|UIHighlightable|Menu Manager|Pagination Manager|
|
|
||||
|
|
|
|
*More to come*
|
|
|
|
-----
|
|
|
|
## [How do I get set up?](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
|
|
|
|
As of Unity 2019, there are now two paths for getting access to the Unity UI Extensions project:
|
|
|
|
- Unity 2019 or higher
|
|
The recommended way to add the Unity UI Extensions project to your solution is to use the Unity package Manager. Simply use the [Unity Package Manager](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/UPMInstallation) to reference the project and install it.
|
|
|
|
Alternatively, you can also use the pre-compiled Unity packages if you wish, however, UPM offers full versioning support to allow you to switch versions as you wish.
|
|
|
|
- Unity 2018 or lower
|
|
The pre-compiled Unity assets are the only solution for Unity 2018 or earlier due to the changes in the Unity UI framework in Unity made for 2019.
|
|
Either clone / download this repository to your machine and then copy the scripts in, or use the pre-packaged .UnityPackage for your version of Unity and import it as a custom package in to your project.
|
|
|
|
## [Contribution guidelines](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ContributionGuidelines)
|
|
|
|
Got a script you want added? Then just fork the bitbucket repository and submit a PR. All contributions accepted (including fixes)
|
|
|
|
Just ensure:
|
|
|
|
* The header of the script should match the standard used in all scripts
|
|
* The script uses the **Unity.UI.Extensions** namespace so they do not affect any other developments
|
|
* (optional) Add Component and Editor options where possible (editor options are in the Editor\UIExtensionsMenuOptions.cs file)
|
|
|
|
## [License](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/License)
|
|
|
|
All scripts conform to the BSD3 license and are free to use / distribute. See the [LICENSE](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/License) file for more information =
|
|
|
|
## [Like what you see?](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/FurtherInfo)
|
|
|
|
All these scripts were put together for my latest book Unity3D UI Essentials
|
|
Check out the [page on my blog](http://bit.ly/Unity3DUIEssentials) for more details and learn all about the inner workings of the new Unity UI System.
|
|
|
|
## [The downloads](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
|
|
|
|
As this repo was created to support my new Unity UI Title ["Unity 3D UI Essentials"](http://bit.ly/Unity3DUIEssentials), in the downloads section you will find two custom assets (SpaceShip-DemoScene-Start.unitypackage and RollABallSample-Start.unitypackage). These are just here as starter scenes for doing UI tasks in the book.
|
|
|
|
I will add more sample scenes for the UI examples in this repository and detail them above over time.
|
|
|
|
## [Previous Releases](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
|
|
|
|
Please see the [full downloads list](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads) for all previous releases and their corresponding download links.
|