Installation

Welcome to MineRL! This guide will get you started.

To start using the MineRL dataset and Gym environments comprising MineRL, you’ll need to install the main python package, minerl.

  1. First make sure you have JDK 8 installed on your system.

    1. Windows installer – On windows go this link and follow the instructions to install JDK 8. Install x64 version.

    2. On Mac, you can install Java 8 using homebrew and AdoptOpenJDK (an open source mirror, used here to get around the fact that Java8 binaries are no longer available directly from Oracle):

      brew tap AdoptOpenJDK/openjdk
      brew install --cask adoptopenjdk8
      
    3. On Debian based systems (Ubuntu!) you can run the following:

      sudo add-apt-repository ppa:openjdk-r/ppa
      sudo apt-get update
      sudo apt-get install openjdk-8-jdk
      
      # Verify installation
      java -version # this should output "1.8.X_XXX"
      # If you are still seeing a wrong Java version, you may use
      # the following line to update it
      # sudo update-alternatives --config java
      
  2. If you are using Windows, you will also need bash command. There are at least two ways to do this:

    1. Install Windows Subsystem for Linux (WSL. Tested on WSL 2). Note that installing MineRL this way may seem especially slow/stuck, but it is not; it is just a bit slow. You can also install MineRL on the WSL system itself, but you may need xvfb to run the environment.

    2. Install bash along some other tools. E.g., Git will come with bash. After installation, you may have to update environment variables to include a path which contains bash.exe. For above git tools, this is [installation-dir]/bin.

  3. Now install the minerl package!:

    pip install git+https://github.com/minerllabs/minerl
    

Note

You may need the user flag: pip install git+https://github.com/minerllabs/minerl --user to install properly.