Speech to Text module for Godot

This is a Speech to Text (STT) module for Godot. In other words, a module that captures the user's microphone input and converts it to text.

Requirements

The module can be built with Godot 2.1.4 on the following platforms:

• Windows
• OS X
• Unix (with PulseAudio or ALSA requirement)
• iOS
• Android (untested; see below for more info)

Barring Android, export templates were successfully built, on all referred platforms, for Godot 2.1.4 with Speech to Text. Godot's repository can be found here.

Check if your system fulfills Godot's building requirements on the desired platform, or for cross-compiling to another system. Other than that, Speech to Text has no additional requirements. It is intended to be used alongside a microphone connected to the system, which will capture voice input.

Building Godot with the module

The following steps assume that you are on a Unix system. For a different platform supported by the module, use the equivalent tools.

1. If you don't have the source code for Godot, clone its repository from GitHub.

   $ git clone https://github.com/godotengine/godot
   

2. Inside the cloned repository, change to the latest stable build that the module works on (when these instructions were made, it was 2.1.4).

   $ git checkout 2.1.4-stable
   

3. Add this repository's speech_to_text/ folder to your Godot modules/ directory.

4. Build Godot, according to your desired platform (follow the instructions given on the Godot Docs).

5. Run Godot:

   $ ./bin/godot*tools*
   

6. In order to check if the module was successfully added, follow these final steps:

   6.1. After opening Godot, click the New Project button on the right side to open the Create New Project window.

   6.2. On the new window, add a Project Path (I'd recommend an empty directory) and a Project Name (you are free to choose as you like).

   6.3. Click Create to open the Godot project editor window.

   6.4. On the right side, there should be a Scene tab with a window below it. Click the first icon below the Scene label, which has a plus symbol +, to create a new node.

   6.5. Check if the STTRunner appears in the list of nodes; it should probably be near the end of the list. There is also a search bar for convenience.

Usage

Check the html tutorial here, which was created on my Godot Docs fork, for more information on how to use the module.

Export templates

If you wish to export a game that uses the Speech to Text module, you will first need to build export templates for the desired platform.

Check the instructions and requirements on the Godot Docs site to learn how to build export templates for a specific system. This includes cross compiling for opposite bits or even for a different platform.

Demo: Color Clutter

Color Clutter is a simple game, developed by me in Godot as a demo for the module.

If you wish to do a quick test, follow the instructions below to run the game from its project directory. Once again, the instructions suppose that you are on a Unix system, but equivalent commands on other platforms should work.

1. Clone the game's repository.

   $ git clone https://github.com/SamuraiSigma/color-clutter
   

2. After building Godot, run it with the directory created in the last step as the -path argument.

   $ ./bin/godot*tools* -path <color_clutter_directory>
   

Instructions on how to play are in the repository's README.md file.