Skip to content

Latest commit

 

History

History
199 lines (141 loc) · 5.72 KB

installation.md

File metadata and controls

199 lines (141 loc) · 5.72 KB

Installation Documentation

Content

1. Linux (Ubuntu 22.04 LTS)

We will install MineLand step by step, in the new Ubuntu 22.04 LTS of Tencent Cloud Server.

MineLand requires at least 4G of memory and non-headless (headed) machine.

If you are using a headless machine, you can refer to 1.8 Headless machine.

1.1 Apt source list

The apt sources list is as follows. You can check the following sources if apt unable to locate some packages.

deb http://mirrors.tencentyun.com/ubuntu jammy main restricted

deb http://mirrors.tencentyun.com/ubuntu jammy-updates main restricted

deb http://mirrors.tencentyun.com/ubuntu jammy universe
deb http://mirrors.tencentyun.com/ubuntu jammy-updates universe

deb http://mirrors.tencentyun.com/ubuntu jammy multiverse
deb http://mirrors.tencentyun.com/ubuntu jammy-updates multiverse

deb http://mirrors.tencentyun.com/ubuntu jammy-security main restricted
deb http://mirrors.tencentyun.com/ubuntu jammy-security universe
deb http://mirrors.tencentyun.com/ubuntu jammy-security multiverse

1.2 Basic tools

sudo apt update
sudo apt upgrade
sudo apt install -y build-essential git wget curl
sudo apt-get install -y libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev # For node-canvas in node.js
sudo apt-get install -y libxi-dev libglu1-mesa-dev libglew-dev pkg-config # For headless-gl in node.js

Be careful, you need to choose suitable packages for node-canvas according to your OS.

1.3 Python 3.11 (Anaconda)

We will install Anaconda to use python.

You can check Installing on Linux for detailed infomation and skip this subsection.

Be careful, you need to change Anaconda version, if you don't use Linux-x86_64.

curl -O https://repo.anaconda.com/archive/Anaconda3-2024.02-1-Linux-x86_64.sh
bash ./Anaconda3-2024.02-1-Linux-x86_64.sh
# The following is an example to install anaconda according to the guideness.
<Enter>
<q>
yes<Enter>
<Enter>
yes<Enter> # This step is important.
<Re-start your shell>
# After re-start your shell, you should see a '(base)' before your shell prompt.

Validate Anaconda installation by executing conda --version and the output may be conda 24.1.2.

conda create -n mineland python=3.11
<Enter>
conda activate mineland

Validate python installation by executing python --version and the output may be Python 3.11.8

1.4 Node.js 18

We will install NVM - Node Version Manager to use node.js.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
<Re-start your shell>

Validate NVM installation by executing nvm --version and the output may be 0.39.7.

nvm install v18.18.2
nvm use v18.18.2
# You can set a default version for node.js by executing:
nvm alias default v18.18.2

Validate NVM installation by executing node --version and the output may be v18.18.2.

1.5 Java 17

If you have any other versions, you can use sudo update-alternatives java to switch java version.

sudo apt install openjdk-17-jdk

Validate java installation by executing java -version and the output may be openjdk version "17.0.10" 2024-01-16.

1.6 MineLand

git clone https://github.com/cocacola-lab/MineLand.git
cd MineLand

conda activate mineland
pip install -e .

cd mineland/sim/mineflayer
nvm use v18.18.2
npm ci
# ci means installing according to package-lock.json
# There are lots of dependencies in node.js, which require some time to install...

1.7 Validate

# move back to MineLand root directory
cd ../../../
python ./scripts/validate_install_simulator.py

Congratulations!

1.8 Headless machine

sudo apt install -y xvfb
Xvfb :1 -screen 0 1024x768x24 </dev/null &
export DISPLAY=":1"

2. Docker

We provide a pre-built docker image based on ubuntu:24.04.

You can run a docker contain according to the following steps:

# Download MineLand image
docker pull yxhxianyu/mineland

# Create a container
docker run -it -p 25565:25565 --name mineland yxhxianyu/mineland /bin/bash
exit

# Start and enter container
docker start mineland
docker exec -it mineland bash -c "cd /root && exec bash"

# Start xvfb for headless machine
# Tips: This command is only needed to be executed once, every time you start container
Xvfb :1 -screen 0 1024x768x24 </dev/null &

# Start MineLand (Tips: python & node environment have both activated in .bashec)
cd /root/MineLand
python ./scripts/validate_install_simulator.py

# After `Validation passed! The simulator is installed correctly.`,
# you can press <ctrl+C> to exit MineLand.

# Exit container
exit

# Stop container
docker stop mineland

This docker image was made according to the above documentation completely. In addition, we installed vim and add the following configuration to /root/.bashrc

conda activate mineland
nvm use v18.18.2
export DISPLAY=":1"

The docker image isn't fully tested. If you encounter any problem, welcome to raise them in issues or create a PR.