MythosMUD Scripts

June 4, 2026 · View on GitHub

This directory contains utility scripts for managing the MythosMUD development environment.

PowerShell Scripts

`start_server.ps1`

Starts the MythosMUD FastAPI server with optional process cleanup.

Usage:

.\start_server.ps1 [-ServerHost <string>] [-Port <int>] [-Reload]

Parameters:

-ServerHost: Host address to bind server to (default: "127.0.0.1")
-Port: Port number to bind server to (default: 54768)
-Reload: Enable auto-reload for development (default: false - hot reloading disabled due to client compatibility issues)

Examples:

# Start with default settings

.\start_server.ps1

# Start on all interfaces, port 8080, with auto-reload enabled

.\start_server.ps1 -ServerHost "0.0.0.0" -Port 8080 -Reload

`stop_server.ps1`

Stops MythosMUD server processes using multiple detection methods.

Usage:

.\stop_server.ps1 [-Force] [-Verbose]

Parameters:

-Force: Force termination of all Python processes regardless of command line
-Verbose: Provide detailed output (automatically available due to CmdletBinding)

Examples:

# Stop server processes gracefully

.\stop_server.ps1

# Force stop all Python processes with detailed output

.\stop_server.ps1 -Force -Verbose

`start_local.ps1`

Starts the complete MythosMUD development environment (both FastAPI server and React client).

Usage:

.\start_local.ps1

Features:

Starts the FastAPI server using start_server.ps1
Starts the React development server
Provides URLs for all development services

Python Scripts

`run.py`

Runs the MythosMUD server using uvicorn.

Database Initialization (PostgreSQL)

Database initialization is handled via environment-specific DDL files: db/mythos_dev_ddl.sql, db/mythos_unit_ddl.sql, and db/mythos_e2e_ddl.sql. Use the one that matches your database. See data/db/README.md and db/ for database setup instructions.

Note: SQLite database initialization scripts have been removed as the project now uses PostgreSQL exclusively.