The purpose of this project is to provide a wrapper for Microsoft's Malmo Platform, intended to serve the following purposes:
- Allow for easier installation of Malmo
- Provide a programming interface that streamlines the creation and execution of scenarios.
- Provide a set of higher-order agent actions for developers to choose from.
Ensure you have the necessary dependencies installed on your machine. The version of Python you need depends on your operating system given Malmo platform requirements.
| Link | Version |
|---|---|
| Java Development Kit |
|
| Python |
|
Install the package:
pip install malmoext
Malmo Minecraft must be started prior to running a scenario. At least one instance is required for each agent present in your scenario(s).
To spawn one or more instances of Malmo Minecraft:
python -m malmoext --ports 10000 10001 ...
Once running, these Malmo Minecraft servers can be reused across multiple scenarios.
Once one or more instances of Malmo Minecraft is running, you can execute one of your scenarios by running its script:
python myScenario.py
For examples on how to build scenarios, check out the examples folder.
The following environment variables can optionally be set:
| Name | Default | Description |
|---|---|---|
MALMO_INSTALL_DIR |
(the current working directory) | The directory that the Malmo Platform should be installed to when starting Malmo Minecraft for the first time. It is recommended that users set this to a constant value in order to avoid having Malmo installed to multiple locations. |