https://github.com/neogeek/a11ytk-rewrite
The Accessibility Toolkit is an open-source Unity package for adding context-aware subtitles in VR, AR, and non-XR environments.
https://github.com/neogeek/a11ytk-rewrite
accessibility subtitles unity
Last synced: 2 months ago
JSON representation
The Accessibility Toolkit is an open-source Unity package for adding context-aware subtitles in VR, AR, and non-XR environments.
- Host: GitHub
- URL: https://github.com/neogeek/a11ytk-rewrite
- Owner: neogeek
- License: mit
- Created: 2024-07-30T19:16:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-30T19:44:18.000Z (about 1 year ago)
- Last Synced: 2025-06-30T20:38:52.313Z (about 1 year ago)
- Topics: accessibility, subtitles, unity
- Language: C#
- Homepage: https://a11ytk.com
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> This is an active rewrite of [A11YTK - Accessibility Toolkit](https://github.com/A11YTK/A11YTK). Please use the original project until the rewrite is complete.
# 
> The Accessibility Toolkit is an open-source Unity package for adding context-aware subtitles in VR, AR, and non-XR environments. Research shows that many digital experiences exclude those with hearing impairments often due to time constraints and budgets. The Accessibility Toolkit allows inclusivity for hard of hearing populations and well as adding the ability to easily internationalize experiences greatly expanding the reach and quality of any project.
## Installation
### Unity Package Manager
#### Git
```json
{
"dependencies": {
"com.a11ytk.a11ytk": "https://github.com/neogeek/a11ytk-rewrite.git?path=Packages/A11YTK",
...
}
}
```
### Include Tests
```json
{
"dependencies": {
"com.unity.test-framework": "1.1.33",
...
},
"testables": ["com.a11ytk.a11ytk"]
}
```
## Usage
1. Create a GameObject with either a `AudioSource` or a `VideoPlayer` component.
1. Attach a `SubtitleRenderer` component.
1. Connect the `AudioSource` or a `VideoPlayer` component to the `SubtitleRenderer` component.
1. Create a `TextMeshProUGUI` GameObject and attach it to the `SubtitleRenderer` as the text component.
1. (Optional) Create an `Image` GameObject with a dark background and attach it to the `SubtitleRenderer` as the background.
1. Add a `TextAsset` with the contents of an SRT file to the `SubtitleRenderer` or use the `SetSubtitles` method at runtime.
1. (Optional) Set the `Anchors` of the `TextMeshProUGUI` (and `Image`) GameObjects `RectTransform` to anchor the subtitle to the top or bottom.
1. (Optional) Set the `Alignment` of the `TextMeshProUGUI` GameObject to `Center` and `Midline`.
1. (Optional) Set the `Scale` of the `Image` transform to `1.1, 1.1, 1.1` to add padding to the subtitle background.