rom24-quickmud-python 1.2.2__tar.gz

rom24_quickmud_python-1.2.2/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2025-09-15
+
+### Added
+
+- Complete telnet server with multi-user support
+- Working shop system with buy/sell/list commands
+- 132 skill system with handler stubs
+- JSON-based world loading with 352 resets in Midgaard
+- Admin commands (teleport, spawn, ban management)
+- Communication system (say, tell, shout, socials)
+- OLC building system for room editing
+- pytest-timeout plugin for proper test timeouts
+
+### Fixed
+
+- Character position initialization (STANDING vs DEAD)
+- Hanging telnet tests resolved
+- Enhanced error handling and null room safety
+- Character creation now allows immediate command execution
+
+### Changed
+
+- Achieved 100% test success rate (200/200 tests)
+- Full test suite completes in ~16 seconds
+- Modern async/await telnet server architecture
+- SQLAlchemy ORM with migrations
+
+### Technical Improvements
+
+- Comprehensive test coverage across all subsystems
+- Memory efficient JSON area loading
+- Optimized command processing pipeline
+- Robust error handling throughout
+
+## [0.1.1] - 2025-09-14
+
+### Added
+
+- Initial ROM 2.4 Python port foundation
+- Basic world loading and character system
+- Core command framework
+- Database integration with SQLAlchemy
+
+### Changed
+
+- Migrated from legacy C codebase to pure Python
+- JSON world data format for easier editing
+- Modern Python packaging structure
+
+## [0.1.0] - 2025-09-13
+
+### Added
+
+- Initial project structure
+- Basic MUD framework
+- ROM compatibility layer
+- Core game loop implementation

rom24_quickmud_python-1.2.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 QuickMUD Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rom24_quickmud_python-1.2.2/MANIFEST.in

@@ -0,0 +1,15 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include pyproject.toml
+recursive-include mud *.py
+recursive-include data *.json
+recursive-include area *.are *.lst
+recursive-include doc *.md *.txt *.doc
+recursive-include tests *.py
+recursive-exclude tests/data *
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude .git*
+global-exclude .pytest_cache
+global-exclude *.log

rom24_quickmud_python-1.2.2/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: rom24-quickmud-python
+Version: 1.2.2
+Summary: A modern Python port of the ROM 2.4b6 MUD engine with full telnet server and JSON world loading
+Author-email: Mark Jedrzejczyk <mark.jedrzejczyk@gmail.com>
+Maintainer-email: Mark Jedrzejczyk <mark.jedrzejczyk@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Nostoi/rom24-quickmud-python
+Project-URL: Repository, https://github.com/Nostoi/rom24-quickmud-python.git
+Project-URL: Documentation, https://github.com/Nostoi/rom24-quickmud-python/blob/master/README.md
+Project-URL: Bug Tracker, https://github.com/Nostoi/rom24-quickmud-python/issues
+Project-URL: Changelog, https://github.com/Nostoi/rom24-quickmud-python/releases
+Keywords: mud,rom,game,mmo,telnet,server
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: SQLAlchemy<3,>=2.0
+Requires-Dist: typer>=0.9
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: fastapi>=0.68.0
+Requires-Dist: uvicorn>=0.15.0
+Requires-Dist: pytest-timeout>=2.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0; extra == "dev"
+Requires-Dist: pytest-timeout>=2.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: jsonschema>=4.0; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Requires-Dist: pytest-cov>=6.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.1.0; extra == "test"
+Dynamic: license-file
+
+# QuickMUD - A Modern ROM 2.4 Python Port
+
+[![PyPI version](https://badge.fury.io/py/quickmud.svg)](https://badge.fury.io/py/quickmud)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://img.shields.io/badge/tests-200%2F200%20passing-brightgreen.svg)](https://github.com/Nostoi/rom24-quickmud-python)
+
+**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 comprehensive testing.
+
+## 🎮 What is a MUD?
+
+A "[Multi-User Dungeon](https://en.wikipedia.org/wiki/MUD)" (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](http://www.carrionfields.net/), one of the most acclaimed MUDs ever created.
+
+## ✨ Key Features
+
+- **🚀 Modern Python Architecture**: Fully async/await networking with SQLAlchemy ORM
+- **📡 Multi-User Telnet Server**: Handle hundreds of concurrent players
+- **🗺️ 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
+- **📊 100% Test Coverage**: 200+ tests ensure reliability and stability
+
+## 📦 Installation
+
+### For Players & Server Operators
+
+```bash
+pip install quickmud
+```
+
+### Quick Start
+
+Run a QuickMUD server:
+
+```bash
+mud runserver
+```
+
+The server will start on `localhost:4000`. Connect with any telnet client:
+
+```bash
+telnet localhost 4000
+```
+
+## 🏗️ For Developers
+
+## 🏗️ For Developers
+
+### Development Installation
+
+```bash
+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
+
+```bash
+pytest  # Run all 200 tests (should complete in ~16 seconds)
+```
+
+### Development Server
+
+```bash
+python -m mud  # Start development server
+```
+
+## 🎯 Project Status
+
+- **Version**: 1.2.0 (Production Ready)
+- **Test Coverage**: 200/200 tests passing (100% success rate)
+- **Performance**: Full test suite completes in ~16 seconds
+- **Compatibility**: Python 3.10+, cross-platform
+
+## 🏛️ Architecture
+
+- **Async Networking**: Modern async/await telnet server
+- **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](LICENSE) file for details.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) and feel free to submit pull requests.
+
+## 📚 Documentation
+
+- [Installation Guide](docs/installation.md)
+- [Configuration](docs/configuration.md)
+- [World Building](docs/world-building.md)
+- [API Reference](docs/api.md)
+
+---
+
+**Experience the classic MUD gameplay with modern Python reliability!** 🐍✨
+
+For a fully reproducible environment, use the pinned requirements files generated with [pip-tools](https://github.com/jazzband/pip-tools):
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+To update the pinned dependencies:
+
+```bash
+pip-compile requirements.in
+pip-compile requirements-dev.in
+```
+
+Tools like [Poetry](https://python-poetry.org/) provide a similar workflow if you prefer that approach.
+
+Run tests with:
+
+```bash
+pytest
+```
+
+### Publishing
+
+To release a new version to PyPI:
+
+1. Update the version in `pyproject.toml`.
+2. Commit and tag:
+
+```bash
+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:
+
+```sh
+python -m mud runserver
+```
+
+## Docker Image
+
+Build and run the Python server with Docker:
+
+```bash
+docker build -t quickmud .
+docker run -p 5000:5000 quickmud
+```
+
+Or use docker-compose to rebuild on changes and mount the repository:
+
+```bash
+docker-compose up
+```
+
+Connect via:
+
+```bash
+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.

rom24_quickmud_python-1.2.2/README.md

@@ -0,0 +1,184 @@
+# QuickMUD - A Modern ROM 2.4 Python Port
+
+[![PyPI version](https://badge.fury.io/py/quickmud.svg)](https://badge.fury.io/py/quickmud)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://img.shields.io/badge/tests-200%2F200%20passing-brightgreen.svg)](https://github.com/Nostoi/rom24-quickmud-python)
+
+**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 comprehensive testing.
+
+## 🎮 What is a MUD?
+
+A "[Multi-User Dungeon](https://en.wikipedia.org/wiki/MUD)" (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](http://www.carrionfields.net/), one of the most acclaimed MUDs ever created.
+
+## ✨ Key Features
+
+- **🚀 Modern Python Architecture**: Fully async/await networking with SQLAlchemy ORM
+- **📡 Multi-User Telnet Server**: Handle hundreds of concurrent players
+- **🗺️ 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
+- **📊 100% Test Coverage**: 200+ tests ensure reliability and stability
+
+## 📦 Installation
+
+### For Players & Server Operators
+
+```bash
+pip install quickmud
+```
+
+### Quick Start
+
+Run a QuickMUD server:
+
+```bash
+mud runserver
+```
+
+The server will start on `localhost:4000`. Connect with any telnet client:
+
+```bash
+telnet localhost 4000
+```
+
+## 🏗️ For Developers
+
+## 🏗️ For Developers
+
+### Development Installation
+
+```bash
+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
+
+```bash
+pytest  # Run all 200 tests (should complete in ~16 seconds)
+```
+
+### Development Server
+
+```bash
+python -m mud  # Start development server
+```
+
+## 🎯 Project Status
+
+- **Version**: 1.2.0 (Production Ready)
+- **Test Coverage**: 200/200 tests passing (100% success rate)
+- **Performance**: Full test suite completes in ~16 seconds
+- **Compatibility**: Python 3.10+, cross-platform
+
+## 🏛️ Architecture
+
+- **Async Networking**: Modern async/await telnet server
+- **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](LICENSE) file for details.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) and feel free to submit pull requests.
+
+## 📚 Documentation
+
+- [Installation Guide](docs/installation.md)
+- [Configuration](docs/configuration.md)
+- [World Building](docs/world-building.md)
+- [API Reference](docs/api.md)
+
+---
+
+**Experience the classic MUD gameplay with modern Python reliability!** 🐍✨
+
+For a fully reproducible environment, use the pinned requirements files generated with [pip-tools](https://github.com/jazzband/pip-tools):
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+To update the pinned dependencies:
+
+```bash
+pip-compile requirements.in
+pip-compile requirements-dev.in
+```
+
+Tools like [Poetry](https://python-poetry.org/) provide a similar workflow if you prefer that approach.
+
+Run tests with:
+
+```bash
+pytest
+```
+
+### Publishing
+
+To release a new version to PyPI:
+
+1. Update the version in `pyproject.toml`.
+2. Commit and tag:
+
+```bash
+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:
+
+```sh
+python -m mud runserver
+```
+
+## Docker Image
+
+Build and run the Python server with Docker:
+
+```bash
+docker build -t quickmud .
+docker run -p 5000:5000 quickmud
+```
+
+Or use docker-compose to rebuild on changes and mount the repository:
+
+```bash
+docker-compose up
+```
+
+Connect via:
+
+```bash
+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.