# 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 [OpenAI Gym](https://gym.openai.com)-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](https://www.bakkesmod.com)
* 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](https://rlgym.github.io/).
Raw data
{
"_id": null,
"home_page": "https://github.com/lucas-emery/rocket-league-gym",
"name": "rlgym",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<3.10",
"maintainer_email": "",
"keywords": "rocket-league,gym,reinforcement-learning",
"author": "Lucas Emery and Matthew Allen",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ef/0b/9eb6fbc6f6f070d48709ef47e0298c56ad07aef7a63606a5524bd45636d3/rlgym-1.2.2.tar.gz",
"platform": null,
"description": "# The Rocket League Gym\nThis is a python API that can be used to treat the game [Rocket League](https://www.rocketleague.com) as though it were an [OpenAI Gym](https://gym.openai.com)-style environment for Reinforcement Learning projects. This API must be used with the accompanying Bakkesmod plugin.\n\n## Requirements\n* A Windows 10 PC\n* Rocket League (Both Steam and Epic are supported)\n* [Bakkesmod](https://www.bakkesmod.com)\n* The RLGym plugin for Bakkesmod (It's installed automatically by pip)\n* Python between versions 3.7 and 3.9 (3.10 not supported).\n\n## Installation\nInstall the library via pip:\n```\npip install rlgym\n```\nOnce 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.\n\nRLGym is now installed! simply run ```example.py``` from our repo to ensure everything works.\n\n## Usage\nFor tutorials and documentation, please visit our [Wiki](https://rlgym.github.io/).",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A python API that can be used to treat the game Rocket League as an Openai Gym-like environment for Reinforcement Learning projects.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/lucas-emery/rocket-league-gym"
},
"split_keywords": [
"rocket-league",
"gym",
"reinforcement-learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef0b9eb6fbc6f6f070d48709ef47e0298c56ad07aef7a63606a5524bd45636d3",
"md5": "440fdbfc874b4b073dc6f8a6e259f24e",
"sha256": "73ea79117e32681c4639775290eb1ab4c32600cae96b4dc659a2ca99d0e4e1ff"
},
"downloads": -1,
"filename": "rlgym-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "440fdbfc874b4b073dc6f8a6e259f24e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<3.10",
"size": 127170,
"upload_time": "2023-07-29T21:33:25",
"upload_time_iso_8601": "2023-07-29T21:33:25.626046Z",
"url": "https://files.pythonhosted.org/packages/ef/0b/9eb6fbc6f6f070d48709ef47e0298c56ad07aef7a63606a5524bd45636d3/rlgym-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-29 21:33:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lucas-emery",
"github_project": "rocket-league-gym",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rlgym"
}
JSON
