diff --git a/README.md b/README.md index c82ce565..14f52065 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,9 @@ env.step(1) # move agent '@' north env.render() ``` +![](/docs/imgs/minihack_gameplay.gif) + + To see the list of all [MiniHack environments](./docs/envs/tasks.md), run: ```bash diff --git a/docs/conf.py b/docs/conf.py index 646db1c1..dbbce513 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- -project = "MiniHack The Planet" +project = "MiniHack" copyright = "2021, MiniHack Team @ Facebook AI Research, UCL, and Oxford" author = "MiniHack Team @ Facebook AI Research, UCL, and Oxford" diff --git a/docs/imgs/minihack_gameplay.gif b/docs/imgs/minihack_gameplay.gif new file mode 100644 index 00000000..77e77d2a Binary files /dev/null and b/docs/imgs/minihack_gameplay.gif differ diff --git a/docs/index.md b/docs/index.md index f3bbe203..0ea0a956 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # MiniHack -![](imgs/minihack_envs.png) +![](imgs/minihack.png) MiniHack is a sandbox framework for easily designing rich and diverse environments for Reinforcement Learning (RL). Based on the game of [NetHack](./about/nethack), arguably the hardest grid-based game in the world, MiniHack uses the [NetHack Learning Environment (NLE)](https://github.com/facebookresearch/nle) to provide a convenient interface for customly created RL testbeds.