Skip to main content

A python API with zero dependencies to create fully customizable environments 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 Gym-style environment for Reinforcement Learning projects.

Installation

Install the library via pip:

pip install rlgym[all]  // Installs every rlgym component

pip install rlgym  // Installs only the api

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

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

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

Testing everything works

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

Dependency Management

DO NOT specify this package as a dependency, this is an installation only package.

You should depend directly on the package you're consuming and its corresponding extras, e.g. rlgym-rocket-league[sim], rlgym-api or whichever of our libraries your project is using.

Usage

For tutorials and documentation, please visit our Wiki.

We also provide the base RLGym API in its own standalone package with no dependencies.

Project details


Download files

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

Source Distribution

rlgym-2.0.0.tar.gz (9.2 kB view details)

Uploaded Source

File details

Details for the file rlgym-2.0.0.tar.gz.

File metadata

  • Download URL: rlgym-2.0.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.8

File hashes

Hashes for rlgym-2.0.0.tar.gz
Algorithm Hash digest
SHA256 6ea691f1eb693dd3172c3cd19f1e083e4709729ee1f24665b4de3124aca25e38
MD5 a9a0923ad7b2f567cb95ee884237c26d
BLAKE2b-256 9bc3d004dbfe6473bd2d02f68c70d0f91e9ddfe55945c99304fd9898f01e9094

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page