Skip to main content

A game server for hosting text-based online MOO-like games.

Project description

DjangoMOO

"LambdaMOO on Django"

release pipeline coverage quality docs

DjangoMOO is a MOO server built on Python and Django. A MOO is a persistent online text world where objects — rooms, things, players — have properties and verbs (methods) that define how they behave. Those verbs are written in Python and run in a sandboxed execution environment, so the world itself is programmable by its inhabitants.

The design follows the LambdaMOO model where it makes sense: a parsed command line, verb dispatch through the caller's inventory and location, object inheritance, and a permission system. The implementation is independent — no MOO bytecode, no C — just Python and Django.

Documentation | GitLab | GitHub mirror | PyPI

What's included

  • A LambdaMOO-inspired parser with full dobj/iobj preposition support
  • Objects, Properties, Verbs, and a ManyToMany inheritance hierarchy backed by PostgreSQL
  • A RestrictedPython verb sandbox with and integrated permissions system and extensive testing
  • A default bootstrap world: rooms, exits, containers, players, a lighting system, in-world mail, and an object placement system
  • Browser playable with no client required, or via plain SSH client
  • Full support for MUDlet and other MUD clients using sshelnet helper
  • Django admin for browsing and editing the world's objects, properties, and verb source
  • Docker for self-hosting with docker compose up

Quick Start

git clone https://gitlab.com/bubblehouse/django-moo
cd django-moo
docker compose up

Bootstrap the database and create your first wizard:

docker compose run webapp manage.py migrate
docker compose run webapp manage.py collectstatic
docker compose run webapp manage.py moo_init
docker compose run webapp manage.py createsuperuser --username wizard
docker compose run webapp manage.py moo_enableuser --wizard wizard Wizard

Connect at https://localhost/ and log in with the account you just created.

Interfaces

MUD Clients

A Mudlet package in extras/mudlet/ provides one-click setup for MUD-client users. Mudlet has no native SSH support, so the package bundles a managed sshelnet launcher that bridges Mudlet's plain-TCP connection to the server's SSH port. It also ships a setup wizard (dmsetup) and a generic-mapper bridge that subscribes to GMCP Room.Info events and feeds them into Mudlet's bundled mapper.

Mudlet Client Example

The server speaks GMCP, MSSP, MSP, EOR, and CHARSET, so other clients (TinTin++, MUSHclient, Blightmud) work too, though without the bundled mapper integration, or automatic sshelnet setup. MXP is not implemented.

Web (WebSocket SSH)

The server is accessible through a browser-based SSH client at /. No SSH client needed.

WebSSH Client Example

WebSSH Editor Example

SSH

Direct SSH access is also available.

ssh -p 8022 yourname@localhost

SSH Client Example

Hit Ctrl-D to disconnect.

Changing your password and managing SSH keys

Credentials are managed from inside the world with in-game verbs rather than the Django admin:

  • @password — interactively changes your password. Prompts for the old password, then the new one twice for confirmation. Wizards may leave the old password blank to perform an administrative reset.
  • @keys — lists your currently registered SSH public keys.
  • @add-key <public-key> — registers a new SSH public key. The key name is taken from the comment field automatically.
  • @remove-key <index> — removes a key by its index from @keys.

Once a key is registered, reconnecting with ssh -p 8022 yourname@localhost skips the password prompt.

Django Admin

A full Django admin interface is available at /admin for managing objects, properties, verbs, and users.

Django Admin Example

LambdaCore attributions

This package is derived from the LambdaMOO and LambdaCore documentation, including the LambdaCore Programmer's Manual and the LambdaMOO Programmer's Manual. The code was written without reading the original LambdaCore source; it is an independent reimplementation based on documented behavior and conventions.

Various verbs have been modified from their LambdaCore equivalents to better fit a Pythonic codebase: output uses print() rather than return values, property access follows Django ORM patterns, and permission idioms have been updated to account for differences in how this server dispatches verbs compared to LambdaMOO.

DjangoMOO could not have happened without the work of the following authors:

  • LambdaCore Database User's Manual (LambdaMOO 1.3, April 1991) Mike Prudence (blip), Simon Hunt (Ezeke), Floyd Moore (Phantom), Kelly Larson (Zaphod), Al Harrington (geezer)

  • LambdaCore Programmer's Manual (LambdaMOO 1.8.0p6, Copyright 1991) Mike Prudence (blip), Simon Hunt (Ezeke), Floyd Moore (Phantom), Kelly Larson (Zaphod), Al Harrington (geezer)

  • LambdaMOO Programmer's Manual (LambdaMOO 1.8.0p6, March 1997) Pavel Curtis (Haakon / Lambda)

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

django_moo-1.5.0.tar.gz (695.4 kB view details)

Uploaded Source

Built Distribution

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

django_moo-1.5.0-py3-none-any.whl (499.9 kB view details)

Uploaded Python 3

File details

Details for the file django_moo-1.5.0.tar.gz.

File metadata

  • Download URL: django_moo-1.5.0.tar.gz
  • Upload date:
  • Size: 695.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for django_moo-1.5.0.tar.gz
Algorithm Hash digest
SHA256 f3cdd834525081d08b6e9d04a70ac0a6afea7a0065c50408e1b8d0891a0ca692
MD5 fcbefa9a9a7255cf065b9c8012fcb6e8
BLAKE2b-256 d57724139dec3511b31902bf68129ae8fdb5e763e7a5825ec755bc06dd19b76e

See more details on using hashes here.

File details

Details for the file django_moo-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: django_moo-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 499.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for django_moo-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c006418691ab91ccecbfa8a2d5da7151a019a8c8e0767d1ff61b8a06877e3699
MD5 6d740effe7d01a9b1834a70cd61ae733
BLAKE2b-256 cebdd9d4e1bf69f476bb15555af2c9422f55d0b12609899c2813fdbcd434fb56

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