|
| 1 | +<!-- Offline documentation --> |
| 2 | + |
| 3 | +# About Unity UI Extensions |
| 4 | + |
| 5 | +The Unity UI Extensions project is a collection of extension scripts/effects and controls to enhance your Unity UI experience. This includes over 70+ controls, utilities, effects and some much-needed love to make the most out of the Unity UI system (formally uGUI) in Unity. |
| 6 | +[Check out our Tumblr page for a sneak peek](https://www.tumblr.com/blog/unityuiextensions) |
| 7 | + |
| 8 | +> Contact the UI Extensions Team |
| 9 | +> Be sure to logon to the new [Gitter Chat site](https://gitter.im/Unity-UI-Extensions/Lobby) for the UI Extensions project, if you have any questions, queries or suggestions |
| 10 | +> Much easier than posting a question / issue on [YouTube](http://www.youtube.com/c/UnityUIExtensions), [Twitter](https://twitter.com/hashtag/UnityUIExtensions) or [Facebook](https://www.facebook.com/UnityUIExtensions) :D |
| 11 | +> |
| 12 | +> [**UIExtensions Gitter Chanel**](https://gitter.im/Unity-UI-Extensions/Lobby) |
| 13 | +
|
| 14 | +# Installing Unity UI Extensions |
| 15 | + |
| 16 | +To install this package, follow the instructions in the Package Manager documentation. |
| 17 | + |
| 18 | +For more details on [Getting Started](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted) please checkout the [online documentation here](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/GettingStarted). |
| 19 | + |
| 20 | +# Using Unity UI Extensions |
| 21 | + |
| 22 | +The UI Extensions project provides many automated functions to add the various controls contained within the project commonly accessed via "***GameObject -> UI -> Extensions -> 'Control'***" from the editor menu. This will add the UI object and all the necessary components to make that control work in the scene in a default state. |
| 23 | + |
| 24 | +Some of the features are also available through the GameObject "Add Component" menu in the inspector. |
| 25 | + |
| 26 | +For a full list of the controls and how they are used, please see the [online documentation](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Controls) for the project. |
| 27 | + |
| 28 | +# Technical details |
| 29 | + |
| 30 | +## Requirements |
| 31 | + |
| 32 | +This version of the Unity UI Extensions is compatible with the following versions of the Unity Editor: |
| 33 | + |
| 34 | +* 2019 and above - the recommended path for 2019+ is to use the Unity Package Manager to get access to the package. Full details for installing via UPM can be [found here](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/UPMInstallation). |
| 35 | + |
| 36 | +> Alternatively, the Asset packages have been tested to work with 2019 as well if you prefer to install that way. |
| 37 | +
|
| 38 | +* 2018 and below - for 2018 and use this package, you will have to import the asset package(s), either from the Asset Store or from the alternate download locations [listed here](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/Downloads). |
| 39 | + |
| 40 | +## [Release Notes](https://bitbucket.org/UnityUIExtensions/unity-ui-extensions/wiki/ReleaseNotes/RELEASENOTES) |
| 41 | + |
| 42 | +### 2019.4 - 2.2 - Back from the future |
| 43 | + |
| 44 | +* New UPM deployment for Unity 2019, 2018 will still need to use the asset packages due to Unity compatibility issues. |
| 45 | +* Updated the project to the new Unity packaging guidelines, including separating out the examples to a separate package. |
| 46 | +* Many line drawing updates, including the ability to draw using a mouse (check the examples) |
| 47 | +* Scroll Snaps (HSS/VSS) now have a "Hard Swipe" feature to restrict movement to a single page for each swipe |
| 48 | +* Scroll Snaps have also been updated to work better with the UIInfiniteScroll control |
| 49 | +* New Unity Card UI controls thanks to @RyanslikeSoCool |
| 50 | +* Update to the Fancy Scroll controls with even more added fanciness |
| 51 | +* Several updates to adopt newer Unity standards in the controls to ensure full forwards and backwards compatibility |
| 52 | + |
| 53 | +# Document revision history |
| 54 | + |
| 55 | +|Date|Details| |
| 56 | +|-|-| |
| 57 | +|July 9th, 2020|2019.4 (v2.2) released, first UPM deployment live | |
| 58 | +|September 3rd, 2019|2019.1 (v2.1) released, First major update for the 2.0 series.| |
0 commit comments