rom24-quickmud-python 2.4.1

A modern Python port of the ROM 2.4b6 MUD engine with full telnet server and JSON world loading

QuickMUD - A Modern ROM 2.4 Python Port

QuickMUD is a modern Python port of the legendary ROM 2.4b6 MUD engine, derived from ROM 2.4b6, Merc 2.1 and DikuMUD. This is a complete rewrite that brings the classic text-based MMORPG experience to modern Python with async networking, JSON world data, and 100% ROM 2.4b behavioral parity.

🎮 What is a MUD?

A "Multi-User Dungeon" (MUD) is a text-based MMORPG that runs over telnet. ROM is renowned for its fast-paced combat system and rich player interaction. ROM was also the foundation for Carrion Fields, one of the most acclaimed MUDs ever created.

✨ Key Features

• 🎯 100% ROM 2.4b Behavioral Parity: Verified through 227 differential tests against original ROM C
• 🚀 Modern Python Architecture: Fully async/await networking with SQLAlchemy ORM
• 📡 Multiple Connection Options: Telnet, WebSocket, and SSH server support
• 🗺️ JSON World Loading: Easy-to-edit world data with 352+ room resets
• 🏪 Complete Shop System: Buy, sell, and list items with working economy
• ⚔️ ROM Combat System: Classic ROM combat mechanics and skill system
• 👥 Social Features: Say, tell, shout, and 100+ social interactions
• 🛠️ Admin Commands: Teleport, spawn, ban management, and OLC building
• 📊 Comprehensive Testing: 1435+ tests ensure reliability and ROM parity
• 🔧 ROM C-Compatible API: Public API wrappers for external tools and scripts (27 functions)

📦 Installation

For Players & Server Operators

pip install quickmud

Quick Start

Run a QuickMUD server:

Telnet Server (port 5000):

python3 -m mud socketserver
# or
mud socketserver

WebSocket Server (port 8000):

python3 -m mud websocketserver
# or
mud websocketserver

SSH Server (port 2222):

python3 -m mud sshserver
# or
mud sshserver

All servers provide:

• ✓ Game tick running at 4 Hz
• ✓ Time advancement
• ✓ Mob AI active

Connect to the server:

Via Telnet:

telnet localhost 5000

Via SSH:

ssh -p 2222 player@localhost
# Note: SSH username/password are ignored; MUD authentication happens after connection

🏗️ For Developers

🏗️ For Developers

Development Installation

git clone https://github.com/Nostoi/rom24-quickmud-python.git
cd rom24-quickmud-python
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .[dev]

Running Tests

pytest  # Run all 1435 tests (should complete in ~16 seconds)

Development Server

python -m mud  # Start development server

🎯 Project Status

• Version: 2.2.1 (Production Ready)
• ROM 2.4b Parity: 100% (227/227 behavioral tests passing)
• ROM C Function Coverage: 96.1% (716/745 functions mapped)
• Test Coverage: 1435/1436 tests passing (99.93% success rate)
• Performance: Full test suite completes in ~16 seconds
• Compatibility: Python 3.10+, cross-platform

🏛️ Architecture

• Async Networking: Modern async/await with Telnet, WebSocket, and SSH servers
• SQLAlchemy ORM: Robust database layer with migrations
• JSON World Data: Human-readable area files with full ROM compatibility
• Modular Design: Clean separation of concerns (commands, world, networking)
• Type Safety: Comprehensive type hints throughout codebase

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines and feel free to submit pull requests.

📚 Documentation

• User Guide - Player and server operator documentation
• Admin Guide - Administrator and immortal documentation
• Builder Migration Guide - For ROM builders transitioning to QuickMUD
• ROM API Reference - ROM C-compatible public API
• Installation Guide
• Configuration
• World Building
• API Reference

---

Experience the classic MUD gameplay with modern Python reliability! 🐍✨

For a fully reproducible environment, use the pinned requirements files generated with pip-tools:

pip install -r requirements-dev.txt

To update the pinned dependencies:

pip-compile requirements.in
pip-compile requirements-dev.in

Tools like Poetry provide a similar workflow if you prefer that approach.

Run tests with:

pytest

Publishing

To release a new version to PyPI:

1. Update the version in pyproject.toml.
2. Commit and tag:

git commit -am "release: v1.2.3"
git tag v1.2.3
git push origin main --tags

The GitHub Actions workflow will build and publish the package when the tag is pushed.

Python Architecture

Game systems are implemented in Python modules:

• mud/net provides asynchronous telnet and websocket servers.
• mud/game_loop.py drives the tick-based update loop.
• mud/commands contains the command dispatcher and handlers.
• mud/combat and mud/skills implement combat and abilities.
• mud/persistence.py handles saving characters and world state.

Start the server with:

python -m mud runserver

Docker Image

Build and run the Python server with Docker:

docker build -t quickmud .
docker run -p 5000:5000 quickmud

Or use docker-compose to rebuild on changes and mount the repository:

docker-compose up

Connect via:

telnet localhost 5000

Data Models

The mud/models package defines dataclasses used by the game engine. They mirror the JSON schemas in schemas/ and supply enums and registries for loading and manipulating area, room, object, and character data.

Project Completeness

QuickMUD is a production-ready ROM 2.4b MUD with 95-98% behavioral parity to the original ROM C codebase:

✅ Fully Implemented Systems

• Combat Engine: Complete ROM combat mechanics with THAC0, damage calculations, and weapon special attacks
• Skills & Spells: All ROM skills and spells with correct formulas and targeting
• Character System: Classes, races, advancement, equipment, and encumbrance
• World System: Area loading, room resets, mob/object spawning, and JSON world data
• Shop Economy: Buy/sell with pricing formulas, shop restocking, and inventory management
• Communication: Say, tell, shout, channels, and 100+ social interactions
• Mob Programs: Complete trigger system with conditional logic and ROM API
• OLC Building: Area/room/mob/object/help editors with save/load functionality
• Admin Tools: Teleport, spawn, ban management, wiznet, and debug commands
• Networking: Async telnet, WebSocket, and SSH servers with game tick integration

📈 Quality Metrics

• Test Coverage: 1435/1436 tests passing (99.93% success rate)
• Behavioral Parity: 227/227 ROM differential tests passing
• Function Coverage: 716/745 ROM C functions mapped (96.1%)
• Performance: Full test suite completes in ~16 seconds

🔧 Advanced Features

For developers interested in extending QuickMUD beyond ROM 2.4b:

• Modern Architecture: Async/await networking, SQLAlchemy ORM, type hints
• JSON World Data: Human-readable area files (easier editing than ROM .are format)
• Multiple Protocols: Telnet, WebSocket, SSH connection options
• ROM API Wrapper: 27 public API functions for external tools and scripts
• Comprehensive Testing: Golden file tests derived from ROM C behavior
• Documentation: User guides, admin guides, and builder migration guides

📚 For Contributors

See ROM_PARITY_FEATURE_TRACKER.md for detailed feature status and AGENTS.md for AI-assisted development workflows.

Development Guidelines:

1. ROM Parity First: Reference original ROM 2.4 C sources in src/ for canonical behavior
2. Test Coverage: Add tests in tests/ with golden files derived from ROM behavior
3. Backward Compatibility: Don't break existing save files or area data
4. Documentation: Update relevant docs and inline code documentation
5. Performance: Consider impact on the main game loop and player experience

---

Experience authentic ROM 2.4 gameplay with modern Python reliability! 🐍✨