This tool provides an easy to use front-end that allows developers to instantly deploy code for your story, or use the generated code as a starting point for more complex projects.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3c5c272 May 23, 2018

README.md

Build An Alexa Gamebook Skill

This Alexa sample skill is a template for a basic gamebook skill. Provided with a branching text adventure from the Twine 2 platform, Alexa will let you play a game.

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, ask Text Adventure where am I?
	>> You are in the main hall of a large castle. Heavy tapestries hang from the walls...
Alexa, start Text Adventure
	>> You're in a small office, there is a door to your left...

Repository Contents

Setup w/ ASK CLI

Pre-requisites

Installation

  1. Clone the repository.

    $ git clone https://github.com/alexa/skill-sample-gamebook/
  2. Initialize the ASK CLI by navigating into the repository and running npm command: ask init. Follow the prompts.

    $ cd skill-sample-gamebook
    $ ask init
  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

Testing

  1. Log in to the Alexa Developer Console, open your skill, and from the Test tab enable the Test switch.

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

     $ ask simulate -l en-US -t "start Text Adventure"
    
     ✓ Simulation created for simulation id: 4a7a9ed8-94b2-40c0-b3bd-fb63d9887fa7
    ◡ Waiting for simulation response{
      "status": "SUCCESSFUL",
      ...
  3. With the Test switch enabled, your skill can also be tested on devices associated with your developer account. Speak to Alexa through any enabled physical device, through your browser with echosim.io, or through your Amazon Mobile App and say:

    start Text Adventure
    

Customization

  1. Amend ./skill.json

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

    Remember that interaction models are locale-specific and must be changed for each locale (en-US, en-GB, de-DE, etc.).

    See the Skill Manifest Documentation for more information.

  2. Amend ./lambda/custom/index.js

    Modify messages, and facts from the source code to customize the skill.

  3. Amend ./models/*.json

    Change the model definition to replace the invocation name and the sample phrase for each intent. Repeat the operation for each locale you are planning to support.

  4. Open the Twine 2 online editor

    Twine 2 is a text adventure authoring platform. It is capable of creating quite complex standalone games using variables and plug-ins. For our purposes we use it to create a simple text-and-choice-based branching game.

    Note that we are not using Twine variables. We leave this as a programming task for any enthused developers.

    You can use the online editor or download and install it as a desktop app.

    We aren't going to teach you how to use Twine here, but if you import the sample game it will give you a head-start.

    Later, when you are developing your own Alexa skills, remember that Twine can be very useful for designing voice interaction flows.

  5. Import and play the sample game

    In the main right-hand menu click on Import From File.

    Import the sample game [Escape the Office.html](../lambda/custom/Escape the Office.html)

Additional Resources

Community

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