Rogueinabox: a Rogue environment for AI learning

Rogueinabox is a higly modular and configurable learning environment built around the videogame Rogue, the father of the roguelike genre.

It offers easy ways to interact with the game, especially for the reinforcement learning setting, providing several built-in state and reward generators and utilities for creating custom ones.

Cloning and building

Clone the repository with the default git command:

git clone <URL>

Before executing the next step, you may want to create/activate your python virtual environment. In order to create it:

python3 -m venv /path/to/venv

And to activate it:

. /path/to/venv/bin/activate

Make sure to do this before the next step, because it will update pip and install python dependencies.

Finally execute:

make install

This will install python dependencies, pull our Rogue custom build (in a submodule) and build its executable.

Manual cloning and building

If you have trouble with the previous procedure, here we describe an alternative more complete manual process. This library comes with its own custom Rogue build, which has its own git repository and is included as a submodule. In order for it to be correctly initialized and used, you can either clone this repo with the following command:

git clone --recurse-submodules <URL>

Or you can clone it in the standard way and then run the following from within your local repo directory:

git submodule update --init --recursive

Install python requirements:

pip install -r requirements.txt

After that, you need to enter in our custom Rogue build directory and make it:

cd rogue
make