Skip to main content

MudGym

A Gymnasium reinforcement learning environment for MUD2. One of the first online multiplayer text adventure games.

Setup

A Docker engine is required to run the game. The image ghcr.io/rolo/mudgym is pulled automatically on first use.

Install MudGym from PyPI:

uv add mudgym

Quickstart

from mudgym import make_env

env = make_env(observation="parsed")
observation, info = env.reset()
observation, reward, terminated, truncated, info = env.step("howl")
print(observation["room_name"], reward)
env.close()

Docs

See the docs for more examples.

License

The Python code and tooling in this repository are made available under the MIT License.

Permission to use the MUD2 game for research purposes has been provided by Richard Bartle, with kind thanks. The MUD2 game, name, source code, and associated story remain the intellectual property of Richard Bartle and Roy Trubshaw and may not be used for commercial purposes.

Download files

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

Source Distribution

mudgym-0.3.0.tar.gz (84.9 kB view details)

Uploaded Source

Built Distribution

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

mudgym-0.3.0-py3-none-any.whl (106.5 kB view details)

Uploaded Python 3

File details

Details for the file mudgym-0.3.0.tar.gz.

File metadata

  • Download URL: mudgym-0.3.0.tar.gz
  • Upload date:
  • Size: 84.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mudgym-0.3.0.tar.gz
Algorithm Hash digest
SHA256 eadbb4fc1684e1c6290b20475c8ac61a9f7eeb8f48b13258a952642248b2fca2
MD5 154731ad7d2b6f0c460df90189f530e8
BLAKE2b-256 e1826a69a47cf470ff9562b30102b569f1a68d978e5d0db5c0a8e9cf0aabae01

See more details on using hashes here.

Provenance

The following attestation bundles were made for mudgym-0.3.0.tar.gz:

Publisher: release.yml on rolo/mudgym

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mudgym-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mudgym-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 106.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mudgym-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b25471092077537ac65e999898dd142360353b32b8eb1b59fa77ae79625b21f7
MD5 06f416a2ddeab24a7585ba55585aac6a
BLAKE2b-256 2546f5c7f88ba40384ef0bb7926e3592a4e1b56271bb3637b22a4b45c42e6593

See more details on using hashes here.

Provenance

The following attestation bundles were made for mudgym-0.3.0-py3-none-any.whl:

Publisher: release.yml on rolo/mudgym

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

This release

0.3.0 This release

2 files

Supported by

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