https://github.com/lucas-emery/rocket-league-gym
A Gym-like environment for Reinforcement Learning in Rocket League
https://github.com/lucas-emery/rocket-league-gym
gym-environment hacktoberfest reinforcement-learning rocket-league
Last synced: 3 months ago
JSON representation
A Gym-like environment for Reinforcement Learning in Rocket League
- Host: GitHub
- URL: https://github.com/lucas-emery/rocket-league-gym
- Owner: lucas-emery
- License: apache-2.0
- Created: 2020-10-15T16:10:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T01:59:35.000Z (6 months ago)
- Last Synced: 2025-03-02T09:08:04.761Z (4 months ago)
- Topics: gym-environment, hacktoberfest, reinforcement-learning, rocket-league
- Language: Python
- Homepage:
- Size: 6.23 MB
- Stars: 217
- Watchers: 10
- Forks: 51
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deep-rl - RLGym - A python API to treat the game Rocket League as an OpenAI Gym environment. (Environments)
README
# The Rocket League Gym
This is a python API that can be used to treat the game [Rocket League](https://www.rocketleague.com) as though it were an
[Gym](https://gymnasium.farama.org/)-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](https://rlgym.org/).
We also provide the base RLGym API in its own [standalone package](https://pypi.org/project/rlgym-api/) with no dependencies.