{"id":13729353,"url":"https://github.com/mikrima/UnityAccessibilityPlugin","last_synced_at":"2025-05-08T01:32:34.371Z","repository":{"id":42691010,"uuid":"359532603","full_name":"mikrima/UnityAccessibilityPlugin","owner":"mikrima","description":"The UI Accessibility Plugin (UAP) allows you to make your UI accessible to blind and visually impaired players on Windows, Android, iOS, Mac and WebGL. ","archived":false,"fork":false,"pushed_at":"2023-05-13T11:06:42.000Z","size":6376,"stargazers_count":75,"open_issues_count":13,"forks_count":19,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-08-04T02:08:38.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikrima.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-04-19T16:50:18.000Z","updated_at":"2024-07-30T12:07:52.000Z","dependencies_parsed_at":"2024-01-06T14:50:04.413Z","dependency_job_id":null,"html_url":"https://github.com/mikrima/UnityAccessibilityPlugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikrima%2FUnityAccessibilityPlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikrima%2FUnityAccessibilityPlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikrima%2FUnityAccessibilityPlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikrima%2FUnityAccessibilityPlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikrima","download_url":"https://codeload.github.com/mikrima/UnityAccessibilityPlugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224688971,"owners_count":17353296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T02:00:58.981Z","updated_at":"2024-11-14T20:30:45.044Z","avatar_url":"https://github.com/mikrima.png","language":"C#","readme":"# UnityAccessibilityPlugin\nThe UI Accessibility Plugin (UAP) allows you to make your UI accessible to blind and visually impaired players on Windows, Android, iOS, Mac and WebGL. \nTested in Unity 5.6 to Unity 2020.1.\n\n# Feature Overview\n- Full source code, including native code for Windows and Android libraries\n- UGUI \u0026 NGUI compatible\n- Supports multiple languages (and more can be added)\n- Works like VoiceOver \u0026 TalkBack\n\n# Supported Platforms\n- Android\n- iOS\n- Windows (Windwos SAPI and NVDA)\n- Mac\n- WebGL (some limitations apply)\n\n# Installation\n1. Download or clone this repo.\n2. Copy the UAP folder into your project's asset folder.\n3. Follow the Quick Start Guide either using the included PDF or the online guide \u003ca href=\"http://www.metalpopgames.com/assetstore/accessibility/doc/QuickStart.html\"\u003ehere\u003c/a\u003e.\n4. Watch the basic tutorial video on \u003ca href=\"https://www.youtube.com/watch?v=SJuQWf7p9T4\u0026ab_channel=MetalPopGames\"\u003eYoutube\u003c/a\u003e.\n\n# Basic Functionality\nThis plugin brings screen reader functionality to Unity apps, making them usable for blind users (without making \nthem unusable for everyone else).\n\n## Developers\nUI elements need to be marked up as accessible so that the UAP can recognize them, read them aloud to users, \nand allow interaction. This is done by adding accessibility-components to the GameObjects that are relevant.\u003cbr\u003e\n\n## Blind Users\nThe controls are based on popular screen readers like VoiceOver, NVDA and TalkBack, so that blind users will not \nhave to relearn a new method of control.\u003cbr\u003e\nThe plugin will try to detect a screen reader running in the background and enable itself if it does. Otherwise \nit will sit dormant and not interfere with the app (making it usable for non-blind users).\n\n# Documentation\nThe documentation, how-to guides and further examples can be found \u003ca href=\"http://www.metalpopgames.com/assetstore/accessibility/doc/index.html\"\u003ehere\u003c/a\u003e.\u003cbr\u003e\nThere's also a tutorial video demonstrating the basic setup: \u003ca href=\"https://www.youtube.com/watch?v=SJuQWf7p9T4\"\u003eBasic Tutorial Video\u003c/a\u003e.\u003cbr\u003e\nHere's a forum thread for discussion and support on the Unity forums: \u003ca href=\"https://forum.unity.com/threads/released-ui-accessibility-plugin-uap-v1-0.469298/?_ga=2.92342237.1961910733.1618848783-1844297938.1510951995\"\u003eUI Accessibility Plugin\u003c/a\u003e\n\n# License \u0026 Asset Usage Rights\nThe UAP plugin itself is made available under the Apache 2.0 license. See included license file for details.\u003cbr\u003e\nThis license does **not** apply to the demo and example content.\n\n## Example Scene\nAll assets inside the Example folder (or its subfolders) of this plugin are for sample purposes only and cannot be redistributed, sold or used in your products (free or commercial).\u003cbr\u003e\nThe UI for the Match 3 game example was created by Vasili Tkach.\u003cbr\u003e\nIt is available for free here: \u003ca href=\"https://dribbble.com/shots/2261532--Funtique-game-UI-kit-free-PSD\"\u003eFuntique UI by Vasili Tkach\u003c/a\u003e\n\n## Third Party Licensing Terms\nWindows only:\u003cbr\u003e\nUAP includes the shared NVDA screen reader controller client library for 64 and 32 Bit.\nThe library can be found in the folders UAP/Plugins/x86 and UAP/Plugins/x86_64 respectively.\nThe NVDA Controller Client API is licensed under the GNU Lesser General Public License (LGPL), version 2.1 (Source)\u003cbr\u003e\nIn simple terms, this library can be used in any application, but cannot be modified.\u003cbr\u003e\nLink to full license text: \u003ca href=\"https://github.com/nvaccess/nvda/blob/master/extras/controllerClient/license.txt\"\u003ehttps://github.com/nvaccess/nvda/blob/master/extras/controllerClient/license.txt\u003c/a\u003e\n\n# FAQ\n\u003cb\u003e*Does this make VoiceOver recognize my Unity app?*\u003c/b\u003e\u003cbr\u003e\nNo. This plugin works and acts like a screen-reader - it does not expose Unity's UI to native screen readers.\nIt basically reimplements the functionality of VoiceOver (and then some). Exposing the UI tree to the native \nscreen readers is not feasible, because UGUI and NGUI don't work this way.\n\u003cbr\u003e\u003cbr\u003e\n\u003cb\u003e*Can this plugin circumvent the problem with TalkBack blocking input?*\u003c/b\u003e\u003cbr\u003e\nTalkBack blocks input to Unity on an OS level, and this plugin can not circumvent that. \nTalkBack can be detected if it is running, and the plugin can enable accessibility automatically, but the \ninput will still need to be unblocked by pausing TalkBack while interacting with the app.\nThe plugin will prompt the user to pause TalkBack.\n\u003cbr\u003e\u003cbr\u003e\n\u003cb\u003e*On iOS 14 VoiceOver only says 'Direct Touch Area' - does the UAP not work in iOS 14?*\u003c/b\u003e\u003cbr\u003e\nUAP works fine in iOS 14. However, Apple changed the default behaviour for non-native UI views in this version of iOS. \nAs a result, many accessible apps now 'appear' to no longer work. But all the user has to do is reenable direct touch \nusing the rotor gesture. Blind users are familiar with this process (and have likely already changed the \nOS default behaviour in their device settings). This topic has been discussed in several forum threads.\u003cbr\u003e\nAs this is caused by the OS, it isn't something that this plugin can automatically circumvent. It is possible \nthat future versions of Unity will register the correct view parameters and solve this issue.\u003cbr\u003e\nMore on the topic can be found here: \u003ca href=\"https://developer.apple.com/forums/thread/663529\"\u003eDirect Touch Interaction Broken in iOS 14?\u003c/a\u003e\n\u003cbr\u003e\u003cbr\u003e\n\u003cb\u003e*Can I delete the Examples folder?*\u003c/b\u003e\u003cbr\u003e\nYes. It is safe to delete the entire \"Examples\" folder from the plugin if it isn't needed.\u003cbr\u003e\nAlso keep in mind that the assets used in the examples do not fall under the Apache 2.0 license, and cannot be \nused in other projects. See section **License \u0026 Asset Usage Rights** further up on this page.\n\u003cbr\u003e\u003cbr\u003e\n\u003cb\u003e*Is this plugin free to use in commercial projects?*\u003c/b\u003e\u003cbr\u003e\nYes.\u003cbr\u003e\nPlease note that the assets used in the Examples folder do not fall under the Apache 2.0 license, and may not be \nused in such projects. See section **License \u0026 Asset Usage Rights** further up on this page.\n","funding_links":[],"categories":["Open Source Repositories","C#"],"sub_categories":["UI"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikrima%2FUnityAccessibilityPlugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikrima%2FUnityAccessibilityPlugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikrima%2FUnityAccessibilityPlugin/lists"}