Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.0b1.tar.gz (68.1 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.0b1-py3-none-any.whl (86.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mudgym-0.3.0b1.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.0

File hashes

Hashes for mudgym-0.3.0b1.tar.gz
Algorithm Hash digest
SHA256 2f6efb83cb5800236bc1a7c06668a81e8a813eea4b5afe1cf973268fec356fd4
MD5 e591ed058c091c1dee0d122a7acf081f
BLAKE2b-256 d31f42744e8b172bd66849faebadf9e3919babaf615f04793028485c419a3093

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mudgym-0.3.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 180c77a4a2c6c5b3de4f68f5eae9d13ef5bcb39760ec90e80aaf652a538ea627
MD5 f86310cbbacbf4e1dfe88c18e85aa9b7
BLAKE2b-256 79b7373700787d75301a79bd0259d6762c2608371cbfd902fb2f6dedec022ab9

See more details on using hashes here.

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

0.3.0

2 files

This release

0.3.0b1 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