/mud-of-babel

Primary LanguageJavaScriptMIT LicenseMIT

MUD of Babel

Generative Redis-based Multi-User Dungeon (MUD). The rooms are built from the Library of Congress Classification Outline.

I talked about the background on this project during a ligtning talk in Code4lib 2018. View the slides.

Installing and running

This MUD uses Redis for session and state management.

  1. Rename the .env.example file to .env and provide the applicable values
  2. Install Yarn (brew install yarn if you have Homebrew)
  3. Run your Redis server (usually redis-server)
  4. Clone/download this repository
  5. Run yarn to install necessary packages.
  6. Run yarn start to start the server which is now available in port 3001 (to run the server in debug mode use yarn debug instead)

Changing the game file

There's a Jupyter notebook (Python) in the python folder that can give you an idea. Running it will output a mud_of_babel_data.json file which you can use to overwrite the gameData variable in cartridges/mud.js (just copy/paste the entirety of the data file as the value for that variable).

Credits

Built on a heavily-modified version of TextAdventure.js.