Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nexus_gym-0.1.1.dev36.tar.gz (149.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nexus_gym-0.1.1.dev36-py3-none-any.whl (102.2 kB view details)

Uploaded Python 3

File details

Details for the file nexus_gym-0.1.1.dev36.tar.gz.

File metadata

  • Download URL: nexus_gym-0.1.1.dev36.tar.gz
  • Upload date:
  • Size: 149.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for nexus_gym-0.1.1.dev36.tar.gz
Algorithm Hash digest
SHA256 2745c7712cfa2e0cda7d173a1541e535302d7bbd7268ba1d55f4dd623bb6c830
MD5 25b55594a249ef2b966934ff948faaaa
BLAKE2b-256 dfad18c3c36931d85801f997503ab62379e718c4bace09042f228e78449fbb59

See more details on using hashes here.

File details

Details for the file nexus_gym-0.1.1.dev36-py3-none-any.whl.

File metadata

  • Download URL: nexus_gym-0.1.1.dev36-py3-none-any.whl
  • Upload date:
  • Size: 102.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for nexus_gym-0.1.1.dev36-py3-none-any.whl
Algorithm Hash digest
SHA256 5d6bbe8448e72fe3730f278ab59acafc5c75d2a56abd0f99f3cd6f685d96663f
MD5 73f24df0f2fd8945de34be6eb6b3fe86
BLAKE2b-256 79205c4cf6c5714bd942a9aefc5c35cff070cba00301ec11d2cc1b9db248f805

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page