Skip to content

compile_engine.md

Latest commit

 

History

History
159 lines (124 loc) · 5.38 KB

compile_engine.md

File metadata and controls

159 lines (124 loc) · 5.38 KB

Compiling Google Research Football Engine

This guide is intended to contain detailed information on building the environment on different platforms and architectures. So far, it covers:

Additionally, Development mode section explains how to install the game in the development (aka, editable) mode.

Windows

Install prerequisites:

Finally, install vcpkg by following a Quick Start Guide or simply by creating a directory, e.g., C:\dev, opening Command Prompt and running the following commands:

:: Navigate to the created directory
cd C:\dev
:: Clone vckpg
git clone https://github.com/microsoft/vcpkg.git
:: Run installation script
.\vcpkg\bootstrap-vcpkg.bat

If you have vcpkg already installed, consider updating it to the latest commit and running .\bootstrap-vcpkg.bat.

As for the C++ engine dependencies (boost, SDL, etc.), you don't have to install them manually, vcpkg's manifest mode will handle it.

Next, run the following lines in the command prompt to install Google Research Football environment:

:: Clone the repository
git clone https://github.com/google-research/football.git
cd football
:: Set VCPKG_ROOT environment variable that points to vcpkg installation
set VCPKG_ROOT=C:\dev\vcpkg\

:: Create and activate virtual environment
python -m venv football-env
football-env\Scripts\activate.bat
:: For PowerShell users: football-env\Scripts\activate.ps1

:: Upgrade pip and install additional packages
python -m pip install --upgrade pip setuptools wheel
python -m pip install psutil

:: Run the installation. It installs vcpkg dependencies and compiles the engine
python -m pip install .

macOS (both Intel processors and Apple Silicon)

Install prerequisites

First, install brew. It should automatically download Command Line Tools. Next, install the required packages:

brew install git python3 cmake sdl2 sdl2_image sdl2_ttf sdl2_gfx boost boost-python3

python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install psutil

Clone the repository and navigate to the directory:

git clone https://github.com/google-research/football.git
cd football

Choosing Python distribution

It is recommended to use Python shipped with brew because boost-python3 is compiled against the same version. To check which Python 3 is used by default on your setup, execute which python3. If the output is /usr/local/bin/python3 or /opt/homebrew/bin/python3, you're good to go.
If you see a different path, e.g. /Library/Frameworks/Python.framework/Versions/3.9/bin/python3 or ...conda..., create a virtual environment with $(brew --prefix python3)/bin/python3 -m venv football-env. If you have conda, you might need to deactivate base environment beforehand conda deactivate.

It is possible to use conda to create a virtual environment, but make sure that you select the same version of Python that was used to build boost-python3 (3.9 as of February 2022).

Create virtual environment and build the game

Use virtual environment to avoid messing up with global dependencies:

python3 -m venv football-env
source football-env/bin/activate

If you decide to use conda environment, use the following commands instead:

conda create --name football-env python=3.9 -y
conda activate football-env

Upgrade pip, setuptools, wheel and install psutil inside the virtual environment:

python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install psutil

Finally, build the game environment:

python3 -m pip install .

Linux

Install required packages:

sudo apt-get install git cmake build-essential libgl1-mesa-dev libsdl2-dev \
libsdl2-image-dev libsdl2-ttf-dev libsdl2-gfx-dev libboost-all-dev \
libdirectfb-dev libst-dev mesa-utils xvfb x11vnc python3-pip

python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install psutil

Clone the repository and navigate to the directory:

git clone https://github.com/google-research/football.git
cd football

Use virtual environment to avoid messing up with global dependencies:

python3 -m venv football-env
source football-env/bin/activate
# update pip and setuptools
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install psutil

Finally, build the game environment:

python3 -m pip install .

Development mode

You can install Google Research Football in the development (aka editable) mode by running:

python3 -m pip install -e .

In such case, Python source files can be edited in-place without reinstallation, the changes will be reflected the next time an interpreter process is started.