Startseite Erkunden Hilfe
Registrieren Anmelden
midas
/
starmire
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

Inspired by LDMUD, this is a telnet, websocket and ssh server that hosts a text-based game. The codebase allows for on-the-fly load/reload code.

Branch: barebones
Branches Tags
starmire
ZIP TAR.GZ
Justin Gilman 7fc3e529a9 removing custom rooms, setting up barebones vor 6 Jahren
players 2a4b5eb743 adding in stubs for phandalin; adding in ability for a player to change their password; refactoring hash command vor 6 Jahren
system ef46240eb8 adding in optional call to function for custom name and description for room, item, mobile; adding in additional error handling for telnet socket connection reset vor 6 Jahren
website 8d509809c4 disabling web console interaction when field is disabled vor 6 Jahren
world 7fc3e529a9 removing custom rooms, setting up barebones vor 6 Jahren
.gitignore f2d1ea27b9 adding basics for ssh server vor 6 Jahren
README.md caeff42719 updating readme vor 6 Jahren
banner.txt 11067c83cc fixing issues with permissions; moving banner out of json and into plaintext file; fixing formatting issues with the banner change vor 6 Jahren
config.json 11067c83cc fixing issues with permissions; moving banner out of json and into plaintext file; fixing formatting issues with the banner change vor 6 Jahren
index.js fe42b416af moving rooms, items, mobile into 'world' directory; moving all system-level classes into 'system' directory; consolidating configs, adding entrypoint for npm start; deleting unused json data; updating readme vor 6 Jahren
package.json 05eb9e2d3b updating package info vor 6 Jahren

README.md

starmire

Inspired by LDMUD, this is a telnet, websocket and ssh server that hosts a mud game world. The codebase allows for active load/reload code. Rooms, items, mobiles are all classes, and they have the full capabilties of any javascript code. There are no restrictions on how this can work, so the only thing limiting your world is your own imagination. (And coding skills)

Dependencies

npm install glob websocket ssh2 mime-types

You will also need to generate an ssh key if you plan to use the ssh server.

ssh-keygen -t rsa -b 4096 -C "nodemud server" -f ./id_rsa

For ease of setup, you should be able to just run

npm install

and all of this will be taken care of. Be careful; it will regenerate your SSH key which will cause your users to see a warning.

How to start the server

The server is set up to automatically run using node. Just execute

./system/server.js

or

npm start

Configuration

The config.json file has some basic configuration settings. Otherwise, just dive in!

Basic Commands

Once the server is running, you can log in using the default admin account (admin:admin) and input commands. You can type 'help' to see a list of all the commands available to you. If you need more details, you can type 'help [topic]'

Error handling is done internally; if the class doesn't run or hits an error, the server will continue happily after outputting the stack trace. Obviously if you screw up some of the classes you can break the server, but the intention is to allow the server to continue running while coders make active changes to it.