MudGym

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

Status

MudGym is a work in progress and very much under active development.

I've been using most of what's in here myself for a while, but the process of putting it out for wider use, and seeing how it gets used for real, means I'm still refining and settling some of the interfaces and assumptions.

So for now, be prepared for interfaces, APIs, specs and defaults to change, sometimes in breaking ways. If you're using MudGym, feedback and real-world use cases are very welcome.

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.4.6.tar.gz (84.7 kB view details)

Uploaded Sep 6, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mudgym-0.4.6-py3-none-any.whl (107.8 kB view details)

Uploaded Sep 6, 2026 Python 3

File details

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

File metadata

Download URL: mudgym-0.4.6.tar.gz
Upload date: Sep 6, 2026
Size: 84.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mudgym-0.4.6.tar.gz
Algorithm	Hash digest
SHA256	`a2c2929dc3ba82154e3cbba0600f0d15bad4bdde10e7143cc55848e3e5649af1`
MD5	`6d830e5cf33121a68db972384ad9de1a`
BLAKE2b-256	`ecb53f58a5cb3632476b1244b3ac06b7f6044044573a90574cab4e52dd225e2c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for mudgym-0.4.6.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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: mudgym-0.4.6.tar.gz
- Subject digest: a2c2929dc3ba82154e3cbba0600f0d15bad4bdde10e7143cc55848e3e5649af1
- Sigstore transparency entry: 2742702708
- Sigstore integration time: Sep 6, 2026
Source repository:
- Permalink: rolo/mudgym@0dfbd600968656b59c3284a9a40ff1457cf10328
- Branch / Tag: refs/tags/v0.4.6
- Owner: https://github.com/rolo
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@0dfbd600968656b59c3284a9a40ff1457cf10328
- Trigger Event: push