https://github.com/microsoft/jericho

A learning environment for man-made Interactive Fiction games.
https://github.com/microsoft/jericho

interactive-fiction reinforcement-learning text-based-adventure

Last synced: 4 days ago
JSON representation

A learning environment for man-made Interactive Fiction games.

• Host: GitHub
• URL: https://github.com/microsoft/jericho
• Owner: microsoft
• License: gpl-2.0
• Created: 2018-10-02T18:09:18.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T17:11:54.000Z (about 1 month ago)
• Last Synced: 2024-11-05T20:10:23.784Z (11 days ago)
• Topics: interactive-fiction, reinforcement-learning, text-based-adventure
• Language: C
• Homepage:
• Size: 1.76 MB
• Stars: 261
• Watchers: 18
• Forks: 43
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-deep-rl - Microsoft Jericho - A learning environment for man-made Interactive Fiction games. (Environments)
• awesome-exploration-rl - Jericho

README

        


    


    

    






  

    

  

  

    

  

  

    

  





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






## Requirements

***Linux***, ***Python 3.9+***, ***Spacy***, and basic build tools like ***gcc***,***make*** & ***curl***.

## Install

```bash

conda create -n jericho python=3

conda activate jericho

python -m pip install jericho

python -m spacy download en_core_web_sm

```

## Documentation

- [Quickstart](https://jericho-py.readthedocs.io/en/latest/tutorial_quick.html)

- [Frotz Environment](https://jericho-py.readthedocs.io/en/latest/frotz_env.html)

- [Object Tree](https://jericho-py.readthedocs.io/en/latest/object_tree.html)

- [Game Dictionary](https://jericho-py.readthedocs.io/en/latest/dictionary.html)

- [Template Action Generator](https://jericho-py.readthedocs.io/en/latest/template_action_generator.html)

- [Utilities](https://jericho-py.readthedocs.io/en/latest/util.html)

- [Defines](https://jericho-py.readthedocs.io/en/latest/defines.html)

## Agents

- [Reading Comprehension Deep Q-Network (RCDQN)](https://github.com/XiaoxiaoGuo/rcdqn)

- [Contextual Action Language Model (CALM)](https://github.com/princeton-nlp/calm-textgame)

- [Q*BERT](https://github.com/rajammanabrolu/Q-BERT)

- [Knowledge Graph Advantage Actor Critic (KG-A2C)](https://github.com/rajammanabrolu/KG-A2C)

- [Template-DQN and DRRN](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](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.