Documentation for the Lucid Mud Engine
      __              _     __   __  ___          __   ______            _
     / /  __  _______(_)___/ /  /  |/  /_  ______/ /  / ____/___  ____ _(_)___  ___
    / /  / / / / ___/ / __  /  / /|_/ / / / / __  /  / __/ / __ \/ __  / / __ \/ _ \
   / /__/ /_/ / /__/ / /_/ /  / /  / / /_/ / /_/ /  / /___/ / / / /_/ / / / / /  __/
  /_____|__,_/\___/_/\__,_/  /_/  /_/\__,_/\__,_/  /_____/_/ /_/\__, /_/_/ /_/\___/
                                                              /____/

Build Status Codacy Badge

The Lucid Mud Engine is a “batteries included” modern framework for building online interactive text games AKA MUDs. It is powered by NodeJS and Moleculer and written in Typescript.

Project Status

Lucid MUD Engine is under active development, and working it’s way to it’s first demo release. While not yet ready to go ahead and start developing your own MUD, the documentation is updated constantly as new features are added.

Requirements

  • PostgreSQL 9
  • Redis
  • NodeJS 10.4

Getting Started

  1. npm install -g yo generator-lucid-engine
  2. yo lucid-engine
  3. follow the prompts.
  4. yarn install
  5. yarn portal:run and in a separate session yarn world:run
Tags: readme