{"id":13528572,"url":"https://github.com/microsoft/jericho","last_synced_at":"2025-04-09T04:02:53.997Z","repository":{"id":33716773,"uuid":"151300728","full_name":"microsoft/jericho","owner":"microsoft","description":"A learning environment for man-made Interactive Fiction games.","archived":false,"fork":false,"pushed_at":"2024-10-15T17:11:54.000Z","size":1844,"stargazers_count":284,"open_issues_count":8,"forks_count":43,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-02T03:01:51.979Z","etag":null,"topics":["interactive-fiction","reinforcement-learning","text-based-adventure"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-02T18:09:18.000Z","updated_at":"2025-03-30T08:53:47.000Z","dependencies_parsed_at":"2024-10-16T20:54:37.562Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/jericho","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fjericho","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fjericho/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fjericho/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fjericho/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/jericho/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247974712,"owners_count":21026742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interactive-fiction","reinforcement-learning","text-based-adventure"],"created_at":"2024-08-01T07:00:21.372Z","updated_at":"2025-04-09T04:02:53.978Z","avatar_url":"https://github.com/microsoft.png","language":"C","funding_links":[],"categories":["Environments","C","Papers"],"sub_categories":["ICLR 2022"],"readme":"\u003cp align=\"center\"\u003e\n    \u003cbr\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/microsoft/jericho/master/docs/source/imgs/jericho.png\" width=\"300\"/\u003e\n    \u003cbr\u003e\n\u003cp\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href='https://jericho-py.readthedocs.io/en/latest/?badge=latest'\u003e\n    \u003cimg src='https://readthedocs.org/projects/jericho-py/badge/?version=latest' alt='Documentation Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://travis-ci.org/microsoft/jericho'\u003e\n    \u003cimg src='https://travis-ci.org/microsoft/jericho.svg?branch=master' alt='Build Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href='https://badge.fury.io/py/jericho'\u003e\n    \u003cimg src='https://badge.fury.io/py/jericho.svg' alt='PyPI version' /\u003e\n  \u003c/a\u003e\n\u003cp\u003e\n\n\u003cp align=\"center\"\u003e\n  A lightweight python-based interface connecting learning agents with interactive fiction games.\n\u003cp\u003e\n\n\u003cbr\u003e\n\n## Requirements\n***Linux***, ***Python 3.9+***, ***Spacy***, and basic build tools like ***gcc***,***make*** \u0026 ***curl***.\n\n## Install\n```bash\nconda create -n jericho python=3\nconda activate jericho\n\npython -m pip install jericho\npython -m spacy download en_core_web_sm\n```\n\n## Documentation\n- [Quickstart](https://jericho-py.readthedocs.io/en/latest/tutorial_quick.html)\n- [Frotz Environment](https://jericho-py.readthedocs.io/en/latest/frotz_env.html)\n- [Object Tree](https://jericho-py.readthedocs.io/en/latest/object_tree.html)\n- [Game Dictionary](https://jericho-py.readthedocs.io/en/latest/dictionary.html)\n- [Template Action Generator](https://jericho-py.readthedocs.io/en/latest/template_action_generator.html)\n- [Utilities](https://jericho-py.readthedocs.io/en/latest/util.html)\n- [Defines](https://jericho-py.readthedocs.io/en/latest/defines.html)\n\n## Agents\n\n- [Reading Comprehension Deep Q-Network (RCDQN)](https://github.com/XiaoxiaoGuo/rcdqn)\n- [Contextual Action Language Model (CALM)](https://github.com/princeton-nlp/calm-textgame)\n- [Q*BERT](https://github.com/rajammanabrolu/Q-BERT)\n- [Knowledge Graph Advantage Actor Critic (KG-A2C)](https://github.com/rajammanabrolu/KG-A2C)\n- [Template-DQN and DRRN](https://github.com/microsoft/tdqn)\n\n## Citing Jericho\nIf Jericho is used in your research, please cite the following:\n```\n@article{hausknecht19,\n  title={Interactive Fiction Games: A Colossal Adventure},\n  author={Hausknecht, Matthew and Ammanabrolu, Prithviraj and C\\^ot\\'{e} Marc-Alexandre and Yuan Xingdi},\n  journal={CoRR},\n  year={2019},\n  url={http://arxiv.org/abs/1909.05398},\n  volume={abs/1909.05398}\n}\n```\n\n## Contributing\n\nThis project welcomes contributions and suggestions.  Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.microsoft.com.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fjericho","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fjericho","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fjericho/lists"}