Introduction

What is RLGym?

RLGym is a Python API for creating reinforcement learning environments. While it was originally designed for the game Rocket League, the core API is now game-agnostic. This means you can use the RLGym API to create a broad range of environments, from simple grid worlds to complex physics simulations. Check out the overview section for a detailed overview of the new API.

Getting Started

RLGym provides an implementation for Rocket League that uses RocketSim as a headless simulator. You can use the default settings or customize the environment by implementing your own configuration objects. Take a look at the Quickstart Guide to train your first Rocket League agent, or check out the Custom Environments section to see an example of how to create your own environment.

Installation

RLGym is split into sub-packages to keep things simple. The core API has no dependencies, and you can add extra features through these sub-packages:

# Installs only the api
pip install rlgym  

# Installs all rocket league packages
pip install rlgym[rl]  

# Installs only RocketSim rocket league packages
pip install rlgym[rl-sim]  

# Installs RLViser and RocketSim rocket league packages
pip install rlgym[rl-rlviser]  

# Installs every rlgym component
pip install rlgym[all]