https://github.com/om-mani-padme-hum/muddy
A Node.js Multi-User Dungeon (MUD) Framework
https://github.com/om-mani-padme-hum/muddy
cli client-server dungeon dungeons-and-dragons game mud mud-server muddy multi-user-dungeon telnet telnet-server virtual-worlds
Last synced: about 1 month ago
JSON representation
A Node.js Multi-User Dungeon (MUD) Framework
- Host: GitHub
- URL: https://github.com/om-mani-padme-hum/muddy
- Owner: om-mani-padme-hum
- License: mit
- Created: 2017-09-16T22:11:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T21:16:36.000Z (about 1 year ago)
- Last Synced: 2024-10-20T08:05:33.974Z (about 1 year ago)
- Topics: cli, client-server, dungeon, dungeons-and-dragons, game, mud, mud-server, muddy, multi-user-dungeon, telnet, telnet-server, virtual-worlds
- Language: JavaScript
- Size: 450 KB
- Stars: 23
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Muddy v0.11.7 [](http://hits.dwyl.com/om-mani-padme-hum/muddy)
A Node.js Multi-User Dungeon (MUD) Framework
## Current Status:
* A good amount of basic functionality in place, but still under development.
* Ability to build onto world while in game partially in place, now can edit items, rooms, and areas.
* Web-based builder interface partially in place, not very useful just yet but some editing is possible.
* Basic fighting has now been added, including incapacitated state and natural healing over time!
* Item stats have been added, and formulas for their effects on fighting and health, mana, move are developed but not implemented
## Installation
Clone muddy:
1. `git clone https://github.com/om-mani-padme-hum/muddy.git`
Enter muddy directory and install dependencies:
2. `cd muddy` (symbolic, just get in the directory)
3. `npm install`
Set up the MySQL database:
4. Download [MySQL](https://www.mysql.com/downloads/) and install, if not already installed.
5. Create a database schema for muddy and import the [muddy.sql](https://github.com/om-mani-padme-hum/muddy/blob/master/muddy.sql) file.
6. Create a JSON file called `mysql-config.json` in the muddy directory with your MySQL info:
```json
{
"host" : "localhost",
"user" : "muddy",
"password" : "S3cur3UrMuD!",
"database" : "muddy"
}
```
Start it up!
7. `npm start`
Login:
8. `telnet localhost 9000`
For the web builder, browse to:
9. `http://localhost:7001/`
## Currently Implemented Commands:
* alist
* astat
* colors
* commands
* create
* dlist
* down
* drop
* dstat
* east
* edit
* equipment
* get
* goto
* look
* help
* ilist
* inventory
* istat
* kill
* mlist
* mstat
* north
* northeast (ne)
* northwest (nw)
* put
* quit
* remove
* rlist
* rstat
* say
* save
* score
* shutdown
* south
* southeast (se)
* southwest (sw)
* title
* up
* ustat
* wear
* west
* who
* wield
## Latest Changes
* Database SQL updated to match code
* Added mobile instance and prototype editing in game
* Ability to create exits in game
* Added elemental properties to characters
* Added help and score commands, default help added, many more to do
* Fixed bugs with capitalization and colors on new character logins
* Ability to look at item details
* Ability to edit item instances and prototypes in game
* Updated database example to match code
* Decided on equipment stats of accuracy, armor, deflection, dodge, power, and speed
* Character positions and command restriction by position
* Basic fighting with incapacitation
* Natural healing over time periodic update
## Planned Track:
* Web-based user interface that can be enabled/disabled for area development and mobile scripting
* Full-fledged fight engine with easy to implement modifiers for powerful, yet easy fight customizability
* Massive, in-game expandable, interactive and dynamic world, with a range of areas, rooms, items, and mobiles
* Random and wide-ranging item rarities and stats, customization on top of that
* Advanced mobile scripting capabilities, along with dynamic weather and other periodic events, all customizable
* Paths and races, each with their unique benefits, deficiencies, and skillsets, again completely customizable
# License
MIT