diff --git a/README.md b/README.md index 5bba532..eb8edac 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,69 @@ # 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) +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) -#For Unity 5.2.2+ - Use the new 5.3 package!# -#*Note, due to limited demand, this is the last release we will update the 4.x/5.1 asset package, we'll be focusing on 5.3/5.4 from now on. +###For Unity 5.2.2+ - Use the new 5.3 package!### +###*Note, due to limited demand, this is the last release we will update the 4.x/5.1 asset package, we'll be focusing on 5.3/5.4 from now on.### -##Intro## +----- +#Intro# 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") -### What is this repository for? ### +You can follow the UI Extentions team for updates and news on: +### [Twitter](https://twitter.com/search?q=%23uiextensions) / [Facebook](https://www.facebook.com/UnityUIExtensions/) / [YouTube](https://www.youtube.com/channel/UCG3gZOkmL-2rmZat4ufv28Q)### +----- +# What is this repository for? # In this repository is a collection of extension scripts to enhance your Unity UI experience. These scripts have been gathered from many sources and 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 the project to access the scripts, or you can also download this precompiled Unity Asset, chock full of goodness -### [Unity UI Extensions Unity 4.x Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-4.x.unitypackage)### -### [Unity UI Extensions Unity 5.1 Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.1.unitypackage)### -### [Unity UI Extensions Unity 5.2 Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.2.unitypackage)### <- 5.2.0 - 5.2.1 base releases ONLY -### [Unity UI Extensions Unity 5.3 (5.2.1P+) Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.3.unitypackage) <- use this for 5.2.1P+ releases### -##Getting Started## +> 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 precompiled Unity Assets, chock full of goodness for each release: + + ### * [Unity UI Extensions Unity 4.x Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-4.x.unitypackage)### + ### * [Unity UI Extensions Unity 5.1 Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.1.unitypackage)### + ### * [Unity UI Extensions Unity 5.2 Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.2.unitypackage) <- 5.2.0 - 5.2.1 base releases ONLY### + ### * [Unity UI Extensions Unity 5.3 (5.2.1P+) Asset](https://bitbucket.org/ddreaper/unity-ui-extensions/downloads/UnityUIExtensions-5.3.unitypackage) <- use this for 5.2.1P+ releases### + +----- +#Getting Started# To get started with the project, here's a little guide: - [![View Getting Started Video](http://img.youtube.com/vi/sVLeYmsNQAI/0.jpg)](http://www.youtube.com/watch?v=sVLeYmsNQAI "Unity UI getting started video") --- -## Updates: ## +#Updates:# -###Update 1.1.0### -Coming soon +##Update 1.1## +[![View 1.1 update Video](http://img.youtube.com/vi/JuE0ja5DmV4/0.jpg)](https://www.youtube.com/watch?v=JuE0ja5DmV4 "Update 1.1 for the Unity UI Extensions Project") -###Release History### +###New / updated features### +* New Polygon primitive +* New UI Vertical Scroller control +* New Curved layout component +* New Shining effect +* New UI Particle system +* New Scroll Conflict Manager +* Soft Alpha Mask updated in line with SAUI 1.3 release +* Line Renderer has had a complete overhaul, including full programmatic support, Line list and Bezier line rendering +* Horizontal and Vertical Scroll Snaps updated to include a Starting page, current page and transition speed parameters. Plus a new GoToPage, Add and Remove page functions +* Added some script helper functions for LZF compression and Serialization +* Two utilities to help manage drag thresholds on high PPI systems + +###Fixes### +* Line Render almost completely re-written with tons of fixes +* Radial layout updated to avoid 360 overlap (first and last) +* Scroll Snaps updates to better handle children. +* Scroll Snaps distribute function updated so it can be called onDirty more efficiently. + +------------------- +##Release History## For the full release history, follow the below link to the full release notes page. ### [Release Notes](https://bitbucket.org/ddreaper/unity-ui-extensions/src/c9354eadf4b9287790eb636c21e4107760cd7b87/RELEASENOTES.md?at=develop_5.3)### --- -## Controls and extensions listed in this project are: ## +#Controls and extensions listed in this project:# ## Controls ## ================ @@ -56,6 +82,7 @@ Control | Description | Menu Command | Component Command | Notes | Donate | Cred **DropDownList** | A basic drop down list with text and image support | UI / Extensions / Dropdown List | UI / Extensions / Dropdown List |[tutorial video](https://www.youtube.com/watch?v=JrEfs47FoOE)|| Perchik **BoundToolTip** | An alternate Tooltip implementation with central listener | UI / Extensions / Bound Tooltip / Tooltip | UI / Extensions / Bound Tooltip / Tooltip Item | Offset and tooltip placement needs work || Martin Sharkbomb | | | UI / Extensions / Bound Tooltip / Tooltip Trigger ||| Martin Sharkbomb +|||||| ## Primitives ## @@ -63,12 +90,13 @@ Control | Description | Menu Command | Component Command | Notes | Donate | Cred Control | Description | Menu Command | Component Command | Notes | Donate | Credits --------- | -------------- | ---------------------- | ---------------------------- | ------- | ---------- | ---------- -**LineRenderer** | Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UI Line Renderer | UI / Extensions / Primitives / UI Line Renderer |[tutorial video](https://www.youtube.com/watch?v=OElcWAZGHi0)|| jack.sydorenko +**UILineRenderer** | Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UI Line Renderer | UI / Extensions / Primitives / UI Line Renderer |[tutorial video](https://www.youtube.com/watch?v=OElcWAZGHi0)|| jack.sydorenko **UILineTextureRenderer** | Graphic control for drawing lines in the UI System | UI / Extensions / Primitives / UI Line Texture Renderer | UI / Extensions / Primitives / UI Line Texture Renderer |[tutorial video](https://www.youtube.com/watch?v=OElcWAZGHi0)|| jack.sydorenko, jonbro5556 **UICircle** | Graphic control for drawing circles in the UI System | UI / Extensions / Primitives / UI Circle | UI / Extensions / Primitives / UI Circle |[tutorial video](https://www.youtube.com/watch?v=2KOnEKAVua0)|| zge **DiamondGraph** | Graphic control for drawing a diamond in the UI System | UI / Extensions / Primitives / DiamondGraph | UI / Extensions / Primitives / DiamondGraph |5.2+ only [tutorial video](https://www.youtube.com/watch?v=2KOnEKAVua0)|| koohddang **UICornerCut** | Graphic control for drawing a diamond in the UI System | UI/Extensions/Primitives/Cut Corners | UI/Extensions/Primitives/Cut Corners ||| Freezy - +**UIPolygon** | Graphic control for drawing custom polygons in the UI System | UI/Extensions/Primitives/UI Polygon | UI/Extensions/Primitives/UI Polygon ||| CiaccoDavide +|||||| ## Layouts ## ================ @@ -90,6 +118,9 @@ Layout | Description | Menu Command | Component Command | Notes | Donate | Credi || UI/Extensions/Re-orderable Lists/Re-orderable Vertical List|||| Ziboo || UI/Extensions/Re-orderable Lists/Re-orderable Hirizontal List|||| Ziboo || UI/Extensions/Re-orderable Lists/Re-orderable Grid|||| Ziboo +**VerticalScroller** | Rolling scrolling selector | UI / Extensions / Vertical Scroller | Layout / Extensions / Vertical Scroller ||tbc|[Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RJ8D9FRFQF9VS)| Mrs. YakaYocha +**CurvedLayout** | A curved layout system || Layout / Extensions / Curved Layout |tbc|| Freezy +|||||| ## Effect components ## @@ -105,17 +136,20 @@ Effect | Description | Component Command | Notes | Donate | Credits **RaycastMask** | An example of an enhanced mask component able to work with the image data. Enables picking on image parts and not just the Rect Transform | UI / Effects / Extensions / Raycast Mask ||| senritsu **UIFlippable** | Image component effect to flip the graphic | UI / Effects / Extensions / UI Flippable ||| ChoMPHi **UIImageCrop** | Shader based mask system which clips to specific ranges X&Y | UI / Effects / Extensions / UI Image Crop ||| 00christian00 -**SoftAlphaMask** | Shader based mask able to clip images using an alpha mask | UI / Effects / Extensions / Soft Mask Script ||| NemoKrad +**SoftAlphaMask** | Shader based mask able to clip images using an alpha mask | UI / Effects / Extensions / Soft Mask Script ||[Donate](https://www.assetstore.unity3d.com/en/#!/content/50339)| NemoKrad **CylinderText** | Allows finers control of text spacing | UI / Effects / Extensions / Cylinder Text ||| Breyer +**UIParticleSystem** | Implementation of a particle system on a canvas | UI / Effects / Extensions / UI Particle System |5.3+ only|| Glennpow +|||||| -## VR Components## +## VR Components ## ======================= Component | Description | Component Command | Notes | Donate | Credits --------- | -------------- | ---------------------------- | ------- | ------ | ---------- **VRCursor** | Cursor script for VR use (requires VRInputModule) | UI / Extensions / VR Cursoe ||| Ralph Barbagallo **VRInputModule** | Input module to support the VR Cursor | Event / Vr Input Module ||| Ralph Barbagallo +||||| ## Input Modules ## @@ -125,6 +159,7 @@ Component | Description | Component Command | Notes | Donate | Credits --------- | -------------- | ---------------------------- | ------- | ------ | ---------- **AimerInputModule** | Replacement Input module to allow for a reciclue to interace with WorldSpace canvas UI | Event / Extensions / Aimer Input Module ||| Chris Trueman **GamePadInputModule** | Stripped down SIM Input module for just gamepad/keybord input | Event / Extensions / GamePad Input Module ||| Simon (darkside) Jackson +||||| ## Additional Components## ======================= @@ -142,29 +177,35 @@ Component | Description | Component Command | Notes | Donate | Credits **UIScrollToSelection** | Enables a ScrollRect to scroll based on the selected child automatically | UI / Extensions / UIScrollToSelection ||| zero3growlithe **UISelectableExtension** | Refactor of original UI Button control, can now add Press/Release and Hold events to any Selectable control | UI / Extensions / UI Selectable Extension ||| AriathTheWise / Simon Jackson **switchToRectTransform** | RectTransform extension method to move one Rect to another | N/A ||| Izitmee +**ScrollConflictManager** | Resolves dragging issues with multiple nested scroll rects | UI / Extensions / Scrollrect Conflict Manager ||| srinivas sunil +**CLFZ2** | LZF Compression library to compress data | N/A |Check the readme in the Utilities folder|| mrbroshkin, Agent_007 +**Serialization** | Serialization library to enable serializing Unity struct types like Vectors, Quaternions | N/A |Check the readme in the Utilities\serialization folder|| Cherno +**DragCorrector** | Utility to manage the EventSystem drag threshold for high DPI systems | UI / Extensions / Drag Corrector ||| FireOApache +**PPIViewer** | Simple script to attach to a text component to display the currnet DPI/PPI | UI / Extensions / PPI Viewer ||| FireOApache +||||| *More to come* ======================= -### How do I get set up? ### +# How do I get set up? # 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 ### -Got a script you want added, then just fork and submit a PR. All contributions accepted (including fixes) +# Contribution guidelines # +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 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) -### License ### +# License # All scripts conform to the BSD license and are free to use / distribute. See the [LICENSE](https://bitbucket.org/ddreaper/unity-ui-extensions/src/6d03f25b0150994afa97c6a55854d6ae696cad13/LICENSE?at=default) file for more information -### Like what you see? ### +# Like what you see? # 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 ### +# The 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. \ No newline at end of file diff --git a/RELEASENOTES.md b/RELEASENOTES.md index d1bbfb6..4b51c8b 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,8 +1,40 @@ # Unity UI Extensions release notes # +This file contains the up to date release notes for each release of the UI Extensions project including release videos where required. -**1.0.6.1 - Minor update to enhance soft alpha mask and add cylinder text plus a fix to letter spacing** +---------------- +##Update 1.1## + +[![View 1.1 update Video](http://img.youtube.com/vi/JuE0ja5DmV4/0.jpg)](https://www.youtube.com/watch?v=JuE0ja5DmV4 "Update 1.1 for the Unity UI Extensions Project") + +###New / updated features### +* New Polygon primitive +* New UI Vertical Scroller control +* New Curved layout component +* New Shining effect +* New UI Particle system +* New Scroll Conflict Manager +* Soft Alpha Mask updated in line with SAUI 1.3 release +* Line Renderer has had a complete overhaul, including full programmatic support, Line list and Bezier line rendering +* Horizontal and Vertical Scroll Snaps updated to include a Starting page, current page and transition speed parameters. Plus a new GoToPage, Add and Remove page functions +* Added some script helper functions for LZF compression and Serialization +* Two utilities to help manage drag thresholds on high PPI systems + +###Fixes### +* Line Render almost completely re-written with tons of fixes +* Radial layout updated to avoid 360 overlap (first and last) +* Scroll Snaps updates to better handle children. +* Scroll Snaps distribute function updated so it can be called onDirty more efficiently. + + + +---------------- +##Update 1.0.6.1## + +- Minor update to enhance soft alpha mask and add cylinder text plus a fix to letter spacing + +---------------- +##Update 1.0.6## -###Update 1.0.6### [![View 1.0.6 update Video](http://img.youtube.com/vi/jpyFiRvSmbg/0.jpg)](http://www.youtube.com/watch?v=jpyFiRvSmbg "Update 1.0.6 for the Unity UI Extensions Project") * Added the awesome ReOrderable List control, plus some other minor bugfixes / changes. @@ -10,16 +42,20 @@ * New set of controls including some shader enhanced solutions * I've added a donate column to the lists. If you are getting great use out of a control, help out the dev who created it. Optional of course. Will update with links as I get them. -###Update 1.0.5### +---------------- +##Update 1.0.5## + Few minor fixes and a couple of additional scripts. Predominately created the new 5.3 branch to maintain the UI API changes from the 5.2.1 Patch releases. 5.3 package is 100% compatible with 5.2.1 Patch releases. -###Update 1.0.4### +---------------- +##Update 1.0.4## [![View Getting Started Video](http://img.youtube.com/vi/oF48Qpaq3ls/0.jpg)](http://www.youtube.com/watch?v=oF48Qpaq3ls "Update 1.0.0.4 for the Unity UI Extensions Project") --- +======================= #Additional Info# ======================= ### How do I get set up? ### diff --git a/UnityUIExtensions-5.3.unitypackage b/UnityUIExtensions-5.3.unitypackage index 51636e1..a4b0f55 100644 Binary files a/UnityUIExtensions-5.3.unitypackage and b/UnityUIExtensions-5.3.unitypackage differ