football

(โ˜… 3,660)

Check out the new game server:

  • .dockerignore
  • .gitattributes
  • .gitignore
  • CHANGELOG
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile_examples
  • LICENSE
  • MANIFEST.in
  • README.md
  • requirements.txt
  • run_docker_test.sh
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/google-research/football

Downloads the entire project code from GitHub to your computer.

cd football

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
  • Homebrew A package manager for macOS/Linux.
sudo apt-get install git cmake build-essential libgl1-mesa-dev libsdl2-dev \

Installs directly from the APT package repository (Debian/Ubuntu-based).

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

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t football .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 football

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ ์ปดํŒŒ์ผ๋Ÿฌ Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
sudo apt-get install git cmake build-essential libgl1-mesa-dev libsdl2-dev \

Installs directly from the APT package repository (Debian/Ubuntu-based).

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

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
libdirectfb-dev libst-dev mesa-utils xvfb x11vnc python3-pip

Type this command into your terminal and run it.

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

Installs the Python libraries listed in requirements.txt (or similar).

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

Installs the Python libraries listed in requirements.txt (or similar).

python3 -m pip install gfootball

Installs the Python libraries listed in requirements.txt (or similar).

python3 -m venv football-env

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation