This project provides a set of OpenAI Gym environments for interacting with Minecraft, leveraging Microsoft's Malmo platform. It's designed for AI researchers and developers experimenting with reinforcement learning agents in a 3D block-based world, offering various pre-configured Minecraft missions for training and evaluation.

How It Works

The environment bundle integrates with the Malmo platform, which acts as a bridge between Minecraft and AI agents. It exposes standard Gym step, reset, and render methods, allowing agents to perceive the Minecraft world state, take actions, and receive rewards. The environments are based on Malmo's missions, with added PrioritiseOffscreenRendering to potentially speed up training by reducing visual overhead.

Quick Start & Requirements

• Install dependencies for your OS (Windows, Linux, MacOSX).
• Install OpenAI Gym: pip install gym.
• Install minecraft_py: git clone https://github.com/tambetm/minecraft-py.git && cd minecraft-py && python setup.py install.
• Install gym-minecraft: git clone https://github.com/tambetm/gym-minecraft.git && cd gym-minecraft && python setup.py install.
• Requires pygame for rendering.
• First-time Minecraft startup can take a while due to downloads and compilation, subsequent starts are around 30 seconds.
• Documentation: Malmo Wiki

Highlighted Details

• Offers 16 pre-defined Minecraft environments, from simple tasks to complex mazes.
• Supports overriding default environment settings like action spaces (discrete/continuous) and video resolution.
• Includes a snippet for debugging Minecraft startup issues.

Maintenance & Community

• The project explicitly states it is "outdated" and recommends using MalmoEnv instead.
• No community links (Discord, Slack) or roadmap are provided in the README.

Licensing & Compatibility

• The README does not explicitly state a license. However, it depends on Malmo and OpenAI Gym, which have permissive licenses.
• Compatibility for commercial use would require clarification on the licensing of the underlying Malmo platform and this wrapper.

Limitations & Caveats

The project is marked as outdated, with a recommendation to use MalmoEnv. This suggests potential lack of maintenance, compatibility issues with newer Gym versions, or unaddressed bugs. The setup process involves downloading and compiling Minecraft, which can be resource-intensive and time-consuming.