/MudDungeonJS

A mud engine using telnet and Web sockets for web built with NodeJs

Primary LanguageJavaScriptMIT LicenseMIT

MudDungeonJS

A JavaScript MUD codebase running on Node.js

Join the chat at https://gitter.im/LiamKenneth/MudDungeonJS codecov.io

Alt text

MudDungonJS is a text based MMORPG also known as a MUD(Multi User Dungeon). The goal of this project is to build an immersive fantasy world that you can get lost in. As well as improve your Javascript, node.js and Testing skills!

#How to run it Due to ES6 use this requires Node version >= 4.2.6

  • Download the project
  • Enter npm install
  • Enter npm start to start the project
  • Go to 127.0.0.1:4000 in a mud client or http://localhost:4001 in your browser
  • The password for your character is 123
  • ^ until the ability of setting a password is added.

#Testing & Coverage

  • npm test generates coverage report & run tests

#eslint

  • npm run lint

#Commands Currently implemented commands

  • N,E,S,W,U,D - Movement
  • Get, drop, look, look at/in, examine
  • inventory
  • score
  • help
  • say

#Features What's available now

  • Character Creation
    • name
    • password (plain text)
    • race selection
    • class selection
  • 2 rooms for testing, no real thought in to world design yet
  • look at items, look in containers
  • examine items for more information
  • drop items
  • view inventory
  • view your player sheet
  • view helpfiles (Only one file at the moment and needs to be rewritten)

#Todo I'll Update this as i remember also will add these in the issue tracker.

  • put command for storing items in containers
  • give command for giving items to players or npc
  • all keyword to take all or drop all, etc
  • World design
  • starter Town Rooms
  • shops
    • commands for buying, selling, inspecting items
  • tick update HP, mana, mvs
  • Fighting
  • Spells
  • Skills
  • Quests
  • Main story?