Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1.15 KB

README.md

File metadata and controls

21 lines (17 loc) · 1.15 KB
Raw

The Rocket League Gym

This is a python API that can be used to treat the game Rocket League as though it were an OpenAI Gym-style environment for Reinforcement Learning projects. This API must be used with the accompanying Bakkesmod plugin.

Requirements

  • A Windows 10 PC
  • Rocket League (Both Steam and Epic are supported)
  • Bakkesmod
  • The RLGym plugin for Bakkesmod (It's installed automatically by pip)
  • Python between versions 3.7 and 3.9 (3.10 not supported).

Installation

Install the library via pip:

pip install rlgym

Once the API is installed, you will need to enable the RLGym plugin from inside the Bakkesmod plugin manager. To do this, first launch the game, then press F2 to open the Bakkesmod menu. Navigate to the plugins tab and open the Plugin Manager. From there, scroll down until you find the RLGym plugin, and enable it. Close the game when this is done.

RLGym is now installed! simply run example.py from our repo to ensure everything works.

Usage

For tutorials and documentation, please visit our Wiki.