Skip to content

README.md

Latest commit

 

History

History
62 lines (44 loc) · 1.06 KB

README.md

File metadata and controls

62 lines (44 loc) · 1.06 KB

What is this?

A framework for building multi-user dungeons. It currently handles:

  • client connections
  • global events
  • command parsing
  • data persistence

Getting Started

Requirements

  • docker
  • docker-compose
# Add user to docker group
~/PyMUD$: sudo gpasswd -a $USER docker

# Start the dev environment
~/PyMUD$: make dev

# Connect
~/PyMUD$: telnet localhost 8000

Running locally

Create a .env file with your local database configuration

DATABASE_URI=postgresql://localhost:5432/pymud

# Set up a virtual env
python -m venv venv
source venv/bin/activate

# Install packages
pip install -r requirements.txt
python -m spacy download en_core_web_sm

# Run migrations
PYTHONPATH=./src alembic upgrade head

# Init data (only do this once)
PYTHONPATH=./src python ./src/data/init_data.py

# Run the server
PYTHONPATH=./src python ./src/pymud.py

To Do

  • Finish validation of targetting
  • Build commands
  • Containers
  • Character Creation & Authentication
  • Combat
  • Chracter advancement