WARNING: This repository is no longer maintained
This repository will not be updated. The repository will be kept available in read-only mode. Refer to https://github.com/IBM/vr-speech-sandbox-cardboard/ for a similar example.
Create voice commands for VR experiences with Watson services
Read this in other languages: 中国.
Watson Conversation is now Watson Assistant. Although some images in this code pattern may show the service as Watson Conversation, the steps and processes will still work.
In Virtual Reality, where you truly “inhabit” the space, speech can feel like a more natural interface than other methods. Providing speech controls allows developers to create more immersive experiences. The Oculus Rift is the 4th most popular head-mounted VR devices (not including Google Cardboard) and an ideal candidate for Speech interaction, selling roughly 355 thousand units in 2016.
When the reader has completed this Code Pattern, they will understand how to:
- Add IBM Watson Speech-to-Text and Assistant to a Virtual Reality environment build in Unity.
- User interacts in virtual reality and gives voice commands such as "Create a large black box".
- The Oculus Rift Headset microphone picks up the voice command and the running application sends it to Watson Speech-to-Text.
- Watson Speech-to-Text converts the audio to text and returns it to the running Application that powers the Oculus Rift.
- The application sends the text to Watson Assistant. Watson conversation returns the recognized intent "Create" and the entities "large", "black", and "box". The virtual reality application then displays the large black box (which falls from the sky).
- IBM Watson Assistant: Create a chatbot with a program that conducts a conversation via auditory or textual methods.
- IBM Watson Speech-to-Text: Converts audio voice into written text.
- Unity: A cross-platform game engine used to develop video games for PC, consoles, mobile devices and websites.
Watch the Video
1. Before You Begin
2. Create IBM Cloud services
On your local machine:
git clone https://github.com/IBM/vr-speech-sandbox-rift.git
In IBM Cloud:
- Create a Speech-To-Text service instance.
- Create an Assistant service instance.
- Once you see the services in the Dashboard, select the Assistant service you created and click the button.
- After logging into the Assistant Tool, click the button.
- Import the Assistant
workspace.jsonfile located in your clone of this repository.
3. Building and Running
Note: This has been compiled and tested using Unity 2018.2.0f2 and Watson Unity SDK from the Unity asset Store as of July 24, 2018 and tested with the
developbranch of the github unity-sdk as of
commit 44d8df33922 July 12.
Note: If you are in any IBM Cloud region other than US-South you must use Unity 2018.2 or higher. This is because Unity 2018.2 or higher is needed for TLS 1.2, which is the only TLS version available in all regions other than US-South.
- Download the Watson SDK for Unity or perform the following:
git clone https://github.com/watson-developer-cloud/unity-sdk.git
Make sure you are on the develop branch.
Navigate to where you cloned this repository and open the "Creation Sandbox" directory.
If prompted to upgrade the project to a newer Unity version, do so.
Follow these instructions to add the Watson Unity SDK downloaded in step 1 to the project.
Follow these instructions to create your Speech To Text and Watson Assistant services and find their credentials (using IBM Cloud). You can find your workspace ID by selecting the expansion menu on your assistant workspace and selecting
In the Unity Hierarchy view, click on
MainMenuand then the
In the Inspector you will see Variables for
Speech To Textand
Watson Assistantand either
CF Authenticationfor the Cloud Foundry username and password, or the
IAM Authenticationif you have the IAM apikey. Since you only have only one version of these credentials, fill out only one of the two for each service.
Fill out the
Speech To Text Service Url, the
Assistant Service Url, the
Assistant Workspace Id, and the
Assistant Version Date. There are tool tips which will show help and any defaults.
- Install Blender
- In the
Unity editor projecttab, select
MainMenuand double click to load the scene.
- Artificial Intelligence Code Patterns: Enjoyed this Code Pattern? Check out our other AI Code Patterns.
- AI and Data Code Pattern Playlist: Bookmark our playlist with all of our Code Pattern videos
- With Watson: Want to take your Watson app to the next level? Looking to utilize Watson Brand assets? Join the With Watson program to leverage exclusive brand, marketing, and tech resources to amplify and accelerate your Watson embedded commercial solution.
This code pattern is licensed under the Apache Software License, Version 2. Separate third party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version 2.