aondio/skill-sample-nodejs-numberguessinggame

The number guessing game is a game where the player tries to guess the target number. After each incorrect guess, the player is informed if the target number is higher or lower than their current guess. This continues until the target number is guessed or the player gives up. This sample Alexa Skill is written in Node.js and demonstrates skill internationalization

Build An Alexa Number Guessing Game Skill

This Alexa sample skill is a template for a basic number guessing game skill. Guess a number, and Alexa will tell you whether the number she has in mind is higher or lower.

Let's Get Started

If this is your first time here, you're new to Alexa Skills Development, or you're looking for more detailed instructions, click the Get Started button below:

Be sure to take a look at the Additional Resources at the bottom of this page!

About

Note: The rest of this readme assumes you have your developer environment ready to go and that you have some familiarity with CLI (Command Line Interface) Tools, AWS, and the ASK Developer Portal. If not, click here for a more detailed walkthrough.

Usage

Alexa, open number guessing game
	>> ...please guess a number between 0 and 100
Five
	>> Five is too low. Try saying a larger number.
...

Repository Contents

• /.ask - ASK CLI (Command Line Interface) Configuration
• /lambda/custom - Back-End Logic for the Alexa Skill hosted on AWS Lambda
• /lambda/custom/i18n - Internationalization strings used in the back-end
• /models - Voice User Interface and Language Specific Interaction Models
• /instructions - Step-by-Step Instructions for Getting Started
• skill.json - Skill Manifest

Setup w/ ASK CLI

Pre-requisites

• Node.js (> v4.3)
• Register for an AWS Account
• Register for an Amazon Developer Account
• Install and Setup ASK CLI

Installation

1. Clone the repository.

   $ git clone https://github.com/germanviscuso/skill-sample-nodejs-numberguessinggame

2. Navigating into the repository's root folder.

   $ cd skill-sample-nodejs-numberguessinggame

3. Install npm dependencies by navigating into the lambda/custom directory and running the npm command: npm install

   $ cd lambda/custom
   $ npm install

Deployment

ASK CLI will create the skill and the lambda function for you. The Lambda function will be created in us-east-1 (Northern Virginia) by default.

1. Deploy the skill and the lambda function in one step by running the following command:

   $ ask deploy

2. Once deployed, additional permissions need to be added to the AWS IAM role being used by the skill since it is persisting data in Amazon DynamoDB. Navigate to the AWS IAM console.

   Note: We are adding the full access policy here for convenience. For a production skill, you should use a more targeted policy restricting access to just the required resources. Refer to the DynamoDB documentation for more details.

   1. Locate the role for your skill (by default, it is named ask-lambda-<your skill name>).
   2. Click on the role, then click Attach Policy.
   3. Search for AmazonDynamoDBFullAccess and click the check box next to it.
   4. Click Attach Policy.

Testing

1. To test, you need to login to Alexa Developer Console, and enable the "Test" switch on your skill from the "Test" Tab.

2. Simulate verbal interaction with your skill through the command line using the following example:

    $ ask simulate -l en-US -t "start the number guessing game"
   
    ✓ Simulation created for simulation id: 4a7a9ed8-94b2-40c0-b3bd-fb63d9887fa7
   ◡ Waiting for simulation response{
     "status": "SUCCESSFUL",
     ...

Note: if you did not add the DynamoDB permission as described in the previous step, the skill will return an error and you will see an error in your CloudWatch Logs reporting: ...Coud not read item...is not authorized to perform: dynamodb:GetItem...

3. Once the "Test" switch is enabled, your skill can be tested on devices associated with the developer account as well. Speak to Alexa from any enabled device, from your browser at echosim.io, or through your Amazon Mobile App and say :

   Alexa, start the number guessing game
   

Customization

1. ./skill.json

   Change the skill name, example phrase, icons, testing instructions etc ...

   Remember that some of the information is locale-specific and must be changed for each locale (en-GB and en-US)

   See the Skill Manifest Documentation for more information.

2. ./lambda/custom/index.js

   Modify things (like e.g the number range) from the source code to customize the skill.

3. ./lambda/custom/i18n/*.json

   Provide localized strings for the backend in each supported locale. Repeat the operation for each locale you are planning to support.

4. ./models/*.json

   Change the model definition to replace the invocation name and, if necessary for your customization, the sample phrases for each intent. Repeat the operation for each locale you are planning to support.

Additional Resources

Community

• Amazon Developer Forums - Join the conversation!
• Hackster.io - See what others are building with Alexa.

Tutorials & Guides

• Voice Design Guide - A great resource for learning conversational and voice user interface design.
• CodeAcademy: Learn Alexa - Learn how to build an Alexa Skill from within your browser with this beginner friendly tutorial on CodeAcademy!

Documentation

• Official Alexa Skills Kit Node.js SDK - The Official Node.js SDK Documentation
• Official Alexa Skills Kit Documentation - Official Alexa Skills Kit Documentation