Implement initial visual impairment accessibility addons

retrohub-org · Mar 19, 2023 · 2a505c0 · 2a505c0
1 parent 67d2c20
commit 2a505c0
Show file tree

Hide file tree

Showing 26 changed files with 1,853 additions and 25 deletions.
diff --git a/.github/workflows/linux_build.yml b/.github/workflows/linux_build.yml
@@ -17,42 +17,52 @@ jobs:
             bin: godot.x11.opt.32
             template: godot_32
             videodecoder: x11_32
+            godot-tts: target/release/32
           - name: 64 Bits
             bits: 64
             bin: godot.x11.opt.64
             template: godot_64
             videodecoder: x11
+            godot-tts: target/release
 
     steps:
       - name: "Checkout RetroHub"
         uses: actions/checkout@v3
         with:
           path: "retrohub"
 
-      - name : "Load cached objects (Godot editor)"
+      - name: "Load cached objects (Godot editor)"
         uses: actions/cache@v3
         id: "cache_editor"
         with:
           path: cached_builds/editor/godot
           key: editor-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Godot templates)"
+
+      - name: "Load cached objects (Godot templates)"
         uses: actions/cache@v3
         id: "cache_template"
         with:
           path: cached_builds/template/godot_${{ matrix.bits }}
           key: Linux-${{ matrix.bits }}-template-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Videodecoder)"
+
+      - name: "Load cached objects (Videodecoder)"
         uses: actions/cache@v3
         id: "cache_videodecoder"
         with:
           path: cached_builds/videodecoder/${{ matrix.videodecoder }}
           key: Linux-${{ matrix.bits }}-videodecoder-build
         continue-on-error: true
 
+      - name: "load cached objects (godot-tts)"
+        uses: actions/cache@v3
+        id: "cache_tts"
+        with:
+          path: cached_builds/tts/${{ matrix.bits }}
+          key: Linux-${{ matrix.bits }}-tts-build
+        continue-on-error: true
+
       - name: "Checkout Custom Godot"
         if: steps.cache_template.outputs.cache-hit != 'true'
         uses: actions/checkout@v3
@@ -69,6 +79,24 @@ jobs:
           submodules: recursive
           path: "videodecoder"
 
+      - name: "Download godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        uses: robinraju/[email protected]
+        with:
+          repository: retrohub-org/godot-tts
+          tag: v1.0.0
+          fileName: godot-tts.zip
+          tarBall: false
+          zipBall: false
+          out-file-path: ""
+
+      - name: "Cache godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        run: |
+          unzip godot-tts.zip -d $RUNNER_TEMP
+          mkdir -p -v cached_builds/tts/${{ matrix.bits }}
+          mv -v $RUNNER_TEMP/godot-tts/${{ matrix.godot-tts }}/*.so cached_builds/tts/${{ matrix.bits }}
+
       - name: "[Videodecoder] Compilation"
         if: steps.cache_videodecoder.outputs.cache-hit != 'true'
         working-directory: ./videodecoder
@@ -147,6 +175,11 @@ jobs:
       - name: "Package default themes"
         uses: ./retrohub/.github/actions/get-default-themes
 
+      - name: "Package godot-tts"
+        run: |
+          mkdir -p -v retrohub/addons/godot-tts/${{ matrix.godot-tts }}
+          cp -r -v cached_builds/tts/${{ matrix.bits }}/* retrohub/addons/godot-tts/${{ matrix.godot-tts }}
+
       - name: "Exporting RetroHub"
         working-directory: retrohub
         run: |

diff --git a/.github/workflows/mac_build.yml b/.github/workflows/mac_build.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: "macos-12"
     name: Extract SDK
     steps:
-      - name : "Load cache"
+      - name: "Load cache"
         uses: actions/cache@v3
         id: "cache"
         with:
@@ -41,15 +41,15 @@ jobs:
     name: Compile FFMPEG
 
     steps:
-      - name : "Load cache (SDK)"
+      - name: "Load cache (SDK)"
         uses: actions/cache@v3
         id: "cache-sdk"
         with:
           path: ~/cached_builds/sdk
           key: MacOS-sdk
         continue-on-error: false
-      
-      - name : "Load cache (videodecoder)"
+
+      - name: "Load cache (videodecoder)"
         uses: actions/cache@v3
         id: "cache-videodecoder"
         with:
@@ -85,30 +85,38 @@ jobs:
         with:
           path: "retrohub"
 
-      - name : "Load cached objects (Godot editor)"
+      - name: "Load cached objects (Godot editor)"
         uses: actions/cache@v3
         id: "cache_editor"
         with:
           path: cached_builds/editor/Godot.app
           key: MacOS-editor-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Godot templates)"
+
+      - name: "Load cached objects (Godot templates)"
         uses: actions/cache@v3
         id: "cache_template"
         with:
           path: cached_builds/template/osx.zip
           key: MacOS-template-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Videodecoder)"
+
+      - name: "Load cached objects (Videodecoder)"
         uses: actions/cache@v3
         id: "cache_videodecoder"
         with:
           path: cached_builds/videodecoder/osx
           key: MacOS-videodecoder-build
         continue-on-error: false
 
+      - name: "load cached objects (godot-tts)"
+        uses: actions/cache@v3
+        id: "cache_tts"
+        with:
+          path: cached_builds/tts/${{ matrix.bits }}
+          key: MacOS-${{ matrix.bits }}-tts-build
+        continue-on-error: true
+
       - name: "Checkout Custom Godot"
         if: steps.cache_template.outputs.cache-hit != 'true'
         uses: actions/checkout@v3
@@ -117,6 +125,25 @@ jobs:
           ref: retrohub_patches
           path: "godot"
 
+      - name: "Download godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        uses: robinraju/[email protected]
+        with:
+          repository: retrohub-org/godot-tts
+          tag: v1.0.0
+          fileName: godot-tts.zip
+          tarBall: false
+          zipBall: false
+          out-file-path: ""
+
+      - name: "Cache godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        run: |
+          unzip godot-tts.zip -d $RUNNER_TEMP
+          mkdir -p -v cached_builds/tts
+          mv -v $RUNNER_TEMP/godot-tts/target/release/*.dylib cached_builds/tts
+
+
       - name: "[Godot] Dependencies"
         if: steps.cache_template.outputs.cache-hit != 'true'
         working-directory: ./godot
@@ -188,6 +215,12 @@ jobs:
       - name: "Package default themes"
         uses: ./retrohub/.github/actions/get-default-themes
 
+      - name: "Package godot-tts"
+        run: |
+          mkdir -p -v retrohub/addons/godot-tts/target/release
+          cp -r -v cached_builds/tts/* retrohub/addons/godot-tts/target/release
+
+
       - name: "Exporting RetroHub"
         working-directory: retrohub
         run: |

diff --git a/.github/workflows/windows_build.yml b/.github/workflows/windows_build.yml
@@ -17,42 +17,52 @@ jobs:
             bin: godot.windows.opt.32.exe
             template: godot_32.exe
             videodecoder: win32
+            godot-tts: target/release/32
           - name: 64 Bits
             bits: 64
             bin: godot.windows.opt.64.exe
             template: godot_64.exe
             videodecoder: win64
+            godot-tts: target/release
 
     steps:
       - name: "Checkout RetroHub"
         uses: actions/checkout@v3
         with:
           path: "retrohub"
 
-      - name : "Load cached objects (Godot editor)"
+      - name: "Load cached objects (Godot editor)"
         uses: actions/cache@v3
         id: "cache_editor"
         with:
           path: cached_builds/editor/godot
           key: editor-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Godot templates)"
+
+      - name: "Load cached objects (Godot templates)"
         uses: actions/cache@v3
         id: "cache_template"
         with:
           path: cached_builds/template/godot_${{ matrix.bits }}.exe
           key: Windows-${{ matrix.bits }}-template-build
         continue-on-error: true
-      
-      - name : "Load cached objects (Videodecoder)"
+
+      - name: "Load cached objects (Videodecoder)"
         uses: actions/cache@v3
         id: "cache_videodecoder"
         with:
           path: cached_builds/videodecoder/${{ matrix.videodecoder }}
           key: Windows-${{ matrix.bits }}-videodecoder-build
         continue-on-error: true
 
+      - name: "load cached objects (godot-tts)"
+        uses: actions/cache@v3
+        id: "cache_tts"
+        with:
+          path: cached_builds/tts/${{ matrix.bits }}
+          key: Windows-${{ matrix.bits }}-tts-build
+        continue-on-error: true
+
       - name: "Checkout Custom Godot"
         if: steps.cache_template.outputs.cache-hit != 'true'
         uses: actions/checkout@v3
@@ -69,6 +79,24 @@ jobs:
           submodules: recursive
           path: "videodecoder"
 
+      - name: "Download godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        uses: robinraju/[email protected]
+        with:
+          repository: retrohub-org/godot-tts
+          tag: v1.0.0
+          fileName: godot-tts.zip
+          tarBall: false
+          zipBall: false
+          out-file-path: ""
+
+      - name: "Cache godot-tts"
+        if: steps.cache_tts.outputs.cache-hit != 'true'
+        run: |
+          unzip godot-tts.zip -d $RUNNER_TEMP
+          mkdir -p -v cached_builds/tts/${{ matrix.bits }}
+          mv -v $RUNNER_TEMP/godot-tts/${{ matrix.godot-tts }}/*.dll cached_builds/tts/${{ matrix.bits }}
+
       - name: "[Videodecoder] Compilation"
         if: steps.cache_videodecoder.outputs.cache-hit != 'true'
         working-directory: ./videodecoder
@@ -156,6 +184,11 @@ jobs:
           echo "export/windows/rcedit = \"$(pwd)/rcedit-x64.exe\"" >> ~/.config/godot/editor_settings-3.tres
           tail -n2 ~/.config/godot/editor_settings-3.tres
 
+      - name: "Package godot-tts"
+        run: |
+          mkdir -p -v retrohub/addons/godot-tts/${{ matrix.godot-tts }}
+          cp -r -v cached_builds/tts/${{ matrix.bits }}/* retrohub/addons/godot-tts/${{ matrix.godot-tts }}
+
       - name: "Exporting RetroHub"
         working-directory: retrohub
         run: |

diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,9 @@ godotOld
 # Ignore pre-built FFMPEG binaries
 addons/godot-videodecoder/**
 
+# Ignore pre-built godot-tts, it is bundled on release
+addons/godot-tts/target/
+
 # Ignore specific addons
 addons/wakatime
 

diff --git a/.godot-accessibility-editor-settings.ini b/.godot-accessibility-editor-settings.ini
@@ -0,0 +1,2 @@
+[global]
+editor_accessibility_enabled = false