rlgym

Name	rlgym JSON
Version	2.0.0 JSON
	download
home_page	https://rlgym.org
Summary	A python API with zero dependencies to create fully customizable environments for Reinforcement Learning projects.
upload_time	2025-01-06 18:40:24
maintainer	None
docs_url	None
author	Lucas Emery, Matthew Allen and Rolv-Arild Braaten
requires_python	>=3.7
license	Apache 2.0
keywords	rocket-league gym reinforcement-learning rlgym
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://rlgym.org",
    "name": "rlgym",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "rocket-league, gym, reinforcement-learning, rlgym",
    "author": "Lucas Emery, Matthew Allen and Rolv-Arild Braaten",
    "author_email": "contact@rlgym.org",
    "download_url": "https://files.pythonhosted.org/packages/9b/c3/d004dbfe6473bd2d02f68c70d0f91e9ddfe55945c99304fd9898f01e9094/rlgym-2.0.0.tar.gz",
    "platform": null,
    "description": "# The Rocket League Gym\r\nThis is a python API that can be used to treat the game [Rocket League](https://www.rocketleague.com) as though it were an \r\n[Gym](https://gymnasium.farama.org/)-style environment for Reinforcement Learning projects. \r\n\r\n\r\n## Installation\r\nInstall the library via pip:\r\n```\r\npip install rlgym[all]  // Installs every rlgym component\r\n\r\npip install rlgym  // Installs only the api\r\n\r\npip install rlgym[rl]  // Installs all rocket league packages\r\n\r\npip install rlgym[rl-sim]  // Installs only RocketSim rocket league packages\r\n\r\npip install rlgym[rl-rlviser]  // Installs RLViser and RocketSim rocket league packages\r\n```\r\n\r\n### Testing everything works\r\nRLGym is now installed! simply run ```example.py``` from our repo to ensure everything works.\r\n\r\n## Dependency Management\r\n**DO NOT** specify this package as a dependency, this is an **installation only** package.\r\n\r\nYou should depend directly on the package you're consuming and its corresponding extras, e.g.\r\n`rlgym-rocket-league[sim]`, `rlgym-api` or whichever of our libraries your project is using.\r\n\r\n## Usage\r\nFor tutorials and documentation, please visit our [Wiki](https://rlgym.org/).\r\n\r\nWe also provide the base RLGym API in its own [standalone package](https://pypi.org/project/rlgym-api/) with no dependencies.\r\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "A python API with zero dependencies to create fully customizable environments for Reinforcement Learning projects.",
    "version": "2.0.0",
    "project_urls": {
        "Homepage": "https://rlgym.org",
        "Source Code": "https://github.com/lucas-emery/rocket-league-gym"
    },
    "split_keywords": [
        "rocket-league",
        " gym",
        " reinforcement-learning",
        " rlgym"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9bc3d004dbfe6473bd2d02f68c70d0f91e9ddfe55945c99304fd9898f01e9094",
                "md5": "a9a0923ad7b2f567cb95ee884237c26d",
                "sha256": "6ea691f1eb693dd3172c3cd19f1e083e4709729ee1f24665b4de3124aca25e38"
            },
            "downloads": -1,
            "filename": "rlgym-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a9a0923ad7b2f567cb95ee884237c26d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 9184,
            "upload_time": "2025-01-06T18:40:24",
            "upload_time_iso_8601": "2025-01-06T18:40:24.354440Z",
            "url": "https://files.pythonhosted.org/packages/9b/c3/d004dbfe6473bd2d02f68c70d0f91e9ddfe55945c99304fd9898f01e9094/rlgym-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-06 18:40:24",
    "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"
}