|
This project is no longer actively maintained by the Google Creative Lab but remains here in a read-only Archive mode so that it can continue to assist developers that may find the examples helpful. We aren’t able to address all pull requests or bug reports but outstanding issues will remain in read-only mode for reference purposes. Also, please note that some of the dependencies may not be up to date and there hasn’t been any QA done in a while so your mileage may vary.
For more details on how Archiving affects Github repositories see this documentation . We welcome users to fork this repository should there be more useful, community-driven efforts that can help continue what this project began. |
Mystery Animal is a Voice Experiment that lets you play a guessing game where the computer pretends to be an animal, and you have to guess what it is.
Play it on a Google Home by saying “Hey Google, let's play Mystery Animal,” or try it in the browser at g.co/mysteryanimal.
This is an experiment, not an official Google product. We will do our best to support and maintain this experiment but your mileage may vary.
Mystery Animal is built on Actions on Google, the platform that allows you to make things for the Google Assistant and the Google Home. It uses Dialogflow to handle understanding what the player says, Firebase Cloud Functions for backend code, and Firebase Database to save data. The project is written in JavaScript, using Actions on Google’s Node.js client library.
This repo contains a pre-built Dialogflow Agent you can import into your own project. It contains all the Intents and Entities for Mystery Animal. This is all in the dialogflow_agent folder.
Everything in the functions folder is used in Firebase Cloud Functions, which hosts the webhook code for Dialogflow. The webhook handles all the response logic for Mystery Animal. The bulk of the code is in index.js.
Go to the Actions on Google developer console, and create a new project.
Click “BUILD” on the Dialogflow card, and follow the flow to create a new Dialogflow agent.
When your agent is created, click on the gear icon to get to the “Export and Import” tab. You can then compress the dialogflow_agent folder from this repo into a zip file, and then import it. You should then see all of Mystery Animal’s Intents and Entities in your project.
Here’s some more info about how Dialogflow works in general.
Install the Firebase CLI.
Go to the functions folder:
cd functions
Install dependencies by going to the running either
yarn or npm install
Initialize Firebase
firebase init
Select “functions” and optionally “database” if you’d also like to save the questions and responses. Select your Google Project ID as your default project. (This can be found in your Dialogflow agent settings.)
Deploy your webhook
firebase deploy
Get your webhook URL and put it in Dialogflow
Once you’ve successfully deployed your webhook, your terminal should give you a url called “Function URL.” In Dialogflow, click the “Fulfillment” tab and toggle the “Enable” switch for the webhook. Paste that url into the text field.
You can read more documentation about using Firebase Cloud Functions for Dialogflow fulfillment here.
You should now be able to test your app in the Dialogflow test console. You can also go to Dialogflow’s Integration tab, and try it on the Actions on Google simulator, where you can also hear it on a Google Home or Assistant device.
The bulk of the response logic is in index.js with some custom classes in the module folder. You can read the docs about the Actions on Google Node SDK, which is called in with const App = require("actions-on-google").DialogflowApp;
The Actions library’s built in app.data object is very useful for storing data within a session.
The repo contains a module called FirebaseDatabase.js, which allows you to save info about what happens in a game to a Firebase Database. If you want to do this, you’ll have to set up your own service account. If you don’t want to use it, you can remove all the Firebase Database code from index.js.
We’re making the animal data we have collected available in animal_names_sizes.json and game_data.json. This data is likely to not be 100% accurate and shouldn’t be used as a scientific reference.
Nicole He and Nick Jonas with friends at the Google Creative Lab.
Copyright 2017 Google Inc.
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
We encourage open sourcing projects as a way of learning from each other. Please respect our and other creators’ rights, including copyright and trademark rights when present, when sharing these works and creating derivative work. If you want more info on Google's policy, you can find that here.
