PipeWorks MUD Mapper

User Guide

  • Usage Guide
    • SQLite + Export Workflow
    • Starting the Application
    • Interface Overview
    • Workspace API Runner
    • Creating a New Map
    • Adding Rooms
    • Editing Rooms
    • Managing Exits
    • Generating Descriptions with Ollama
      • Template Strategy
      • Length Control (Target Words vs Tokens)
      • Sampling Controls (Temperature, Top-P, Top-K)
      • Short Output Checklist
    • Saving and Exporting
    • Validating Your Map
    • Keyboard Shortcuts
    • Tips and Best Practices
  • File Formats
    • SQLite + Export Workflow
    • Map JSON Export Format
      • Basic Structure
    • Zone File Format
      • Basic Structure
    • Top-Level Fields
    • Room Fields
    • Coordinate System
    • Exit Directions
    • Cross-Zone Exits
    • Example Map File
    • Example Zone File
    • Validation Rules

API Reference

  • API Reference
    • pipeworks_mud_mapper
      • Features
      • Architecture
      • Quick Start
      • Zone File Format
      • License
      • Submodules
        • pipeworks_mud_mapper.app
        • pipeworks_mud_mapper.callbacks
        • pipeworks_mud_mapper.components
        • pipeworks_mud_mapper.layout
        • pipeworks_mud_mapper.models
        • pipeworks_mud_mapper.services

Project

  • Changelog
    • Changelog
      • 0.1.10 (2026-02-09)
        • Features
        • Fixes
        • Documentation
        • Internal Changes
      • 0.1.9 (2026-02-04)
        • Fixes
        • Documentation
        • Internal Changes
      • 0.1.8 (2026-02-04)
        • Features
        • Internal Changes
      • 0.1.7 (2026-02-04)
        • Fixes
      • 0.1.6 (2026-02-04)
        • Features
      • 0.1.5 (2026-02-03)
        • Features
        • Fixes
        • Internal Changes
      • 0.1.4 (2026-02-03)
        • Features
      • 0.1.3 (2026-02-03)
        • Features
      • 0.1.2 (2026-02-03)
        • Features
      • 0.1.1 (2026-02-03)
        • Features
        • Fixes
        • Documentation
        • Internal Changes
      • 0.0.10 (2026-02-02)
        • Features
      • 0.0.9 (2026-02-02)
        • Features
        • Documentation
      • 0.0.8 (2026-02-02)
        • Features
        • Fixes
      • 0.0.7 (2026-02-02)
        • Features
      • 0.0.6 (2026-02-02)
        • Documentation
      • 0.0.5 (2026-02-02)
        • Features
        • Documentation
        • Internal Changes
      • 0.0.4 (2026-02-02)
        • Features
        • Fixes
      • 0.0.3 (2026-02-01)
        • Features
      • 0.0.2 (2026-02-01)
        • Features
        • Fixes
PipeWorks MUD Mapper
  • Search

© Copyright 2026, Andrew Park.

Built with Sphinx using a theme provided by Read the Docs.