A Gymnasium environment for the Nexus Platformer game with WebSocket communication
Project description
title: Nexus Gym emoji: 🚀 colorFrom: red colorTo: red sdk: docker app_port: 7860 app_file: main_train.py tags:
- fastapi
- reinforcement-learning
- gymnasium pinned: false short_description: NEXUS - an AI-powered platformer game with procedural level license: apache-2.0
Nexus Gym
A Gymnasium environment for the Nexus Platformer game, capable of training reinforcement learning agents via WebSocket communication.
Installation
pip install nexus-gym
Release Process
This project uses setuptools_scm for versioning, meaning the package version is derived automatically from Git tags.
1. Tag the Release
Create a new tag for the version you want to release (e.g., v0.1.0).
git tag v0.1.0
git push origin v0.1.0
# Or to push all tags: git push origin --tags
Note: The make release command will fail if your git repository has uncommitted changes. Ensure you are in a clean state.
2. Build the Package
This command runs the npm build for the game simulation and packages the Python project.
make release
3. Publish to TestPyPI (Optional)
It is recommended to upload to TestPyPI first to verify everything looks correct.
make publish-test
4. Publish to PyPI
When you are ready to publish the official release:
make publish
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nexus_gym-0.1.1.dev19.tar.gz.
File metadata
- Download URL: nexus_gym-0.1.1.dev19.tar.gz
- Upload date:
- Size: 145.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
01acc6e026bc17fa37c6fe95447e6f8edcdd8c927d96f9ffb1f3c1400fd07e46
|
|
| MD5 |
c13586abcf218355bd8e454a501c2c16
|
|
| BLAKE2b-256 |
9233b2b56a845e10763099e74e30d78e4412858426c79c8e77c0cd06aadd3d66
|
File details
Details for the file nexus_gym-0.1.1.dev19-py3-none-any.whl.
File metadata
- Download URL: nexus_gym-0.1.1.dev19-py3-none-any.whl
- Upload date:
- Size: 94.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d2df75429cfdaaa4320175f8d3e4cb3babd9cc1e33e276b45068c38ef04a524a
|
|
| MD5 |
d546fda1ace01c7db005eeee7125d0d9
|
|
| BLAKE2b-256 |
7c451dbddd609647cd9d859fb4ee0d68d267de58bc2305c1ef1a9291dd3ff16d
|