From a6afc882093ef96664b0d7835a578df037a04d5b Mon Sep 17 00:00:00 2001 From: follower Date: Tue, 16 Jun 2020 21:50:43 +1200 Subject: [PATCH 1/5] Typo fix: "ar" -> "are" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04fa105..4fcabd1 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ There is an [accessible starter project](https://github.com/lightsoutgames/godot enabled=[ "godot-accessibility" ] ``` -4. Optionally, configure the plugin by creating a file named _.godot-accessibility-editor-settings.ini_ in your project directory. This file is entirely optional, and defaults ar shown below: +4. Optionally, configure the plugin by creating a file named _.godot-accessibility-editor-settings.ini_ in your project directory. This file is entirely optional, and defaults are shown below: ``` [global] editor_accessibility__enabled = true ; Set to false if you'd like this plugin's accessibility nodes but don't need editor speech, good for sighted collaborators. From 7f47af81774f68d435247928f449af273b2ab3b6 Mon Sep 17 00:00:00 2001 From: follower Date: Tue, 16 Jun 2020 22:00:49 +1200 Subject: [PATCH 2/5] Fix-up of Markdown formatting This change ensures that the items numbered 5, 6 & 7 appear as individual paragraphs with a list number instead of being run together in a single paragraph. The change inserts an extra blank line between list items which ensures their correct formatting. However, the last sentence of item 4 is now indented incorrectly (it currently has no indent) but it was getting too complicated to figure out how to get all the content of item 4 indented correctly while also fixing the remaining items so decided to split the tasks. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4fcabd1..5e8eb28 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,11 @@ editor_accessibility__enabled = true ; Set to false if you'd like this plugin's rate = 50 ; range is 0 to 100. ``` This file shouldn't be checked into version control, so add it to your ignore patterns. + 5. Optionally, set up Android TTS. After performing [Android export setup](https://docs.godotengine.org/en/3.2/getting_started/workflow/export/exporting_for_android.html) and downloading templates, click _Project -> Install Android Build Template_. Copy, or link, _addons/godot-tts/android_ to _android/godot-tts_. + 6. Perform the below Windows-only procedure if you would prefer that editor speech be done with your screen reader. Note that these steps aren't necessary if all you want is speech in exports. + 7. Launch your project in the editor by running `godot -e` in the top-level directory. Or, to launch the game normally, simply run `godot`. Windows-only: If you need speech in the editor and would prefer to use your screen reader, please perform the following additional steps: From b70de2d97f7b4ea354094ef695f09dfc0b104511 Mon Sep 17 00:00:00 2001 From: follower Date: Tue, 16 Jun 2020 22:07:56 +1200 Subject: [PATCH 3/5] Fix-up of Markdown formatting for items 1-3 Add necessary blank lines between items (even though they still displayed correctly). Add additional indent spaces to ensure that "fenced" code blocks (both the back-tick open/close markers & the actual content ) are indented correctly in order to appear aligned with the rest of the item. --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e8eb28..9b90d1c 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,17 @@ Anecdotally, I've learned that building games with Godot is not only possible, b There is an [accessible starter project](https://github.com/lightsoutgames/godot-accessible-starter) that does most of this for you, and sets up a basic project with an in-game screen reader and editor accessibility. But here are the steps from an empty Godot project: 1. Place this repository in a directory named _addons/godot-accessibility_ inside your project. This plugins root directory should be reachable at the Godot path _res://addons/godot-accessibility_. -2. Download the [latest release of the Godot TTS addon](https://github.com/lightsoutgames/godot-tts/releases) and place its files in _addons/godot-tts_. When complete, you should have paths like _addons/godot-tts/TTS.gd_. -3. Enable the Godot Accessibility plugin from the editor UI. Or, if you have a _project.godot_ file, ensure that you have a section like: -``` -[editor_plugins] -enabled=[ "godot-accessibility" ] -``` +2. Download the [latest release of the Godot TTS addon](https://github.com/lightsoutgames/godot-tts/releases) and place its files in _addons/godot-tts_. When complete, you should have paths like _addons/godot-tts/TTS.gd_. + +3. Enable the Godot Accessibility plugin from the editor UI. Or, if you have a _project.godot_ file, ensure that you have a section like: + + ``` + [editor_plugins] + + enabled=[ "godot-accessibility" ] + ``` + 4. Optionally, configure the plugin by creating a file named _.godot-accessibility-editor-settings.ini_ in your project directory. This file is entirely optional, and defaults are shown below: ``` [global] From ab87ab6ef4918ebf38d8a268b5b6c555dc381fed Mon Sep 17 00:00:00 2001 From: follower Date: Tue, 16 Jun 2020 22:11:50 +1200 Subject: [PATCH 4/5] Fix-up of Markdown formatting for item 4 Add required indent spaces to content of item 4 in order to get all the item's content to be aligned correctly. --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9b90d1c..fb0f80a 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,15 @@ There is an [accessible starter project](https://github.com/lightsoutgames/godot ``` 4. Optionally, configure the plugin by creating a file named _.godot-accessibility-editor-settings.ini_ in your project directory. This file is entirely optional, and defaults are shown below: -``` -[global] -editor_accessibility__enabled = true ; Set to false if you'd like this plugin's accessibility nodes but don't need editor speech, good for sighted collaborators. -[speech] -rate = 50 ; range is 0 to 100. -``` -This file shouldn't be checked into version control, so add it to your ignore patterns. + + ``` + [global] + editor_accessibility__enabled = true ; Set to false if you'd like this plugin's accessibility nodes but don't need editor speech, good for sighted collaborators. + [speech] + rate = 50 ; range is 0 to 100. + ``` + + This file shouldn't be checked into version control, so add it to your ignore patterns. 5. Optionally, set up Android TTS. After performing [Android export setup](https://docs.godotengine.org/en/3.2/getting_started/workflow/export/exporting_for_android.html) and downloading templates, click _Project -> Install Android Build Template_. Copy, or link, _addons/godot-tts/android_ to _android/godot-tts_. From 5aaa252f60b781f297d053fb64677de4352ee5aa Mon Sep 17 00:00:00 2001 From: follower Date: Tue, 16 Jun 2020 22:16:13 +1200 Subject: [PATCH 5/5] Enable syntax highlighting of `.ini` file snippets Figured I might as well while I'm here. :) Do screen readers make use of syntax highlighting in a context like this? --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb0f80a..6deb0db 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ There is an [accessible starter project](https://github.com/lightsoutgames/godot 3. Enable the Godot Accessibility plugin from the editor UI. Or, if you have a _project.godot_ file, ensure that you have a section like: - ``` + ```ini [editor_plugins] enabled=[ "godot-accessibility" ] @@ -32,7 +32,7 @@ There is an [accessible starter project](https://github.com/lightsoutgames/godot 4. Optionally, configure the plugin by creating a file named _.godot-accessibility-editor-settings.ini_ in your project directory. This file is entirely optional, and defaults are shown below: - ``` + ```ini [global] editor_accessibility__enabled = true ; Set to false if you'd like this plugin's accessibility nodes but don't need editor speech, good for sighted collaborators. [speech]