Inclusive UI Audit — Accessibility Checker for uGUI & TextMeshPro
Includes a demo shop and settings screen with one deliberate problem for each rule. WORKS WITH Unity 2022.3 LTS and Unity 6 ... Any build target. ... No network calls, no analytics.
by YudiGamesStudio
Price History +
FEATURES
• Nine rules: A11Y001 text contrast (WCAG 1.4.3), A11Y002 icon control contrast (1.4.11), A11Y003 touch target size (2.5.8), A11Y004 touch target spacing (2.5.8), A11Y005 text size (best practice), A11Y006 missing accessible label (4.1.2), A11Y007 state colors (1.4.11), A11Y008 color-only toggles (1.4.1), A11Y009 text at 200% size (1.4.4)
• Screens laid out at a reference device (default 1080 × 1920 at 480 dpi) with each CanvasScaler mode, in throw-away copies of prefabs and scenes, and rendered offscreen to sample the pixels behind each character and control
• Sizes in dp, and text in WCAG points (1 pt = 4/3 dp)
• Profiles: folders, reference device, thresholds, per-rule severity and on/off
• Command line: -executeMethod YudiGamesStudio.InclusiveUIAudit.Editor.InclusiveUIAuditCommandLine.Run; exit codes 0 (pass), 1 (issues), 2 (audit couldn't run)
• Reports: HTML evidence report, JSON (with a JSON schema), CSV and JUnit XML
• Extension API: IAuditRule for your own rules; rules from other packages through an attribute named InclusiveUIAuditRuleAttribute, with no assembly reference
• Editor-only assemblies; the demo has one small sample component
SUPPORTED OS
• Unity Editor on Windows (tested). macOS and Linux Editors are not tested.
DOCUMENTATION
• https://yudigamesstudio.github.io/inclusive-ui-audit/InclusiveUIAudit-Manual.pdf
Most mobile games build their UI with uGUI and TextMesh Pro. Inclusive UI Audit is the accessibility audit built for
them. It lays out each prefab and scene as a reference phone would show it, renders it, and measures what is really
on screen. Then it lists every problem with the WCAG 2.2 guideline it refers to, and keeps a dated report of what you
fixed and what you accepted.
KEY FEATURES
• Text contrast measured against the background as it renders: gradients, images and see-through panels included,
not guessed from the hierarchy
• Touch-target size and spacing in real dp, for every CanvasScaler mode
• Finds icon-only buttons and other controls a screen reader can't name
• Text size, state colors, color-only toggles and text that won't fit at 200% size
• Color-vision preview: see your screen with protanopia, deuteranopia, tritanopia or achromatopsia
• Click an issue to see the screen with it outlined, or jump to the object; Scene view markers
• Accept an issue with a reason; acceptances live in one project file that reviews well in git
• Dated HTML evidence report with screenshots, WCAG 2.2 links and the reason for every accepted issue
• Command line for CI, with exit codes and HTML, JSON, CSV and JUnit reports
• Fast: 200 screens audited in under 30 seconds (measured on a laptop with an i7-11370H and an RTX 3050 Ti)
• Add your own rules with a small C# interface
Includes a demo shop and settings screen with one deliberate problem for each rule.
WORKS WITH
• Unity 2022.3 LTS and Unity 6
• Built-in Render Pipeline, URP and HDRP
• uGUI and TextMesh Pro: Screen Space Overlay, Screen Space Camera and World Space canvases
• Any build target. Inclusive UI Audit is editor-only and adds nothing to your builds. Tested in the Unity Editor on
Windows.
REQUIREMENTS
• TextMesh Pro (com.unity.textmeshpro on 2022.3; built into com.unity.ugui on Unity 6)
• A graphics device: screens are rendered to measure contrast, so command-line runs can't use -nographics
• For the demo, import TMP Essential Resources
DATA HANDLING
• Runs entirely in the editor. No network calls, no analytics.
• Reads your prefabs and scenes in throw-away copies and never modifies them. Writes only its own settings, the
issues you accept, and the reports you export.
KNOWN LIMITATIONS
• UI Toolkit screens aren't audited yet.
• Game-world backgrounds behind see-through UI are left out of contrast samples, since they change while playing.
• Animated UI is measured in the state it is saved in.
• Accessible labels are checked for being present, not for meaning.
• The checks help you find problems; they don't certify compliance with any law or standard.
DOCUMENTATION & SUPPORT
• Offline manual included (Documentation/Manual.pdf)
• Online: https://yudigamesstudio.github.io/inclusive-ui-audit/
• Support: yudigamesstudio@gmail.com, replies within 48 hours
THIRD-PARTY NOTICES
• This package contains no third-party components.