notebooks/Playing TextWorld generated games with OpenAI Gym.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Playing TextWorld generated games with OpenAI Gym\n",
    "This tutorial shows how to play a text-based adventure game **generated by TextWorld** using OpenAI's Gym API."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Generate a new TextWorld game"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Global seed: 1234\n",
      "Game generated: tw_games/game.ulx\n",
      "Welcome to another fast paced game of TextWorld! Here is your task for today. First, it would be great if you could try to go east. With that accomplished, take the shoe that's in the attic. With the shoe, place the shoe on the shelf. Alright, thanks!\n"
     ]
    }
   ],
   "source": [
    "!tw-make custom --world-size 2 --quest-length 3 --nb-objects 10 --output tw_games/game.ulx -f -v --seed 1234"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Register the game with Gym\n",
    "In order to call to `gym.make`, we need to create a valid `env_id` for our game."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [],
   "source": [
    "import textworld.gym\n",
    "env_id = textworld.gym.register_game('tw_games/game.ulx')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Make the gym environment\n",
    "With our `env_id` we are ready to use gym to start the new environment."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [],
   "source": [
    "import gym\n",
    "env = gym.make(env_id)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Start the game\n",
    "Like for other Gym environments, we start a new game by calling the `env.reset` method. It returns the initial observation text string as well as a dictionary for additional informations (more on that later)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "\n",
      "\n",
      "                    ________  ________  __    __  ________        \n",
      "                   |        \\|        \\|  \\  |  \\|        \\       \n",
      "                    \\$$$$$$$$| $$$$$$$$| $$  | $$ \\$$$$$$$$       \n",
      "                      | $$   | $$__     \\$$\\/  $$   | $$          \n",
      "                      | $$   | $$  \\     >$$  $$    | $$          \n",
      "                      | $$   | $$$$$    /  $$$$\\    | $$          \n",
      "                      | $$   | $$_____ |  $$ \\$$\\   | $$          \n",
      "                      | $$   | $$     \\| $$  | $$   | $$          \n",
      "                       \\$$    \\$$$$$$$$ \\$$   \\$$    \\$$          \n",
      "              __       __   ______   _______   __        _______  \n",
      "             |  \\  _  |  \\ /      \\ |       \\ |  \\      |       \\ \n",
      "             | $$ / \\ | $$|  $$$$$$\\| $$$$$$$\\| $$      | $$$$$$$\\\n",
      "             | $$/  $\\| $$| $$  | $$| $$__| $$| $$      | $$  | $$\n",
      "             | $$  $$$\\ $$| $$  | $$| $$    $$| $$      | $$  | $$\n",
      "             | $$ $$\\$$\\$$| $$  | $$| $$$$$$$\\| $$      | $$  | $$\n",
      "             | $$$$  \\$$$$| $$__/ $$| $$  | $$| $$_____ | $$__/ $$\n",
      "             | $$$    \\$$$ \\$$    $$| $$  | $$| $$     \\| $$    $$\n",
      "              \\$$      \\$$  \\$$$$$$  \\$$   \\$$ \\$$$$$$$$ \\$$$$$$$ \n",
      "\n",
      "Welcome to another fast paced game of TextWorld! Here is your task for today. First, it would be great if you could try to go east. With that accomplished, take the shoe that's in the attic. With the shoe, place the shoe on the shelf. Alright, thanks!\n",
      "\n",
      "-= Scullery =-\n",
      "You've just shown up in a scullery.\n",
      "\n",
      "You make out a Canadian style box. If you haven't noticed it already, there seems to be something there by the wall, it's a board. The board appears to be empty. What, you think everything in TextWorld should have stuff on it? You bend down to tie your shoe. When you stand up, you notice a bowl. But there isn't a thing on it. This always happens!\n",
      "\n",
      "You don't like doors? Why not try going east, that entranceway is unguarded.\n",
      "\n",
      "\n",
      "\n",
      "\n"
     ]
    }
   ],
   "source": [
    "obs, infos = env.reset()\n",
    "print(obs)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Interact with the game\n",
    "The `env.step` method is used to send text command to the game. This method returns the observation for the new state, the current game score, whether the game is done, and dictionary for additional informations (more on that later)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "You have to unlock the Canadian style box with the Canadian style key first.\n",
      "\n",
      "\n"
     ]
    }
   ],
   "source": [
    "obs, score, done, infos = env.step(\"open box\")\n",
    "print(obs)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Make a simple play loop\n",
    "We now have everything we need in order to interactively play a text-based game."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "\n",
      "\n",
      "                    ________  ________  __    __  ________        \n",
      "                   |        \\|        \\|  \\  |  \\|        \\       \n",
      "                    \\$$$$$$$$| $$$$$$$$| $$  | $$ \\$$$$$$$$       \n",
      "                      | $$   | $$__     \\$$\\/  $$   | $$          \n",
      "                      | $$   | $$  \\     >$$  $$    | $$          \n",
      "                      | $$   | $$$$$    /  $$$$\\    | $$          \n",
      "                      | $$   | $$_____ |  $$ \\$$\\   | $$          \n",
      "                      | $$   | $$     \\| $$  | $$   | $$          \n",
      "                       \\$$    \\$$$$$$$$ \\$$   \\$$    \\$$          \n",
      "              __       __   ______   _______   __        _______  \n",
      "             |  \\  _  |  \\ /      \\ |       \\ |  \\      |       \\ \n",
      "             | $$ / \\ | $$|  $$$$$$\\| $$$$$$$\\| $$      | $$$$$$$\\\n",
      "             | $$/  $\\| $$| $$  | $$| $$__| $$| $$      | $$  | $$\n",
      "             | $$  $$$\\ $$| $$  | $$| $$    $$| $$      | $$  | $$\n",
      "             | $$ $$\\$$\\$$| $$  | $$| $$$$$$$\\| $$      | $$  | $$\n",
      "             | $$$$  \\$$$$| $$__/ $$| $$  | $$| $$_____ | $$__/ $$\n",
      "             | $$$    \\$$$ \\$$    $$| $$  | $$| $$     \\| $$    $$\n",
      "              \\$$      \\$$  \\$$$$$$  \\$$   \\$$ \\$$$$$$$$ \\$$$$$$$ \n",
      "\n",
      "Welcome to another fast paced game of TextWorld! Here is your task for today. First, it would be great if you could try to go east. With that accomplished, take the shoe that's in the attic. With the shoe, place the shoe on the shelf. Alright, thanks!\n",
      "\n",
      "-= Scullery =-\n",
      "You've just shown up in a scullery.\n",
      "\n",
      "You make out a Canadian style box. If you haven't noticed it already, there seems to be something there by the wall, it's a board. The board appears to be empty. What, you think everything in TextWorld should have stuff on it? You bend down to tie your shoe. When you stand up, you notice a bowl. But there isn't a thing on it. This always happens!\n",
      "\n",
      "You don't like doors? Why not try going east, that entranceway is unguarded.\n",
      "\n",
      "\n",
      "\n",
      "\n",
      "> help\n",
      "Available commands:\n",
      "  look:                describe the current room\n",
      "  goal:                print the goal of this game\n",
      "  inventory:           print player's inventory\n",
      "  go <dir>:            move the player north, east, south or west\n",
      "  examine ...:         examine something more closely\n",
      "  eat ...:             eat edible food\n",
      "  open ...:            open a door or a container\n",
      "  close ...:           close a door or a container\n",
      "  drop ...:            drop an object on the floor\n",
      "  take ...:            take an object that is on the floor\n",
      "  put ... on ...:      place an object on a supporter\n",
      "  take ... from ...:   take an object from a container or a supporter\n",
      "  insert ... into ...: place an object into a container\n",
      "  lock ... with ...:   lock a door or a container with a key\n",
      "  unlock ... with ...: unlock a door or a container with a key\n",
      "\n",
      "\n",
      "\n",
      "Played 1 steps, scoring 0 points.\n"
     ]
    }
   ],
   "source": [
    "try:\n",
    "    done = False\n",
    "    obs, _ = env.reset()\n",
    "    print(obs)\n",
    "    nb_moves = 0\n",
    "    while not done:\n",
    "        command = input(\"> \")\n",
    "        obs, score, done, _ = env.step(command)\n",
    "        print(obs)\n",
    "        nb_moves += 1\n",
    "\n",
    "except KeyboardInterrupt:\n",
    "    pass  # Press the stop button in the toolbar to quit the game.\n",
    "\n",
    "print(\"Played {} steps, scoring {} points.\".format(nb_moves, score))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Request additional information\n",
    "<span style=\"color:red\">_*Only available for games generated with TextWorld._</span>\n",
    "\n",
    "To ease the learning process of AI agents, TextWorld offers control over what information should be available alongside the game's narrative (i.e. the observation).\n",
    "\n",
    "Let's request the list of __admissible__ commands (i.e. commands that are guaranteed to be understood by the game interpreter) for every game state. We will also request the list of entity names that can be interacted with. For the complete list of information that can be requested, see the [documentation](https://textworld.readthedocs.io/en/latest/_modules/textworld/envs/wrappers/filter.html?highlight=envinfos))."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Entities: ['safe', 'Canadian style box', 'shoe', 'cane', 'shelf', 'workbench', 'board', 'bowl', 'Canadian style key', 'book', 'fork', 'pair of pants', 'north', 'south', 'east', 'west']\n",
      "Admissible commands:\n",
      "  drop Canadian style key\n",
      "  drop book\n",
      "  drop fork\n",
      "  examine Canadian style box\n",
      "  examine Canadian style key\n",
      "  examine board\n",
      "  examine book\n",
      "  examine bowl\n",
      "  examine fork\n",
      "  go east\n",
      "  inventory\n",
      "  look\n",
      "  put Canadian style key on board\n",
      "  put Canadian style key on bowl\n",
      "  put book on board\n",
      "  put book on bowl\n",
      "  put fork on board\n",
      "  put fork on bowl\n",
      "  unlock Canadian style box with Canadian style key\n"
     ]
    }
   ],
   "source": [
    "import textworld\n",
    "request_infos = textworld.EnvInfos(admissible_commands=True, entities=True)\n",
    "\n",
    "# Requesting additional information should be done when registering the game.\n",
    "env_id = textworld.gym.register_game('tw_games/game.ulx', request_infos)\n",
    "env = gym.make(env_id)\n",
    "\n",
    "obs, infos = env.reset()\n",
    "print(\"Entities: {}\".format(infos[\"entities\"]))\n",
    "print(\"Admissible commands:\\n  {}\".format(\"\\n  \".join(infos[\"admissible_commands\"])))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}