Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.45 KB

setup_ubuntu.md

File metadata and controls

52 lines (36 loc) · 1.45 KB
Raw

vcmi-gym setup guide (Ubuntu)

Important

VCMI requires data files from the original "Heroes 3: Shadow of Death" or "Heroes 3: Complete" editions.
Make sure you have access to those files before you proceed.

The setup guide below is tested with Python 3.10.12 on Ubuntu 22.04.

Checkout code

Please refer to the Checkout code instructions for MacOS.

Build VCMI

Please follow the instructions in this guide.

Build vcmi-gym C++ libs

Custom-made libraries that "connect" VCMI with the gym env:

$ cd "$VCMIGYM/vcmi_gym/connectors"
# TODO: libboost-all-dev has libgfortran5 dependency
#       ...which creeps as a libtorch dependency during libtorch builds
#       must find a less-generic boost package to install
$ sudo apt install libboost-all-dev
$ cmake -S . -B rel -Wno-dev \
    -D CMAKE_BUILD_TYPE=Release \
    -D CMAKE_EXPORT_COMPILE_COMMANDS=0

$ cmake --build rel/

Python env and deps

Please refer to the Python env and deps instructions for MacOS.

Vcmi-gym maps

Auto-generated maps for the purposes of training combat AIs must be symlinked in order to make them visible in VCMI:

$ ln -s "$VCMIGYM/maps/gym" "${XDG_DATA_HOME:-$HOME/.local/share}/vcmi/Maps/gym"

Manual test

Please refer to the Manual test instructions for MacOS.