Skip to main content

A python API that can be used to treat the game Rocket League as an Openai Gym-like environment for Reinforcement Learning projects.

Project description

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 >= 3.7

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rlgym, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size rlgym-1.0.1.tar.gz (117.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page