ranviermud/bundle-example-input-events

ranvier

Node.js-based MUD engine

Ranvier is a MUD game engine whose goal is to be a simple but powerful way to build whatever MUD you want with special care given to extensibility. The core code strives to be completely unopinionated toward any specific style of game while using the bundle system to build the game you want without having to dig through the engine's code.

Special Features

• Robust bundle system: Nearly every aspect of the game can be modified without changing the core and allows for easy packaging and sharing of commands/areas/items/npcs/channels/behaviors
• Unopinionated network layer: easily swap out telnet for any network layer you like. No need to gut the whole codebase just to support a different transport type, just drop in a file.
• Customizable data layer: You are not tied to saving in any particular database or file storage sytem
• Optional coordinate based room system allowing for the flexibilty of a standard MUD world with the easy mappability of a strict 3D world.
• Scripting for all entities in the game for any event along with behaviors to create shared, composable scripts
• Skill system with passive/active skills
• Effects e.g., buffs/debuffs
• Quest system allowing for starting/progress/completion from any event in the game
• Communication channels with custom audiences

Documentation

Ranvier prides itself on having thorough documentation which is available on our website: ranviermud.com

Slack

We have a Slack channel you can use to ask questions, suggest features, or just keep up to date with the project: https://ranviermud.slack.com

Get an invite

Requirements

• Node.js >= v10.12.0

Demo

Point your favorite client or telnet to ranviermud.com port 4000. This demo server is wiped and updated from the master branch every hour.

bundle-example-input-events's Issues

External Bundle Dependencies

It looks like three files require dependencies in ../../bundle-example-classes

• choose-class.js
• finish-player
• done

If we remove these dependencies this default bundle would be more widely applicable and facilitate looser coupling and higher cohesion with bundles that seek to alter the default class system. As it stands now, modifying class design requires unnecessary forking of this repository.

This issue could be fixed by doing,

1. Refactoring the aforementioned input-events into the bundle-example-classes
2. Synchronously calling these steps from bundle-example-input-events when necessary

The steps above could also be renamed to more descriptive steps,

• 'choose-class' -> 'init-new-player'
• 'finish-player' -> 'post-init-new-player'
• 'done' -> 'init-player'

This would allow any number of alternate packages to add listeners on these events. And so long as all the listeners synchronously execute, they could all configure the new player without altering the base package.

For example, if someone was writing a race bundle that allows players to select a race, they could write synchronous input-events that seamlessly fit into the design of this package.

Please let me know if you would like me to make a pull request with these changes, or if you have any input on this issue.