Skip to main content

pyfiction, a universal API for text-based games

Project description

Python API for all kinds of text-based games.

Introduction

Text-based games, more commonly known as interactive fiction (IF), come in various formats and use different interpreters that aren’t often compatible with each other.

The goal of pyfiction is to wrap the functionality of different IF simulators and to provide a universal API for text games for research purposes.

Pyfiction also includes sample agents that can learn to play the supplied text games.

Requirements

  • Python 3.6 (older version might work but they aren’t tested, Python 3.5 tested briefly)
  • text-games submodule for games ‘Saving John’ and ‘Machine of Death’
  • keras, tensorflow and their dependencies for launching the example agents
  • selenium and chromedriver for running the HTML-based games
  • h5py for saving and loading models
  • pydot for visualising model graphs

Installation

To install the latest published version, simply run:

pip install pyfiction

To install the bleeding-edge version from this repository, run:

git clone --recursive https://github.com/MikulasZelinka/pyfiction
cd pyfiction
pip install -e .

Interface

pyfiction provides a simple agent-environment interface for text-game environments.

agent-environment interface

Simple RL interface [4]. In pyfiction, the agent calls the corresponding functions of the game environment:

  • state, actions, rewards = game.read() (left branch),
  • game.write(action) (right branch).

Examples

To run any example (from the game list below or from this list), simply run:

python file.py

on these files:

or on one of the supported games below.

Currently supported games

The following links lead to training experiments of the SSAQN agent on the supported games:

Additionally, the plan is to integrate the individual games to the OpenAI Gym, see the pull request and the text_games branch for details.

Adding new games

TODO.

Status

Version 0.1.2, Alpha

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pyfiction-0.1.2-py2.py3-none-any.whl (8.1 MB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 30, 2017
pyfiction-0.1.2.tar.gz (8.1 MB) Copy SHA256 hash SHA256 Source None Jul 30, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page