A lightweight python-based interface connecting learning agents with interactive fiction games.

Requirements

Linux, Python 3, and basic build tools like gcc.

Install

pip3 install --user jericho

Documentation

• Quickstart
• Frotz Environment
• Object Tree
• Game Dictionary
• Template Action Generator
• Utilities
• Defines

Agents

Reference implementations of DRRN and TDQN agents may be found at https://github.com/microsoft/tdqn.

Citing Jericho

If Jericho is used in your research, please cite the following:

@article{hausknecht19,
  title={Interactive Fiction Games: A Colossal Adventure},
  author={Hausknecht, Matthew and Ammanabrolu, Prithviraj and C\^ot\'{e} Marc-Alexandre and Yuan Xingdi},
  journal={CoRR},
  year={2019},
  url={http://arxiv.org/abs/1909.05398},
  volume={abs/1909.05398}
}

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.