Installation

To install the latest stable version, simply install with pip:

pip install highway-env

or with uv:

uv pip install highway-env

Special cases

Ubuntu

If you are on Linux, you may need additional dependencies for pygame-ce, which provides the graphics:

sudo apt-get update -y
sudo apt-get install -y python-dev libsdl-image1.2-dev libsdl-mixer1.2-dev \
    libsdl-ttf2.0-dev libsdl1.2-dev libsmpeg-dev python-numpy subversion libportmidi-dev \
    ffmpeg libswscale-dev libavformat-dev libavcodec-dev libfreetype6-dev gcc

Development version

If you want to install the current development version (unstable!):

pip install git+https://github.com/Farama-Foundation/HighwayEnv

or with uv:

uv pip install git+https://github.com/Farama-Foundation/HighwayEnv

Contributing / Development setup

If you want to contribute to HighwayEnv (insert smiley face here), these tools would be helpful to developers:

• uv — fast Python package manager with lockfile support (recommended for contributors), install with standalone installer or simply pip install uv.

• just — command runner used for common development tasks (see the Justfile), install with your package manager of choice.

Check How do I set up a development environment with pinned dependency versions? for how to set up a development environment using uv with the pinned lockfile, and What are the unit test coverage requirements for contributions? for the unit test coverage requirements enforced in CI.

See the full contribution guidelines on GitHub.