rlgym

v1.2.2

A python API that can be used to treat the game Rocket League as an Openai Gym-like environment for Reinforcement Learning projects. For more information about how to use this package see README

Latest version published 1 year ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

43 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Limited

GitHub Stars: 204
Forks: 48
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package rlgym, we found that it has been starred 204 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 29, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like rlgym is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 14
Open PR: 10
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of rlgym based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for rlgym is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the rlgym repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like rlgym is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7,<3.10

Age: 4 years
Latest Release: 7 months ago
Dependencies: N/A
Versions: 22
Maintainers: 1
Wheels: No

Readme

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

FAQs

What is rlgym?

A python API that can be used to treat the game Rocket League as an Openai Gym-like environment for Reinforcement Learn... Visit Snyk Advisor to see a full health score report for rlgym, including popularity, security, maintenance & community analysis.

Is rlgym popular?

The python package rlgym receives a total of 554 weekly downloads. As such, rlgym popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is rlgym well maintained?

We found indications that rlgym is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is rlgym safe to use?

While scanning the latest version of rlgym, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 29 November-2024, at 11:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP