com.unity.uiextensions.nosa.../README.md

221 lines
13 KiB
Markdown
Raw Normal View History

2017-08-11 20:17:10 +08:00
# README
2014-12-31 06:25:53 +08:00
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)
2018-03-11 04:42:39 +08:00
> ## [Check out the control demos on our Tumblr page](https://unityuiextensions.tumblr.com/)
2015-09-09 00:23:11 +08:00
2018-08-28 17:44:56 +08:00
> ### We've disabled Anonymous issue for creation for now, as it's making it extreemely hard to provide feedback and help to users. Please ensure you logon with your Bitbucket account when raising issues.
> If you don't want to do that, then reach out to us on Gitter
2017-08-11 20:17:10 +08:00
# [Intro](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
2015-09-01 22:59:54 +08:00
For more info, here's a little introduction video for the project:
[![View Intro Video](http://img.youtube.com/vi/njoIeE4akq0/0.jpg)](http://www.youtube.com/watch?v=njoIeE4akq0 "Unity UI Extensions intro video")
2015-09-01 22:52:45 +08:00
You can follow the UI Extensions team for updates and news on:
2017-08-11 20:17:10 +08:00
## [Twitter](https://twitter.com/hashtag/UnityUIExtensions?src=hash) / [Facebook](https://www.facebook.com/UnityUIExtensions/) / [YouTube](https://www.youtube.com/channel/UCG3gZOkmL-2rmZat4ufv28Q)
2017-08-11 20:17:10 +08:00
> ## Also, come chat live with the Unity UI Extensions community on Gitter here: [UI Extensions Live Chat](https://gitter.im/Unity-UI-Extensions/Lobby)
-----
2017-08-11 20:17:10 +08:00
# [What is this repository for? ](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/About)
2014-12-31 06:25:53 +08:00
2017-08-11 20:17:10 +08:00
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.
2015-09-01 23:08:53 +08:00
> 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:
2019-03-09 22:09:22 +08:00
# [Download](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads) - 2019.1 (aka 2.1)
2019-03-09 22:09:22 +08:00
We have expanded where you can download the UnityPackage asset and widened the options to contribute to the project.
2017-08-11 20:17:10 +08:00
> I will still stress however, ***contribution is optional***. **The asset / code will always remain FREE**
2017-10-25 22:37:58 +08:00
| [![Download from Itch.IO](https://bytebucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/itchio.png)](https://unityuiextensions.itch.io/uiextensions2-0 "Download from Itch.IO") | [![Download from Itch.IO](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/unionassets.png)](https://unionassets.com/unity-ui-extensions "Download from Union Assets") | [![Download from Itch.IO](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/patreon.jpg)](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) |
2019-03-09 22:09:22 +08:00
> Still available on the [BitBucket site](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads/UnityUIExtensions-2019-1.unitypackage) if you prefer
2017-08-11 20:17:10 +08:00
To view previous releases, visit the [release archive](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
-----
2017-08-11 20:17:10 +08:00
# [Supporting the UI Extensions project](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=89L8T9N6BR7LJ)
2017-08-11 20:17:10 +08:00
If you wish to further support the Unity UI Extensions project itself, then you can either subsidise your downloads above, or contribute direct using the PayPal link below.
All funds go to support the project, no matter the amount, donations in code are also extremely welcome :D
2017-08-11 20:17:10 +08:00
> (PayPal account not required and you can remain anonymous if you wish)
2017-08-11 20:17:10 +08:00
## [>> Donate via PayPal <<](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=89L8T9N6BR7LJ)
2017-08-11 20:17:10 +08:00
-----
2017-08-11 20:17:10 +08:00
# [Getting Started](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
To get started with the project, here's a little guide:
2017-08-11 20:17:10 +08:00
[![View Getting Started Video](http://img.youtube.com/vi/sVLeYmsNQAI/0.jpg)](http://www.youtube.com/watch?v=sVLeYmsNQAI "Unity UI getting started video")
2017-08-11 20:17:10 +08:00
-----
2017-08-11 20:17:10 +08:00
# [Updates:](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ReleaseNotes/RELEASENOTES)
2019-03-09 22:09:22 +08:00
## Update 2019.1 - formally 2.1 - Going with the times
Given that it's been a while since the last release and a fair few number of fixes have been introduced since the last update, it's only fair I get this point release out for the masses. This is only a point release and we are still working hard on the next full update
Be sure to logon to the new Gitter Chat 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
New / updated features
Updated and tested with Unity 2018 / 2019
FancyScrollView updated with newer version (note breaking change)
Added test version of a LineRender control using a List instead of an array
New CardUI layout control, for a snazzy flip card system
New UI Circle Progress indicator control
Examples / Examples / Examples
(All examples can be deleted without affecting the extensions)
Added example for CardUI
Added example for the LineRendererList experiment
FancyScrollView examples updated to the new version
Example for new UICircle progress control
Fixes
General clean up of build warnings
Refactored primitive controls to be cleaner
Various HSS / VSS updates, mostly from the community
ScrollConflictManager updated to work better with nested HSS/VSS
UI Knob resolved to with screen space camera
Fix for the menu system, which was disabling prefabs instead of the scene instance
Fixed shader in UIParticle System
TextPic updated to support culling properly
Reorderable List updated with additional options
Screenspace overlay support added to the Tooltip control
UIParticle system now supports 3D rotation
UIVerticalScroller updated
Radial slider updated with fixes
Known issues
No new issues in this release, but check the issues list for things we are currently working on:
UI Extensions Issue log
Upgrade Notes
No significant concerns, should be able to update over the 2.1 package. If upgrading prior to 2.1, we still recommend removing the UnityUIExtensions folder and then re-importing
2017-08-11 20:17:10 +08:00
----------------
## Release History
For the full release history, follow the below link to the full release notes page.
2017-08-11 20:17:10 +08:00
### [Release Notes](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ReleaseNotes/RELEASENOTES)
---
2017-08-11 20:17:10 +08:00
# [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)
2017-10-25 22:36:35 +08:00
> | [![UI Line Renderer](https://bytebucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/LineRenderer.gif)](https://www.tumblr.com/blog/unityuiextensions "UI Line Renderer") | [![UI Knob](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/UIKnob.gif)](https://www.tumblr.com/blog/unityuiextensions "UI Knob") | [![ScrollSnap](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/SiteImages/ScrollSnap.gif)](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) |
2017-08-11 20:17:10 +08:00
## [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|SelectionBox|UIFlippable|ComboBox
AutoCompleteComboBox|DropDownList|BoundToolTip|UIWindowBase|UI_Knob
TextPic|InputFocus|Box Slider|CooldownButton|Segmented Control
Stepper||||
||||
[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||||
||||
[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
2017-08-02 01:57:47 +08:00
CylinderText|UIParticleSystem|CurlyUI||
||||
[VR Components](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-vr_components)|||||
------|------|------|------|
VRCursor|VRInputModule|||
||||
[Input Modules](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls#markdown-header-input_modules)|||||
------|------|------|------|
AimerInputModule|GamePadInputModule|||
||||
[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
2017-08-11 20:17:10 +08:00
switchToRectTransform|ScrollConflictManager|CLFZ2 (Encryption)|DragCorrector|PPIViewer
UI_TweenScale|UI_InfiniteScroll|UI_ScrollRectOcclusion|NonDrawingGraphic|UILineConnector
UIHighlightable|Menu Manager|Pagination Manager||
||||
2014-12-31 06:27:53 +08:00
*More to come*
2014-12-31 06:25:53 +08:00
---
2017-08-11 20:17:10 +08:00
# [How do I get set up? ](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted)
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.
2014-12-31 06:25:53 +08:00
2017-08-11 20:17:10 +08:00
# [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)
2015-02-10 01:05:15 +08:00
Just ensure
* The header of the script matches 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)
2017-08-11 20:17:10 +08:00
# [License ](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/License)
All scripts conform to the BSD license and are free to use / distribute. See the [LICENSE](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/License) file for more information
2014-12-31 06:25:53 +08:00
2017-08-11 20:17:10 +08:00
# [Like what you see? ](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/FurtherInfo)
2014-12-31 06:25:53 +08:00
All these scripts were put together for my latest book Unity3D UI Essentials
2015-01-16 01:44:17 +08:00
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.
2017-08-11 20:17:10 +08:00
# [The downloads ](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
2015-01-16 01:44:17 +08:00
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.
2017-08-11 20:17:10 +08:00
# [Previous Releases](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads)
2017-08-11 20:17:10 +08:00
* [Unity UI Extensions Unity 4.x Asset](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads/UnityUIExtensions-4.x.unitypackage)
2017-08-11 20:17:10 +08:00
* [Unity UI Extensions Unity 5.1 Asset](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads/UnityUIExtensions-5.1.unitypackage)
2017-08-11 20:17:10 +08:00
* [Unity UI Extensions Unity 5.2 Asset](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads/UnityUIExtensions-5.2.unitypackage) <- 5.2.0 - 5.2.1 base releases ONLY
2017-08-11 20:17:10 +08:00
* [Unity UI Extensions Unity 5.3 (5.2.1P+) Asset](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/downloads/UnityUIExtensions-5.3.unitypackage) <- use this for 5.2.1P+ releases
> **Note** To retain 5.2 compatibility in the 5.3 package, you will see two warnings related to:
> ```
> `UnityEngine.UI.InputField.onValueChange' is obsolete.
> ```
> This has no effect on the package working in 5.4 plus and is only there to maintain backwards compatibility. We will look to update/remove this in a future release, likely after 5.4.
If you have any concerns, feel free to update your code in your project to add the missing "d". Unity have ensured it still works as they have mapped the API change for now.